Class: PostFinanceCheckout::TransactionLineItemVersion

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

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



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

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?(:'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?(:'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?(:'lineItems')
    if (value = attributes[:'lineItems']).is_a?(Array)
      self.line_items = value
    end
  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?(:'processingOn')
    self.processing_on = attributes[:'processingOn']
  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?(:'taxAmount')
    self.tax_amount = attributes[:'taxAmount']
  end

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

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

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

Instance Attribute Details

#amountObject

Returns the value of attribute amount.



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

def amount
  @amount
end

#created_byObject

Returns the value of attribute created_by.



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

def created_by
  @created_by
end

#created_onObject

The date and time when the object was created.



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

def created_on
  @created_on
end

#external_idObject

A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.



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

def external_id
  @external_id
end

#failed_onObject

Returns the value of attribute failed_on.



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

def failed_on
  @failed_on
end

#failure_reasonObject

Returns the value of attribute failure_reason.



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

def failure_reason
  @failure_reason
end

#idObject

A unique identifier for the object.



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

def id
  @id
end

#labelsObject

Returns the value of attribute labels.



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

def labels
  @labels
end

#languageObject

The language that is linked to the object.



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

def language
  @language
end

#line_itemsObject

Returns the value of attribute line_items.



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

def line_items
  @line_items
end

#linked_space_idObject

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#linked_transactionObject

Returns the value of attribute linked_transaction.



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

def linked_transaction
  @linked_transaction
end

#next_update_onObject

Returns the value of attribute next_update_on.



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

def next_update_on
  @next_update_on
end

#planned_purge_dateObject

The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.



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

def planned_purge_date
  @planned_purge_date
end

#processing_onObject

Returns the value of attribute processing_on.



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

def processing_on
  @processing_on
end

#space_view_idObject

Returns the value of attribute space_view_id.



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

def space_view_id
  @space_view_id
end

#stateObject

The object’s current state.



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

def state
  @state
end

#succeeded_onObject

Returns the value of attribute succeeded_on.



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

def succeeded_on
  @succeeded_on
end

#tax_amountObject

Returns the value of attribute tax_amount.



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

def tax_amount
  @tax_amount
end

#timeout_onObject

Returns the value of attribute timeout_on.



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

def timeout_on
  @timeout_on
end

#transactionObject

Returns the value of attribute transaction.



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

def transaction
  @transaction
end

#versionObject

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



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

def version
  @version
end

Class Method Details

.attribute_mapObject

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 90

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

.swagger_typesObject

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



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

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 &&
      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 &&
      labels == o.labels &&
      language == o.language &&
      line_items == o.line_items &&
      next_update_on == o.next_update_on &&
      planned_purge_date == o.planned_purge_date &&
      processing_on == o.processing_on &&
      space_view_id == o.space_view_id &&
      state == o.state &&
      succeeded_on == o.succeeded_on &&
      tax_amount == o.tax_amount &&
      timeout_on == o.timeout_on &&
      transaction == o.transaction &&
      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



324
325
326
327
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
360
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 324

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



390
391
392
393
394
395
396
397
398
399
400
401
402
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 390

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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 303

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


290
291
292
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 290

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



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

def hash
  [id, linked_space_id, linked_transaction, amount, created_by, created_on, external_id, failed_on, failure_reason, labels, language, line_items, next_update_on, planned_purge_date, processing_on, space_view_id, state, succeeded_on, tax_amount, timeout_on, transaction, version].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



248
249
250
251
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 248

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



370
371
372
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 370

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



376
377
378
379
380
381
382
383
384
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 376

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



364
365
366
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 364

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



255
256
257
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_line_item_version.rb', line 255

def valid?
  true
end