Class: SquareConnect::InventoryCount
- Inherits:
-
Object
- Object
- SquareConnect::InventoryCount
- Defined in:
- lib/square_connect/models/inventory_count.rb
Overview
Represents Square’s estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments
Instance Attribute Summary collapse
-
#calculated_at ⇒ Object
A read-only timestamp in RFC 3339 format that indicates when Square received the most recent physical count or adjustment that had an affect on the estimated count.
-
#catalog_object_id ⇒ Object
The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked.
-
#catalog_object_type ⇒ Object
The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked.
-
#location_id ⇒ Object
The Square ID of the [Location](#type-location) where the related quantity of items are being tracked.
-
#quantity ⇒ Object
The number of items in the count as a decimal string.
-
#state ⇒ Object
The current [InventoryState](#type-inventorystate) for the related quantity of items.
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 = {}) ⇒ InventoryCount
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 = {}) ⇒ InventoryCount
Initializes the object
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/square_connect/models/inventory_count.rb', line 60 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?(:'catalog_object_id') self.catalog_object_id = attributes[:'catalog_object_id'] end if attributes.has_key?(:'catalog_object_type') self.catalog_object_type = attributes[:'catalog_object_type'] end if attributes.has_key?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'location_id') self.location_id = attributes[:'location_id'] end if attributes.has_key?(:'quantity') self.quantity = attributes[:'quantity'] end if attributes.has_key?(:'calculated_at') self.calculated_at = attributes[:'calculated_at'] end end |
Instance Attribute Details
#calculated_at ⇒ Object
A read-only timestamp in RFC 3339 format that indicates when Square received the most recent physical count or adjustment that had an affect on the estimated count.
31 32 33 |
# File 'lib/square_connect/models/inventory_count.rb', line 31 def calculated_at @calculated_at end |
#catalog_object_id ⇒ Object
The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked.
16 17 18 |
# File 'lib/square_connect/models/inventory_count.rb', line 16 def catalog_object_id @catalog_object_id end |
#catalog_object_type ⇒ Object
The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the ‘ITEM_VARIATION` type.
19 20 21 |
# File 'lib/square_connect/models/inventory_count.rb', line 19 def catalog_object_type @catalog_object_type end |
#location_id ⇒ Object
The Square ID of the [Location](#type-location) where the related quantity of items are being tracked.
25 26 27 |
# File 'lib/square_connect/models/inventory_count.rb', line 25 def location_id @location_id end |
#quantity ⇒ Object
The number of items in the count as a decimal string. Can support up to 5 digits after the decimal point. Important: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, ‘2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](/orders-api/what-it-does#decimal-quantities) for more information.
28 29 30 |
# File 'lib/square_connect/models/inventory_count.rb', line 28 def quantity @quantity end |
#state ⇒ Object
The current [InventoryState](#type-inventorystate) for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values
22 23 24 |
# File 'lib/square_connect/models/inventory_count.rb', line 22 def state @state end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
35 36 37 38 39 40 41 42 43 44 |
# File 'lib/square_connect/models/inventory_count.rb', line 35 def self.attribute_map { :'catalog_object_id' => :'catalog_object_id', :'catalog_object_type' => :'catalog_object_type', :'state' => :'state', :'location_id' => :'location_id', :'quantity' => :'quantity', :'calculated_at' => :'calculated_at' } end |
.swagger_types ⇒ Object
Attribute type mapping.
47 48 49 50 51 52 53 54 55 56 |
# File 'lib/square_connect/models/inventory_count.rb', line 47 def self.swagger_types { :'catalog_object_id' => :'String', :'catalog_object_type' => :'String', :'state' => :'String', :'location_id' => :'String', :'quantity' => :'String', :'calculated_at' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
107 108 109 110 111 112 113 114 115 116 |
# File 'lib/square_connect/models/inventory_count.rb', line 107 def ==(o) return true if self.equal?(o) self.class == o.class && catalog_object_id == o.catalog_object_id && catalog_object_type == o.catalog_object_type && state == o.state && location_id == o.location_id && quantity == o.quantity && calculated_at == o.calculated_at end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 |
# File 'lib/square_connect/models/inventory_count.rb', line 154 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
220 221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/square_connect/models/inventory_count.rb', line 220 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
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
# File 'lib/square_connect/models/inventory_count.rb', line 133 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
120 121 122 |
# File 'lib/square_connect/models/inventory_count.rb', line 120 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
126 127 128 |
# File 'lib/square_connect/models/inventory_count.rb', line 126 def hash [catalog_object_id, catalog_object_type, state, location_id, quantity, calculated_at].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
94 95 96 97 |
# File 'lib/square_connect/models/inventory_count.rb', line 94 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)
200 201 202 |
# File 'lib/square_connect/models/inventory_count.rb', line 200 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
206 207 208 209 210 211 212 213 214 |
# File 'lib/square_connect/models/inventory_count.rb', line 206 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
194 195 196 |
# File 'lib/square_connect/models/inventory_count.rb', line 194 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
101 102 103 |
# File 'lib/square_connect/models/inventory_count.rb', line 101 def valid? return true end |