Class: AdvancedBilling::InvoiceTaxBreakout

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

Overview

InvoiceTaxBreakout Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(uid: SKIP, taxable_amount: SKIP, tax_amount: SKIP, tax_exempt_amount: SKIP, additional_properties: {}) ⇒ InvoiceTaxBreakout

Returns a new instance of InvoiceTaxBreakout.



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/advanced_billing/models/invoice_tax_breakout.rb', line 53

def initialize(uid: SKIP, taxable_amount: SKIP, tax_amount: SKIP,
               tax_exempt_amount: SKIP, additional_properties: {})
  @uid = uid unless uid == SKIP
  @taxable_amount = taxable_amount unless taxable_amount == SKIP
  @tax_amount = tax_amount unless tax_amount == SKIP
  @tax_exempt_amount = tax_exempt_amount unless tax_exempt_amount == SKIP

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

Instance Attribute Details

#tax_amount ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


22
23
24
 
# File 'lib/advanced_billing/models/invoice_tax_breakout.rb', line 22

def tax_amount
  @tax_amount
end

#tax_exempt_amount ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


26
27
28
 
# File 'lib/advanced_billing/models/invoice_tax_breakout.rb', line 26

def tax_exempt_amount
  @tax_exempt_amount
end

#taxable_amount ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def taxable_amount
  @taxable_amount
end

#uid ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def uid
  @uid
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/advanced_billing/models/invoice_tax_breakout.rb', line 67

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  uid = hash.key?('uid') ? hash['uid'] : SKIP
  taxable_amount =
    hash.key?('taxable_amount') ? hash['taxable_amount'] : SKIP
  tax_amount = hash.key?('tax_amount') ? hash['tax_amount'] : SKIP
  tax_exempt_amount =
    hash.key?('tax_exempt_amount') ? hash['tax_exempt_amount'] : SKIP

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

  # Create object from extracted values.
  InvoiceTaxBreakout.new(uid: uid,
                         taxable_amount: taxable_amount,
                         tax_amount: tax_amount,
                         tax_exempt_amount: tax_exempt_amount,
                         additional_properties: hash)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['uid'] = 'uid'
  @_hash['taxable_amount'] = 'taxable_amount'
  @_hash['tax_amount'] = 'tax_amount'
  @_hash['tax_exempt_amount'] = 'tax_exempt_amount'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



49
50
51
 
# File 'lib/advanced_billing/models/invoice_tax_breakout.rb', line 49

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



39
40
41
42
43
44
45
46
 
# File 'lib/advanced_billing/models/invoice_tax_breakout.rb', line 39

def self.optionals
  %w[
    uid
    taxable_amount
    tax_amount
    tax_exempt_amount
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



91
92
93
94
95
96
97
 
# File 'lib/advanced_billing/models/invoice_tax_breakout.rb', line 91

def self.validate(value)
  return true if value.instance_of? self

  return false unless value.instance_of? Hash

  true
end