Class: AdvancedBilling::RefundInvoiceRequest

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

Overview

RefundInvoiceRequest Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(refund:, additional_properties: {}) ⇒ RefundInvoiceRequest

Returns a new instance of RefundInvoiceRequest.



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

def initialize(refund:, additional_properties: {})
  @refund = refund

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

Instance Attribute Details

#refundObject

TODO: Write general description for this method

Returns:

  • (Object)


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

def refund
  @refund
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
56
57
# File 'lib/advanced_billing/models/refund_invoice_request.rb', line 43

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  refund = hash.key?('refund') ? APIHelper.deserialize_union_type(
    UnionTypeLookUp.get(:RefundInvoiceRequestRefund), hash['refund']
  ) : nil

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

  # Create object from extracted values.
  RefundInvoiceRequest.new(refund: refund,
                           additional_properties: hash)
end

.namesObject

A mapping from model property names to API property names.



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

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

.nullablesObject

An array for nullable fields



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

def self.nullables
  []
end

.optionalsObject

An array for optional fields



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

def self.optionals
  []
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



61
62
63
64
65
66
67
68
69
70
71
# File 'lib/advanced_billing/models/refund_invoice_request.rb', line 61

def self.validate(value)
  if value.instance_of? self
    return UnionTypeLookUp.get(:RefundInvoiceRequestRefund)
                          .validate(value.refund)
  end

  return false unless value.instance_of? Hash

  UnionTypeLookUp.get(:RefundInvoiceRequestRefund)
                 .validate(value['refund'])
end