Class: AdvancedBilling::SignupProformaPreview

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

Overview

SignupProformaPreview Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(current_proforma_invoice: SKIP, next_proforma_invoice: SKIP, additional_properties: {}) ⇒ SignupProformaPreview

Returns a new instance of SignupProformaPreview.



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

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

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

Instance Attribute Details

#current_proforma_invoice ⇒ ProformaInvoice

TODO: Write general description for this method

Returns:



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

def current_proforma_invoice
  @current_proforma_invoice
end

#next_proforma_invoice ⇒ ProformaInvoice

TODO: Write general description for this method

Returns:



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

def next_proforma_invoice
  @next_proforma_invoice
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
 
# File 'lib/advanced_billing/models/signup_proforma_preview.rb', line 53

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  current_proforma_invoice = ProformaInvoice.from_hash(hash['current_proforma_invoice']) if
    hash['current_proforma_invoice']
  next_proforma_invoice = ProformaInvoice.from_hash(hash['next_proforma_invoice']) if
    hash['next_proforma_invoice']

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

  # Create object from extracted values.
  SignupProformaPreview.new(current_proforma_invoice: current_proforma_invoice,
                            next_proforma_invoice: next_proforma_invoice,
                            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/signup_proforma_preview.rb', line 21

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

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/advanced_billing/models/signup_proforma_preview.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/signup_proforma_preview.rb', line 29

def self.optionals
  %w[
    current_proforma_invoice
    next_proforma_invoice
  ]
end