Class: VRPayment::ChargeAttempt

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

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



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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'invocation')
    self.invocation = attributes[:'invocation']
  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?(:'linkedTransaction')
    self.linked_transaction = attributes[:'linkedTransaction']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#charge ⇒ Object

The charge that the charge attempt belongs to.



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

def charge
  @charge
end

#completion_behavior ⇒ Object

The behavior that controls when the transaction is completed.



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

def completion_behavior
  @completion_behavior
end

#connector_configuration ⇒ Object

The payment connector configuration that was used for the charge attempt.



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

def connector_configuration
  @connector_configuration
end

#created_on ⇒ Object

The date and time when the object was created.



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

def created_on
  @created_on
end

#customers_presence ⇒ Object

The customer’s presence indicates whether and in what way the charge attempt’s customer is present.



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

def customers_presence
  @customers_presence
end

#environment ⇒ Object

The environment in which the charge attempt is executed.



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

def environment
  @environment
end

#failed_on ⇒ Object

The date and time when the charge attempt failed.



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

def failed_on
  @failed_on
end

#failure_reason ⇒ Object

The reason for the failure of the charge attempt.



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

def failure_reason
  @failure_reason
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#initializing_token_version ⇒ Object

Whether a new token version is being initialized.



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

def initializing_token_version
  @initializing_token_version
end

#invocation ⇒ Object

The connector invocation that the charge attempt belongs to.



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

def invocation
  @invocation
end

#labels ⇒ Object

The labels providing additional information about the object.



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

def labels
  @labels
end

#language ⇒ Object

The language that is linked to the object.



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

def language
  @language
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#linked_transaction ⇒ Object

The payment transaction this object is linked to.



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

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.



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

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.



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

def planned_purge_date
  @planned_purge_date
end

#redirection_url ⇒ Object

The URL to redirect the customer to after payment processing.



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

def redirection_url
  @redirection_url
end

#sales_channel ⇒ Object

The sales channel through which the charge attempt was made.



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

def sales_channel
  @sales_channel
end

#space_view_id ⇒ Object

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



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

def space_view_id
  @space_view_id
end

#state ⇒ Object

The object’s current state.



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

def state
  @state
end

#succeeded_on ⇒ Object

The date and time when the charge attempt succeeded.



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

def succeeded_on
  @succeeded_on
end

#terminal ⇒ Object

The payment terminal through which the charge attempt was made.



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

def terminal
  @terminal
end

#time_zone ⇒ Object

The time zone that this object is associated with.



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

def time_zone
  @time_zone
end

#timeout_on ⇒ Object

The date and time when the object will expire.



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

def timeout_on
  @timeout_on
end

#token_version ⇒ Object

The token version used for the charge attempt.



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

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.



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

def user_failure_message
  @user_failure_message
end

#version ⇒ Object

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



105
106
107
 
# File 'lib/vrpayment-ruby-sdk/models/charge_attempt.rb', line 105

def version
  @version
end

#wallet ⇒ Object

The type of wallet used to make the charge attempt.



108
109
110
 
# File 'lib/vrpayment-ruby-sdk/models/charge_attempt.rb', line 108

def wallet
  @wallet
end

Class Method Details

.attribute_map ⇒ Object

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/vrpayment-ruby-sdk/models/charge_attempt.rb', line 111

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

.swagger_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/vrpayment-ruby-sdk/models/charge_attempt.rb', line 337

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



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/vrpayment-ruby-sdk/models/charge_attempt.rb', line 407

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



473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/vrpayment-ruby-sdk/models/charge_attempt.rb', line 473

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



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/vrpayment-ruby-sdk/models/charge_attempt.rb', line 386

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


373
374
375
 
# File 'lib/vrpayment-ruby-sdk/models/charge_attempt.rb', line 373

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



379
380
381
 
# File 'lib/vrpayment-ruby-sdk/models/charge_attempt.rb', line 379

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



309
310
311
312
313
314
315
316
 
# File 'lib/vrpayment-ruby-sdk/models/charge_attempt.rb', line 309

def list_invalid_properties
  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



453
454
455
 
# File 'lib/vrpayment-ruby-sdk/models/charge_attempt.rb', line 453

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



459
460
461
462
463
464
465
466
467
 
# File 'lib/vrpayment-ruby-sdk/models/charge_attempt.rb', line 459

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



447
448
449
 
# File 'lib/vrpayment-ruby-sdk/models/charge_attempt.rb', line 447

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



320
321
322
323
 
# File 'lib/vrpayment-ruby-sdk/models/charge_attempt.rb', line 320

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