Class: SquareConnect::CreateOrderRequestLineItem

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

Overview

__Deprecated__: Please use the [OrderLineItem](#type-orderlineitem) type in the order field of [CreateOrderRequest](#type-createorderrequest) instead. Represents a line item to include in an order. Each line item describes a different product to purchase, with its own quantity and price details. Line items can either reference objects from the merchant’s catalog, or can alternatively specify a name and price instead.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateOrderRequestLineItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/square_connect/models/create_order_request_line_item.rb', line 75

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

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

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

  if attributes.has_key?(:'variation_name')
    self.variation_name = attributes[:'variation_name']
  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?(:'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

end

Instance Attribute Details

#base_price_money ⇒ Object

The base price for a single unit of the line item. ‘base_price_money` is required for ad hoc line items and variable priced [CatalogItemVariation](#type-catalogitemvariation)s. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the CatalogItemVariation’s price.



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

def base_price_money
  @base_price_money
end

#catalog_object_id ⇒ Object

Only used for Catalog line items. The catalog object ID for an existing [CatalogItemVariation](#type-catalogitemvariation). Do not provide a value for this field if you provide a value for ‘name` and `base_price_money`.



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

def catalog_object_id
  @catalog_object_id
end

#discounts ⇒ Object

The discounts to include on the line item.



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

def discounts
  @discounts
end

#modifiers ⇒ Object

Only used for Catalog line items. The modifiers to include on the line item.



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

def modifiers
  @modifiers
end

#name ⇒ Object

Only used for ad hoc line items. The name of the line item. This value cannot exceed 500 characters. Do not provide a value for this field if you provide a value for ‘catalog_object_id`.



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

def name
  @name
end

#note ⇒ Object

The note of the line item. This value cannot exceed 500 characters.



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

def note
  @note
end

#quantity ⇒ Object

The quantity to purchase, as a string representation of a number. This string must have a positive integer value.



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

def quantity
  @quantity
end

#taxes ⇒ Object

The taxes to include on the line item.



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

def taxes
  @taxes
end

#variation_name ⇒ Object

Only used for ad hoc line items. The variation name of the line item. This value cannot exceed 255 characters. If this value is not set for an ad hoc line item, the default value of ‘Regular` is used. Do not provide a value for this field if you provide a value for the `catalog_object_id`.



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

def variation_name
  @variation_name
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/square_connect/models/create_order_request_line_item.rb', line 44

def self.attribute_map
  {
    :'name' => :'name',
    :'quantity' => :'quantity',
    :'base_price_money' => :'base_price_money',
    :'variation_name' => :'variation_name',
    :'note' => :'note',
    :'catalog_object_id' => :'catalog_object_id',
    :'modifiers' => :'modifiers',
    :'taxes' => :'taxes',
    :'discounts' => :'discounts'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/square_connect/models/create_order_request_line_item.rb', line 59

def self.swagger_types
  {
    :'name' => :'String',
    :'quantity' => :'String',
    :'base_price_money' => :'Money',
    :'variation_name' => :'String',
    :'note' => :'String',
    :'catalog_object_id' => :'String',
    :'modifiers' => :'Array<CreateOrderRequestModifier>',
    :'taxes' => :'Array<CreateOrderRequestTax>',
    :'discounts' => :'Array<CreateOrderRequestDiscount>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/square_connect/models/create_order_request_line_item.rb', line 237

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      quantity == o.quantity &&
      base_price_money == o.base_price_money &&
      variation_name == o.variation_name &&
      note == o.note &&
      catalog_object_id == o.catalog_object_id &&
      modifiers == o.modifiers &&
      taxes == o.taxes &&
      discounts == o.discounts
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



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
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/square_connect/models/create_order_request_line_item.rb', line 287

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



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

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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/square_connect/models/create_order_request_line_item.rb', line 266

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


253
254
255
 
# File 'lib/square_connect/models/create_order_request_line_item.rb', line 253

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



259
260
261
 
# File 'lib/square_connect/models/create_order_request_line_item.rb', line 259

def hash
  [name, quantity, base_price_money, variation_name, note, catalog_object_id, modifiers, taxes, discounts].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



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

def list_invalid_properties
  invalid_properties = Array.new
  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 > 5
    invalid_properties.push("invalid value for 'quantity', the character length must be smaller than or equal to 5.")
  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 !@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

  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

  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



333
334
335
 
# File 'lib/square_connect/models/create_order_request_line_item.rb', line 333

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



339
340
341
342
343
344
345
346
347
 
# File 'lib/square_connect/models/create_order_request_line_item.rb', line 339

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



327
328
329
 
# File 'lib/square_connect/models/create_order_request_line_item.rb', line 327

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



162
163
164
165
166
167
168
169
170
171
 
# File 'lib/square_connect/models/create_order_request_line_item.rb', line 162

def valid?
  return false if !@name.nil? && @name.to_s.length > 500
  return false if @quantity.nil?
  return false if @quantity.to_s.length > 5
  return false if @quantity.to_s.length < 1
  return false if !@variation_name.nil? && @variation_name.to_s.length > 255
  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 true
end