Class: SquareConnect::CatalogItemVariation

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

Overview

An item variation (i.e., product) in the Catalog object model. Each item may have a maximum of 250 item variations.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CatalogItemVariation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#inventory_alert_threshold ⇒ Object

If the inventory quantity for the variation is less than or equal to this value and ‘inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard. This value is always an integer.



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

def inventory_alert_threshold
  @inventory_alert_threshold
end

#inventory_alert_type ⇒ Object

Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its ‘inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for possible values



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

def inventory_alert_type
  @inventory_alert_type
end

#item_id ⇒ Object

The ID of the [CatalogItem](#type-catalogitem) associated with this item variation. Searchable.



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

def item_id
  @item_id
end

#item_option_values ⇒ Object

List of item option values associated with this item variation. Listed in the same order as the item options of the parent item.



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

def item_option_values
  @item_option_values
end

#location_overrides ⇒ Object

Per-(#type-location) price and inventory overrides.



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

def location_overrides
  @location_overrides
end

#measurement_unit_id ⇒ Object

ID of the ‘CatalogMeasurementUnit’ that is used to measure the quantity sold of this item variation. If left unset, the item will be sold in whole quantities.



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

def measurement_unit_id
  @measurement_unit_id
end

#name ⇒ Object

The item variation’s name. Searchable. This field has max length of 255 Unicode code points.



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

def name
  @name
end

#ordinal ⇒ Object

The order in which this item variation should be displayed. This value is read-only. On writes, the ordinal for each item variation within a parent [CatalogItem](#type-catalogitem) is set according to the item variations’s position. On reads, the value is not guaranteed to be sequential or unique.



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

def ordinal
  @ordinal
end

#price_money ⇒ Object

The item variation’s price, if fixed pricing is used.



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

def price_money
  @price_money
end

#pricing_type ⇒ Object

Indicates whether the item variation’s price is fixed or determined at the time of sale. See [CatalogPricingType](#type-catalogpricingtype) for possible values



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

def pricing_type
  @pricing_type
end

#service_duration ⇒ Object

If the [CatalogItem](#type-catalogitem) that owns this item variation is of type ‘APPOINTMENTS_SERVICE`, then this is the duration of the service in milliseconds. For example, a 30 minute appointment would have the value `1800000`, which is equal to 30 (minutes) * 60 (seconds per minute) * 1000 (milliseconds per second).



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

def service_duration
  @service_duration
end

#sku ⇒ Object

The item variation’s SKU, if any. Searchable.



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

def sku
  @sku
end

#track_inventory ⇒ Object

If ‘true`, inventory tracking is active for the variation.



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

def track_inventory
  @track_inventory
end

#upc ⇒ Object

The item variation’s UPC, if any. Searchable in the Connect API. This field is only exposed in the Connect API. It is not exposed in Square’s Dashboard, Square Point of Sale app or Retail Point of Sale app.



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

def upc
  @upc
end

#user_data ⇒ Object

Arbitrary user metadata to associate with the item variation. Cannot exceed 255 characters. Searchable.



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

def user_data
  @user_data
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/square_connect/models/catalog_item_variation.rb', line 62

def self.attribute_map
  {
    :'item_id' => :'item_id',
    :'name' => :'name',
    :'sku' => :'sku',
    :'upc' => :'upc',
    :'ordinal' => :'ordinal',
    :'pricing_type' => :'pricing_type',
    :'price_money' => :'price_money',
    :'location_overrides' => :'location_overrides',
    :'track_inventory' => :'track_inventory',
    :'inventory_alert_type' => :'inventory_alert_type',
    :'inventory_alert_threshold' => :'inventory_alert_threshold',
    :'user_data' => :'user_data',
    :'service_duration' => :'service_duration',
    :'item_option_values' => :'item_option_values',
    :'measurement_unit_id' => :'measurement_unit_id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/square_connect/models/catalog_item_variation.rb', line 83

def self.swagger_types
  {
    :'item_id' => :'String',
    :'name' => :'String',
    :'sku' => :'String',
    :'upc' => :'String',
    :'ordinal' => :'Integer',
    :'pricing_type' => :'String',
    :'price_money' => :'Money',
    :'location_overrides' => :'Array<ItemVariationLocationOverrides>',
    :'track_inventory' => :'BOOLEAN',
    :'inventory_alert_type' => :'String',
    :'inventory_alert_threshold' => :'Integer',
    :'user_data' => :'String',
    :'service_duration' => :'Integer',
    :'item_option_values' => :'Array<CatalogItemOptionValueForItemVariation>',
    :'measurement_unit_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/square_connect/models/catalog_item_variation.rb', line 192

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      item_id == o.item_id &&
      name == o.name &&
      sku == o.sku &&
      upc == o.upc &&
      ordinal == o.ordinal &&
      pricing_type == o.pricing_type &&
      price_money == o.price_money &&
      location_overrides == o.location_overrides &&
      track_inventory == o.track_inventory &&
      inventory_alert_type == o.inventory_alert_type &&
      inventory_alert_threshold == o.inventory_alert_threshold &&
      user_data == o.user_data &&
      service_duration == o.service_duration &&
      item_option_values == o.item_option_values &&
      measurement_unit_id == o.measurement_unit_id
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



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
279
280
281
282
283
284
 
# File 'lib/square_connect/models/catalog_item_variation.rb', line 248

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



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/square_connect/models/catalog_item_variation.rb', line 314

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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/square_connect/models/catalog_item_variation.rb', line 227

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



220
221
222
 
# File 'lib/square_connect/models/catalog_item_variation.rb', line 220

def hash
  [item_id, name, sku, upc, ordinal, pricing_type, price_money, location_overrides, track_inventory, inventory_alert_type, inventory_alert_threshold, user_data, service_duration, item_option_values, measurement_unit_id].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



179
180
181
182
 
# File 'lib/square_connect/models/catalog_item_variation.rb', line 179

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



294
295
296
 
# File 'lib/square_connect/models/catalog_item_variation.rb', line 294

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



300
301
302
303
304
305
306
307
308
 
# File 'lib/square_connect/models/catalog_item_variation.rb', line 300

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



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

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



186
187
188
 
# File 'lib/square_connect/models/catalog_item_variation.rb', line 186

def valid?
  return true
end