Class: SquareConnect::V1Variation

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

Overview

V1Variation

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1Variation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/square_connect/models/v1_variation.rb', line 90

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

end

Instance Attribute Details

#id ⇒ Object

The item variation’s unique ID.



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

def id
  @id
end

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



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

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 [V1VariationInventoryAlertType](#type-v1variationinventoryalerttype) for possible values



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

def inventory_alert_type
  @inventory_alert_type
end

#item_id ⇒ Object

The ID of the variation’s associated item.



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

def item_id
  @item_id
end

#name ⇒ Object

The item variation’s name.



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

def name
  @name
end

#ordinal ⇒ Object

Indicates the variation’s list position when displayed in Square Register and the merchant dashboard. If more than one variation for the same item has the same ordinal value, those variations are displayed in alphabetical order



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

def ordinal
  @ordinal
end

#price_money ⇒ Object

The item variation’s price, if any.



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

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 [V1VariationPricingType](#type-v1variationpricingtype) for possible values



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

def pricing_type
  @pricing_type
end

#sku ⇒ Object

The item variation’s SKU, if any.



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

def sku
  @sku
end

#track_inventory ⇒ Object

If true, inventory tracking is active for the variation.



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

def track_inventory
  @track_inventory
end

#user_data ⇒ Object

Arbitrary metadata associated with the variation. Cannot exceed 255 characters.



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

def user_data
  @user_data
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.



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

def v2_id
  @v2_id
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/square_connect/models/v1_variation.rb', line 53

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'item_id' => :'item_id',
    :'ordinal' => :'ordinal',
    :'pricing_type' => :'pricing_type',
    :'price_money' => :'price_money',
    :'sku' => :'sku',
    :'track_inventory' => :'track_inventory',
    :'inventory_alert_type' => :'inventory_alert_type',
    :'inventory_alert_threshold' => :'inventory_alert_threshold',
    :'user_data' => :'user_data',
    :'v2_id' => :'v2_id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/square_connect/models/v1_variation.rb', line 71

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'item_id' => :'String',
    :'ordinal' => :'Integer',
    :'pricing_type' => :'String',
    :'price_money' => :'V1Money',
    :'sku' => :'String',
    :'track_inventory' => :'BOOLEAN',
    :'inventory_alert_type' => :'String',
    :'inventory_alert_threshold' => :'Integer',
    :'user_data' => :'String',
    :'v2_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/square_connect/models/v1_variation.rb', line 161

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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/square_connect/models/v1_variation.rb', line 214

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



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/square_connect/models/v1_variation.rb', line 280

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



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

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [id, name, item_id, ordinal, pricing_type, price_money, sku, track_inventory, inventory_alert_type, inventory_alert_threshold, user_data, 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



148
149
150
151
 
# File 'lib/square_connect/models/v1_variation.rb', line 148

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



260
261
262
 
# File 'lib/square_connect/models/v1_variation.rb', line 260

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



266
267
268
269
270
271
272
273
274
 
# File 'lib/square_connect/models/v1_variation.rb', line 266

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



254
255
256
 
# File 'lib/square_connect/models/v1_variation.rb', line 254

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



155
156
157
 
# File 'lib/square_connect/models/v1_variation.rb', line 155

def valid?
  return true
end