Class: WalleeRubySdk::PaymentAppProcessor

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

Defined Under Namespace

Classes: EnumAttributeValidator

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



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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/wallee-ruby-sdk/models/payment_app_processor.rb', line 150

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    fail ArgumentError, "The input argument (attributes) must be a hash in `WalleeRubySdk::PaymentAppProcessor` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    unless self.class.attribute_map.key?(k.to_sym)
      fail ArgumentError, "`#{k}` is not a valid attribute in `WalleeRubySdk::PaymentAppProcessor`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#configured_environment ⇒ Object

Returns the value of attribute configured_environment.



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

def configured_environment
  @configured_environment
end

#created_on ⇒ Object

The date and time when the processor was created.



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

def created_on
  @created_on
end

#documentation_url ⇒ Object

A URL pointing to the documentation that explains how to configure and use the processor.



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

def documentation_url
  @documentation_url
end

#external_id ⇒ Object

A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.



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

def external_id
  @external_id
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#installation_id ⇒ Object

The installation ID identifies the Web App installation.



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

def installation_id
  @installation_id
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#name ⇒ Object

The name used to identify the processor.



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

def name
  @name
end

#processor_configuration ⇒ Object

Returns the value of attribute processor_configuration.



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

def processor_configuration
  @processor_configuration
end

#production_mode_url ⇒ Object

A URL pointing to the site where merchants can set up production mode for the processor.



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

def production_mode_url
  @production_mode_url
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#svg_icon ⇒ Object

An SVG icon representing the processor, displayed to the user in the interface.



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

def svg_icon
  @svg_icon
end

#updated_on ⇒ Object

The date and time when the processor was last updated.



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

def updated_on
  @updated_on
end

#usable_in_production ⇒ Object

Whether the processor is fully prepared and available for handling transactions in a production environment.



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

def usable_in_production
  @usable_in_production
end

#usable_in_production_since ⇒ Object

the date and time when the processor became fully usable and available for handling transactions in a production environment.



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

def usable_in_production_since
  @usable_in_production_since
end

#version ⇒ Object

The version is used for optimistic locking and incremented whenever the object is updated.



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

def version
  @version
end

Class Method Details

._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



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/wallee-ruby-sdk/models/payment_app_processor.rb', line 360

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = WalleeRubySdk.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



116
117
118
 
# File 'lib/wallee-ruby-sdk/models/payment_app_processor.rb', line 116

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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

.build_from_hash(attributes) ⇒ Object

Returns the model itself

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/wallee-ruby-sdk/models/payment_app_processor.rb', line 336

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



143
144
145
146
 
# File 'lib/wallee-ruby-sdk/models/payment_app_processor.rb', line 143

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/wallee-ruby-sdk/models/payment_app_processor.rb', line 121

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/wallee-ruby-sdk/models/payment_app_processor.rb', line 302

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      documentation_url == o.documentation_url &&
      configured_environment == o.configured_environment &&
      external_id == o.external_id &&
      svg_icon == o.svg_icon &&
      updated_on == o.updated_on &&
      usable_in_production == o.usable_in_production &&
      created_on == o.created_on &&
      version == o.version &&
      processor_configuration == o.processor_configuration &&
      linked_space_id == o.linked_space_id &&
      usable_in_production_since == o.usable_in_production_since &&
      name == o.name &&
      id == o.id &&
      installation_id == o.installation_id &&
      production_mode_url == o.production_mode_url &&
      state == o.state
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



431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/wallee-ruby-sdk/models/payment_app_processor.rb', line 431

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


325
326
327
 
# File 'lib/wallee-ruby-sdk/models/payment_app_processor.rb', line 325

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



331
332
333
 
# File 'lib/wallee-ruby-sdk/models/payment_app_processor.rb', line 331

def hash
  [documentation_url, configured_environment, external_id, svg_icon, updated_on, usable_in_production, created_on, version, processor_configuration, linked_space_id, usable_in_production_since, name, id, installation_id, production_mode_url, state].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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/wallee-ruby-sdk/models/payment_app_processor.rb', line 230

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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 !@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

  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

  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



407
408
409
 
# File 'lib/wallee-ruby-sdk/models/payment_app_processor.rb', line 407

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



413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/wallee-ruby-sdk/models/payment_app_processor.rb', line 413

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



401
402
403
 
# File 'lib/wallee-ruby-sdk/models/payment_app_processor.rb', line 401

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



250
251
252
253
254
255
256
 
# File 'lib/wallee-ruby-sdk/models/payment_app_processor.rb', line 250

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@external_id.nil? && @external_id.to_s.length > 40
  return false if !@svg_icon.nil? && @svg_icon.to_s.length > 10000
  return false if !@name.nil? && @name.to_s.length > 100
  true
end