Class: Noths::Financials

Inherits:
Object
  • Object
show all
Defined in:
lib/noths/models/financials.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Financials

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
135
136
137
138
139
140
141
142
143
144
145
146
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
 
# File 'lib/noths/models/financials.rb', line 105

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'commission')
    self.commission = attributes[:'commission']
  end

  if attributes.has_key?(:'delivery_commission')
    self.delivery_commission = attributes[:'delivery_commission']
  end

  if attributes.has_key?(:'items_commission')
    self.items_commission = attributes[:'items_commission']
  end

  if attributes.has_key?(:'listing_delivery')
    self.listing_delivery = attributes[:'listing_delivery']
  end

  if attributes.has_key?(:'listing_discount')
    self.listing_discount = attributes[:'listing_discount']
  end

  if attributes.has_key?(:'listing_items')
    self.listing_items = attributes[:'listing_items']
  end

  if attributes.has_key?(:'listing_subtotal')
    self.listing_subtotal = attributes[:'listing_subtotal']
  end

  if attributes.has_key?(:'listing_total')
    self.listing_total = attributes[:'listing_total']
  end

  if attributes.has_key?(:'manual_payment_total')
    self.manual_payment_total = attributes[:'manual_payment_total']
  end

  if attributes.has_key?(:'purchase_delivery')
    self.purchase_delivery = attributes[:'purchase_delivery']
  end

  if attributes.has_key?(:'purchase_discount')
    self.purchase_discount = attributes[:'purchase_discount']
  end

  if attributes.has_key?(:'purchase_items')
    self.purchase_items = attributes[:'purchase_items']
  end

  if attributes.has_key?(:'purchase_subtotal')
    self.purchase_subtotal = attributes[:'purchase_subtotal']
  end

  if attributes.has_key?(:'purchase_total')
    self.purchase_total = attributes[:'purchase_total']
  end

  if attributes.has_key?(:'partner_total')
    self.partner_total = attributes[:'partner_total']
  end

  if attributes.has_key?(:'listing_items_discounted')
    self.listing_items_discounted = attributes[:'listing_items_discounted']
  end

  if attributes.has_key?(:'listing_total_with_discount')
    self.listing_total_with_discount = attributes[:'listing_total_with_discount']
  end

  if attributes.has_key?(:'manual_payments')
    if (value = attributes[:'manual_payments']).is_a?(Array)
      self.manual_payments = value
    end
  end

end

Instance Attribute Details

#commission ⇒ Object

Returns the value of attribute commission.



18
19
20
 
# File 'lib/noths/models/financials.rb', line 18

def commission
  @commission
end

#delivery_commission ⇒ Object

Returns the value of attribute delivery_commission.



20
21
22
 
# File 'lib/noths/models/financials.rb', line 20

def delivery_commission
  @delivery_commission
end

#items_commission ⇒ Object

Returns the value of attribute items_commission.



22
23
24
 
# File 'lib/noths/models/financials.rb', line 22

def items_commission
  @items_commission
end

#listing_delivery ⇒ Object

Returns the value of attribute listing_delivery.



24
25
26
 
# File 'lib/noths/models/financials.rb', line 24

def listing_delivery
  @listing_delivery
end

#listing_discount ⇒ Object

Returns the value of attribute listing_discount.



26
27
28
 
# File 'lib/noths/models/financials.rb', line 26

def listing_discount
  @listing_discount
end

#listing_items ⇒ Object

Returns the value of attribute listing_items.



28
29
30
 
# File 'lib/noths/models/financials.rb', line 28

def listing_items
  @listing_items
end

#listing_items_discounted ⇒ Object

Returns the value of attribute listing_items_discounted.



48
49
50
 
# File 'lib/noths/models/financials.rb', line 48

def listing_items_discounted
  @listing_items_discounted
end

#listing_subtotal ⇒ Object

Returns the value of attribute listing_subtotal.



30
31
32
 
# File 'lib/noths/models/financials.rb', line 30

def listing_subtotal
  @listing_subtotal
end

#listing_total ⇒ Object

Returns the value of attribute listing_total.



32
33
34
 
# File 'lib/noths/models/financials.rb', line 32

def listing_total
  @listing_total
end

#listing_total_with_discount ⇒ Object

Returns the value of attribute listing_total_with_discount.



50
51
52
 
# File 'lib/noths/models/financials.rb', line 50

def listing_total_with_discount
  @listing_total_with_discount
end

#manual_payment_total ⇒ Object

Returns the value of attribute manual_payment_total.



34
35
36
 
# File 'lib/noths/models/financials.rb', line 34

def manual_payment_total
  @manual_payment_total
end

#manual_payments ⇒ Object

Returns the value of attribute manual_payments.



52
53
54
 
# File 'lib/noths/models/financials.rb', line 52

def manual_payments
  @manual_payments
end

#partner_total ⇒ Object

Returns the value of attribute partner_total.



46
47
48
 
# File 'lib/noths/models/financials.rb', line 46

def partner_total
  @partner_total
end

#purchase_delivery ⇒ Object

Returns the value of attribute purchase_delivery.



36
37
38
 
# File 'lib/noths/models/financials.rb', line 36

def purchase_delivery
  @purchase_delivery
end

#purchase_discount ⇒ Object

Returns the value of attribute purchase_discount.



38
39
40
 
# File 'lib/noths/models/financials.rb', line 38

def purchase_discount
  @purchase_discount
end

#purchase_items ⇒ Object

Returns the value of attribute purchase_items.



40
41
42
 
# File 'lib/noths/models/financials.rb', line 40

def purchase_items
  @purchase_items
end

#purchase_subtotal ⇒ Object

Returns the value of attribute purchase_subtotal.



42
43
44
 
# File 'lib/noths/models/financials.rb', line 42

def purchase_subtotal
  @purchase_subtotal
end

#purchase_total ⇒ Object

Returns the value of attribute purchase_total.



44
45
46
 
# File 'lib/noths/models/financials.rb', line 44

def purchase_total
  @purchase_total
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/noths/models/financials.rb', line 56

def self.attribute_map
  {
    :'commission' => :'commission',
    :'delivery_commission' => :'delivery_commission',
    :'items_commission' => :'items_commission',
    :'listing_delivery' => :'listing_delivery',
    :'listing_discount' => :'listing_discount',
    :'listing_items' => :'listing_items',
    :'listing_subtotal' => :'listing_subtotal',
    :'listing_total' => :'listing_total',
    :'manual_payment_total' => :'manual_payment_total',
    :'purchase_delivery' => :'purchase_delivery',
    :'purchase_discount' => :'purchase_discount',
    :'purchase_items' => :'purchase_items',
    :'purchase_subtotal' => :'purchase_subtotal',
    :'purchase_total' => :'purchase_total',
    :'partner_total' => :'partner_total',
    :'listing_items_discounted' => :'listing_items_discounted',
    :'listing_total_with_discount' => :'listing_total_with_discount',
    :'manual_payments' => :'manual_payments'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/noths/models/financials.rb', line 80

def self.swagger_types
  {
    :'commission' => :'FinancialsDetails',
    :'delivery_commission' => :'FinancialsDetails',
    :'items_commission' => :'FinancialsDetails',
    :'listing_delivery' => :'FinancialsDetails',
    :'listing_discount' => :'FinancialsDetails',
    :'listing_items' => :'FinancialsDetails',
    :'listing_subtotal' => :'FinancialsDetails',
    :'listing_total' => :'FinancialsDetails',
    :'manual_payment_total' => :'FinancialsDetails',
    :'purchase_delivery' => :'FinancialsDetails',
    :'purchase_discount' => :'FinancialsDetails',
    :'purchase_items' => :'FinancialsDetails',
    :'purchase_subtotal' => :'FinancialsDetails',
    :'purchase_total' => :'FinancialsDetails',
    :'partner_total' => :'FinancialsDetails',
    :'listing_items_discounted' => :'FinancialsDetails',
    :'listing_total_with_discount' => :'FinancialsDetails',
    :'manual_payments' => :'Array<ManualPayment>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/noths/models/financials.rb', line 292

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      commission == o.commission &&
      delivery_commission == o.delivery_commission &&
      items_commission == o.items_commission &&
      listing_delivery == o.listing_delivery &&
      listing_discount == o.listing_discount &&
      listing_items == o.listing_items &&
      listing_subtotal == o.listing_subtotal &&
      listing_total == o.listing_total &&
      manual_payment_total == o.manual_payment_total &&
      purchase_delivery == o.purchase_delivery &&
      purchase_discount == o.purchase_discount &&
      purchase_items == o.purchase_items &&
      purchase_subtotal == o.purchase_subtotal &&
      purchase_total == o.purchase_total &&
      partner_total == o.partner_total &&
      listing_items_discounted == o.listing_items_discounted &&
      listing_total_with_discount == o.listing_total_with_discount &&
      manual_payments == o.manual_payments
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/noths/models/financials.rb', line 351

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = Noths.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/noths/models/financials.rb', line 417

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/noths/models/financials.rb', line 330

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


317
318
319
 
# File 'lib/noths/models/financials.rb', line 317

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



323
324
325
 
# File 'lib/noths/models/financials.rb', line 323

def hash
  [commission, delivery_commission, items_commission, listing_delivery, listing_discount, listing_items, listing_subtotal, listing_total, manual_payment_total, purchase_delivery, purchase_discount, purchase_items, purchase_subtotal, purchase_total, partner_total, listing_items_discounted, listing_total_with_discount, manual_payments].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/noths/models/financials.rb', line 189

def list_invalid_properties
  invalid_properties = Array.new
  if @commission.nil?
    invalid_properties.push("invalid value for 'commission', commission cannot be nil.")
  end

  if @delivery_commission.nil?
    invalid_properties.push("invalid value for 'delivery_commission', delivery_commission cannot be nil.")
  end

  if @items_commission.nil?
    invalid_properties.push("invalid value for 'items_commission', items_commission cannot be nil.")
  end

  if @listing_delivery.nil?
    invalid_properties.push("invalid value for 'listing_delivery', listing_delivery cannot be nil.")
  end

  if @listing_discount.nil?
    invalid_properties.push("invalid value for 'listing_discount', listing_discount cannot be nil.")
  end

  if @listing_items.nil?
    invalid_properties.push("invalid value for 'listing_items', listing_items cannot be nil.")
  end

  if @listing_subtotal.nil?
    invalid_properties.push("invalid value for 'listing_subtotal', listing_subtotal cannot be nil.")
  end

  if @listing_total.nil?
    invalid_properties.push("invalid value for 'listing_total', listing_total cannot be nil.")
  end

  if @manual_payment_total.nil?
    invalid_properties.push("invalid value for 'manual_payment_total', manual_payment_total cannot be nil.")
  end

  if @purchase_delivery.nil?
    invalid_properties.push("invalid value for 'purchase_delivery', purchase_delivery cannot be nil.")
  end

  if @purchase_discount.nil?
    invalid_properties.push("invalid value for 'purchase_discount', purchase_discount cannot be nil.")
  end

  if @purchase_items.nil?
    invalid_properties.push("invalid value for 'purchase_items', purchase_items cannot be nil.")
  end

  if @purchase_subtotal.nil?
    invalid_properties.push("invalid value for 'purchase_subtotal', purchase_subtotal cannot be nil.")
  end

  if @purchase_total.nil?
    invalid_properties.push("invalid value for 'purchase_total', purchase_total cannot be nil.")
  end

  if @partner_total.nil?
    invalid_properties.push("invalid value for 'partner_total', partner_total cannot be nil.")
  end

  if @listing_items_discounted.nil?
    invalid_properties.push("invalid value for 'listing_items_discounted', listing_items_discounted cannot be nil.")
  end

  if @listing_total_with_discount.nil?
    invalid_properties.push("invalid value for 'listing_total_with_discount', listing_total_with_discount cannot be nil.")
  end

  if @manual_payments.nil?
    invalid_properties.push("invalid value for 'manual_payments', manual_payments cannot be nil.")
  end

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



397
398
399
 
# File 'lib/noths/models/financials.rb', line 397

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



403
404
405
406
407
408
409
410
411
 
# File 'lib/noths/models/financials.rb', line 403

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



391
392
393
 
# File 'lib/noths/models/financials.rb', line 391

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/noths/models/financials.rb', line 268

def valid?
  return false if @commission.nil?
  return false if @delivery_commission.nil?
  return false if @items_commission.nil?
  return false if @listing_delivery.nil?
  return false if @listing_discount.nil?
  return false if @listing_items.nil?
  return false if @listing_subtotal.nil?
  return false if @listing_total.nil?
  return false if @manual_payment_total.nil?
  return false if @purchase_delivery.nil?
  return false if @purchase_discount.nil?
  return false if @purchase_items.nil?
  return false if @purchase_subtotal.nil?
  return false if @purchase_total.nil?
  return false if @partner_total.nil?
  return false if @listing_items_discounted.nil?
  return false if @listing_total_with_discount.nil?
  return false if @manual_payments.nil?
  return true
end