Class: AdvancedBilling::PaymentForAllocation

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

Overview

Information for captured payment, if applicable

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(id: SKIP, amount_in_cents: SKIP, success: SKIP, memo: SKIP, additional_properties: {}) ⇒ PaymentForAllocation

Returns a new instance of PaymentForAllocation.



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

def initialize(id: SKIP, amount_in_cents: SKIP, success: SKIP, memo: SKIP,
               additional_properties: {})
  @id = id unless id == SKIP
  @amount_in_cents = amount_in_cents unless amount_in_cents == SKIP
  @success = success unless success == SKIP
  @memo = memo unless memo == SKIP

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

Instance Attribute Details

#amount_in_cents ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def amount_in_cents
  @amount_in_cents
end

#id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def id
  @id
end

#memo ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def memo
  @memo
end

#success ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


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

def success
  @success
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
 
# File 'lib/advanced_billing/models/payment_for_allocation.rb', line 67

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  id = hash.key?('id') ? hash['id'] : SKIP
  amount_in_cents =
    hash.key?('amount_in_cents') ? hash['amount_in_cents'] : SKIP
  success = hash.key?('success') ? hash['success'] : SKIP
  memo = hash.key?('memo') ? hash['memo'] : SKIP

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

  # Create object from extracted values.
  PaymentForAllocation.new(id: id,
                           amount_in_cents: amount_in_cents,
                           success: success,
                           memo: memo,
                           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/payment_for_allocation.rb', line 29

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['id'] = 'id'
  @_hash['amount_in_cents'] = 'amount_in_cents'
  @_hash['success'] = 'success'
  @_hash['memo'] = 'memo'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



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

def self.optionals
  %w[
    id
    amount_in_cents
    success
    memo
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



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

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

  return false unless value.instance_of? Hash

  true
end