Class: PostFinanceCheckout::PaymentMethodConfiguration

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

Overview

The payment method configuration builds the base to connect with different payment method connectors.

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



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
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 122

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?(:'dataCollectionType')
    self.data_collection_type = attributes[:'dataCollectionType']
  end

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

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

  if attributes.has_key?(:'imageResourcePath')
    self.image_resource_path = attributes[:'imageResourcePath']
  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?(:'oneClickPaymentMode')
    self.one_click_payment_mode = attributes[:'oneClickPaymentMode']
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#data_collection_type ⇒ Object

The data collection type determines who is collecting the payment information. This can be done either by the processor (offsite) or by our application (onsite).



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

def data_collection_type
  @data_collection_type
end

#description ⇒ Object

The payment method configuration description can be used to show a text during the payment process. Choose an appropriate description as it will be displayed to your customer.



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

def description
  @description
end

#id ⇒ Object

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



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

def id
  @id
end

#image_resource_path ⇒ Object

The image of the payment method configuration overrides the default image of the payment method.



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

def image_resource_path
  @image_resource_path
end

#linked_space_id ⇒ Object

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



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

def linked_space_id
  @linked_space_id
end

#name ⇒ Object

The payment method configuration name is used internally to identify the payment method configuration. For example the name is used within search fields and hence it should be distinct and descriptive.



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

def name
  @name
end

#one_click_payment_mode ⇒ Object

When the buyer is present on the payment page or within the iFrame the payment details can be stored automatically. The buyer will be able to use the stored payment details for subsequent transactions. When the transaction already contains a token one-click payments are disabled anyway



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

def one_click_payment_mode
  @one_click_payment_mode
end

#payment_method ⇒ Object

Returns the value of attribute payment_method.



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

def payment_method
  @payment_method
end

#planned_purge_date ⇒ Object

The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.



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

def planned_purge_date
  @planned_purge_date
end

#resolved_description ⇒ Object

The resolved description uses the specified description or the default one when it is not overridden.



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

def resolved_description
  @resolved_description
end

#resolved_image_url ⇒ Object

The resolved URL of the image to use with this payment method.



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

def resolved_image_url
  @resolved_image_url
end

#resolved_title ⇒ Object

The resolved title uses the specified title or the default one when it is not overridden.



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

def resolved_title
  @resolved_title
end

#sort_order ⇒ Object

The sort order of the payment method determines the ordering of the methods shown to the user during the payment process.



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

def sort_order
  @sort_order
end

#space_id ⇒ Object

Returns the value of attribute space_id.



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

def space_id
  @space_id
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#title ⇒ Object

The title of the payment method configuration is used within the payment process. The title is visible to the customer.



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

def title
  @title
end

#version ⇒ Object

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



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 75

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

.swagger_types ⇒ Object

Attribute type mapping.



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.swagger_types
  {
    :'data_collection_type' => :'DataCollectionType',
    :'description' => :'DatabaseTranslatedString',
    :'id' => :'Integer',
    :'image_resource_path' => :'ResourcePath',
    :'linked_space_id' => :'Integer',
    :'name' => :'String',
    :'one_click_payment_mode' => :'OneClickPaymentMode',
    :'payment_method' => :'Integer',
    :'planned_purge_date' => :'DateTime',
    :'resolved_description' => :'Hash<String, String>',
    :'resolved_image_url' => :'String',
    :'resolved_title' => :'Hash<String, String>',
    :'sort_order' => :'Integer',
    :'space_id' => :'Integer',
    :'state' => :'CreationEntityState',
    :'title' => :'DatabaseTranslatedString',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 231

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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 289

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 = PostFinanceCheckout.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



355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 355

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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 268

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


255
256
257
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 255

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



261
262
263
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 261

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



203
204
205
206
207
208
209
210
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 203

def list_invalid_properties
  invalid_properties = Array.new
  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



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

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



341
342
343
344
345
346
347
348
349
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 341

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



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

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



214
215
216
217
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_method_configuration.rb', line 214

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