Class: AdvancedBilling::ProformaInvoiceDiscount

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

Overview

ProformaInvoiceDiscount Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

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

Constructor Details

#initialize(uid: SKIP, title: SKIP, code: SKIP, source_type: SKIP, discount_type: SKIP, eligible_amount: SKIP, discount_amount: SKIP, line_item_breakouts: SKIP, additional_properties: {}) ⇒ ProformaInvoiceDiscount 



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/advanced_billing/models/proforma_invoice_discount.rb', line 77

def initialize(uid: SKIP, title: SKIP, code: SKIP, source_type: SKIP,
               discount_type: SKIP, eligible_amount: SKIP,
               discount_amount: SKIP, line_item_breakouts: SKIP,
               additional_properties: {})
  # Add additional model properties to the instance.

  additional_properties.each do |_name, _value|
    instance_variable_set("@#{_name}", _value)
  end

  @uid = uid unless uid == SKIP
  @title = title unless title == SKIP
  @code = code unless code == SKIP
  @source_type = source_type unless source_type == SKIP
  @discount_type = discount_type unless discount_type == SKIP
  @eligible_amount = eligible_amount unless eligible_amount == SKIP
  @discount_amount = discount_amount unless discount_amount == SKIP
  @line_item_breakouts = line_item_breakouts unless line_item_breakouts == SKIP
end

Instance Attribute Details

#code ⇒ String

TODO: Write general description for this method



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

def code
  @code
end

#discount_amount ⇒ String

TODO: Write general description for this method



38
39
40
 
# File 'lib/advanced_billing/models/proforma_invoice_discount.rb', line 38

def discount_amount
  @discount_amount
end

#discount_type ⇒ InvoiceDiscountType

TODO: Write general description for this method



30
31
32
 
# File 'lib/advanced_billing/models/proforma_invoice_discount.rb', line 30

def discount_type
  @discount_type
end

#eligible_amount ⇒ String

TODO: Write general description for this method



34
35
36
 
# File 'lib/advanced_billing/models/proforma_invoice_discount.rb', line 34

def eligible_amount
  @eligible_amount
end

#line_item_breakouts ⇒ Array[InvoiceDiscountBreakout]

TODO: Write general description for this method



42
43
44
 
# File 'lib/advanced_billing/models/proforma_invoice_discount.rb', line 42

def line_item_breakouts
  @line_item_breakouts
end

#source_type ⇒ ProformaInvoiceDiscountSourceType

TODO: Write general description for this method



26
27
28
 
# File 'lib/advanced_billing/models/proforma_invoice_discount.rb', line 26

def source_type
  @source_type
end

#title ⇒ String

TODO: Write general description for this method



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

def title
  @title
end

#uid ⇒ String

TODO: Write general description for this method



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

def uid
  @uid
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/advanced_billing/models/proforma_invoice_discount.rb', line 97

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  uid = hash.key?('uid') ? hash['uid'] : SKIP
  title = hash.key?('title') ? hash['title'] : SKIP
  code = hash.key?('code') ? hash['code'] : SKIP
  source_type = hash.key?('source_type') ? hash['source_type'] : SKIP
  discount_type = hash.key?('discount_type') ? hash['discount_type'] : SKIP
  eligible_amount =
    hash.key?('eligible_amount') ? hash['eligible_amount'] : SKIP
  discount_amount =
    hash.key?('discount_amount') ? hash['discount_amount'] : SKIP
  # Parameter is an array, so we need to iterate through it

  line_item_breakouts = nil
  unless hash['line_item_breakouts'].nil?
    line_item_breakouts = []
    hash['line_item_breakouts'].each do |structure|
      line_item_breakouts << (InvoiceDiscountBreakout.from_hash(structure) if structure)
    end
  end

  line_item_breakouts = SKIP unless hash.key?('line_item_breakouts')

  # Clean out expected properties from Hash.

  additional_properties = hash.reject { |k, _| names.value?(k) }

  # Create object from extracted values.

  ProformaInvoiceDiscount.new(uid: uid,
                              title: title,
                              code: code,
                              source_type: source_type,
                              discount_type: discount_type,
                              eligible_amount: eligible_amount,
                              discount_amount: discount_amount,
                              line_item_breakouts: line_item_breakouts,
                              additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['uid'] = 'uid'
  @_hash['title'] = 'title'
  @_hash['code'] = 'code'
  @_hash['source_type'] = 'source_type'
  @_hash['discount_type'] = 'discount_type'
  @_hash['eligible_amount'] = 'eligible_amount'
  @_hash['discount_amount'] = 'discount_amount'
  @_hash['line_item_breakouts'] = 'line_item_breakouts'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



73
74
75
 
# File 'lib/advanced_billing/models/proforma_invoice_discount.rb', line 73

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    uid
    title
    code
    source_type
    discount_type
    eligible_amount
    discount_amount
    line_item_breakouts
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



146
147
148
149
150
151
152
153
 
# File 'lib/advanced_billing/models/proforma_invoice_discount.rb', line 146

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} uid: #{@uid.inspect}, title: #{@title.inspect}, code: #{@code.inspect},"\
  " source_type: #{@source_type.inspect}, discount_type: #{@discount_type.inspect},"\
  " eligible_amount: #{@eligible_amount.inspect}, discount_amount:"\
  " #{@discount_amount.inspect}, line_item_breakouts: #{@line_item_breakouts.inspect},"\
  " additional_properties: #{get_additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



137
138
139
140
141
142
143
 
# File 'lib/advanced_billing/models/proforma_invoice_discount.rb', line 137

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} uid: #{@uid}, title: #{@title}, code: #{@code}, source_type:"\
  " #{@source_type}, discount_type: #{@discount_type}, eligible_amount: #{@eligible_amount},"\
  " discount_amount: #{@discount_amount}, line_item_breakouts: #{@line_item_breakouts},"\
  " additional_properties: #{get_additional_properties}>"
end