Class: PostfinancecheckoutRubySdk::ChargeAttempt

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChargeAttempt

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge_attempt.rb', line 214

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PostfinancecheckoutRubySdk::ChargeAttempt` 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::ChargeAttempt`. 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?(:'language')
    self.language = attributes[:'language']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#charge ⇒ Object

Returns the value of attribute charge.



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

def charge
  @charge
end

#completion_behavior ⇒ Object

Returns the value of attribute completion_behavior.



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

def completion_behavior
  @completion_behavior
end

#connector_configuration ⇒ Object

Returns the value of attribute connector_configuration.



92
93
94
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge_attempt.rb', line 92

def connector_configuration
  @connector_configuration
end

#created_on ⇒ Object

The date and time when the object was created.



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

def created_on
  @created_on
end

#customers_presence ⇒ Object

Returns the value of attribute customers_presence.



99
100
101
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge_attempt.rb', line 99

def customers_presence
  @customers_presence
end

#environment ⇒ Object

Returns the value of attribute environment.



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

def environment
  @environment
end

#failed_on ⇒ Object

The date and time when the charge attempt failed.



102
103
104
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge_attempt.rb', line 102

def failed_on
  @failed_on
end

#failure_reason ⇒ Object

Returns the value of attribute failure_reason.



97
98
99
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge_attempt.rb', line 97

def failure_reason
  @failure_reason
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#initializing_token_version ⇒ Object

Whether a new token version is being initialized.



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

def initializing_token_version
  @initializing_token_version
end

#invocation ⇒ Object

Returns the value of attribute invocation.



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

def invocation
  @invocation
end

#labels ⇒ Object

The labels providing additional information about the object.



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

def labels
  @labels
end

#language ⇒ Object

The language that is linked to the object.



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

def language
  @language
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#linked_transaction ⇒ Object

The payment transaction this object is linked to.



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

def linked_transaction
  @linked_transaction
end

#next_update_on ⇒ Object

The date and time when the next update of the object’s state is planned.



95
96
97
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge_attempt.rb', line 95

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



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

def planned_purge_date
  @planned_purge_date
end

#redirection_url ⇒ Object

The URL to redirect the customer to after payment processing.



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

def redirection_url
  @redirection_url
end

#sales_channel ⇒ Object

The sales channel through which the charge attempt was made.



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

def sales_channel
  @sales_channel
end

#space_view_id ⇒ Object

The ID of the space view this object is linked to.



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

def space_view_id
  @space_view_id
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#succeeded_on ⇒ Object

The date and time when the charge attempt succeeded.



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

def succeeded_on
  @succeeded_on
end

#terminal ⇒ Object

Returns the value of attribute terminal.



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

def terminal
  @terminal
end

#time_zone ⇒ Object

The time zone that this object is associated with.



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

def time_zone
  @time_zone
end

#timeout_on ⇒ Object

The date and time when the object will expire.



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

def timeout_on
  @timeout_on
end

#token_version ⇒ Object

Returns the value of attribute token_version.



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

def token_version
  @token_version
end

#user_failure_message ⇒ Object

The message that can be displayed to the customer explaining why the charge attempt failed, in the customer’s language.



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

def user_failure_message
  @user_failure_message
end

#version ⇒ Object

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



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

def version
  @version
end

#wallet ⇒ Object

Returns the value of attribute wallet.



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

def wallet
  @wallet
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



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge_attempt.rb', line 466

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



162
163
164
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge_attempt.rb', line 162

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



167
168
169
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge_attempt.rb', line 167

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'language' => :'language',
    :'sales_channel' => :'salesChannel',
    :'created_on' => :'createdOn',
    :'initializing_token_version' => :'initializingTokenVersion',
    :'token_version' => :'tokenVersion',
    :'succeeded_on' => :'succeededOn',
    :'id' => :'id',
    :'state' => :'state',
    :'linked_transaction' => :'linkedTransaction',
    :'redirection_url' => :'redirectionUrl',
    :'charge' => :'charge',
    :'wallet' => :'wallet',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'time_zone' => :'timeZone',
    :'space_view_id' => :'spaceViewId',
    :'terminal' => :'terminal',
    :'user_failure_message' => :'userFailureMessage',
    :'completion_behavior' => :'completionBehavior',
    :'version' => :'version',
    :'labels' => :'labels',
    :'linked_space_id' => :'linkedSpaceId',
    :'timeout_on' => :'timeoutOn',
    :'environment' => :'environment',
    :'invocation' => :'invocation',
    :'connector_configuration' => :'connectorConfiguration',
    :'next_update_on' => :'nextUpdateOn',
    :'failure_reason' => :'failureReason',
    :'customers_presence' => :'customersPresence',
    :'failed_on' => :'failedOn'
  }
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



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge_attempt.rb', line 442

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



207
208
209
210
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge_attempt.rb', line 207

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'language' => :'String',
    :'sales_channel' => :'Integer',
    :'created_on' => :'Time',
    :'initializing_token_version' => :'Boolean',
    :'token_version' => :'TokenVersion',
    :'succeeded_on' => :'Time',
    :'id' => :'Integer',
    :'state' => :'ChargeAttemptState',
    :'linked_transaction' => :'Integer',
    :'redirection_url' => :'String',
    :'charge' => :'Charge',
    :'wallet' => :'WalletType',
    :'planned_purge_date' => :'Time',
    :'time_zone' => :'String',
    :'space_view_id' => :'Integer',
    :'terminal' => :'PaymentTerminal',
    :'user_failure_message' => :'String',
    :'completion_behavior' => :'TransactionCompletionBehavior',
    :'version' => :'Integer',
    :'labels' => :'Array<Label>',
    :'linked_space_id' => :'Integer',
    :'timeout_on' => :'Time',
    :'environment' => :'ChargeAttemptEnvironment',
    :'invocation' => :'ConnectorInvocation',
    :'connector_configuration' => :'PaymentConnectorConfiguration',
    :'next_update_on' => :'Time',
    :'failure_reason' => :'FailureReason',
    :'customers_presence' => :'CustomersPresence',
    :'failed_on' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge_attempt.rb', line 393

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      language == o.language &&
      sales_channel == o.sales_channel &&
      created_on == o.created_on &&
      initializing_token_version == o.initializing_token_version &&
      token_version == o.token_version &&
      succeeded_on == o.succeeded_on &&
      id == o.id &&
      state == o.state &&
      linked_transaction == o.linked_transaction &&
      redirection_url == o.redirection_url &&
      charge == o.charge &&
      wallet == o.wallet &&
      planned_purge_date == o.planned_purge_date &&
      time_zone == o.time_zone &&
      space_view_id == o.space_view_id &&
      terminal == o.terminal &&
      user_failure_message == o.user_failure_message &&
      completion_behavior == o.completion_behavior &&
      version == o.version &&
      labels == o.labels &&
      linked_space_id == o.linked_space_id &&
      timeout_on == o.timeout_on &&
      environment == o.environment &&
      invocation == o.invocation &&
      connector_configuration == o.connector_configuration &&
      next_update_on == o.next_update_on &&
      failure_reason == o.failure_reason &&
      customers_presence == o.customers_presence &&
      failed_on == o.failed_on
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



537
538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge_attempt.rb', line 537

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


429
430
431
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge_attempt.rb', line 429

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



435
436
437
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge_attempt.rb', line 435

def hash
  [language, sales_channel, created_on, initializing_token_version, token_version, succeeded_on, id, state, linked_transaction, redirection_url, charge, wallet, planned_purge_date, time_zone, space_view_id, terminal, user_failure_message, completion_behavior, version, labels, linked_space_id, timeout_on, environment, invocation, connector_configuration, next_update_on, failure_reason, customers_presence, failed_on].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



349
350
351
352
353
354
355
356
357
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge_attempt.rb', line 349

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



513
514
515
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge_attempt.rb', line 513

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



519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge_attempt.rb', line 519

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



507
508
509
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge_attempt.rb', line 507

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



361
362
363
364
365
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge_attempt.rb', line 361

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@user_failure_message.nil? && @user_failure_message.to_s.length > 2000
  true
end