Class: SquareConnect::CatalogItemVariation
- Inherits:
-
Object
- Object
- SquareConnect::CatalogItemVariation
- Defined in:
- lib/square_connect/models/catalog_item_variation.rb
Overview
An item variation (i.e., product) in the Catalog object model.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#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.
-
#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`.
-
#item_id ⇒ Object
The ID of the [CatalogItem](#type-catalogitem) associated with this item variation.
-
#location_overrides ⇒ Object
Per-(#type-location) price and inventory overrides.
-
#name ⇒ Object
The item variation’s name.
-
#ordinal ⇒ Object
The order in which this item variation should be displayed.
-
#price_money ⇒ Object
The item variation’s price, if fixed pricing is used.
-
#pricing_type ⇒ Object
Indicates whether the item variation’s price is fixed or determined at the time of sale.
-
#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.
-
#sku ⇒ Object
The item variation’s SKU, if any.
-
#track_inventory ⇒ Object
If ‘true`, inventory tracking is active for the variation.
-
#upc ⇒ Object
The item variation’s UPC, if any.
-
#user_data ⇒ Object
Arbitrary user metadata to associate with the item variation.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ CatalogItemVariation
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ CatalogItemVariation
Initializes the object
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 |
# File 'lib/square_connect/models/catalog_item_variation.rb', line 116 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 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 all 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 |
#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 |
#name ⇒ Object
The item variation’s name. Searchable.
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 all 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.
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.
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 |
# File 'lib/square_connect/models/catalog_item_variation.rb', line 77 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' } end |
.swagger_types ⇒ Object
Attribute type mapping.
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 |
# File 'lib/square_connect/models/catalog_item_variation.rb', line 96 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' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 |
# File 'lib/square_connect/models/catalog_item_variation.rb', line 217 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 end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
# File 'lib/square_connect/models/catalog_item_variation.rb', line 271 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
337 338 339 340 341 342 343 344 345 346 347 348 349 |
# File 'lib/square_connect/models/catalog_item_variation.rb', line 337 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
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 |
# File 'lib/square_connect/models/catalog_item_variation.rb', line 250 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
237 238 239 |
# File 'lib/square_connect/models/catalog_item_variation.rb', line 237 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
243 244 245 |
# File 'lib/square_connect/models/catalog_item_variation.rb', line 243 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].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
180 181 182 183 |
# File 'lib/square_connect/models/catalog_item_variation.rb', line 180 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)
317 318 319 |
# File 'lib/square_connect/models/catalog_item_variation.rb', line 317 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
323 324 325 326 327 328 329 330 331 |
# File 'lib/square_connect/models/catalog_item_variation.rb', line 323 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
311 312 313 |
# File 'lib/square_connect/models/catalog_item_variation.rb', line 311 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
187 188 189 190 191 192 193 |
# File 'lib/square_connect/models/catalog_item_variation.rb', line 187 def valid? pricing_type_validator = EnumAttributeValidator.new('String', ["FIXED_PRICING", "VARIABLE_PRICING"]) return false unless pricing_type_validator.valid?(@pricing_type) inventory_alert_type_validator = EnumAttributeValidator.new('String', ["NONE", "LOW_QUANTITY"]) return false unless inventory_alert_type_validator.valid?(@inventory_alert_type) return true end |