Class: AdvancedBilling::CreatePayment

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

Overview

CreatePayment Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(amount:, memo:, payment_details:, payment_method:, additional_properties: {}) ⇒ CreatePayment

Returns a new instance of CreatePayment.



48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/advanced_billing/models/create_payment.rb', line 48

def initialize(amount:, memo:, payment_details:, payment_method:,
               additional_properties: {})
  @amount = amount
  @memo = memo
  @payment_details = payment_details
  @payment_method = payment_method

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

Instance Attribute Details

#amount ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def amount
  @amount
end

#memo ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def memo
  @memo
end

#payment_details ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def payment_details
  @payment_details
end

#payment_method ⇒ InvoicePaymentMethodType

The type of payment method used. Defaults to other.

Returns:



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

def payment_method
  @payment_method
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/advanced_billing/models/create_payment.rb', line 62

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  amount = hash.key?('amount') ? hash['amount'] : nil
  memo = hash.key?('memo') ? hash['memo'] : nil
  payment_details =
    hash.key?('payment_details') ? hash['payment_details'] : nil
  payment_method =
    hash.key?('payment_method') ? hash['payment_method'] : nil

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

  # Create object from extracted values.
  CreatePayment.new(amount: amount,
                    memo: memo,
                    payment_details: payment_details,
                    payment_method: payment_method,
                    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/create_payment.rb', line 29

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['amount'] = 'amount'
  @_hash['memo'] = 'memo'
  @_hash['payment_details'] = 'payment_details'
  @_hash['payment_method'] = 'payment_method'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



44
45
46
 
# File 'lib/advanced_billing/models/create_payment.rb', line 44

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



39
40
41
 
# File 'lib/advanced_billing/models/create_payment.rb', line 39

def self.optionals
  []
end