class SquareConnect::BatchRetrieveInventoryChangesRequest
Attributes
Filters results by [CatalogObject](type-catalogobject) ID. Only applied when set. Default: unset.
A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](/basics/api101/pagination) for more information.
Filters results by [Location](type-location) ID. Only applied when set. Default: unset.
Filters `ADJUSTMENT` query results by [InventoryState](type-inventorystate). Only applied when set. Default: unset. See [InventoryState](type-inventorystate) for possible values
Filters results by [InventoryChangeType](type-inventorychangetype). Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. See [InventoryChangeType](type-inventorychangetype) for possible values
Provided as an RFC 3339 timestamp. Returns results whose `created_at` or `calculated_at` value is after the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`).
Provided as an RFC 3339 timestamp. Returns results whose `created_at` or `calculated_at` value is strictly before the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`).
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/square_connect/models/batch_retrieve_inventory_changes_request.rb, line 38 def self.attribute_map { :'catalog_object_ids' => :'catalog_object_ids', :'location_ids' => :'location_ids', :'types' => :'types', :'states' => :'states', :'updated_after' => :'updated_after', :'updated_before' => :'updated_before', :'cursor' => :'cursor' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/square_connect/models/batch_retrieve_inventory_changes_request.rb, line 65 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_ids') if (value = attributes[:'catalog_object_ids']).is_a?(Array) self.catalog_object_ids = value end end if attributes.has_key?(:'location_ids') if (value = attributes[:'location_ids']).is_a?(Array) self.location_ids = value end end if attributes.has_key?(:'types') if (value = attributes[:'types']).is_a?(Array) self.types = value end end if attributes.has_key?(:'states') if (value = attributes[:'states']).is_a?(Array) self.states = value end end if attributes.has_key?(:'updated_after') self.updated_after = attributes[:'updated_after'] end if attributes.has_key?(:'updated_before') self.updated_before = attributes[:'updated_before'] end if attributes.has_key?(:'cursor') self.cursor = attributes[:'cursor'] end end
Attribute type mapping.
# File lib/square_connect/models/batch_retrieve_inventory_changes_request.rb, line 51 def self.swagger_types { :'catalog_object_ids' => :'Array<String>', :'location_ids' => :'Array<String>', :'types' => :'Array<String>', :'states' => :'Array<String>', :'updated_after' => :'String', :'updated_before' => :'String', :'cursor' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/square_connect/models/batch_retrieve_inventory_changes_request.rb, line 124 def ==(o) return true if self.equal?(o) self.class == o.class && catalog_object_ids == o.catalog_object_ids && location_ids == o.location_ids && types == o.types && states == o.states && updated_after == o.updated_after && updated_before == o.updated_before && cursor == o.cursor 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/batch_retrieve_inventory_changes_request.rb, line 172 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/batch_retrieve_inventory_changes_request.rb, line 238 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/batch_retrieve_inventory_changes_request.rb, line 151 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/batch_retrieve_inventory_changes_request.rb, line 138 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/square_connect/models/batch_retrieve_inventory_changes_request.rb, line 144 def hash [catalog_object_ids, location_ids, types, states, updated_after, updated_before, cursor].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/batch_retrieve_inventory_changes_request.rb, line 111 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/batch_retrieve_inventory_changes_request.rb, line 224 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/batch_retrieve_inventory_changes_request.rb, line 212 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/batch_retrieve_inventory_changes_request.rb, line 118 def valid? return true end