Class: TogaiClient::Invoice

Inherits:
Object
  • Object
show all
Defined in:
lib/togai_client/models/invoice.rb

Overview

Structure of invoice

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Invoice

Initializes the object



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
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
 
# File 'lib/togai_client/models/invoice.rb', line 179

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TogaiClient::Invoice` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TogaiClient::Invoice`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

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

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

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

  if attributes.key?(:'usage_info')
    if (value = attributes[:'usage_info']).is_a?(Array)
      self.usage_info = value
    end
  end

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

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

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = nil
  end

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

  if attributes.key?(:'invoice_class')
    self.invoice_class = attributes[:'invoice_class']
  else
    self.invoice_class = nil
  end

  if attributes.key?(:'invoice_type')
    self.invoice_type = attributes[:'invoice_type']
  else
    self.invoice_type = nil
  end

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

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

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

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

  if attributes.key?(:'invoice_date')
    self.invoice_date = attributes[:'invoice_date']
  else
    self.invoice_date = nil
  end

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

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

  if attributes.key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  else
    self.updated_at = nil
  end

  if attributes.key?(:'metadata')
    if (value = attributes[:'metadata']).is_a?(Hash)
      self.metadata = value
    end
  end

  if attributes.key?(:'info')
    if (value = attributes[:'info']).is_a?(Array)
      self.info = value
    end
  end

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

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

  if attributes.key?(:'total_amount')
    self.total_amount = attributes[:'total_amount']
  else
    self.total_amount = nil
  end

  if attributes.key?(:'paid_amount')
    self.paid_amount = attributes[:'paid_amount']
  else
    self.paid_amount = nil
  end

  if attributes.key?(:'net_term_days')
    self.net_term_days = attributes[:'net_term_days']
  else
    self.net_term_days = nil
  end
end

Instance Attribute Details

#auto_advance ⇒ Object

Returns the value of attribute auto_advance.



42
43
44
 
# File 'lib/togai_client/models/invoice.rb', line 42

def auto_advance
  @auto_advance
end

#customer_id ⇒ Object

Returns the value of attribute customer_id.



22
23
24
 
# File 'lib/togai_client/models/invoice.rb', line 22

def customer_id
  @customer_id
end

#due_date ⇒ Object

Due date of the invoice



57
58
59
 
# File 'lib/togai_client/models/invoice.rb', line 57

def due_date
  @due_date
end

#end_date ⇒ Object

End date of the invoice



48
49
50
 
# File 'lib/togai_client/models/invoice.rb', line 48

def end_date
  @end_date
end

#end_date_inclusive ⇒ Object

Inclusive end date of the invoice



51
52
53
 
# File 'lib/togai_client/models/invoice.rb', line 51

def end_date_inclusive
  @end_date_inclusive
end

#finalizing_status ⇒ Object

Returns the value of attribute finalizing_status.



36
37
38
 
# File 'lib/togai_client/models/invoice.rb', line 36

def finalizing_status
  @finalizing_status
end

#generated_at ⇒ Object

Returns the value of attribute generated_at.



59
60
61
 
# File 'lib/togai_client/models/invoice.rb', line 59

def generated_at
  @generated_at
end

#id ⇒ Object

Identifier of invoice



20
21
22
 
# File 'lib/togai_client/models/invoice.rb', line 20

def id
  @id
end

#info ⇒ Object

Returns the value of attribute info.



65
66
67
 
# File 'lib/togai_client/models/invoice.rb', line 65

def info
  @info
end

#invoice_class ⇒ Object

Returns the value of attribute invoice_class.



38
39
40
 
# File 'lib/togai_client/models/invoice.rb', line 38

def invoice_class
  @invoice_class
end

#invoice_date ⇒ Object

Invoice date of the invoice



54
55
56
 
# File 'lib/togai_client/models/invoice.rb', line 54

def invoice_date
  @invoice_date
end

#invoice_details ⇒ Object

Returns the value of attribute invoice_details.



32
33
34
 
# File 'lib/togai_client/models/invoice.rb', line 32

def invoice_details
  @invoice_details
end

#invoice_type ⇒ Object

Returns the value of attribute invoice_type.



40
41
42
 
# File 'lib/togai_client/models/invoice.rb', line 40

def invoice_type
  @invoice_type
end

#metadata ⇒ Object

Returns the value of attribute metadata.



63
64
65
 
# File 'lib/togai_client/models/invoice.rb', line 63

def metadata
  @metadata
end

#net_term_days ⇒ Object

Number of days from the invoice date after which an invoice is considered overdue.



78
79
80
 
# File 'lib/togai_client/models/invoice.rb', line 78

def net_term_days
  @net_term_days
end

#owner_id ⇒ Object

Returns the value of attribute owner_id.



24
25
26
 
# File 'lib/togai_client/models/invoice.rb', line 24

def owner_id
  @owner_id
end

Returns the value of attribute paid_amount.



75
76
77
 
# File 'lib/togai_client/models/invoice.rb', line 75

def paid_amount
  @paid_amount
end

#pdf_url ⇒ Object

Download URL of the pdf file corresponding to the invoice



71
72
73
 
# File 'lib/togai_client/models/invoice.rb', line 71

def pdf_url
  @pdf_url
end

#price_plan_id ⇒ Object

Returns the value of attribute price_plan_id.



26
27
28
 
# File 'lib/togai_client/models/invoice.rb', line 26

def price_plan_id
  @price_plan_id
end

#revenue_info ⇒ Object

Returns the value of attribute revenue_info.



30
31
32
 
# File 'lib/togai_client/models/invoice.rb', line 30

def revenue_info
  @revenue_info
end

#sequence_id ⇒ Object

Sequence id of the invoice



68
69
70
 
# File 'lib/togai_client/models/invoice.rb', line 68

def sequence_id
  @sequence_id
end

#start_date ⇒ Object

Start date of the invoice



45
46
47
 
# File 'lib/togai_client/models/invoice.rb', line 45

def start_date
  @start_date
end

#status ⇒ Object

Returns the value of attribute status.



34
35
36
 
# File 'lib/togai_client/models/invoice.rb', line 34

def status
  @status
end

#total_amount ⇒ Object

Returns the value of attribute total_amount.



73
74
75
 
# File 'lib/togai_client/models/invoice.rb', line 73

def total_amount
  @total_amount
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



61
62
63
 
# File 'lib/togai_client/models/invoice.rb', line 61

def updated_at
  @updated_at
end

#usage_info ⇒ Object

Returns the value of attribute usage_info.



28
29
30
 
# File 'lib/togai_client/models/invoice.rb', line 28

def usage_info
  @usage_info
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/togai_client/models/invoice.rb', line 484

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 = TogaiClient.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_attributes ⇒ Object

Returns all the JSON keys this model knows about



135
136
137
 
# File 'lib/togai_client/models/invoice.rb', line 135

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/togai_client/models/invoice.rb', line 103

def self.attribute_map
  {
    :'id' => :'id',
    :'customer_id' => :'customerId',
    :'owner_id' => :'ownerId',
    :'price_plan_id' => :'pricePlanId',
    :'usage_info' => :'usageInfo',
    :'revenue_info' => :'revenueInfo',
    :'invoice_details' => :'invoiceDetails',
    :'status' => :'status',
    :'finalizing_status' => :'finalizingStatus',
    :'invoice_class' => :'invoiceClass',
    :'invoice_type' => :'invoiceType',
    :'auto_advance' => :'autoAdvance',
    :'start_date' => :'startDate',
    :'end_date' => :'endDate',
    :'end_date_inclusive' => :'endDateInclusive',
    :'invoice_date' => :'invoiceDate',
    :'due_date' => :'dueDate',
    :'generated_at' => :'generatedAt',
    :'updated_at' => :'updatedAt',
    :'metadata' => :'metadata',
    :'info' => :'info',
    :'sequence_id' => :'sequenceId',
    :'pdf_url' => :'pdfUrl',
    :'total_amount' => :'totalAmount',
    :'paid_amount' => :'paidAmount',
    :'net_term_days' => :'netTermDays'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/togai_client/models/invoice.rb', line 460

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



172
173
174
175
 
# File 'lib/togai_client/models/invoice.rb', line 172

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

.openapi_types ⇒ Object

Attribute type mapping.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/togai_client/models/invoice.rb', line 140

def self.openapi_types
  {
    :'id' => :'String',
    :'customer_id' => :'String',
    :'owner_id' => :'String',
    :'price_plan_id' => :'String',
    :'usage_info' => :'Array<InvoiceLineItem>',
    :'revenue_info' => :'InvoiceLineItem',
    :'invoice_details' => :'InvoiceDetails',
    :'status' => :'InvoicesStatus',
    :'finalizing_status' => :'String',
    :'invoice_class' => :'InvoicesClass',
    :'invoice_type' => :'InvoicesType',
    :'auto_advance' => :'Boolean',
    :'start_date' => :'Time',
    :'end_date' => :'Time',
    :'end_date_inclusive' => :'Time',
    :'invoice_date' => :'Time',
    :'due_date' => :'Time',
    :'generated_at' => :'Time',
    :'updated_at' => :'Time',
    :'metadata' => :'Hash<String, Object>',
    :'info' => :'Array<InvoiceInfoInner>',
    :'sequence_id' => :'String',
    :'pdf_url' => :'String',
    :'total_amount' => :'Float',
    :'paid_amount' => :'Float',
    :'net_term_days' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/togai_client/models/invoice.rb', line 414

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      customer_id == o.customer_id &&
      owner_id == o.owner_id &&
      price_plan_id == o.price_plan_id &&
      usage_info == o.usage_info &&
      revenue_info == o.revenue_info &&
      invoice_details == o.invoice_details &&
      status == o.status &&
      finalizing_status == o.finalizing_status &&
      invoice_class == o.invoice_class &&
      invoice_type == o.invoice_type &&
      auto_advance == o.auto_advance &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      end_date_inclusive == o.end_date_inclusive &&
      invoice_date == o.invoice_date &&
      due_date == o.due_date &&
      generated_at == o.generated_at &&
      updated_at == o.updated_at &&
      metadata == o.metadata &&
      info == o.info &&
      sequence_id == o.sequence_id &&
      pdf_url == o.pdf_url &&
      total_amount == o.total_amount &&
      paid_amount == o.paid_amount &&
      net_term_days == o.net_term_days
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



555
556
557
558
559
560
561
562
563
564
565
566
567
 
# File 'lib/togai_client/models/invoice.rb', line 555

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

See Also:

  • `==` method


447
448
449
 
# File 'lib/togai_client/models/invoice.rb', line 447

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



453
454
455
 
# File 'lib/togai_client/models/invoice.rb', line 453

def hash
  [id, customer_id, owner_id, price_plan_id, usage_info, revenue_info, invoice_details, status, finalizing_status, invoice_class, invoice_type, auto_advance, start_date, end_date, end_date_inclusive, invoice_date, due_date, generated_at, updated_at, metadata, info, sequence_id, pdf_url, total_amount, paid_amount, net_term_days].hash
end

#list_invalid_properties ⇒ Object

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



323
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
361
362
363
364
365
366
367
 
# File 'lib/togai_client/models/invoice.rb', line 323

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @id.to_s.length > 50
    invalid_properties.push('invalid value for "id", the character length must be smaller than or equal to 50.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @invoice_class.nil?
    invalid_properties.push('invalid value for "invoice_class", invoice_class cannot be nil.')
  end

  if @invoice_type.nil?
    invalid_properties.push('invalid value for "invoice_type", invoice_type cannot be nil.')
  end

  if @invoice_date.nil?
    invalid_properties.push('invalid value for "invoice_date", invoice_date cannot be nil.')
  end

  if @updated_at.nil?
    invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
  end

  if @total_amount.nil?
    invalid_properties.push('invalid value for "total_amount", total_amount cannot be nil.')
  end

  if @paid_amount.nil?
    invalid_properties.push('invalid value for "paid_amount", paid_amount cannot be nil.')
  end

  if @net_term_days.nil?
    invalid_properties.push('invalid value for "net_term_days", net_term_days cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



531
532
533
 
# File 'lib/togai_client/models/invoice.rb', line 531

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



537
538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/togai_client/models/invoice.rb', line 537

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



525
526
527
 
# File 'lib/togai_client/models/invoice.rb', line 525

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/togai_client/models/invoice.rb', line 371

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @id.to_s.length > 50
  return false if @status.nil?
  finalizing_status_validator = EnumAttributeValidator.new('String', ["FINALIZING", "FINALIZED"])
  return false unless finalizing_status_validator.valid?(@finalizing_status)
  return false if @invoice_class.nil?
  return false if @invoice_type.nil?
  return false if @invoice_date.nil?
  return false if @updated_at.nil?
  return false if @total_amount.nil?
  return false if @paid_amount.nil?
  return false if @net_term_days.nil?
  true
end