Class: AdvancedBilling::PaymentResponse

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

Overview

PaymentResponse Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(paid_invoices = SKIP, prepayment = SKIP) ⇒ PaymentResponse

Returns a new instance of PaymentResponse.



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

def initialize(paid_invoices = SKIP, prepayment = SKIP)
  @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/payment_response.rb', line 14

def paid_invoices
  @paid_invoices
end

#prepayment ⇒ PrePayment

TODO: Write general description for this method

Returns:



18
19
20
 
# File 'lib/advanced_billing/models/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.



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

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 << (Payment.from_hash(structure) if structure)
    end
  end

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

  # Create object from extracted values.
  PaymentResponse.new(paid_invoices,
                      prepayment)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/advanced_billing/models/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
 
# File 'lib/advanced_billing/models/payment_response.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/payment_response.rb', line 29

def self.optionals
  %w[
    paid_invoices
    prepayment
  ]
end