Class: SquareConnect::OrderLineItem

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

Overview

Represents a line item in an order. Each line item describes a different product to purchase, with its own quantity and price details.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderLineItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
186
 
# File 'lib/square_connect/models/order_line_item.rb', line 110

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'gross_sales_money')
    self.gross_sales_money = attributes[:'gross_sales_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_money')
    self.total_money = attributes[:'total_money']
  end

end

Instance Attribute Details

#base_price_money ⇒ Object

The base price for a single unit of the line item.



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

def base_price_money
  @base_price_money
end

#catalog_object_id ⇒ Object

The [CatalogItemVariation](#type-catalogitemvariation) id applied to this line item.



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

def catalog_object_id
  @catalog_object_id
end

#discounts ⇒ Object

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



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

def discounts
  @discounts
end

#gross_sales_money ⇒ Object

The amount of money made in gross sales for this line item. Calculated as the sum of the variation’s total price and each modifier’s total price. This field is read-only.



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

def gross_sales_money
  @gross_sales_money
end

#modifiers ⇒ Object

The [CatalogModifier](#type-catalogmodifier)s applied to this line item.



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

def modifiers
  @modifiers
end

#name ⇒ Object

The name of the line item.



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

def name
  @name
end

#note ⇒ Object

The note of the line item.



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

def note
  @note
end

#quantity ⇒ Object

The quantity purchased, formatted as a decimal number. For example: ‘"3"`. Line items with a `quantity_unit` can have non-integer quantities. For example: `"1.70000"`.



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

def quantity
  @quantity
end

#quantity_unit ⇒ Object

The unit and precision that this line item’s quantity is measured in.



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

def quantity_unit
  @quantity_unit
end

#taxes ⇒ Object

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



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

def taxes
  @taxes
end

#total_discount_money ⇒ Object

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



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

def total_discount_money
  @total_discount_money
end

#total_money ⇒ Object

The total amount of money to collect for this line item. This field is read-only.



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

def total_money
  @total_money
end

#total_tax_money ⇒ Object

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



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

def total_tax_money
  @total_tax_money
end

#uid ⇒ Object

Unique ID that identifies the line item only within this order. This field is read-only.



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

def uid
  @uid
end

#variation_name ⇒ Object

The name of the variation applied to this line item.



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

def variation_name
  @variation_name
end

#variation_total_price_money ⇒ Object

The total price of all item variations sold in this line item. Calculated as ‘base_price_money` multiplied by `quantity`. Does not include modifiers.



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

def variation_total_price_money
  @variation_total_price_money
end

Class Method Details

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/square_connect/models/order_line_item.rb', line 65

def self.attribute_map
  {
    :'uid' => :'uid',
    :'name' => :'name',
    :'quantity' => :'quantity',
    :'quantity_unit' => :'quantity_unit',
    :'note' => :'note',
    :'catalog_object_id' => :'catalog_object_id',
    :'variation_name' => :'variation_name',
    :'modifiers' => :'modifiers',
    :'taxes' => :'taxes',
    :'discounts' => :'discounts',
    :'base_price_money' => :'base_price_money',
    :'variation_total_price_money' => :'variation_total_price_money',
    :'gross_sales_money' => :'gross_sales_money',
    :'total_tax_money' => :'total_tax_money',
    :'total_discount_money' => :'total_discount_money',
    :'total_money' => :'total_money'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/square_connect/models/order_line_item.rb', line 87

def self.swagger_types
  {
    :'uid' => :'String',
    :'name' => :'String',
    :'quantity' => :'String',
    :'quantity_unit' => :'OrderQuantityUnit',
    :'note' => :'String',
    :'catalog_object_id' => :'String',
    :'variation_name' => :'String',
    :'modifiers' => :'Array<OrderLineItemModifier>',
    :'taxes' => :'Array<OrderLineItemTax>',
    :'discounts' => :'Array<OrderLineItemDiscount>',
    :'base_price_money' => :'Money',
    :'variation_total_price_money' => :'Money',
    :'gross_sales_money' => :'Money',
    :'total_tax_money' => :'Money',
    :'total_discount_money' => :'Money',
    :'total_money' => :'Money'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/square_connect/models/order_line_item.rb', line 316

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      uid == o.uid &&
      name == o.name &&
      quantity == o.quantity &&
      quantity_unit == o.quantity_unit &&
      note == o.note &&
      catalog_object_id == o.catalog_object_id &&
      variation_name == o.variation_name &&
      modifiers == o.modifiers &&
      taxes == o.taxes &&
      discounts == o.discounts &&
      base_price_money == o.base_price_money &&
      variation_total_price_money == o.variation_total_price_money &&
      gross_sales_money == o.gross_sales_money &&
      total_tax_money == o.total_tax_money &&
      total_discount_money == o.total_discount_money &&
      total_money == o.total_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



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/square_connect/models/order_line_item.rb', line 373

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



439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/square_connect/models/order_line_item.rb', line 439

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



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/square_connect/models/order_line_item.rb', line 352

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


339
340
341
 
# File 'lib/square_connect/models/order_line_item.rb', line 339

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



345
346
347
 
# File 'lib/square_connect/models/order_line_item.rb', line 345

def hash
  [uid, name, quantity, quantity_unit, note, catalog_object_id, variation_name, modifiers, taxes, discounts, base_price_money, variation_total_price_money, gross_sales_money, total_tax_money, total_discount_money, total_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



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

def list_invalid_properties
  invalid_properties = Array.new
  if !@uid.nil? && @uid.to_s.length > 60
    invalid_properties.push("invalid value for 'uid', the character length must be smaller than or equal to 60.")
  end

  if !@name.nil? && @name.to_s.length > 500
    invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 500.")
  end

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

  if @quantity.to_s.length > 12
    invalid_properties.push("invalid value for 'quantity', the character length must be smaller than or equal to 12.")
  end

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

  if !@note.nil? && @note.to_s.length > 500
    invalid_properties.push("invalid value for 'note', the character length must be smaller than or equal to 500.")
  end

  if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192
    invalid_properties.push("invalid value for 'catalog_object_id', the character length must be smaller than or equal to 192.")
  end

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



419
420
421
 
# File 'lib/square_connect/models/order_line_item.rb', line 419

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



425
426
427
428
429
430
431
432
433
 
# File 'lib/square_connect/models/order_line_item.rb', line 425

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



413
414
415
 
# File 'lib/square_connect/models/order_line_item.rb', line 413

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



229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/square_connect/models/order_line_item.rb', line 229

def valid?
  return false if !@uid.nil? && @uid.to_s.length > 60
  return false if !@name.nil? && @name.to_s.length > 500
  return false if @quantity.nil?
  return false if @quantity.to_s.length > 12
  return false if @quantity.to_s.length < 1
  return false if !@note.nil? && @note.to_s.length > 500
  return false if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192
  return false if !@variation_name.nil? && @variation_name.to_s.length > 255
  return true
end