Class: WhiteLabelMachineName::PaymentAppProcessor

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentAppProcessor

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 117

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'configuredEnvironment')
    self.configured_environment = attributes[:'configuredEnvironment']
  end

  if attributes.has_key?(:'createdOn')
    self.created_on = attributes[:'createdOn']
  end

  if attributes.has_key?(:'documentationUrl')
    self.documentation_url = attributes[:'documentationUrl']
  end

  if attributes.has_key?(:'externalId')
    self.external_id = attributes[:'externalId']
  end

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'installationId')
    self.installation_id = attributes[:'installationId']
  end

  if attributes.has_key?(:'linkedSpaceId')
    self.linked_space_id = attributes[:'linkedSpaceId']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'processorConfiguration')
    self.processor_configuration = attributes[:'processorConfiguration']
  end

  if attributes.has_key?(:'productionModeUrl')
    self.production_mode_url = attributes[:'productionModeUrl']
  end

  if attributes.has_key?(:'state')
    self.state = attributes[:'state']
  end

  if attributes.has_key?(:'svgIcon')
    self.svg_icon = attributes[:'svgIcon']
  end

  if attributes.has_key?(:'updatedOn')
    self.updated_on = attributes[:'updatedOn']
  end

  if attributes.has_key?(:'usableInProduction')
    self.usable_in_production = attributes[:'usableInProduction']
  end

  if attributes.has_key?(:'usableInProductionSince')
    self.usable_in_production_since = attributes[:'usableInProductionSince']
  end

  if attributes.has_key?(:'version')
    self.version = attributes[:'version']
  end
end

Instance Attribute Details

#configured_environment ⇒ Object

Returns the value of attribute configured_environment.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 24

def configured_environment
  @configured_environment
end

#created_on ⇒ Object

The created on date is the date when this processor has been added.



27
28
29
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 27

def created_on
  @created_on
end

#documentation_url ⇒ Object

The documentation URL points to a web site that describes how to configure and use the processor.



30
31
32
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 30

def documentation_url
  @documentation_url
end

#external_id ⇒ Object

The external ID corresponds to the ID that was provided during creation of the processor.



33
34
35
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 33

def external_id
  @external_id
end

#id ⇒ Object

The ID is the primary key of the entity. The ID identifies the entity uniquely.



36
37
38
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 36

def id
  @id
end

#installation_id ⇒ Object

The installation ID identifies the Web App installation.



39
40
41
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 39

def installation_id
  @installation_id
end

#linked_space_id ⇒ Object

The linked space id holds the ID of the space to which the entity belongs to.



42
43
44
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 42

def linked_space_id
  @linked_space_id
end

#name ⇒ Object

The name of the processor will be displayed within the user interfaces that the merchant is interacting with.



45
46
47
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 45

def name
  @name
end

#processor_configuration ⇒ Object

This processor configuration is created as part of the app processor. Any transaction created with the processor is linked with this processor configuration.



48
49
50
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 48

def processor_configuration
  @processor_configuration
end

#production_mode_url ⇒ Object

When the user sets the processor into the production mode the user will be forwarded to this URL to configure the production environment. When no URL is provided no redirection will happen.



51
52
53
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 51

def production_mode_url
  @production_mode_url
end

#state ⇒ Object

Returns the value of attribute state.



54
55
56
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 54

def state
  @state
end

#svg_icon ⇒ Object

Returns the value of attribute svg_icon.



57
58
59
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 57

def svg_icon
  @svg_icon
end

#updated_on ⇒ Object

The updated on date indicates when the last update on the processor occurred.



60
61
62
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 60

def updated_on
  @updated_on
end

#usable_in_production ⇒ Object

When the processor is ready to be used for transactions in the production environment this flag is set to true.



63
64
65
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 63

def usable_in_production
  @usable_in_production
end

#usable_in_production_since ⇒ Object

Returns the value of attribute usable_in_production_since.



66
67
68
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 66

def usable_in_production_since
  @usable_in_production_since
end

#version ⇒ Object

The version number indicates the version of the entity. The version is incremented whenever the entity is changed.



69
70
71
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 69

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 72

def self.attribute_map
  {
    :'configured_environment' => :'configuredEnvironment',
    :'created_on' => :'createdOn',
    :'documentation_url' => :'documentationUrl',
    :'external_id' => :'externalId',
    :'id' => :'id',
    :'installation_id' => :'installationId',
    :'linked_space_id' => :'linkedSpaceId',
    :'name' => :'name',
    :'processor_configuration' => :'processorConfiguration',
    :'production_mode_url' => :'productionModeUrl',
    :'state' => :'state',
    :'svg_icon' => :'svgIcon',
    :'updated_on' => :'updatedOn',
    :'usable_in_production' => :'usableInProduction',
    :'usable_in_production_since' => :'usableInProductionSince',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 94

def self.swagger_types
  {
    :'configured_environment' => :'ChargeAttemptEnvironment',
    :'created_on' => :'DateTime',
    :'documentation_url' => :'String',
    :'external_id' => :'String',
    :'id' => :'Integer',
    :'installation_id' => :'Integer',
    :'linked_space_id' => :'Integer',
    :'name' => :'String',
    :'processor_configuration' => :'PaymentProcessorConfiguration',
    :'production_mode_url' => :'String',
    :'state' => :'PaymentAppProcessorState',
    :'svg_icon' => :'String',
    :'updated_on' => :'DateTime',
    :'usable_in_production' => :'BOOLEAN',
    :'usable_in_production_since' => :'DateTime',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 248

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      configured_environment == o.configured_environment &&
      created_on == o.created_on &&
      documentation_url == o.documentation_url &&
      external_id == o.external_id &&
      id == o.id &&
      installation_id == o.installation_id &&
      linked_space_id == o.linked_space_id &&
      name == o.name &&
      processor_configuration == o.processor_configuration &&
      production_mode_url == o.production_mode_url &&
      state == o.state &&
      svg_icon == o.svg_icon &&
      updated_on == o.updated_on &&
      usable_in_production == o.usable_in_production &&
      usable_in_production_since == o.usable_in_production_since &&
      version == o.version
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 305

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = WhiteLabelMachineName.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 371

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 284

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


271
272
273
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 271

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



277
278
279
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 277

def hash
  [configured_environment, created_on, documentation_url, external_id, id, installation_id, linked_space_id, name, processor_configuration, production_mode_url, state, svg_icon, updated_on, usable_in_production, usable_in_production_since, version].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 190

def list_invalid_properties
  invalid_properties = Array.new
  if !@external_id.nil? && @external_id.to_s.length > 40
    invalid_properties.push('invalid value for "external_id", the character length must be smaller than or equal to 40.')
  end

  if !@name.nil? && @name.to_s.length > 100
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
  end

  if !@svg_icon.nil? && @svg_icon.to_s.length > 10000
    invalid_properties.push('invalid value for "svg_icon", the character length must be smaller than or equal to 10000.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



351
352
353
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 351

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



357
358
359
360
361
362
363
364
365
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 357

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



345
346
347
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 345

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



209
210
211
212
213
214
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_processor.rb', line 209

def valid?
  return false if !@external_id.nil? && @external_id.to_s.length > 40
  return false if !@name.nil? && @name.to_s.length > 100
  return false if !@svg_icon.nil? && @svg_icon.to_s.length > 10000
  true
end