class SquareConnect::InventoryAdjustment

Represents a change in state or quantity of product inventory at a particular time and location.

Attributes

catalog_object_id[RW]

The Square generated ID of the [CatalogObject](type-catalogobject) being tracked.

catalog_object_type[RW]

The [CatalogObjectType](type-catalogobjecttype) of the [CatalogObject](type-catalogobject) being tracked. Tracking is only supported for the `ITEM_VARIATION` type.

created_at[RW]

A read-only timestamp in RFC 3339 format that indicates when Square received the adjustment.

employee_id[RW]

The Square ID of the [Employee](type-employee) responsible for the inventory adjustment.

from_state[RW]

The [InventoryState](type-inventorystate) of the related quantity of items before the adjustment. See [InventoryState](type-inventorystate) for possible values

goods_receipt_id[RW]

The read-only Square ID of the Square goods receipt that caused the adjustment. Only relevant for state transitions from the Square for Retail app.

id[RW]

A unique ID generated by Square for the [InventoryAdjustment](type-inventoryadjustment).

location_id[RW]

The Square ID of the [Location](type-location) where the related quantity of items are being tracked.

occurred_at[RW]

A client-generated timestamp in RFC 3339 format that indicates when the adjustment 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.

purchase_order_id[RW]

The read-only Square ID of the purchase order that caused the adjustment. Only relevant for state transitions from the Square for Retail app.

quantity[RW]

The number of items affected by the adjustment 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.

reference_id[RW]

An optional ID provided by the application to tie the [InventoryAdjustment](type-inventoryadjustment) to an external system.

refund_id[RW]

The read-only Square ID of the [Refund] that caused the adjustment. Only relevant for refund-related state transitions.

source[RW]

Read-only information about the application that caused the inventory adjustment.

to_state[RW]

The [InventoryState](type-inventorystate) of the related quantity of items after the adjustment. See [InventoryState](type-inventorystate) for possible values

total_price_money[RW]

The read-only total price paid for goods associated with the adjustment. Present if and only if `to_state` is `SOLD`. Always non-negative.

transaction_id[RW]

The read-only Square ID of the [Transaction] that caused the adjustment. Only relevant for payment-related state transitions.

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/square_connect/models/inventory_adjustment.rb, line 68
def self.attribute_map
  {
    :'id' => :'id',
    :'reference_id' => :'reference_id',
    :'from_state' => :'from_state',
    :'to_state' => :'to_state',
    :'location_id' => :'location_id',
    :'catalog_object_id' => :'catalog_object_id',
    :'catalog_object_type' => :'catalog_object_type',
    :'quantity' => :'quantity',
    :'total_price_money' => :'total_price_money',
    :'occurred_at' => :'occurred_at',
    :'created_at' => :'created_at',
    :'source' => :'source',
    :'employee_id' => :'employee_id',
    :'transaction_id' => :'transaction_id',
    :'refund_id' => :'refund_id',
    :'purchase_order_id' => :'purchase_order_id',
    :'goods_receipt_id' => :'goods_receipt_id'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/square_connect/models/inventory_adjustment.rb, line 115
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?(:'from_state')
    self.from_state = attributes[:'from_state']
  end

  if attributes.has_key?(:'to_state')
    self.to_state = attributes[:'to_state']
  end

  if attributes.has_key?(:'location_id')
    self.location_id = attributes[:'location_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?(:'quantity')
    self.quantity = attributes[:'quantity']
  end

  if attributes.has_key?(:'total_price_money')
    self.total_price_money = attributes[:'total_price_money']
  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

  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?(:'transaction_id')
    self.transaction_id = attributes[:'transaction_id']
  end

  if attributes.has_key?(:'refund_id')
    self.refund_id = attributes[:'refund_id']
  end

  if attributes.has_key?(:'purchase_order_id')
    self.purchase_order_id = attributes[:'purchase_order_id']
  end

  if attributes.has_key?(:'goods_receipt_id')
    self.goods_receipt_id = attributes[:'goods_receipt_id']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/square_connect/models/inventory_adjustment.rb, line 91
def self.swagger_types
  {
    :'id' => :'String',
    :'reference_id' => :'String',
    :'from_state' => :'String',
    :'to_state' => :'String',
    :'location_id' => :'String',
    :'catalog_object_id' => :'String',
    :'catalog_object_type' => :'String',
    :'quantity' => :'String',
    :'total_price_money' => :'Money',
    :'occurred_at' => :'String',
    :'created_at' => :'String',
    :'source' => :'SourceApplication',
    :'employee_id' => :'String',
    :'transaction_id' => :'String',
    :'refund_id' => :'String',
    :'purchase_order_id' => :'String',
    :'goods_receipt_id' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/square_connect/models/inventory_adjustment.rb, line 206
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      reference_id == o.reference_id &&
      from_state == o.from_state &&
      to_state == o.to_state &&
      location_id == o.location_id &&
      catalog_object_id == o.catalog_object_id &&
      catalog_object_type == o.catalog_object_type &&
      quantity == o.quantity &&
      total_price_money == o.total_price_money &&
      occurred_at == o.occurred_at &&
      created_at == o.created_at &&
      source == o.source &&
      employee_id == o.employee_id &&
      transaction_id == o.transaction_id &&
      refund_id == o.refund_id &&
      purchase_order_id == o.purchase_order_id &&
      goods_receipt_id == o.goods_receipt_id
end
_deserialize(type, value) click to toggle source

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_adjustment.rb, line 264
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) click to toggle source

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_adjustment.rb, line 330
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) click to toggle source

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_adjustment.rb, line 243
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/square_connect/models/inventory_adjustment.rb, line 230
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/square_connect/models/inventory_adjustment.rb, line 236
def hash
  [id, reference_id, from_state, to_state, location_id, catalog_object_id, catalog_object_type, quantity, total_price_money, occurred_at, created_at, source, employee_id, transaction_id, refund_id, purchase_order_id, goods_receipt_id].hash
end
list_invalid_properties() click to toggle source

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_adjustment.rb, line 193
def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/square_connect/models/inventory_adjustment.rb, line 310
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/square_connect/models/inventory_adjustment.rb, line 316
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/square_connect/models/inventory_adjustment.rb, line 304
def to_s
  to_hash.to_s
end
valid?() click to toggle source

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_adjustment.rb, line 200
def valid?
  return true
end