Class: AdvancedBilling::CreateInvoicePaymentRequest

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

Overview

CreateInvoicePaymentRequest Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

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

Constructor Details

#initialize(payment:, type: SKIP, additional_properties: {}) ⇒ CreateInvoicePaymentRequest

Returns a new instance of CreateInvoicePaymentRequest.



40
41
42
43
44
45
46
47
48
 
# File 'lib/advanced_billing/models/create_invoice_payment_request.rb', line 40

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

  @payment = payment
  @type = type unless type == SKIP
end

Instance Attribute Details

#payment ⇒ CreateInvoicePayment

TODO: Write general description for this method

Returns:



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

def payment
  @payment
end

#type ⇒ InvoicePaymentType

The type of payment to be applied to an Invoice. Defaults to external.

Returns:



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

def type
  @type
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  payment = CreateInvoicePayment.from_hash(hash['payment']) if hash['payment']
  type = hash.key?('type') ? hash['type'] : SKIP

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

  # Create object from extracted values.
  CreateInvoicePaymentRequest.new(payment: payment,
                                  type: type,
                                  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/create_invoice_payment_request.rb', line 21

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

.nullables ⇒ Object

An array for nullable fields



36
37
38
 
# File 'lib/advanced_billing/models/create_invoice_payment_request.rb', line 36

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    type
  ]
end