Class: AdvancedBilling::ListProformaInvoicesResponse

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

Overview

ListProformaInvoicesResponse Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(proforma_invoices: SKIP, meta: SKIP, additional_properties: {}) ⇒ ListProformaInvoicesResponse

Returns a new instance of ListProformaInvoicesResponse.



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/advanced_billing/models/list_proforma_invoices_response.rb', line 41

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

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

Instance Attribute Details

#meta ⇒ ListProformaInvoicesMeta

TODO: Write general description for this method

Returns:



18
19
20
 
# File 'lib/advanced_billing/models/list_proforma_invoices_response.rb', line 18

def meta
  @meta
end

#proforma_invoices ⇒ Array[ProformaInvoice]

TODO: Write general description for this method

Returns:



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

def proforma_invoices
  @proforma_invoices
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/advanced_billing/models/list_proforma_invoices_response.rb', line 53

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
  proforma_invoices = nil
  unless hash['proforma_invoices'].nil?
    proforma_invoices = []
    hash['proforma_invoices'].each do |structure|
      proforma_invoices << (ProformaInvoice.from_hash(structure) if structure)
    end
  end

  proforma_invoices = SKIP unless hash.key?('proforma_invoices')
  meta = ListProformaInvoicesMeta.from_hash(hash['meta']) if hash['meta']

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

  # Create object from extracted values.
  ListProformaInvoicesResponse.new(proforma_invoices: proforma_invoices,
                                   meta: meta,
                                   additional_properties: hash)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/advanced_billing/models/list_proforma_invoices_response.rb', line 21

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

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/advanced_billing/models/list_proforma_invoices_response.rb', line 37

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
32
33
34
 
# File 'lib/advanced_billing/models/list_proforma_invoices_response.rb', line 29

def self.optionals
  %w[
    proforma_invoices
    meta
  ]
end