Class: PostfinancecheckoutRubySdk::TransactionLineItemVersion

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionLineItemVersion

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

  if attributes.key?(:'created_on')
    self.created_on = attributes[:'created_on']
  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?(:'line_items')
    if (value = attributes[:'line_items']).is_a?(Array)
      self.line_items = 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?(:'created_by')
    self.created_by = attributes[:'created_by']
  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?(:'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?(:'tax_amount')
    self.tax_amount = attributes[:'tax_amount']
  end

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

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

Instance Attribute Details

#amount ⇒ Object

The total amount of the updated line items, including taxes.



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

def amount
  @amount
end

#created_by ⇒ Object

The ID of the user the line item version was created by.



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

def created_by
  @created_by
end

#created_on ⇒ Object

The date and time when the object was created.



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

def created_on
  @created_on
end

#external_id ⇒ Object

A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.



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

def external_id
  @external_id
end

#failed_on ⇒ Object

The date and time when the processing of the line item version failed.



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

def failed_on
  @failed_on
end

#failure_reason ⇒ Object

Returns the value of attribute failure_reason.



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

def failure_reason
  @failure_reason
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#labels ⇒ Object

The labels providing additional information about the object.



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

def labels
  @labels
end

#language ⇒ Object

The language that is linked to the object.



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

def language
  @language
end

#line_items ⇒ Object

The line items that replace the original line items in the transaction.



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

def line_items
  @line_items
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#linked_transaction ⇒ Object

The payment transaction this object is linked to.



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

def linked_transaction
  @linked_transaction
end

#next_update_on ⇒ Object

The date and time when the next update of the line item version’s state is planned.



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

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.



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

def planned_purge_date
  @planned_purge_date
end

#processing_on ⇒ Object

The date and time when the processing of the line item version was started.



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

def processing_on
  @processing_on
end

#space_view_id ⇒ Object

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



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

def space_view_id
  @space_view_id
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#succeeded_on ⇒ Object

The date and time when the line item version was processed successfully.



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

def succeeded_on
  @succeeded_on
end

#tax_amount ⇒ Object

The portion of the total amount that corresponds to taxes.



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

def tax_amount
  @tax_amount
end

#timeout_on ⇒ Object

The date and time by when the line item version is expected to be processed.



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

def timeout_on
  @timeout_on
end

#transaction ⇒ Object

Returns the value of attribute transaction.



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

def transaction
  @transaction
end

#version ⇒ Object

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



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

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



387
388
389
390
391
392
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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 387

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



142
143
144
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 142

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



147
148
149
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 147

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 114

def self.attribute_map
  {
    :'amount' => :'amount',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'processing_on' => :'processingOn',
    :'external_id' => :'externalId',
    :'language' => :'language',
    :'space_view_id' => :'spaceViewId',
    :'created_on' => :'createdOn',
    :'version' => :'version',
    :'labels' => :'labels',
    :'line_items' => :'lineItems',
    :'linked_space_id' => :'linkedSpaceId',
    :'timeout_on' => :'timeoutOn',
    :'created_by' => :'createdBy',
    :'next_update_on' => :'nextUpdateOn',
    :'failure_reason' => :'failureReason',
    :'succeeded_on' => :'succeededOn',
    :'id' => :'id',
    :'state' => :'state',
    :'linked_transaction' => :'linkedTransaction',
    :'tax_amount' => :'taxAmount',
    :'failed_on' => :'failedOn',
    :'transaction' => :'transaction'
  }
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



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 363

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



180
181
182
183
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 180

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'amount' => :'Float',
    :'planned_purge_date' => :'Time',
    :'processing_on' => :'Time',
    :'external_id' => :'String',
    :'language' => :'String',
    :'space_view_id' => :'Integer',
    :'created_on' => :'Time',
    :'version' => :'Integer',
    :'labels' => :'Array<Label>',
    :'line_items' => :'Array<LineItem>',
    :'linked_space_id' => :'Integer',
    :'timeout_on' => :'Time',
    :'created_by' => :'Integer',
    :'next_update_on' => :'Time',
    :'failure_reason' => :'FailureReason',
    :'succeeded_on' => :'Time',
    :'id' => :'Integer',
    :'state' => :'TransactionLineItemVersionState',
    :'linked_transaction' => :'Integer',
    :'tax_amount' => :'Float',
    :'failed_on' => :'Time',
    :'transaction' => :'Transaction'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      planned_purge_date == o.planned_purge_date &&
      processing_on == o.processing_on &&
      external_id == o.external_id &&
      language == o.language &&
      space_view_id == o.space_view_id &&
      created_on == o.created_on &&
      version == o.version &&
      labels == o.labels &&
      line_items == o.line_items &&
      linked_space_id == o.linked_space_id &&
      timeout_on == o.timeout_on &&
      created_by == o.created_by &&
      next_update_on == o.next_update_on &&
      failure_reason == o.failure_reason &&
      succeeded_on == o.succeeded_on &&
      id == o.id &&
      state == o.state &&
      linked_transaction == o.linked_transaction &&
      tax_amount == o.tax_amount &&
      failed_on == o.failed_on &&
      transaction == o.transaction
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



458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 458

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


350
351
352
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 350

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



356
357
358
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 356

def hash
  [amount, planned_purge_date, processing_on, external_id, language, space_view_id, created_on, version, labels, line_items, linked_space_id, timeout_on, created_by, next_update_on, failure_reason, succeeded_on, id, state, linked_transaction, tax_amount, failed_on, transaction].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



296
297
298
299
300
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 296

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



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

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



440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 440

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



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

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



304
305
306
307
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 304

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end