Class: OrderCloud::Order

Inherits:
Object
  • Object
show all
Defined in:
lib/order_cloud/models/order.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Order

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/order_cloud/models/order.rb', line 140

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?(:'ID')
    self.id = attributes[:'ID']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#billing_address ⇒ Object

Returns the value of attribute billing_address.



41
42
43
 
# File 'lib/order_cloud/models/order.rb', line 41

def billing_address
  @billing_address
end

#billing_address_id ⇒ Object

Returns the value of attribute billing_address_id.



39
40
41
 
# File 'lib/order_cloud/models/order.rb', line 39

def billing_address_id
  @billing_address_id
end

#comments ⇒ Object

Returns the value of attribute comments.



45
46
47
 
# File 'lib/order_cloud/models/order.rb', line 45

def comments
  @comments
end

#date_approved ⇒ Object

Returns the value of attribute date_approved.



55
56
57
 
# File 'lib/order_cloud/models/order.rb', line 55

def date_approved
  @date_approved
end

#date_canceled ⇒ Object

Returns the value of attribute date_canceled.



59
60
61
 
# File 'lib/order_cloud/models/order.rb', line 59

def date_canceled
  @date_canceled
end

#date_completed ⇒ Object

Returns the value of attribute date_completed.



61
62
63
 
# File 'lib/order_cloud/models/order.rb', line 61

def date_completed
  @date_completed
end

#date_created ⇒ Object

Returns the value of attribute date_created.



51
52
53
 
# File 'lib/order_cloud/models/order.rb', line 51

def date_created
  @date_created
end

#date_declined ⇒ Object

Returns the value of attribute date_declined.



57
58
59
 
# File 'lib/order_cloud/models/order.rb', line 57

def date_declined
  @date_declined
end

#date_submitted ⇒ Object

Returns the value of attribute date_submitted.



53
54
55
 
# File 'lib/order_cloud/models/order.rb', line 53

def date_submitted
  @date_submitted
end

#from_user_first_name ⇒ Object

Returns the value of attribute from_user_first_name.



35
36
37
 
# File 'lib/order_cloud/models/order.rb', line 35

def from_user_first_name
  @from_user_first_name
end

#from_user_id ⇒ Object

Returns the value of attribute from_user_id.



33
34
35
 
# File 'lib/order_cloud/models/order.rb', line 33

def from_user_id
  @from_user_id
end

#from_user_last_name ⇒ Object

Returns the value of attribute from_user_last_name.



37
38
39
 
# File 'lib/order_cloud/models/order.rb', line 37

def from_user_last_name
  @from_user_last_name
end

#id ⇒ Object

Returns the value of attribute id.



29
30
31
 
# File 'lib/order_cloud/models/order.rb', line 29

def id
  @id
end

#is_submitted ⇒ Object

Returns the value of attribute is_submitted.



73
74
75
 
# File 'lib/order_cloud/models/order.rb', line 73

def is_submitted
  @is_submitted
end

#line_item_count ⇒ Object

Returns the value of attribute line_item_count.



47
48
49
 
# File 'lib/order_cloud/models/order.rb', line 47

def line_item_count
  @line_item_count
end

#promotion_discount ⇒ Object

Returns the value of attribute promotion_discount.



69
70
71
 
# File 'lib/order_cloud/models/order.rb', line 69

def promotion_discount
  @promotion_discount
end

#shipping_address_id ⇒ Object

Returns the value of attribute shipping_address_id.



43
44
45
 
# File 'lib/order_cloud/models/order.rb', line 43

def shipping_address_id
  @shipping_address_id
end

#shipping_cost ⇒ Object

Returns the value of attribute shipping_cost.



65
66
67
 
# File 'lib/order_cloud/models/order.rb', line 65

def shipping_cost
  @shipping_cost
end

#status ⇒ Object

Returns the value of attribute status.



49
50
51
 
# File 'lib/order_cloud/models/order.rb', line 49

def status
  @status
end

#subtotal ⇒ Object

Returns the value of attribute subtotal.



63
64
65
 
# File 'lib/order_cloud/models/order.rb', line 63

def subtotal
  @subtotal
end

#tax_cost ⇒ Object

Returns the value of attribute tax_cost.



67
68
69
 
# File 'lib/order_cloud/models/order.rb', line 67

def tax_cost
  @tax_cost
end

#total ⇒ Object

Returns the value of attribute total.



71
72
73
 
# File 'lib/order_cloud/models/order.rb', line 71

def total
  @total
end

#type ⇒ Object

Returns the value of attribute type.



31
32
33
 
# File 'lib/order_cloud/models/order.rb', line 31

def type
  @type
end

#xp ⇒ Object

Returns the value of attribute xp.



75
76
77
 
# File 'lib/order_cloud/models/order.rb', line 75

def xp
  @xp
end

Class Method Details

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/order_cloud/models/order.rb', line 79

def self.attribute_map
  {
    :'id' => :'ID',
    :'type' => :'Type',
    :'from_user_id' => :'FromUserID',
    :'from_user_first_name' => :'FromUserFirstName',
    :'from_user_last_name' => :'FromUserLastName',
    :'billing_address_id' => :'BillingAddressID',
    :'billing_address' => :'BillingAddress',
    :'shipping_address_id' => :'ShippingAddressID',
    :'comments' => :'Comments',
    :'line_item_count' => :'LineItemCount',
    :'status' => :'Status',
    :'date_created' => :'DateCreated',
    :'date_submitted' => :'DateSubmitted',
    :'date_approved' => :'DateApproved',
    :'date_declined' => :'DateDeclined',
    :'date_canceled' => :'DateCanceled',
    :'date_completed' => :'DateCompleted',
    :'subtotal' => :'Subtotal',
    :'shipping_cost' => :'ShippingCost',
    :'tax_cost' => :'TaxCost',
    :'promotion_discount' => :'PromotionDiscount',
    :'total' => :'Total',
    :'is_submitted' => :'IsSubmitted',
    :'xp' => :'xp'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/order_cloud/models/order.rb', line 109

def self.swagger_types
  {
    :'id' => :'String',
    :'type' => :'String',
    :'from_user_id' => :'String',
    :'from_user_first_name' => :'String',
    :'from_user_last_name' => :'String',
    :'billing_address_id' => :'String',
    :'billing_address' => :'Address',
    :'shipping_address_id' => :'String',
    :'comments' => :'String',
    :'line_item_count' => :'Integer',
    :'status' => :'String',
    :'date_created' => :'String',
    :'date_submitted' => :'String',
    :'date_approved' => :'String',
    :'date_declined' => :'String',
    :'date_canceled' => :'String',
    :'date_completed' => :'String',
    :'subtotal' => :'Float',
    :'shipping_cost' => :'Float',
    :'tax_cost' => :'Float',
    :'promotion_discount' => :'Float',
    :'total' => :'Float',
    :'is_submitted' => :'BOOLEAN',
    :'xp' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/order_cloud/models/order.rb', line 259

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      type == o.type &&
      from_user_id == o.from_user_id &&
      from_user_first_name == o.from_user_first_name &&
      from_user_last_name == o.from_user_last_name &&
      billing_address_id == o.billing_address_id &&
      billing_address == o.billing_address &&
      shipping_address_id == o.shipping_address_id &&
      comments == o.comments &&
      line_item_count == o.line_item_count &&
      status == o.status &&
      date_created == o.date_created &&
      date_submitted == o.date_submitted &&
      date_approved == o.date_approved &&
      date_declined == o.date_declined &&
      date_canceled == o.date_canceled &&
      date_completed == o.date_completed &&
      subtotal == o.subtotal &&
      shipping_cost == o.shipping_cost &&
      tax_cost == o.tax_cost &&
      promotion_discount == o.promotion_discount &&
      total == o.total &&
      is_submitted == o.is_submitted &&
      xp == o.xp
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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/order_cloud/models/order.rb', line 324

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 =~ /^(true|t|yes|y|1)$/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 = OrderCloud.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



390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/order_cloud/models/order.rb', line 390

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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/order_cloud/models/order.rb', line 303

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/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


290
291
292
 
# File 'lib/order_cloud/models/order.rb', line 290

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



296
297
298
 
# File 'lib/order_cloud/models/order.rb', line 296

def hash
  [id, type, from_user_id, from_user_first_name, from_user_last_name, billing_address_id, billing_address, shipping_address_id, comments, line_item_count, status, date_created, date_submitted, date_approved, date_declined, date_canceled, date_completed, subtotal, shipping_cost, tax_cost, promotion_discount, total, is_submitted, xp].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



246
247
248
249
 
# File 'lib/order_cloud/models/order.rb', line 246

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



370
371
372
 
# File 'lib/order_cloud/models/order.rb', line 370

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



376
377
378
379
380
381
382
383
384
 
# File 'lib/order_cloud/models/order.rb', line 376

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



364
365
366
 
# File 'lib/order_cloud/models/order.rb', line 364

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



253
254
255
 
# File 'lib/order_cloud/models/order.rb', line 253

def valid?
  return true
end