Class: SquareConnect::InventoryPhysicalCount
- Inherits:
-
Object
- Object
- SquareConnect::InventoryPhysicalCount
- Defined in:
- lib/square_connect/models/inventory_physical_count.rb
Overview
Represents the quantity of an item variation that is physically present at a specific location, verified by a seller or a seller’s employee. For example, a physical count might come from an employee counting the item variations on hand or from syncing with an external system.
Instance Attribute Summary collapse
-
#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.
-
#created_at ⇒ Object
A read-only timestamp in RFC 3339 format that indicates when Square received the physical count.
-
#employee_id ⇒ Object
The Square ID of the [Employee](#type-employee) responsible for the physical count.
-
#id ⇒ Object
A unique ID generated by Square for the [InventoryPhysicalCount](#type-inventoryphysicalcount).
-
#location_id ⇒ Object
The Square ID of the [Location](#type-location) where the related quantity of items are being tracked.
-
#occurred_at ⇒ Object
A client-generated timestamp in RFC 3339 format that indicates when the physical count took place.
-
#quantity ⇒ Object
The number of items affected by the physical count as a decimal string.
-
#reference_id ⇒ Object
An optional ID provided by the application to tie the [InventoryPhysicalCount](#type-inventoryphysicalcount) to an external system.
-
#source ⇒ Object
Read-only information about the application that submitted the physical count.
-
#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 = {}) ⇒ InventoryPhysicalCount
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 = {}) ⇒ InventoryPhysicalCount
Initializes the object
85 86 87 88 89 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 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 85 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?(:'reference_id') self.reference_id = attributes[:'reference_id'] end 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?(:'source') self.source = attributes[:'source'] end if attributes.has_key?(:'employee_id') self.employee_id = attributes[:'employee_id'] end if attributes.has_key?(:'occurred_at') self.occurred_at = attributes[:'occurred_at'] end if attributes.has_key?(:'created_at') self.created_at = attributes[:'created_at'] end end |
Instance Attribute Details
#catalog_object_id ⇒ Object
The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked.
22 23 24 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 22 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.
25 26 27 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 25 def catalog_object_type @catalog_object_type end |
#created_at ⇒ Object
A read-only timestamp in RFC 3339 format that indicates when Square received the physical count.
46 47 48 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 46 def created_at @created_at end |
#employee_id ⇒ Object
The Square ID of the [Employee](#type-employee) responsible for the physical count.
40 41 42 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 40 def employee_id @employee_id end |
#id ⇒ Object
A unique ID generated by Square for the [InventoryPhysicalCount](#type-inventoryphysicalcount).
16 17 18 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 16 def id @id end |
#location_id ⇒ Object
The Square ID of the [Location](#type-location) where the related quantity of items are being tracked.
31 32 33 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 31 def location_id @location_id end |
#occurred_at ⇒ Object
A client-generated timestamp in RFC 3339 format that indicates when the physical count took place. For write actions, the ‘occurred_at` timestamp cannot be older than 24 hours or in the future relative to the time of the request.
43 44 45 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 43 def occurred_at @occurred_at end |
#quantity ⇒ Object
The number of items affected by the physical 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.
34 35 36 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 34 def quantity @quantity end |
#reference_id ⇒ Object
An optional ID provided by the application to tie the [InventoryPhysicalCount](#type-inventoryphysicalcount) to an external system.
19 20 21 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 19 def reference_id @reference_id end |
#source ⇒ Object
Read-only information about the application that submitted the physical count.
37 38 39 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 37 def source @source end |
#state ⇒ Object
The current [InventoryState](#type-inventorystate) for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values
28 29 30 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 28 def state @state end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 50 def self.attribute_map { :'id' => :'id', :'reference_id' => :'reference_id', :'catalog_object_id' => :'catalog_object_id', :'catalog_object_type' => :'catalog_object_type', :'state' => :'state', :'location_id' => :'location_id', :'quantity' => :'quantity', :'source' => :'source', :'employee_id' => :'employee_id', :'occurred_at' => :'occurred_at', :'created_at' => :'created_at' } end |
.swagger_types ⇒ Object
Attribute type mapping.
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 67 def self.swagger_types { :'id' => :'String', :'reference_id' => :'String', :'catalog_object_id' => :'String', :'catalog_object_type' => :'String', :'state' => :'String', :'location_id' => :'String', :'quantity' => :'String', :'source' => :'SourceApplication', :'employee_id' => :'String', :'occurred_at' => :'String', :'created_at' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 152 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && reference_id == o.reference_id && 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 && source == o.source && employee_id == o.employee_id && occurred_at == o.occurred_at && created_at == o.created_at end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
204 205 206 207 208 209 210 211 212 213 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 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 204 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
270 271 272 273 274 275 276 277 278 279 280 281 282 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 270 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
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 183 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
170 171 172 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 170 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
176 177 178 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 176 def hash [id, reference_id, catalog_object_id, catalog_object_type, state, location_id, quantity, source, employee_id, occurred_at, created_at].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
139 140 141 142 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 139 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)
250 251 252 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 250 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
256 257 258 259 260 261 262 263 264 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 256 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
244 245 246 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 244 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
146 147 148 |
# File 'lib/square_connect/models/inventory_physical_count.rb', line 146 def valid? return true end |