Class: AdvancedBilling::VoidInvoice

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

Overview

VoidInvoice 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(reason:, additional_properties: {}) ⇒ VoidInvoice

Returns a new instance of VoidInvoice.



33
34
35
36
37
38
39
40
 
# File 'lib/advanced_billing/models/void_invoice.rb', line 33

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

  @reason = reason
end

Instance Attribute Details

#reason ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def reason
  @reason
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  reason = hash.key?('reason') ? hash['reason'] : nil

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

  # Create object from extracted values.
  VoidInvoice.new(reason: reason,
                  additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



17
18
19
20
21
 
# File 'lib/advanced_billing/models/void_invoice.rb', line 17

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

.nullables ⇒ Object

An array for nullable fields



29
30
31
 
# File 'lib/advanced_billing/models/void_invoice.rb', line 29

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



24
25
26
 
# File 'lib/advanced_billing/models/void_invoice.rb', line 24

def self.optionals
  []
end