Class: SquareConnect::Order

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

Overview

Contains all information related to a single order to process with Square, including line items that specify the products to purchase. Order objects also include information on any associated tenders, refunds, and returns. All Connect V2 Transactions have all been converted to Orders including all associated itemization data.

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



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
266
267
268
 
# File 'lib/square_connect/models/order.rb', line 150

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#closed_at ⇒ Object

Timestamp for when the order was closed. In RFC 3339 format, e.g., "2016-09-04T23:59:33.123Z". This field is read-only.



70
71
72
 
# File 'lib/square_connect/models/order.rb', line 70

def closed_at
  @closed_at
end

#created_at ⇒ Object

Timestamp for when the order was created. In RFC 3339 format, e.g., "2016-09-04T23:59:33.123Z". This field is read-only.



64
65
66
 
# File 'lib/square_connect/models/order.rb', line 64

def created_at
  @created_at
end

#customer_id ⇒ Object

The [Customer](#type-customer) ID of the customer associated with the order.



28
29
30
 
# File 'lib/square_connect/models/order.rb', line 28

def customer_id
  @customer_id
end

#discounts ⇒ Object

A list of discounts applied to this order. On read or retrieve, this list includes both order-level and item-level discounts. When creating an Order, set your order-level discounts in this list.



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

def discounts
  @discounts
end

#fulfillments ⇒ Object

Details on order fulfillment. Orders can only be created with at most one fulfillment. However, orders returned by the API may contain multiple fulfillments.



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

def fulfillments
  @fulfillments
end

#id ⇒ Object

The order’s unique ID. This field is read-only.



16
17
18
 
# File 'lib/square_connect/models/order.rb', line 16

def id
  @id
end

#line_items ⇒ Object

The line items included in the order.



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

def line_items
  @line_items
end

#location_id ⇒ Object

The ID of the merchant location this order is associated with.



19
20
21
 
# File 'lib/square_connect/models/order.rb', line 19

def location_id
  @location_id
end

#net_amounts ⇒ Object

Net money amounts (sale money - return money). This field is read-only.



52
53
54
 
# File 'lib/square_connect/models/order.rb', line 52

def net_amounts
  @net_amounts
end

#reference_id ⇒ Object

A client specified identifier to associate an entity in another system with this order.



22
23
24
 
# File 'lib/square_connect/models/order.rb', line 22

def reference_id
  @reference_id
end

#refunds ⇒ Object

The Refunds that are part of this Order. This field is read-only.



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

def refunds
  @refunds
end

#return_amounts ⇒ Object

Rollup of returned money amounts. This field is read-only.



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

def return_amounts
  @return_amounts
end

#returns ⇒ Object

Collection of items from sale Orders being returned in this one. Normally part of an Itemized Return or Exchange. There will be exactly one ‘Return` object per sale Order being referenced. This field is read-only.



46
47
48
 
# File 'lib/square_connect/models/order.rb', line 46

def returns
  @returns
end

#rounding_adjustment ⇒ Object

A positive or negative rounding adjustment to the total of the order, commonly used to apply Cash Rounding when the minimum unit of account is smaller than the lowest physical denomination of currency. This field is read-only.



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

def rounding_adjustment
  @rounding_adjustment
end

#service_charges ⇒ Object

A list of service charges applied to the order.



40
41
42
 
# File 'lib/square_connect/models/order.rb', line 40

def service_charges
  @service_charges
end

#source ⇒ Object

The origination details of the order.



25
26
27
 
# File 'lib/square_connect/models/order.rb', line 25

def source
  @source
end

#state ⇒ Object

The current state of the order. ‘OPEN`,`COMPLETED`,`CANCELED` See [OrderState](#type-orderstate) for possible values



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

def state
  @state
end

#taxes ⇒ Object

A list of taxes applied to this order. On read or retrieve, this list includes both order-level and item-level taxes. When creating an Order, set your order-level taxes in this list.



34
35
36
 
# File 'lib/square_connect/models/order.rb', line 34

def taxes
  @taxes
end

#tenders ⇒ Object

The Tenders which were used to pay for the Order. This field is read-only.



58
59
60
 
# File 'lib/square_connect/models/order.rb', line 58

def tenders
  @tenders
end

#total_discount_money ⇒ Object

The total discount amount of money to collect for the order. This field is read-only.



82
83
84
 
# File 'lib/square_connect/models/order.rb', line 82

def total_discount_money
  @total_discount_money
end

#total_money ⇒ Object

The total amount of money to collect for the order. This field is read-only.



76
77
78
 
# File 'lib/square_connect/models/order.rb', line 76

def total_money
  @total_money
end

#total_service_charge_money ⇒ Object

The total amount of money collected in service charges for the order. Note: ‘total_service_charge_money` is the sum of `applied_money` fields for each individual service charge. Therefore, `total_service_charge_money` will only include inclusive tax amounts, not additive tax amounts. This field is read-only.



85
86
87
 
# File 'lib/square_connect/models/order.rb', line 85

def total_service_charge_money
  @total_service_charge_money
end

#total_tax_money ⇒ Object

The total tax amount of money to collect for the order. This field is read-only.



79
80
81
 
# File 'lib/square_connect/models/order.rb', line 79

def total_tax_money
  @total_tax_money
end

#updated_at ⇒ Object

Timestamp for when the order was last updated. In RFC 3339 format, e.g., "2016-09-04T23:59:33.123Z". This field is read-only.



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

def updated_at
  @updated_at
end

Class Method Details

.attribute_map ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/square_connect/models/order.rb', line 89

def self.attribute_map
  {
    :'id' => :'id',
    :'location_id' => :'location_id',
    :'reference_id' => :'reference_id',
    :'source' => :'source',
    :'customer_id' => :'customer_id',
    :'line_items' => :'line_items',
    :'taxes' => :'taxes',
    :'discounts' => :'discounts',
    :'service_charges' => :'service_charges',
    :'fulfillments' => :'fulfillments',
    :'returns' => :'returns',
    :'return_amounts' => :'return_amounts',
    :'net_amounts' => :'net_amounts',
    :'rounding_adjustment' => :'rounding_adjustment',
    :'tenders' => :'tenders',
    :'refunds' => :'refunds',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'closed_at' => :'closed_at',
    :'state' => :'state',
    :'total_money' => :'total_money',
    :'total_tax_money' => :'total_tax_money',
    :'total_discount_money' => :'total_discount_money',
    :'total_service_charge_money' => :'total_service_charge_money'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'String',
    :'location_id' => :'String',
    :'reference_id' => :'String',
    :'source' => :'OrderSource',
    :'customer_id' => :'String',
    :'line_items' => :'Array<OrderLineItem>',
    :'taxes' => :'Array<OrderLineItemTax>',
    :'discounts' => :'Array<OrderLineItemDiscount>',
    :'service_charges' => :'Array<OrderServiceCharge>',
    :'fulfillments' => :'Array<OrderFulfillment>',
    :'returns' => :'Array<OrderReturn>',
    :'return_amounts' => :'OrderMoneyAmounts',
    :'net_amounts' => :'OrderMoneyAmounts',
    :'rounding_adjustment' => :'OrderRoundingAdjustment',
    :'tenders' => :'Array<Tender>',
    :'refunds' => :'Array<Refund>',
    :'created_at' => :'String',
    :'updated_at' => :'String',
    :'closed_at' => :'String',
    :'state' => :'String',
    :'total_money' => :'Money',
    :'total_tax_money' => :'Money',
    :'total_discount_money' => :'Money',
    :'total_service_charge_money' => :'Money'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      location_id == o.location_id &&
      reference_id == o.reference_id &&
      source == o.source &&
      customer_id == o.customer_id &&
      line_items == o.line_items &&
      taxes == o.taxes &&
      discounts == o.discounts &&
      service_charges == o.service_charges &&
      fulfillments == o.fulfillments &&
      returns == o.returns &&
      return_amounts == o.return_amounts &&
      net_amounts == o.net_amounts &&
      rounding_adjustment == o.rounding_adjustment &&
      tenders == o.tenders &&
      refunds == o.refunds &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      closed_at == o.closed_at &&
      state == o.state &&
      total_money == o.total_money &&
      total_tax_money == o.total_tax_money &&
      total_discount_money == o.total_discount_money &&
      total_service_charge_money == o.total_service_charge_money
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



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/square_connect/models/order.rb', line 390

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 = SquareConnect.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



456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/square_connect/models/order.rb', line 456

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



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/square_connect/models/order.rb', line 369

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


356
357
358
 
# File 'lib/square_connect/models/order.rb', line 356

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



362
363
364
 
# File 'lib/square_connect/models/order.rb', line 362

def hash
  [id, location_id, reference_id, source, customer_id, line_items, taxes, discounts, service_charges, fulfillments, returns, return_amounts, net_amounts, rounding_adjustment, tenders, refunds, created_at, updated_at, closed_at, state, total_money, total_tax_money, total_discount_money, total_service_charge_money].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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/square_connect/models/order.rb', line 272

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

  if @location_id.to_s.length < 1
    invalid_properties.push("invalid value for 'location_id', the character length must be great than or equal to 1.")
  end

  if !@reference_id.nil? && @reference_id.to_s.length > 40
    invalid_properties.push("invalid value for 'reference_id', the character length must be smaller than or equal to 40.")
  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



436
437
438
 
# File 'lib/square_connect/models/order.rb', line 436

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



442
443
444
445
446
447
448
449
450
 
# File 'lib/square_connect/models/order.rb', line 442

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



430
431
432
 
# File 'lib/square_connect/models/order.rb', line 430

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



291
292
293
294
295
296
 
# File 'lib/square_connect/models/order.rb', line 291

def valid?
  return false if @location_id.nil?
  return false if @location_id.to_s.length < 1
  return false if !@reference_id.nil? && @reference_id.to_s.length > 40
  return true
end