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

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



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

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?(:'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?(:'fulfillments')
    if (value = attributes[:'fulfillments']).is_a?(Array)
      self.fulfillments = value
    end
  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

end

Instance Attribute Details

#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.



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

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.



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

def fulfillments
  @fulfillments
end

#id ⇒ Object

The order’s unique ID. This value is only present for Order objects created by the Orders API through the [CreateOrder](#endpoint-createorder) endpoint.



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.



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

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

#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

#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.



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

def taxes
  @taxes
end

#total_discount_money ⇒ Object

The total discount amount of money to collect for the order.



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

def total_discount_money
  @total_discount_money
end

#total_money ⇒ Object

The total amount of money to collect for the order.



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

def total_money
  @total_money
end

#total_tax_money ⇒ Object

The total tax amount of money to collect for the order.



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

def total_tax_money
  @total_tax_money
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/square_connect/models/order.rb', line 47

def self.attribute_map
  {
    :'id' => :'id',
    :'location_id' => :'location_id',
    :'reference_id' => :'reference_id',
    :'line_items' => :'line_items',
    :'taxes' => :'taxes',
    :'discounts' => :'discounts',
    :'fulfillments' => :'fulfillments',
    :'total_money' => :'total_money',
    :'total_tax_money' => :'total_tax_money',
    :'total_discount_money' => :'total_discount_money'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/square_connect/models/order.rb', line 63

def self.swagger_types
  {
    :'id' => :'String',
    :'location_id' => :'String',
    :'reference_id' => :'String',
    :'line_items' => :'Array<OrderLineItem>',
    :'taxes' => :'Array<OrderLineItemTax>',
    :'discounts' => :'Array<OrderLineItemDiscount>',
    :'fulfillments' => :'Array<OrderFulfillment>',
    :'total_money' => :'Money',
    :'total_tax_money' => :'Money',
    :'total_discount_money' => :'Money'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/square_connect/models/order.rb', line 191

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 &&
      line_items == o.line_items &&
      taxes == o.taxes &&
      discounts == o.discounts &&
      fulfillments == o.fulfillments &&
      total_money == o.total_money &&
      total_tax_money == o.total_tax_money &&
      total_discount_money == o.total_discount_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



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
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/square_connect/models/order.rb', line 242

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



308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/square_connect/models/order.rb', line 308

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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/square_connect/models/order.rb', line 221

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


208
209
210
 
# File 'lib/square_connect/models/order.rb', line 208

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



214
215
216
 
# File 'lib/square_connect/models/order.rb', line 214

def hash
  [id, location_id, reference_id, line_items, taxes, discounts, fulfillments, total_money, total_tax_money, total_discount_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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/square_connect/models/order.rb', line 138

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



288
289
290
 
# File 'lib/square_connect/models/order.rb', line 288

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



294
295
296
297
298
299
300
301
302
 
# File 'lib/square_connect/models/order.rb', line 294

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



282
283
284
 
# File 'lib/square_connect/models/order.rb', line 282

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



157
158
159
160
161
162
 
# File 'lib/square_connect/models/order.rb', line 157

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