Class: AdvancedBilling::InvoiceDiscountBreakout

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

Overview

InvoiceDiscountBreakout Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(uid: SKIP, eligible_amount: SKIP, discount_amount: SKIP, additional_properties: {}) ⇒ InvoiceDiscountBreakout

Returns a new instance of InvoiceDiscountBreakout.



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/advanced_billing/models/invoice_discount_breakout.rb', line 47

def initialize(uid: SKIP, eligible_amount: SKIP, discount_amount: SKIP,
               additional_properties: {})
  @uid = uid unless uid == SKIP
  @eligible_amount = eligible_amount unless eligible_amount == SKIP
  @discount_amount = discount_amount unless discount_amount == SKIP

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

Instance Attribute Details

#discount_amount ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def discount_amount
  @discount_amount
end

#eligible_amount ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def eligible_amount
  @eligible_amount
end

#uid ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def uid
  @uid
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/advanced_billing/models/invoice_discount_breakout.rb', line 60

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  uid = hash.key?('uid') ? hash['uid'] : SKIP
  eligible_amount =
    hash.key?('eligible_amount') ? hash['eligible_amount'] : SKIP
  discount_amount =
    hash.key?('discount_amount') ? hash['discount_amount'] : SKIP

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

  # Create object from extracted values.
  InvoiceDiscountBreakout.new(uid: uid,
                              eligible_amount: eligible_amount,
                              discount_amount: discount_amount,
                              additional_properties: hash)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/advanced_billing/models/invoice_discount_breakout.rb', line 25

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

.nullables ⇒ Object

An array for nullable fields



43
44
45
 
# File 'lib/advanced_billing/models/invoice_discount_breakout.rb', line 43

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    uid
    eligible_amount
    discount_amount
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



82
83
84
85
86
87
88
 
# File 'lib/advanced_billing/models/invoice_discount_breakout.rb', line 82

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

  return false unless value.instance_of? Hash

  true
end