Class: WhiteLabelMachineName::ChargeAttempt

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-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



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

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

Instance Attribute Details

#charge ⇒ Object

Returns the value of attribute charge.



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

def charge
  @charge
end

#completion_behavior ⇒ Object

Returns the value of attribute completion_behavior.



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

def completion_behavior
  @completion_behavior
end

#connector_configuration ⇒ Object

Returns the value of attribute connector_configuration.



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

def connector_configuration
  @connector_configuration
end

#created_on ⇒ Object

The created on date indicates the date on which the entity was stored into the database.



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

def created_on
  @created_on
end

#customers_presence ⇒ Object

The customers presence indicates which kind of customer interaction was used during the charge attempt.



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

def customers_presence
  @customers_presence
end

#environment ⇒ Object

Returns the value of attribute environment.



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

def environment
  @environment
end

#failed_on ⇒ Object

Returns the value of attribute failed_on.



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

def failed_on
  @failed_on
end

#failure_reason ⇒ Object

Returns the value of attribute failure_reason.



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

def failure_reason
  @failure_reason
end

#id ⇒ Object

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



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

def id
  @id
end

#initializing_token_version ⇒ Object

Returns the value of attribute initializing_token_version.



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

def initializing_token_version
  @initializing_token_version
end

#invocation ⇒ Object

Returns the value of attribute invocation.



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

def invocation
  @invocation
end

#labels ⇒ Object

Returns the value of attribute labels.



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

def labels
  @labels
end

#language ⇒ Object

Returns the value of attribute language.



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

def language
  @language
end

#linked_space_id ⇒ Object

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



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

def linked_space_id
  @linked_space_id
end

#linked_transaction ⇒ Object

Returns the value of attribute linked_transaction.



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

def linked_transaction
  @linked_transaction
end

#next_update_on ⇒ Object

Returns the value of attribute next_update_on.



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

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



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

def planned_purge_date
  @planned_purge_date
end

#redirection_url ⇒ Object

Returns the value of attribute redirection_url.



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

def redirection_url
  @redirection_url
end

#sales_channel ⇒ Object

Returns the value of attribute sales_channel.



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

def sales_channel
  @sales_channel
end

#space_view_id ⇒ Object

Returns the value of attribute space_view_id.



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

def space_view_id
  @space_view_id
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#succeeded_on ⇒ Object

Returns the value of attribute succeeded_on.



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

def succeeded_on
  @succeeded_on
end

#terminal ⇒ Object

Returns the value of attribute terminal.



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

def terminal
  @terminal
end

#time_zone ⇒ Object

Returns the value of attribute time_zone.



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

def time_zone
  @time_zone
end

#timeout_on ⇒ Object

Returns the value of attribute timeout_on.



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

def timeout_on
  @timeout_on
end

#token_version ⇒ Object

Returns the value of attribute token_version.



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

def token_version
  @token_version
end

#user_failure_message ⇒ Object

The user failure message contains the message for the user in case the attempt failed. The message is localized into the language specified on the transaction.



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

def user_failure_message
  @user_failure_message
end

#version ⇒ Object

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



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



108
109
110
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/charge_attempt.rb', line 108

def self.attribute_map
  {
    :'id' => :'id',
    :'linked_space_id' => :'linkedSpaceId',
    :'linked_transaction' => :'linkedTransaction',
    :'charge' => :'charge',
    :'completion_behavior' => :'completionBehavior',
    :'connector_configuration' => :'connectorConfiguration',
    :'created_on' => :'createdOn',
    :'customers_presence' => :'customersPresence',
    :'environment' => :'environment',
    :'failed_on' => :'failedOn',
    :'failure_reason' => :'failureReason',
    :'initializing_token_version' => :'initializingTokenVersion',
    :'invocation' => :'invocation',
    :'labels' => :'labels',
    :'language' => :'language',
    :'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'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'Integer',
    :'linked_space_id' => :'Integer',
    :'linked_transaction' => :'Integer',
    :'charge' => :'Charge',
    :'completion_behavior' => :'TransactionCompletionBehavior',
    :'connector_configuration' => :'PaymentConnectorConfiguration',
    :'created_on' => :'DateTime',
    :'customers_presence' => :'CustomersPresence',
    :'environment' => :'ChargeAttemptEnvironment',
    :'failed_on' => :'DateTime',
    :'failure_reason' => :'FailureReason',
    :'initializing_token_version' => :'BOOLEAN',
    :'invocation' => :'ConnectorInvocation',
    :'labels' => :'Array<Label>',
    :'language' => :'String',
    :'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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/charge_attempt.rb', line 328

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      linked_space_id == o.linked_space_id &&
      linked_transaction == o.linked_transaction &&
      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 &&
      initializing_token_version == o.initializing_token_version &&
      invocation == o.invocation &&
      labels == o.labels &&
      language == o.language &&
      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
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



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
426
427
428
429
430
431
432
433
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/charge_attempt.rb', line 397

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



463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/charge_attempt.rb', line 463

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



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/charge_attempt.rb', line 376

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



369
370
371
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/charge_attempt.rb', line 369

def hash
  [id, linked_space_id, linked_transaction, charge, completion_behavior, connector_configuration, created_on, customers_presence, environment, failed_on, failure_reason, initializing_token_version, invocation, labels, language, 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].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



300
301
302
303
304
305
306
307
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/charge_attempt.rb', line 300

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



443
444
445
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/charge_attempt.rb', line 443

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



449
450
451
452
453
454
455
456
457
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/charge_attempt.rb', line 449

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



437
438
439
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/charge_attempt.rb', line 437

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



311
312
313
314
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/charge_attempt.rb', line 311

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