Class: PostfinancecheckoutRubySdk::TransactionInvoice

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionInvoice

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

The total sum of all line items on the invoice, including taxes.



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

def amount
  @amount
end

#billing_address ⇒ Object

Returns the value of attribute billing_address.



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

def billing_address
  @billing_address
end

#completion ⇒ Object

Returns the value of attribute completion.



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

def completion
  @completion
end

#created_on ⇒ Object

The date and time when the object was created.



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

def created_on
  @created_on
end

#derecognized_by ⇒ Object

The ID of the user the invoice was derecognized by.



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

def derecognized_by
  @derecognized_by
end

#derecognized_on ⇒ Object

The date and time when the invoice was derecognized, meaning it is no longer considered outstanding or valid in the system.



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

def derecognized_on
  @derecognized_on
end

#due_on ⇒ Object

The due date for payment of the invoice.



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

def due_on
  @due_on
end

#environment ⇒ Object

Returns the value of attribute environment.



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

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



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

def external_id
  @external_id
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#language ⇒ Object

The language that is linked to the object.



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

def language
  @language
end

#line_items ⇒ Object

The invoiced line items that will appear on the invoice document.



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

def line_items
  @line_items
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#linked_transaction ⇒ Object

The payment transaction this object is linked to.



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

def linked_transaction
  @linked_transaction
end

#merchant_reference ⇒ Object

The merchant’s reference used to identify the invoice.



91
92
93
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_invoice.rb', line 91

def merchant_reference
  @merchant_reference
end

#outstanding_amount ⇒ Object

The remaining amount the buyer owes to the merchant. A negative value indicates the invoice has been overpaid.



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

def outstanding_amount
  @outstanding_amount
end

The date and time when the invoice was recorded as paid. May differ from the actual payment date due to processing delays.



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

def paid_on
  @paid_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.



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

def planned_purge_date
  @planned_purge_date
end

#space_view_id ⇒ Object

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



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

def space_view_id
  @space_view_id
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#tax_amount ⇒ Object

The portion of the invoiced amount that corresponds to taxes.



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

def tax_amount
  @tax_amount
end

#time_zone ⇒ Object

The time zone that this object is associated with.



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

def time_zone
  @time_zone
end

#version ⇒ Object

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



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

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



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_invoice.rb', line 453

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



145
146
147
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_invoice.rb', line 145

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



150
151
152
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_invoice.rb', line 150

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'completion' => :'completion',
    :'derecognized_on' => :'derecognizedOn',
    :'amount' => :'amount',
    :'due_on' => :'dueOn',
    :'outstanding_amount' => :'outstandingAmount',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'external_id' => :'externalId',
    :'time_zone' => :'timeZone',
    :'language' => :'language',
    :'space_view_id' => :'spaceViewId',
    :'created_on' => :'createdOn',
    :'paid_on' => :'paidOn',
    :'version' => :'version',
    :'line_items' => :'lineItems',
    :'linked_space_id' => :'linkedSpaceId',
    :'environment' => :'environment',
    :'derecognized_by' => :'derecognizedBy',
    :'billing_address' => :'billingAddress',
    :'id' => :'id',
    :'state' => :'state',
    :'linked_transaction' => :'linkedTransaction',
    :'tax_amount' => :'taxAmount',
    :'merchant_reference' => :'merchantReference'
  }
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



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_invoice.rb', line 429

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



184
185
186
187
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_invoice.rb', line 184

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'completion' => :'TransactionCompletion',
    :'derecognized_on' => :'Time',
    :'amount' => :'Float',
    :'due_on' => :'Time',
    :'outstanding_amount' => :'Float',
    :'planned_purge_date' => :'Time',
    :'external_id' => :'String',
    :'time_zone' => :'String',
    :'language' => :'String',
    :'space_view_id' => :'Integer',
    :'created_on' => :'Time',
    :'paid_on' => :'Time',
    :'version' => :'Integer',
    :'line_items' => :'Array<LineItem>',
    :'linked_space_id' => :'Integer',
    :'environment' => :'Environment',
    :'derecognized_by' => :'Integer',
    :'billing_address' => :'Address',
    :'id' => :'Integer',
    :'state' => :'TransactionInvoiceState',
    :'linked_transaction' => :'Integer',
    :'tax_amount' => :'Float',
    :'merchant_reference' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      completion == o.completion &&
      derecognized_on == o.derecognized_on &&
      amount == o.amount &&
      due_on == o.due_on &&
      outstanding_amount == o.outstanding_amount &&
      planned_purge_date == o.planned_purge_date &&
      external_id == o.external_id &&
      time_zone == o.time_zone &&
      language == o.language &&
      space_view_id == o.space_view_id &&
      created_on == o.created_on &&
      paid_on == o.paid_on &&
      version == o.version &&
      line_items == o.line_items &&
      linked_space_id == o.linked_space_id &&
      environment == o.environment &&
      derecognized_by == o.derecognized_by &&
      billing_address == o.billing_address &&
      id == o.id &&
      state == o.state &&
      linked_transaction == o.linked_transaction &&
      tax_amount == o.tax_amount &&
      merchant_reference == o.merchant_reference
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



524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_invoice.rb', line 524

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


416
417
418
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_invoice.rb', line 416

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



422
423
424
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_invoice.rb', line 422

def hash
  [completion, derecognized_on, amount, due_on, outstanding_amount, planned_purge_date, external_id, time_zone, language, space_view_id, created_on, paid_on, version, line_items, linked_space_id, environment, derecognized_by, billing_address, id, state, linked_transaction, tax_amount, merchant_reference].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



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

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

  pattern = Regexp.new(/[	\x20-\x7e]*/)
  if !@external_id.nil? && @external_id !~ pattern
    invalid_properties.push("invalid value for \"external_id\", must conform to the pattern #{pattern}.")
  end

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

  pattern = Regexp.new(/[	\x20-\x7e]*/)
  if !@merchant_reference.nil? && @merchant_reference !~ pattern
    invalid_properties.push("invalid value for \"merchant_reference\", must conform to the pattern #{pattern}.")
  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



500
501
502
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_invoice.rb', line 500

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



506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_invoice.rb', line 506

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



494
495
496
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_invoice.rb', line 494

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



332
333
334
335
336
337
338
339
340
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_invoice.rb', line 332

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  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 !@external_id.nil? && @external_id !~ Regexp.new(/[	\x20-\x7e]*/)
  return false if !@merchant_reference.nil? && @merchant_reference.to_s.length > 100
  return false if !@merchant_reference.nil? && @merchant_reference !~ Regexp.new(/[	\x20-\x7e]*/)
  true
end