Class: AdvancedBilling::ConsolidatedInvoice

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/advanced_billing/models/consolidated_invoice.rb

Overview

ConsolidatedInvoice Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(invoices: SKIP, additional_properties: {}) ⇒ ConsolidatedInvoice

Returns a new instance of ConsolidatedInvoice.



35
36
37
38
39
40
41
42
 
# File 'lib/advanced_billing/models/consolidated_invoice.rb', line 35

def initialize(invoices: SKIP, additional_properties: {})
  @invoices = invoices unless invoices == SKIP

  # Add additional model properties to the instance.
  additional_properties.each do |_name, _value|
    instance_variable_set("@#{_name}", _value)
  end
end

Instance Attribute Details

#invoices ⇒ Array[Invoice]

TODO: Write general description for this method

Returns:



14
15
16
 
# File 'lib/advanced_billing/models/consolidated_invoice.rb', line 14

def invoices
  @invoices
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/advanced_billing/models/consolidated_invoice.rb', line 45

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  # Parameter is an array, so we need to iterate through it
  invoices = nil
  unless hash['invoices'].nil?
    invoices = []
    hash['invoices'].each do |structure|
      invoices << (Invoice.from_hash(structure) if structure)
    end
  end

  invoices = SKIP unless hash.key?('invoices')

  # Clean out expected properties from Hash.
  names.each_value { |k| hash.delete(k) }

  # Create object from extracted values.
  ConsolidatedInvoice.new(invoices: invoices,
                          additional_properties: hash)
end

.names ⇒ Object

A mapping from model property names to API property names.



17
18
19
20
21
 
# File 'lib/advanced_billing/models/consolidated_invoice.rb', line 17

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['invoices'] = 'invoices'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



31
32
33
 
# File 'lib/advanced_billing/models/consolidated_invoice.rb', line 31

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



24
25
26
27
28
 
# File 'lib/advanced_billing/models/consolidated_invoice.rb', line 24

def self.optionals
  %w[
    invoices
  ]
end