Class: AdvancedBilling::InvoicePreviousBalance

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

Overview

InvoicePreviousBalance Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(capture_date = SKIP, invoices = SKIP) ⇒ InvoicePreviousBalance

Returns a new instance of InvoicePreviousBalance.



41
42
43
44
 
# File 'lib/advanced_billing/models/invoice_previous_balance.rb', line 41

def initialize(capture_date = SKIP, invoices = SKIP)
  @capture_date = capture_date unless capture_date == SKIP
  @invoices = invoices unless invoices == SKIP
end

Instance Attribute Details

#capture_date ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def capture_date
  @capture_date
end

#invoices ⇒ Array[InvoiceBalanceItem]

TODO: Write general description for this method

Returns:



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

def invoices
  @invoices
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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/invoice_previous_balance.rb', line 47

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  capture_date = hash.key?('capture_date') ? hash['capture_date'] : SKIP
  # Parameter is an array, so we need to iterate through it

  invoices = nil
  unless hash['invoices'].nil?
    invoices = []
    hash['invoices'].each do |structure|
      invoices << (InvoiceBalanceItem.from_hash(structure) if structure)
    end
  end

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

  # Create object from extracted values.

  InvoicePreviousBalance.new(capture_date,
                             invoices)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

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

.nullables ⇒ Object

An array for nullable fields



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

def self.optionals
  %w[
    capture_date
    invoices
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



70
71
72
73
74
75
76
 
# File 'lib/advanced_billing/models/invoice_previous_balance.rb', line 70

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

  return false unless value.instance_of? Hash

  true
end