Class: AdvancedBilling::RecordPaymentResponse

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

Overview

RecordPaymentResponse 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(paid_invoices: SKIP, prepayment: SKIP, additional_properties: {}) ⇒ RecordPaymentResponse

Returns a new instance of RecordPaymentResponse.



43
44
45
46
47
48
49
50
51
52
 
# File 'lib/advanced_billing/models/record_payment_response.rb', line 43

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

  @paid_invoices = paid_invoices unless paid_invoices == SKIP
  @prepayment = prepayment unless prepayment == SKIP
end

Instance Attribute Details

TODO: Write general description for this method

Returns:



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

def paid_invoices
  @paid_invoices
end

#prepayment ⇒ InvoicePrePayment

TODO: Write general description for this method

Returns:



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

def prepayment
  @prepayment
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

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

  paid_invoices = SKIP unless hash.key?('paid_invoices')
  prepayment = InvoicePrePayment.from_hash(hash['prepayment']) if hash['prepayment']

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

  # Create object from extracted values.
  RecordPaymentResponse.new(paid_invoices: paid_invoices,
                            prepayment: prepayment,
                            additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

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

.nullables ⇒ Object

An array for nullable fields



37
38
39
40
41
 
# File 'lib/advanced_billing/models/record_payment_response.rb', line 37

def self.nullables
  %w[
    prepayment
  ]
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    paid_invoices
    prepayment
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



88
89
90
91
92
 
# File 'lib/advanced_billing/models/record_payment_response.rb', line 88

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



81
82
83
84
85
 
# File 'lib/advanced_billing/models/record_payment_response.rb', line 81

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