class SquareConnect::InventoryPhysicalCount
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.
Attributes
The Square generated ID of the [CatalogObject](type-catalogobject) being tracked.
The [CatalogObjectType](type-catalogobjecttype) of the [CatalogObject](type-catalogobject) being tracked. Tracking is only supported for the `ITEM_VARIATION` type.
A read-only timestamp in RFC 3339 format that indicates when Square received the physical count.
The Square ID of the [Employee](type-employee) responsible for the physical count.
A unique ID generated by Square for the [InventoryPhysicalCount](type-inventoryphysicalcount).
The Square ID of the [Location](type-location) where the related quantity of items are being tracked.
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.
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.
An optional ID provided by the application to tie the [InventoryPhysicalCount](type-inventoryphysicalcount) to an external system.
Read-only information about the application that submitted the physical count.
The current [InventoryState](type-inventorystate) for the related quantity of items. See [InventoryState](type-inventorystate) for possible values
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# 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
Attribute type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# 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
@see the `==` method @param [Object] Object to be compared
# File lib/square_connect/models/inventory_physical_count.rb, line 170 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/square_connect/models/inventory_physical_count.rb, line 139 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/square_connect/models/inventory_physical_count.rb, line 244 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/square_connect/models/inventory_physical_count.rb, line 146 def valid? return true end