Class: PostfinancecheckoutRubySdk::PaymentMethodConfiguration

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentMethodConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 161

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

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

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

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

  if attributes.key?(:'description')
    if (value = attributes[:'description']).is_a?(Hash)
      self.description = value
    end
  end

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

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

  if attributes.key?(:'title')
    if (value = attributes[:'title']).is_a?(Hash)
      self.title = value
    end
  end

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

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

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

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

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

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

  if attributes.key?(:'resolved_description')
    if (value = attributes[:'resolved_description']).is_a?(Hash)
      self.resolved_description = value
    end
  end

  if attributes.key?(:'resolved_title')
    if (value = attributes[:'resolved_title']).is_a?(Hash)
      self.resolved_title = value
    end
  end

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

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

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

Instance Attribute Details

#data_collection_type ⇒ Object

Returns the value of attribute data_collection_type.



28
29
30
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 28

def data_collection_type
  @data_collection_type
end

#description ⇒ Object

A customer-facing custom description for the payment method.



34
35
36
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 34

def description
  @description
end

#id ⇒ Object

A unique identifier for the object.



71
72
73
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 71

def id
  @id
end

#image_resource_path ⇒ Object

The resource path to a custom image for the payment method, displayed to the customer for visual identification.



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

def image_resource_path
  @image_resource_path
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#name ⇒ Object

The name used to identify the payment method configuration.



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

def name
  @name
end

#one_click_payment_mode ⇒ Object

Returns the value of attribute one_click_payment_mode.



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

def one_click_payment_mode
  @one_click_payment_mode
end

#payment_method ⇒ Object

Returns the value of attribute payment_method.



68
69
70
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 68

def payment_method
  @payment_method
end

#planned_purge_date ⇒ Object

The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.



31
32
33
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 31

def planned_purge_date
  @planned_purge_date
end

#resolved_description ⇒ Object

The description of the payment method displayed to the customer. If a custom description is defined, it will be used; otherwise, the default description of the payment method will be shown.



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

def resolved_description
  @resolved_description
end

#resolved_image_url ⇒ Object

The URL to the image of the payment method displayed to the customer. If a custom image is defined, it will be used; otherwise, the default image of the payment method will be shown.



37
38
39
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 37

def resolved_image_url
  @resolved_image_url
end

#resolved_title ⇒ Object

The title of the payment method displayed to the customer. If a custom title is defined, it will be used; otherwise, the default title of the payment method will be shown.



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

def resolved_title
  @resolved_title
end

#sort_order ⇒ Object

When listing payment methods, they can be sorted by this number.



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

def sort_order
  @sort_order
end

#space_id ⇒ Object

The ID of the space this object belongs to.



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

def space_id
  @space_id
end

#state ⇒ Object

Returns the value of attribute state.



73
74
75
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 73

def state
  @state
end

#title ⇒ Object

A customer-facing custom title for the payment method.



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

def title
  @title
end

#version ⇒ Object

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



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

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



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
398
399
400
401
402
403
404
405
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 368

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 = PostfinancecheckoutRubySdk.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



121
122
123
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 121

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



126
127
128
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 126

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 98

def self.attribute_map
  {
    :'data_collection_type' => :'dataCollectionType',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'description' => :'description',
    :'resolved_image_url' => :'resolvedImageUrl',
    :'one_click_payment_mode' => :'oneClickPaymentMode',
    :'title' => :'title',
    :'version' => :'version',
    :'linked_space_id' => :'linkedSpaceId',
    :'space_id' => :'spaceId',
    :'image_resource_path' => :'imageResourcePath',
    :'sort_order' => :'sortOrder',
    :'name' => :'name',
    :'resolved_description' => :'resolvedDescription',
    :'resolved_title' => :'resolvedTitle',
    :'payment_method' => :'paymentMethod',
    :'id' => :'id',
    :'state' => :'state'
  }
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



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 344

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



154
155
156
157
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 154

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

.openapi_types ⇒ Object

Attribute type mapping.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 131

def self.openapi_types
  {
    :'data_collection_type' => :'DataCollectionType',
    :'planned_purge_date' => :'Time',
    :'description' => :'Hash<String, String>',
    :'resolved_image_url' => :'String',
    :'one_click_payment_mode' => :'OneClickPaymentMode',
    :'title' => :'Hash<String, String>',
    :'version' => :'Integer',
    :'linked_space_id' => :'Integer',
    :'space_id' => :'Integer',
    :'image_resource_path' => :'String',
    :'sort_order' => :'Integer',
    :'name' => :'String',
    :'resolved_description' => :'Hash<String, String>',
    :'resolved_title' => :'Hash<String, String>',
    :'payment_method' => :'PaymentMethod',
    :'id' => :'Integer',
    :'state' => :'CreationEntityState'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 307

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      data_collection_type == o.data_collection_type &&
      planned_purge_date == o.planned_purge_date &&
      description == o.description &&
      resolved_image_url == o.resolved_image_url &&
      one_click_payment_mode == o.one_click_payment_mode &&
      title == o.title &&
      version == o.version &&
      linked_space_id == o.linked_space_id &&
      space_id == o.space_id &&
      image_resource_path == o.image_resource_path &&
      sort_order == o.sort_order &&
      name == o.name &&
      resolved_description == o.resolved_description &&
      resolved_title == o.resolved_title &&
      payment_method == o.payment_method &&
      id == o.id &&
      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



439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 439

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



337
338
339
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 337

def hash
  [data_collection_type, planned_purge_date, description, resolved_image_url, one_click_payment_mode, title, version, linked_space_id, space_id, image_resource_path, sort_order, name, resolved_description, resolved_title, payment_method, id, 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



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 254

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@space_id.nil? && @space_id < 1
    invalid_properties.push('invalid value for "space_id", must be greater than or equal to 1.')
  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



415
416
417
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 415

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



421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 421

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



409
410
411
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 409

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



270
271
272
273
274
275
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 270

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