Class: SquareConnect::V1Item

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

Overview

V1Item

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1Item

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#abbreviation ⇒ Object

The text of the item’s display label in Square Register. Only up to the first five characters of the string are used.



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

def abbreviation
  @abbreviation
end

#available_for_pickup ⇒ Object

If true, the item can be added to pickup orders from the merchant’s online store. Default value: false



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

def available_for_pickup
  @available_for_pickup
end

#available_online ⇒ Object

If true, the item can be added to shipping orders from the merchant’s online store.



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

def available_online
  @available_online
end

#category ⇒ Object

The category the item belongs to, if any.



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

def category
  @category
end

#category_id ⇒ Object

The ID of the item’s category, if any.



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

def category_id
  @category_id
end

#color ⇒ Object

The color of the discount’s display label in Square Register, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values



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

def color
  @color
end

#description ⇒ Object

The item’s description.



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

def description
  @description
end

#fees ⇒ Object

The fees that apply to the item, if any.



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

def fees
  @fees
end

#id ⇒ Object

The item’s ID. Must be unique among all entity IDs ever provided on behalf of the merchant. You can never reuse an ID. This value can include alphanumeric characters, dashes (-), and underscores (_).



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

def id
  @id
end

#master_image ⇒ Object

The item’s master image, if any.



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

def master_image
  @master_image
end

#modifier_lists ⇒ Object

The modifier lists that apply to the item, if any.



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

def modifier_lists
  @modifier_lists
end

#name ⇒ Object

The item’s name.



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

def name
  @name
end

#taxable ⇒ Object

Deprecated. This field is not used.



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

def taxable
  @taxable
end

#type ⇒ Object

The item’s type. This value is NORMAL for almost all items. See [V1ItemType](#type-v1itemtype) for possible values



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

def type
  @type
end

#v2_id ⇒ Object

The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.



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

def v2_id
  @v2_id
end

#variations ⇒ Object

The item’s variations. You must specify at least one variation.



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

def variations
  @variations
end

#visibility ⇒ Object

Indicates whether the item is viewable from the merchant’s online store (PUBLIC) or PRIVATE. See [V1ItemVisibility](#type-v1itemvisibility) for possible values



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

def visibility
  @visibility
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
 
# File 'lib/square_connect/models/v1_item.rb', line 89

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'description' => :'description',
    :'type' => :'type',
    :'color' => :'color',
    :'abbreviation' => :'abbreviation',
    :'visibility' => :'visibility',
    :'available_online' => :'available_online',
    :'master_image' => :'master_image',
    :'category' => :'category',
    :'variations' => :'variations',
    :'modifier_lists' => :'modifier_lists',
    :'fees' => :'fees',
    :'taxable' => :'taxable',
    :'category_id' => :'category_id',
    :'available_for_pickup' => :'available_for_pickup',
    :'v2_id' => :'v2_id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/square_connect/models/v1_item.rb', line 112

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'type' => :'String',
    :'color' => :'String',
    :'abbreviation' => :'String',
    :'visibility' => :'String',
    :'available_online' => :'BOOLEAN',
    :'master_image' => :'V1ItemImage',
    :'category' => :'V1Category',
    :'variations' => :'Array<V1Variation>',
    :'modifier_lists' => :'Array<V1Variation>',
    :'fees' => :'Array<V1Fee>',
    :'taxable' => :'BOOLEAN',
    :'category_id' => :'String',
    :'available_for_pickup' => :'BOOLEAN',
    :'v2_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/square_connect/models/v1_item.rb', line 269

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      type == o.type &&
      color == o.color &&
      abbreviation == o.abbreviation &&
      visibility == o.visibility &&
      available_online == o.available_online &&
      master_image == o.master_image &&
      category == o.category &&
      variations == o.variations &&
      modifier_lists == o.modifier_lists &&
      fees == o.fees &&
      taxable == o.taxable &&
      category_id == o.category_id &&
      available_for_pickup == o.available_for_pickup &&
      v2_id == o.v2_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



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
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/square_connect/models/v1_item.rb', line 327

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



393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/square_connect/models/v1_item.rb', line 393

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



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

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


293
294
295
 
# File 'lib/square_connect/models/v1_item.rb', line 293

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



299
300
301
 
# File 'lib/square_connect/models/v1_item.rb', line 299

def hash
  [id, name, description, type, color, abbreviation, visibility, available_online, master_image, category, variations, modifier_lists, fees, taxable, category_id, available_for_pickup, v2_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



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

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



373
374
375
 
# File 'lib/square_connect/models/v1_item.rb', line 373

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



379
380
381
382
383
384
385
386
387
 
# File 'lib/square_connect/models/v1_item.rb', line 379

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



367
368
369
 
# File 'lib/square_connect/models/v1_item.rb', line 367

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



227
228
229
230
231
232
233
234
235
 
# File 'lib/square_connect/models/v1_item.rb', line 227

def valid?
  type_validator = EnumAttributeValidator.new('String', ["NORMAL", "GIFT_CARD", "OTHER"])
  return false unless type_validator.valid?(@type)
  color_validator = EnumAttributeValidator.new('String', ["9da2a6", "4ab200", "0b8000", "2952cc", "a82ee5", "e5457a", "b21212", "593c00", "e5BF00"])
  return false unless color_validator.valid?(@color)
  visibility_validator = EnumAttributeValidator.new('String', ["PUBLIC", "PRIVATE"])
  return false unless visibility_validator.valid?(@visibility)
  return true
end