Class: PostFinanceCheckout::TokenVersion

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TokenVersion

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

  if attributes.has_key?(:'labels')
    if (value = attributes[:'labels']).is_a?(Array)
      self.labels = value
    end
  end

  if attributes.has_key?(:'language')
    self.language = attributes[:'language']
  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?(:'obsoletedOn')
    self.obsoleted_on = attributes[:'obsoletedOn']
  end

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

  if attributes.has_key?(:'paymentInformationHashes')
    if (value = attributes[:'paymentInformationHashes']).is_a?(Array)
      self.payment_information_hashes = value
    end
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#activated_on ⇒ Object

Returns the value of attribute activated_on.



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

def activated_on
  @activated_on
end

#billing_address ⇒ Object

Returns the value of attribute billing_address.



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

def billing_address
  @billing_address
end

#created_on ⇒ Object

The date and time when the object was created.



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

def created_on
  @created_on
end

#environment ⇒ Object

Returns the value of attribute environment.



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

def environment
  @environment
end

#expires_on ⇒ Object

The expires on date indicates when token version expires. Once this date is reached the token version is marked as obsolete.



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

def expires_on
  @expires_on
end

#icon_url ⇒ Object

Returns the value of attribute icon_url.



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

def icon_url
  @icon_url
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#labels ⇒ Object

Returns the value of attribute labels.



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

def labels
  @labels
end

#language ⇒ Object

The language that is linked to the object.



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

def language
  @language
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#obsoleted_on ⇒ Object

Returns the value of attribute obsoleted_on.



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

def obsoleted_on
  @obsoleted_on
end

#payment_connector_configuration ⇒ Object

Returns the value of attribute payment_connector_configuration.



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

def payment_connector_configuration
  @payment_connector_configuration
end

#payment_information_hashes ⇒ Object

The payment information hash set contains hashes of the payment information represented by this token version.



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

def payment_information_hashes
  @payment_information_hashes
end

#payment_method ⇒ Object

Returns the value of attribute payment_method.



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

def payment_method
  @payment_method
end

#payment_method_brand ⇒ Object

Returns the value of attribute payment_method_brand.



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

def payment_method_brand
  @payment_method_brand
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.



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

def planned_purge_date
  @planned_purge_date
end

#processor_token ⇒ Object

Returns the value of attribute processor_token.



75
76
77
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_version.rb', line 75

def processor_token
  @processor_token
end

#shipping_address ⇒ Object

Returns the value of attribute shipping_address.



78
79
80
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_version.rb', line 78

def shipping_address
  @shipping_address
end

#state ⇒ Object

The object’s current state.



81
82
83
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_version.rb', line 81

def state
  @state
end

#token ⇒ Object

Returns the value of attribute token.



84
85
86
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_version.rb', line 84

def token
  @token
end

#type ⇒ Object

The token version type determines what kind of token it is and by which payment connector the token can be processed by.



87
88
89
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_version.rb', line 87

def type
  @type
end

#version ⇒ Object

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



90
91
92
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_version.rb', line 90

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'activated_on' => :'activatedOn',
    :'billing_address' => :'billingAddress',
    :'created_on' => :'createdOn',
    :'environment' => :'environment',
    :'expires_on' => :'expiresOn',
    :'icon_url' => :'iconUrl',
    :'id' => :'id',
    :'labels' => :'labels',
    :'language' => :'language',
    :'linked_space_id' => :'linkedSpaceId',
    :'name' => :'name',
    :'obsoleted_on' => :'obsoletedOn',
    :'payment_connector_configuration' => :'paymentConnectorConfiguration',
    :'payment_information_hashes' => :'paymentInformationHashes',
    :'payment_method' => :'paymentMethod',
    :'payment_method_brand' => :'paymentMethodBrand',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'processor_token' => :'processorToken',
    :'shipping_address' => :'shippingAddress',
    :'state' => :'state',
    :'token' => :'token',
    :'type' => :'type',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_version.rb', line 122

def self.swagger_types
  {
    :'activated_on' => :'DateTime',
    :'billing_address' => :'Address',
    :'created_on' => :'DateTime',
    :'environment' => :'ChargeAttemptEnvironment',
    :'expires_on' => :'DateTime',
    :'icon_url' => :'String',
    :'id' => :'Integer',
    :'labels' => :'Array<Label>',
    :'language' => :'String',
    :'linked_space_id' => :'Integer',
    :'name' => :'String',
    :'obsoleted_on' => :'DateTime',
    :'payment_connector_configuration' => :'PaymentConnectorConfiguration',
    :'payment_information_hashes' => :'Array<PaymentInformationHash>',
    :'payment_method' => :'Integer',
    :'payment_method_brand' => :'Integer',
    :'planned_purge_date' => :'DateTime',
    :'processor_token' => :'String',
    :'shipping_address' => :'Address',
    :'state' => :'TokenVersionState',
    :'token' => :'Token',
    :'type' => :'TokenVersionType',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
326
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_version.rb', line 300

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      activated_on == o.activated_on &&
      billing_address == o.billing_address &&
      created_on == o.created_on &&
      environment == o.environment &&
      expires_on == o.expires_on &&
      icon_url == o.icon_url &&
      id == o.id &&
      labels == o.labels &&
      language == o.language &&
      linked_space_id == o.linked_space_id &&
      name == o.name &&
      obsoleted_on == o.obsoleted_on &&
      payment_connector_configuration == o.payment_connector_configuration &&
      payment_information_hashes == o.payment_information_hashes &&
      payment_method == o.payment_method &&
      payment_method_brand == o.payment_method_brand &&
      planned_purge_date == o.planned_purge_date &&
      processor_token == o.processor_token &&
      shipping_address == o.shipping_address &&
      state == o.state &&
      token == o.token &&
      type == o.type &&
      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



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
398
399
400
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_version.rb', line 364

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



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

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



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

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [activated_on, billing_address, created_on, environment, expires_on, icon_url, id, labels, language, linked_space_id, name, obsoleted_on, payment_connector_configuration, payment_information_hashes, payment_method, payment_method_brand, planned_purge_date, processor_token, shipping_address, state, token, type, 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



257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_version.rb', line 257

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

  if !@processor_token.nil? && @processor_token.to_s.length > 150
    invalid_properties.push('invalid value for "processor_token", the character length must be smaller than or equal to 150.')
  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



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

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



416
417
418
419
420
421
422
423
424
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_version.rb', line 416

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



404
405
406
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_version.rb', line 404

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



272
273
274
275
276
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_version.rb', line 272

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