Class: ShellDataReportingApIs::FeeItemSummaryAllOf0

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb

Overview

FeeItemSummaryAllOf0 Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(fee_type_group = SKIP, fee_type_id = SKIP, product_id = SKIP, product_code = SKIP, product_name = SKIP, product_group_id = SKIP, product_group_name = SKIP, total_quantity = SKIP, total_invoice_net_amount = SKIP, total_invoice_gross_amount = SKIP, total_invoice_vat_amount = SKIP, invoice_currency_code = SKIP, invoice_currency_symbol = SKIP) ⇒ FeeItemSummaryAllOf0

Returns a new instance of FeeItemSummaryAllOf0.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# File 'lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb', line 121

def initialize(fee_type_group = SKIP, fee_type_id = SKIP, product_id = SKIP,
               product_code = SKIP, product_name = SKIP,
               product_group_id = SKIP, product_group_name = SKIP,
               total_quantity = SKIP, total_invoice_net_amount = SKIP,
               total_invoice_gross_amount = SKIP,
               total_invoice_vat_amount = SKIP,
               invoice_currency_code = SKIP, invoice_currency_symbol = SKIP)
  @fee_type_group = fee_type_group unless fee_type_group == SKIP
  @fee_type_id = fee_type_id unless fee_type_id == SKIP
  @product_id = product_id unless product_id == SKIP
  @product_code = product_code unless product_code == SKIP
  @product_name = product_name unless product_name == SKIP
  @product_group_id = product_group_id unless product_group_id == SKIP
  @product_group_name = product_group_name unless product_group_name == SKIP
  @total_quantity = total_quantity unless total_quantity == SKIP
  @total_invoice_net_amount = total_invoice_net_amount unless total_invoice_net_amount == SKIP
  unless total_invoice_gross_amount == SKIP
    @total_invoice_gross_amount =
      total_invoice_gross_amount
  end
  @total_invoice_vat_amount = total_invoice_vat_amount unless total_invoice_vat_amount == SKIP
  @invoice_currency_code = invoice_currency_code unless invoice_currency_code == SKIP
  @invoice_currency_symbol = invoice_currency_symbol unless invoice_currency_symbol == SKIP
end

Instance Attribute Details

#fee_type_groupString

Fee type group in under which the Fee item is generated.

Returns:

  • (String)


14
15
16
# File 'lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb', line 14

def fee_type_group
  @fee_type_group
end

#fee_type_idString

Fee Type Id ID Description

Returns:

  • (String)


18
19
20
# File 'lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb', line 18

def fee_type_id
  @fee_type_id
end

#invoice_currency_codeString

ISO 4217 currency code of the country

Returns:

  • (String)


58
59
60
# File 'lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb', line 58

def invoice_currency_code
  @invoice_currency_code
end

#invoice_currency_symbolString

Currency symbol of the Invoice Currency Code

Returns:

  • (String)


62
63
64
# File 'lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb', line 62

def invoice_currency_symbol
  @invoice_currency_symbol
end

#product_codeString

Product Code

Returns:

  • (String)


26
27
28
# File 'lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb', line 26

def product_code
  @product_code
end

#product_group_idInteger

Product Group Id

Returns:

  • (Integer)


34
35
36
# File 'lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb', line 34

def product_group_id
  @product_group_id
end

#product_group_nameString

Product Group Name

Returns:

  • (String)


38
39
40
# File 'lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb', line 38

def product_group_name
  @product_group_name
end

#product_idInteger

Product Id

Returns:

  • (Integer)


22
23
24
# File 'lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb', line 22

def product_id
  @product_id
end

#product_nameString

Product Name

Returns:

  • (String)


30
31
32
# File 'lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb', line 30

def product_name
  @product_name
end

#total_invoice_gross_amountFloat

Total Gross amount in invoice currency

Returns:

  • (Float)


50
51
52
# File 'lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb', line 50

def total_invoice_gross_amount
  @total_invoice_gross_amount
end

#total_invoice_net_amountFloat

Total Net amount in invoice currency

Returns:

  • (Float)


46
47
48
# File 'lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb', line 46

def total_invoice_net_amount
  @total_invoice_net_amount
end

#total_invoice_vat_amountFloat

Total VAT amount in invoice currency

Returns:

  • (Float)


54
55
56
# File 'lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb', line 54

def total_invoice_vat_amount
  @total_invoice_vat_amount
end

#total_quantityFloat

Total Quantity

Returns:

  • (Float)


42
43
44
# File 'lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb', line 42

def total_quantity
  @total_quantity
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
# File 'lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb', line 147

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  fee_type_group = hash.key?('FeeTypeGroup') ? hash['FeeTypeGroup'] : SKIP
  fee_type_id = hash.key?('FeeTypeId') ? hash['FeeTypeId'] : SKIP
  product_id = hash.key?('ProductId') ? hash['ProductId'] : SKIP
  product_code = hash.key?('ProductCode') ? hash['ProductCode'] : SKIP
  product_name = hash.key?('ProductName') ? hash['ProductName'] : SKIP
  product_group_id =
    hash.key?('ProductGroupId') ? hash['ProductGroupId'] : SKIP
  product_group_name =
    hash.key?('ProductGroupName') ? hash['ProductGroupName'] : SKIP
  total_quantity = hash.key?('TotalQuantity') ? hash['TotalQuantity'] : SKIP
  total_invoice_net_amount =
    hash.key?('TotalInvoiceNetAmount') ? hash['TotalInvoiceNetAmount'] : SKIP
  total_invoice_gross_amount =
    hash.key?('TotalInvoiceGrossAmount') ? hash['TotalInvoiceGrossAmount'] : SKIP
  total_invoice_vat_amount =
    hash.key?('TotalInvoiceVATAmount') ? hash['TotalInvoiceVATAmount'] : SKIP
  invoice_currency_code =
    hash.key?('InvoiceCurrencyCode') ? hash['InvoiceCurrencyCode'] : SKIP
  invoice_currency_symbol =
    hash.key?('InvoiceCurrencySymbol') ? hash['InvoiceCurrencySymbol'] : SKIP

  # Create object from extracted values.
  FeeItemSummaryAllOf0.new(fee_type_group,
                           fee_type_id,
                           product_id,
                           product_code,
                           product_name,
                           product_group_id,
                           product_group_name,
                           total_quantity,
                           total_invoice_net_amount,
                           total_invoice_gross_amount,
                           total_invoice_vat_amount,
                           invoice_currency_code,
                           invoice_currency_symbol)
end

.namesObject

A mapping from model property names to API property names.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb', line 65

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['fee_type_group'] = 'FeeTypeGroup'
  @_hash['fee_type_id'] = 'FeeTypeId'
  @_hash['product_id'] = 'ProductId'
  @_hash['product_code'] = 'ProductCode'
  @_hash['product_name'] = 'ProductName'
  @_hash['product_group_id'] = 'ProductGroupId'
  @_hash['product_group_name'] = 'ProductGroupName'
  @_hash['total_quantity'] = 'TotalQuantity'
  @_hash['total_invoice_net_amount'] = 'TotalInvoiceNetAmount'
  @_hash['total_invoice_gross_amount'] = 'TotalInvoiceGrossAmount'
  @_hash['total_invoice_vat_amount'] = 'TotalInvoiceVATAmount'
  @_hash['invoice_currency_code'] = 'InvoiceCurrencyCode'
  @_hash['invoice_currency_symbol'] = 'InvoiceCurrencySymbol'
  @_hash
end

.nullablesObject

An array for nullable fields



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb', line 103

def self.nullables
  %w[
    fee_type_group
    fee_type_id
    product_id
    product_code
    product_name
    product_group_id
    product_group_name
    total_quantity
    total_invoice_net_amount
    total_invoice_gross_amount
    total_invoice_vat_amount
    invoice_currency_code
    invoice_currency_symbol
  ]
end

.optionalsObject

An array for optional fields



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb', line 84

def self.optionals
  %w[
    fee_type_group
    fee_type_id
    product_id
    product_code
    product_name
    product_group_id
    product_group_name
    total_quantity
    total_invoice_net_amount
    total_invoice_gross_amount
    total_invoice_vat_amount
    invoice_currency_code
    invoice_currency_symbol
  ]
end