Class: AdvancedBilling::ProformaInvoicePayment

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

Overview

ProformaInvoicePayment Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #get_additional_properties, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(memo: SKIP, original_amount: SKIP, applied_amount: SKIP, prepayment: SKIP, additional_properties: {}) ⇒ ProformaInvoicePayment

Returns a new instance of ProformaInvoicePayment.



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

def initialize(memo: SKIP, original_amount: SKIP, applied_amount: SKIP,
               prepayment: SKIP, additional_properties: {})
  # Add additional model properties to the instance.
  additional_properties.each do |_name, _value|
    instance_variable_set("@#{_name}", _value)
  end

  @memo = memo unless memo == SKIP
  @original_amount = original_amount unless original_amount == SKIP
  @applied_amount = applied_amount unless applied_amount == SKIP
  @prepayment = prepayment unless prepayment == SKIP
end

Instance Attribute Details

#applied_amount ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def applied_amount
  @applied_amount
end

#memo ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def memo
  @memo
end

#original_amount ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def original_amount
  @original_amount
end

#prepayment ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


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

def prepayment
  @prepayment
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/proforma_invoice_payment.rb', line 67

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  memo = hash.key?('memo') ? hash['memo'] : SKIP
  original_amount =
    hash.key?('original_amount') ? hash['original_amount'] : SKIP
  applied_amount =
    hash.key?('applied_amount') ? hash['applied_amount'] : SKIP
  prepayment = hash.key?('prepayment') ? hash['prepayment'] : SKIP

  # Clean out expected properties from Hash.
  additional_properties = hash.reject { |k, _| names.value?(k) }

  # Create object from extracted values.
  ProformaInvoicePayment.new(memo: memo,
                             original_amount: original_amount,
                             applied_amount: applied_amount,
                             prepayment: prepayment,
                             additional_properties: additional_properties)
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/proforma_invoice_payment.rb', line 29

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['memo'] = 'memo'
  @_hash['original_amount'] = 'original_amount'
  @_hash['applied_amount'] = 'applied_amount'
  @_hash['prepayment'] = 'prepayment'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



49
50
51
 
# File 'lib/advanced_billing/models/proforma_invoice_payment.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/proforma_invoice_payment.rb', line 39

def self.optionals
  %w[
    memo
    original_amount
    applied_amount
    prepayment
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



98
99
100
101
102
103
 
# File 'lib/advanced_billing/models/proforma_invoice_payment.rb', line 98

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} memo: #{@memo.inspect}, original_amount: #{@original_amount.inspect},"\
  " applied_amount: #{@applied_amount.inspect}, prepayment: #{@prepayment.inspect},"\
  " additional_properties: #{get_additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



90
91
92
93
94
95
 
# File 'lib/advanced_billing/models/proforma_invoice_payment.rb', line 90

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} memo: #{@memo}, original_amount: #{@original_amount}, applied_amount:"\
  " #{@applied_amount}, prepayment: #{@prepayment}, additional_properties:"\
  " #{get_additional_properties}>"
end