Class: VRPayment::TransactionInvoice

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

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



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
245
246
247
248
249
250
251
 
# File 'lib/vrpayment-ruby-sdk/models/transaction_invoice.rb', line 152

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

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



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

def amount
  @amount
end

#billing_address ⇒ Object

The address associated with the invoice, used for billing purposes.



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

def billing_address
  @billing_address
end

#completion ⇒ Object

The transaction completion this object is linked to.



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

def completion
  @completion
end

#created_on ⇒ Object

The date and time when the object was created.



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

def created_on
  @created_on
end

#derecognized_by ⇒ Object

The ID of the user the invoice was derecognized by.



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

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.



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

def derecognized_on
  @derecognized_on
end

#due_on ⇒ Object

The due date for payment of the invoice.



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

def due_on
  @due_on
end

#environment ⇒ Object

The environment used when rendering resources.



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

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.



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

def external_id
  @external_id
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#language ⇒ Object

The language that is linked to the object.



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

def language
  @language
end

#line_items ⇒ Object

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



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

def line_items
  @line_items
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#linked_transaction ⇒ Object

The payment transaction this object is linked to.



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

def linked_transaction
  @linked_transaction
end

#merchant_reference ⇒ Object

The merchant’s reference used to identify the invoice.



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

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.



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

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.



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

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.



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

def planned_purge_date
  @planned_purge_date
end

#space_view_id ⇒ Object

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



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

def space_view_id
  @space_view_id
end

#state ⇒ Object

The object’s current state.



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

def state
  @state
end

#tax_amount ⇒ Object

The portion of the invoiced amount that corresponds to taxes.



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

def tax_amount
  @tax_amount
end

#time_zone ⇒ Object

The time zone that this object is associated with.



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

def time_zone
  @time_zone
end

#version ⇒ Object

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



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/vrpayment-ruby-sdk/models/transaction_invoice.rb', line 93

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

.swagger_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/vrpayment-ruby-sdk/models/transaction_invoice.rb', line 307

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



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/vrpayment-ruby-sdk/models/transaction_invoice.rb', line 371

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



437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/vrpayment-ruby-sdk/models/transaction_invoice.rb', line 437

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



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/vrpayment-ruby-sdk/models/transaction_invoice.rb', line 350

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


337
338
339
 
# File 'lib/vrpayment-ruby-sdk/models/transaction_invoice.rb', line 337

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



343
344
345
 
# File 'lib/vrpayment-ruby-sdk/models/transaction_invoice.rb', line 343

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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/vrpayment-ruby-sdk/models/transaction_invoice.rb', line 255

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 !@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

  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



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

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



423
424
425
426
427
428
429
430
431
 
# File 'lib/vrpayment-ruby-sdk/models/transaction_invoice.rb', line 423

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



411
412
413
 
# File 'lib/vrpayment-ruby-sdk/models/transaction_invoice.rb', line 411

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



274
275
276
277
278
279
 
# File 'lib/vrpayment-ruby-sdk/models/transaction_invoice.rb', line 274

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 !@merchant_reference.nil? && @merchant_reference.to_s.length > 100
  true
end