Class: AdvancedBilling::IssueServiceCredit

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

Overview

IssueServiceCredit 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: SKIP, additional_properties: {}) ⇒ IssueServiceCredit

Returns a new instance of IssueServiceCredit.



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

def initialize(amount:, memo: SKIP, additional_properties: {})
  @amount = amount
  @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 ⇒ Object

TODO: Write general description for this method

Returns:

  • (Object) 


14
15
16
 
# File 'lib/advanced_billing/models/issue_service_credit.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/issue_service_credit.rb', line 18

def memo
  @memo
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
66
67
 
# File 'lib/advanced_billing/models/issue_service_credit.rb', line 51

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  amount = hash.key?('amount') ? APIHelper.deserialize_union_type(
    UnionTypeLookUp.get(:IssueServiceCreditAmount), hash['amount']
  ) : nil
  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.
  IssueServiceCredit.new(amount: amount,
                         memo: memo,
                         additional_properties: hash)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/advanced_billing/models/issue_service_credit.rb', line 21

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

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    memo
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/advanced_billing/models/issue_service_credit.rb', line 71

def self.validate(value)
  if value.instance_of? self
    return UnionTypeLookUp.get(:IssueServiceCreditAmount)
                          .validate(value.amount)
  end

  return false unless value.instance_of? Hash

  UnionTypeLookUp.get(:IssueServiceCreditAmount)
                 .validate(value['amount'])
end