Class: WhiteLabelMachineName::TransactionCompletion

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionCompletion

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion.rb', line 192

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

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

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

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

  if attributes.has_key?(:'externalId')
    self.external_id = attributes[:'externalId']
  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?(:'invoiceMerchantReference')
    self.invoice_merchant_reference = attributes[:'invoiceMerchantReference']
  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?(:'lastCompletion')
    self.last_completion = attributes[:'lastCompletion']
  end

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'remainingLineItems')
    if (value = attributes[:'remainingLineItems']).is_a?(Array)
      self.remaining_line_items = value
    end
  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?(:'statementDescriptor')
    self.statement_descriptor = attributes[:'statementDescriptor']
  end

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

  if attributes.has_key?(:'taxAmount')
    self.tax_amount = attributes[:'taxAmount']
  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?(:'version')
    self.version = attributes[:'version']
  end
end

Instance Attribute Details

#amount ⇒ Object

The amount which is captured. The amount represents sum of line items including taxes.



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

def amount
  @amount
end

#base_line_items ⇒ Object

The base line items on which the completion is applied on.



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

def base_line_items
  @base_line_items
end

#created_by ⇒ Object

Returns the value of attribute created_by.



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

def created_by
  @created_by
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/transaction_completion.rb', line 42

def created_on
  @created_on
end

#external_id ⇒ Object

The external ID helps to identify the entity and a subsequent creation of an entity with the same ID will not create a new entity.



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

def external_id
  @external_id
end

#failed_on ⇒ Object

Returns the value of attribute failed_on.



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

def failed_on
  @failed_on
end

#failure_reason ⇒ Object

Returns the value of attribute failure_reason.



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

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/transaction_completion.rb', line 24

def id
  @id
end

#invoice_merchant_reference ⇒ Object

Returns the value of attribute invoice_merchant_reference.



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

def invoice_merchant_reference
  @invoice_merchant_reference
end

#labels ⇒ Object

Returns the value of attribute labels.



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

def labels
  @labels
end

#language ⇒ Object

Returns the value of attribute language.



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

def language
  @language
end

#last_completion ⇒ Object

Indicates if this is the last completion. After the last completion is created the transaction cannot be completed anymore.



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

def last_completion
  @last_completion
end

#line_item_version ⇒ Object

Returns the value of attribute line_item_version.



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

def line_item_version
  @line_item_version
end

#line_items ⇒ Object

The line items which are captured.



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

def line_items
  @line_items
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/transaction_completion.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/transaction_completion.rb', line 30

def linked_transaction
  @linked_transaction
end

#mode ⇒ Object

Returns the value of attribute mode.



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

def mode
  @mode
end

#next_update_on ⇒ Object

Returns the value of attribute next_update_on.



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

def next_update_on
  @next_update_on
end

#payment_information ⇒ Object

Returns the value of attribute payment_information.



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

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



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

def planned_purge_date
  @planned_purge_date
end

#processing_on ⇒ Object

Returns the value of attribute processing_on.



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

def processing_on
  @processing_on
end

#processor_reference ⇒ Object

Returns the value of attribute processor_reference.



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

def processor_reference
  @processor_reference
end

#remaining_line_items ⇒ Object

Returns the value of attribute remaining_line_items.



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

def remaining_line_items
  @remaining_line_items
end

#space_view_id ⇒ Object

Returns the value of attribute space_view_id.



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

def space_view_id
  @space_view_id
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#statement_descriptor ⇒ Object

The statement descriptor explain charges or payments on bank statements.



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

def statement_descriptor
  @statement_descriptor
end

#succeeded_on ⇒ Object

Returns the value of attribute succeeded_on.



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

def succeeded_on
  @succeeded_on
end

#tax_amount ⇒ Object

The total sum of all taxes of line items.



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

def tax_amount
  @tax_amount
end

#time_zone ⇒ Object

Returns the value of attribute time_zone.



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

def time_zone
  @time_zone
end

#timeout_on ⇒ Object

Returns the value of attribute timeout_on.



111
112
113
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion.rb', line 111

def timeout_on
  @timeout_on
end

#version ⇒ Object

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



114
115
116
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion.rb', line 114

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



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
144
145
146
147
148
149
150
151
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion.rb', line 117

def self.attribute_map
  {
    :'id' => :'id',
    :'linked_space_id' => :'linkedSpaceId',
    :'linked_transaction' => :'linkedTransaction',
    :'amount' => :'amount',
    :'base_line_items' => :'baseLineItems',
    :'created_by' => :'createdBy',
    :'created_on' => :'createdOn',
    :'external_id' => :'externalId',
    :'failed_on' => :'failedOn',
    :'failure_reason' => :'failureReason',
    :'invoice_merchant_reference' => :'invoiceMerchantReference',
    :'labels' => :'labels',
    :'language' => :'language',
    :'last_completion' => :'lastCompletion',
    :'line_item_version' => :'lineItemVersion',
    :'line_items' => :'lineItems',
    :'mode' => :'mode',
    :'next_update_on' => :'nextUpdateOn',
    :'payment_information' => :'paymentInformation',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'processing_on' => :'processingOn',
    :'processor_reference' => :'processorReference',
    :'remaining_line_items' => :'remainingLineItems',
    :'space_view_id' => :'spaceViewId',
    :'state' => :'state',
    :'statement_descriptor' => :'statementDescriptor',
    :'succeeded_on' => :'succeededOn',
    :'tax_amount' => :'taxAmount',
    :'time_zone' => :'timeZone',
    :'timeout_on' => :'timeoutOn',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'Integer',
    :'linked_space_id' => :'Integer',
    :'linked_transaction' => :'Integer',
    :'amount' => :'Float',
    :'base_line_items' => :'Array<LineItem>',
    :'created_by' => :'Integer',
    :'created_on' => :'DateTime',
    :'external_id' => :'String',
    :'failed_on' => :'DateTime',
    :'failure_reason' => :'FailureReason',
    :'invoice_merchant_reference' => :'String',
    :'labels' => :'Array<Label>',
    :'language' => :'String',
    :'last_completion' => :'BOOLEAN',
    :'line_item_version' => :'TransactionLineItemVersion',
    :'line_items' => :'Array<LineItem>',
    :'mode' => :'TransactionCompletionMode',
    :'next_update_on' => :'DateTime',
    :'payment_information' => :'String',
    :'planned_purge_date' => :'DateTime',
    :'processing_on' => :'DateTime',
    :'processor_reference' => :'String',
    :'remaining_line_items' => :'Array<LineItem>',
    :'space_view_id' => :'Integer',
    :'state' => :'TransactionCompletionState',
    :'statement_descriptor' => :'String',
    :'succeeded_on' => :'DateTime',
    :'tax_amount' => :'Float',
    :'time_zone' => :'String',
    :'timeout_on' => :'DateTime',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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 &&
      amount == o.amount &&
      base_line_items == o.base_line_items &&
      created_by == o.created_by &&
      created_on == o.created_on &&
      external_id == o.external_id &&
      failed_on == o.failed_on &&
      failure_reason == o.failure_reason &&
      invoice_merchant_reference == o.invoice_merchant_reference &&
      labels == o.labels &&
      language == o.language &&
      last_completion == o.last_completion &&
      line_item_version == o.line_item_version &&
      line_items == o.line_items &&
      mode == o.mode &&
      next_update_on == o.next_update_on &&
      payment_information == o.payment_information &&
      planned_purge_date == o.planned_purge_date &&
      processing_on == o.processing_on &&
      processor_reference == o.processor_reference &&
      remaining_line_items == o.remaining_line_items &&
      space_view_id == o.space_view_id &&
      state == o.state &&
      statement_descriptor == o.statement_descriptor &&
      succeeded_on == o.succeeded_on &&
      tax_amount == o.tax_amount &&
      time_zone == o.time_zone &&
      timeout_on == o.timeout_on &&
      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



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
504
505
506
507
508
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion.rb', line 472

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



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

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



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion.rb', line 451

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [id, linked_space_id, linked_transaction, amount, base_line_items, created_by, created_on, external_id, failed_on, failure_reason, invoice_merchant_reference, labels, language, last_completion, line_item_version, line_items, mode, next_update_on, payment_information, planned_purge_date, processing_on, processor_reference, remaining_line_items, space_view_id, state, statement_descriptor, succeeded_on, tax_amount, time_zone, timeout_on, 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



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion.rb', line 333

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

  if !@external_id.nil? && @external_id.to_s.length < 1
    invalid_properties.push('invalid value for "external_id", the character length must be great than or equal to 1.')
  end

  if !@invoice_merchant_reference.nil? && @invoice_merchant_reference.to_s.length > 100
    invalid_properties.push('invalid value for "invoice_merchant_reference", the character length must be smaller than or equal to 100.')
  end

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



518
519
520
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion.rb', line 518

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



524
525
526
527
528
529
530
531
532
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion.rb', line 524

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



512
513
514
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion.rb', line 512

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



356
357
358
359
360
361
362
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion.rb', line 356

def valid?
  return false if !@external_id.nil? && @external_id.to_s.length > 100
  return false if !@external_id.nil? && @external_id.to_s.length < 1
  return false if !@invoice_merchant_reference.nil? && @invoice_merchant_reference.to_s.length > 100
  return false if !@statement_descriptor.nil? && @statement_descriptor.to_s.length > 22
  true
end