Class: UltracartClient::OrderSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/order_summary.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
187
188
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
265
 
# File 'lib/ultracart_api/models/order_summary.rb', line 149

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::OrderSummary` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::OrderSummary`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'actual_fulfillment')
    self.actual_fulfillment = attributes[:'actual_fulfillment']
  end

  if attributes.key?(:'actual_other_cost')
    self.actual_other_cost = attributes[:'actual_other_cost']
  end

  if attributes.key?(:'actual_payment_processing')
    self.actual_payment_processing = attributes[:'actual_payment_processing']
  end

  if attributes.key?(:'actual_profit')
    self.actual_profit = attributes[:'actual_profit']
  end

  if attributes.key?(:'actual_profit_analyzed')
    self.actual_profit_analyzed = attributes[:'actual_profit_analyzed']
  end

  if attributes.key?(:'actual_profit_review')
    self.actual_profit_review = attributes[:'actual_profit_review']
  end

  if attributes.key?(:'actual_shipping')
    self.actual_shipping = attributes[:'actual_shipping']
  end

  if attributes.key?(:'arbitrary_shipping_handling_total')
    self.arbitrary_shipping_handling_total = attributes[:'arbitrary_shipping_handling_total']
  end

  if attributes.key?(:'health_benefit_card_amount')
    self.health_benefit_card_amount = attributes[:'health_benefit_card_amount']
  end

  if attributes.key?(:'health_benefit_card_refunded')
    self.health_benefit_card_refunded = attributes[:'health_benefit_card_refunded']
  end

  if attributes.key?(:'internal_gift_certificate_amount')
    self.internal_gift_certificate_amount = attributes[:'internal_gift_certificate_amount']
  end

  if attributes.key?(:'internal_gift_certificate_refunded')
    self.internal_gift_certificate_refunded = attributes[:'internal_gift_certificate_refunded']
  end

  if attributes.key?(:'other_refunded')
    self.other_refunded = attributes[:'other_refunded']
  end

  if attributes.key?(:'shipping_handling_refunded')
    self.shipping_handling_refunded = attributes[:'shipping_handling_refunded']
  end

  if attributes.key?(:'shipping_handling_total')
    self.shipping_handling_total = attributes[:'shipping_handling_total']
  end

  if attributes.key?(:'shipping_handling_total_discount')
    self.shipping_handling_total_discount = attributes[:'shipping_handling_total_discount']
  end

  if attributes.key?(:'subtotal')
    self.subtotal = attributes[:'subtotal']
  end

  if attributes.key?(:'subtotal_discount')
    self.subtotal_discount = attributes[:'subtotal_discount']
  end

  if attributes.key?(:'subtotal_discount_refunded')
    self.subtotal_discount_refunded = attributes[:'subtotal_discount_refunded']
  end

  if attributes.key?(:'subtotal_refunded')
    self.subtotal_refunded = attributes[:'subtotal_refunded']
  end

  if attributes.key?(:'tax')
    self.tax = attributes[:'tax']
  end

  if attributes.key?(:'tax_refunded')
    self.tax_refunded = attributes[:'tax_refunded']
  end

  if attributes.key?(:'taxable_subtotal')
    self.taxable_subtotal = attributes[:'taxable_subtotal']
  end

  if attributes.key?(:'taxable_subtotal_discount')
    self.taxable_subtotal_discount = attributes[:'taxable_subtotal_discount']
  end

  if attributes.key?(:'total')
    self.total = attributes[:'total']
  end

  if attributes.key?(:'total_refunded')
    self.total_refunded = attributes[:'total_refunded']
  end
end

Instance Attribute Details

#actual_fulfillment ⇒ Object

Returns the value of attribute actual_fulfillment.



18
19
20
 
# File 'lib/ultracart_api/models/order_summary.rb', line 18

def actual_fulfillment
  @actual_fulfillment
end

#actual_other_cost ⇒ Object

Returns the value of attribute actual_other_cost.



20
21
22
 
# File 'lib/ultracart_api/models/order_summary.rb', line 20

def actual_other_cost
  @actual_other_cost
end

#actual_payment_processing ⇒ Object

Returns the value of attribute actual_payment_processing.



22
23
24
 
# File 'lib/ultracart_api/models/order_summary.rb', line 22

def actual_payment_processing
  @actual_payment_processing
end

#actual_profit ⇒ Object

Returns the value of attribute actual_profit.



24
25
26
 
# File 'lib/ultracart_api/models/order_summary.rb', line 24

def actual_profit
  @actual_profit
end

#actual_profit_analyzed ⇒ Object

Actual profit has been analyzed



27
28
29
 
# File 'lib/ultracart_api/models/order_summary.rb', line 27

def actual_profit_analyzed
  @actual_profit_analyzed
end

#actual_profit_review ⇒ Object

Actual profit needs review



30
31
32
 
# File 'lib/ultracart_api/models/order_summary.rb', line 30

def actual_profit_review
  @actual_profit_review
end

#actual_shipping ⇒ Object

Returns the value of attribute actual_shipping.



32
33
34
 
# File 'lib/ultracart_api/models/order_summary.rb', line 32

def actual_shipping
  @actual_shipping
end

#arbitrary_shipping_handling_total ⇒ Object

Returns the value of attribute arbitrary_shipping_handling_total.



34
35
36
 
# File 'lib/ultracart_api/models/order_summary.rb', line 34

def arbitrary_shipping_handling_total
  @arbitrary_shipping_handling_total
end

#health_benefit_card_amount ⇒ Object

Returns the value of attribute health_benefit_card_amount.



36
37
38
 
# File 'lib/ultracart_api/models/order_summary.rb', line 36

def health_benefit_card_amount
  @health_benefit_card_amount
end

#health_benefit_card_refunded ⇒ Object

Returns the value of attribute health_benefit_card_refunded.



38
39
40
 
# File 'lib/ultracart_api/models/order_summary.rb', line 38

def health_benefit_card_refunded
  @health_benefit_card_refunded
end

#internal_gift_certificate_amount ⇒ Object

Returns the value of attribute internal_gift_certificate_amount.



40
41
42
 
# File 'lib/ultracart_api/models/order_summary.rb', line 40

def internal_gift_certificate_amount
  @internal_gift_certificate_amount
end

#internal_gift_certificate_refunded ⇒ Object

Returns the value of attribute internal_gift_certificate_refunded.



42
43
44
 
# File 'lib/ultracart_api/models/order_summary.rb', line 42

def internal_gift_certificate_refunded
  @internal_gift_certificate_refunded
end

#other_refunded ⇒ Object

Returns the value of attribute other_refunded.



44
45
46
 
# File 'lib/ultracart_api/models/order_summary.rb', line 44

def other_refunded
  @other_refunded
end

#shipping_handling_refunded ⇒ Object

Returns the value of attribute shipping_handling_refunded.



46
47
48
 
# File 'lib/ultracart_api/models/order_summary.rb', line 46

def shipping_handling_refunded
  @shipping_handling_refunded
end

#shipping_handling_total ⇒ Object

Returns the value of attribute shipping_handling_total.



48
49
50
 
# File 'lib/ultracart_api/models/order_summary.rb', line 48

def shipping_handling_total
  @shipping_handling_total
end

#shipping_handling_total_discount ⇒ Object

Returns the value of attribute shipping_handling_total_discount.



50
51
52
 
# File 'lib/ultracart_api/models/order_summary.rb', line 50

def shipping_handling_total_discount
  @shipping_handling_total_discount
end

#subtotal ⇒ Object

Returns the value of attribute subtotal.



52
53
54
 
# File 'lib/ultracart_api/models/order_summary.rb', line 52

def subtotal
  @subtotal
end

#subtotal_discount ⇒ Object

Returns the value of attribute subtotal_discount.



54
55
56
 
# File 'lib/ultracart_api/models/order_summary.rb', line 54

def subtotal_discount
  @subtotal_discount
end

#subtotal_discount_refunded ⇒ Object

Returns the value of attribute subtotal_discount_refunded.



56
57
58
 
# File 'lib/ultracart_api/models/order_summary.rb', line 56

def subtotal_discount_refunded
  @subtotal_discount_refunded
end

#subtotal_refunded ⇒ Object

Returns the value of attribute subtotal_refunded.



58
59
60
 
# File 'lib/ultracart_api/models/order_summary.rb', line 58

def subtotal_refunded
  @subtotal_refunded
end

#tax ⇒ Object

Returns the value of attribute tax.



60
61
62
 
# File 'lib/ultracart_api/models/order_summary.rb', line 60

def tax
  @tax
end

#tax_refunded ⇒ Object

Returns the value of attribute tax_refunded.



62
63
64
 
# File 'lib/ultracart_api/models/order_summary.rb', line 62

def tax_refunded
  @tax_refunded
end

#taxable_subtotal ⇒ Object

Returns the value of attribute taxable_subtotal.



64
65
66
 
# File 'lib/ultracart_api/models/order_summary.rb', line 64

def taxable_subtotal
  @taxable_subtotal
end

#taxable_subtotal_discount ⇒ Object

Returns the value of attribute taxable_subtotal_discount.



66
67
68
 
# File 'lib/ultracart_api/models/order_summary.rb', line 66

def taxable_subtotal_discount
  @taxable_subtotal_discount
end

#total ⇒ Object

Returns the value of attribute total.



68
69
70
 
# File 'lib/ultracart_api/models/order_summary.rb', line 68

def total
  @total
end

#total_refunded ⇒ Object

Returns the value of attribute total_refunded.



70
71
72
 
# File 'lib/ultracart_api/models/order_summary.rb', line 70

def total_refunded
  @total_refunded
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



105
106
107
 
# File 'lib/ultracart_api/models/order_summary.rb', line 105

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/ultracart_api/models/order_summary.rb', line 73

def self.attribute_map
  {
    :'actual_fulfillment' => :'actual_fulfillment',
    :'actual_other_cost' => :'actual_other_cost',
    :'actual_payment_processing' => :'actual_payment_processing',
    :'actual_profit' => :'actual_profit',
    :'actual_profit_analyzed' => :'actual_profit_analyzed',
    :'actual_profit_review' => :'actual_profit_review',
    :'actual_shipping' => :'actual_shipping',
    :'arbitrary_shipping_handling_total' => :'arbitrary_shipping_handling_total',
    :'health_benefit_card_amount' => :'health_benefit_card_amount',
    :'health_benefit_card_refunded' => :'health_benefit_card_refunded',
    :'internal_gift_certificate_amount' => :'internal_gift_certificate_amount',
    :'internal_gift_certificate_refunded' => :'internal_gift_certificate_refunded',
    :'other_refunded' => :'other_refunded',
    :'shipping_handling_refunded' => :'shipping_handling_refunded',
    :'shipping_handling_total' => :'shipping_handling_total',
    :'shipping_handling_total_discount' => :'shipping_handling_total_discount',
    :'subtotal' => :'subtotal',
    :'subtotal_discount' => :'subtotal_discount',
    :'subtotal_discount_refunded' => :'subtotal_discount_refunded',
    :'subtotal_refunded' => :'subtotal_refunded',
    :'tax' => :'tax',
    :'tax_refunded' => :'tax_refunded',
    :'taxable_subtotal' => :'taxable_subtotal',
    :'taxable_subtotal_discount' => :'taxable_subtotal_discount',
    :'total' => :'total',
    :'total_refunded' => :'total_refunded'
  }
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



328
329
330
 
# File 'lib/ultracart_api/models/order_summary.rb', line 328

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



142
143
144
145
 
# File 'lib/ultracart_api/models/order_summary.rb', line 142

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/ultracart_api/models/order_summary.rb', line 110

def self.openapi_types
  {
    :'actual_fulfillment' => :'Currency',
    :'actual_other_cost' => :'Currency',
    :'actual_payment_processing' => :'Currency',
    :'actual_profit' => :'Currency',
    :'actual_profit_analyzed' => :'Boolean',
    :'actual_profit_review' => :'Boolean',
    :'actual_shipping' => :'Currency',
    :'arbitrary_shipping_handling_total' => :'Currency',
    :'health_benefit_card_amount' => :'Currency',
    :'health_benefit_card_refunded' => :'Currency',
    :'internal_gift_certificate_amount' => :'Currency',
    :'internal_gift_certificate_refunded' => :'Currency',
    :'other_refunded' => :'Currency',
    :'shipping_handling_refunded' => :'Currency',
    :'shipping_handling_total' => :'Currency',
    :'shipping_handling_total_discount' => :'Currency',
    :'subtotal' => :'Currency',
    :'subtotal_discount' => :'Currency',
    :'subtotal_discount_refunded' => :'Currency',
    :'subtotal_refunded' => :'Currency',
    :'tax' => :'Currency',
    :'tax_refunded' => :'Currency',
    :'taxable_subtotal' => :'Currency',
    :'taxable_subtotal_discount' => :'Currency',
    :'total' => :'Currency',
    :'total_refunded' => :'Currency'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/ultracart_api/models/order_summary.rb', line 282

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      actual_fulfillment == o.actual_fulfillment &&
      actual_other_cost == o.actual_other_cost &&
      actual_payment_processing == o.actual_payment_processing &&
      actual_profit == o.actual_profit &&
      actual_profit_analyzed == o.actual_profit_analyzed &&
      actual_profit_review == o.actual_profit_review &&
      actual_shipping == o.actual_shipping &&
      arbitrary_shipping_handling_total == o.arbitrary_shipping_handling_total &&
      health_benefit_card_amount == o.health_benefit_card_amount &&
      health_benefit_card_refunded == o.health_benefit_card_refunded &&
      internal_gift_certificate_amount == o.internal_gift_certificate_amount &&
      internal_gift_certificate_refunded == o.internal_gift_certificate_refunded &&
      other_refunded == o.other_refunded &&
      shipping_handling_refunded == o.shipping_handling_refunded &&
      shipping_handling_total == o.shipping_handling_total &&
      shipping_handling_total_discount == o.shipping_handling_total_discount &&
      subtotal == o.subtotal &&
      subtotal_discount == o.subtotal_discount &&
      subtotal_discount_refunded == o.subtotal_discount_refunded &&
      subtotal_refunded == o.subtotal_refunded &&
      tax == o.tax &&
      tax_refunded == o.tax_refunded &&
      taxable_subtotal == o.taxable_subtotal &&
      taxable_subtotal_discount == o.taxable_subtotal_discount &&
      total == o.total &&
      total_refunded == o.total_refunded
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



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
388
389
390
391
392
393
394
395
396
 
# File 'lib/ultracart_api/models/order_summary.rb', line 359

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/ultracart_api/models/order_summary.rb', line 430

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



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/ultracart_api/models/order_summary.rb', line 335

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


315
316
317
 
# File 'lib/ultracart_api/models/order_summary.rb', line 315

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



321
322
323
 
# File 'lib/ultracart_api/models/order_summary.rb', line 321

def hash
  [actual_fulfillment, actual_other_cost, actual_payment_processing, actual_profit, actual_profit_analyzed, actual_profit_review, actual_shipping, arbitrary_shipping_handling_total, health_benefit_card_amount, health_benefit_card_refunded, internal_gift_certificate_amount, internal_gift_certificate_refunded, other_refunded, shipping_handling_refunded, shipping_handling_total, shipping_handling_total_discount, subtotal, subtotal_discount, subtotal_discount_refunded, subtotal_refunded, tax, tax_refunded, taxable_subtotal, taxable_subtotal_discount, total, total_refunded].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



269
270
271
272
 
# File 'lib/ultracart_api/models/order_summary.rb', line 269

def list_invalid_properties
  invalid_properties = Array.new
  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



406
407
408
 
# File 'lib/ultracart_api/models/order_summary.rb', line 406

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



412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/ultracart_api/models/order_summary.rb', line 412

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



400
401
402
 
# File 'lib/ultracart_api/models/order_summary.rb', line 400

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



276
277
278
 
# File 'lib/ultracart_api/models/order_summary.rb', line 276

def valid?
  true
end