Class: SquareConnect::InventoryAdjustment
- Inherits:
-
Object
- Object
- SquareConnect::InventoryAdjustment
- Defined in:
- lib/square_connect/models/inventory_adjustment.rb
Overview
Represents a change in state or quantity of product inventory at a particular time and location.
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 adjustment.
-
#employee_id ⇒ Object
The Square ID of the [Employee](#type-employee) responsible for the inventory adjustment.
-
#from_state ⇒ Object
The [InventoryState](#type-inventorystate) of the related quantity of items before the adjustment.
-
#goods_receipt_id ⇒ Object
The read-only Square ID of the Square goods receipt that caused the adjustment.
-
#id ⇒ Object
A unique ID generated by Square for the [InventoryAdjustment](#type-inventoryadjustment).
-
#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 adjustment took place.
-
#purchase_order_id ⇒ Object
The read-only Square ID of the purchase order that caused the adjustment.
-
#quantity ⇒ Object
The number of items affected by the adjustment as a decimal string.
-
#reference_id ⇒ Object
An optional ID provided by the application to tie the [InventoryAdjustment](#type-inventoryadjustment) to an external system.
-
#refund_id ⇒ Object
The read-only Square ID of the [Refund] that caused the adjustment.
-
#source ⇒ Object
Read-only information about the application that caused the inventory adjustment.
-
#to_state ⇒ Object
The [InventoryState](#type-inventorystate) of the related quantity of items after the adjustment.
-
#total_price_money ⇒ Object
The read-only total price paid for goods associated with the adjustment.
-
#transaction_id ⇒ Object
The read-only Square ID of the [Transaction] that caused the adjustment.
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 = {}) ⇒ InventoryAdjustment
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 = {}) ⇒ InventoryAdjustment
Initializes the object
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 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 |
# 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 |
Instance Attribute Details
#catalog_object_id ⇒ Object
The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked.
31 32 33 |
# File 'lib/square_connect/models/inventory_adjustment.rb', line 31 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.
34 35 36 |
# File 'lib/square_connect/models/inventory_adjustment.rb', line 34 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 adjustment.
46 47 48 |
# File 'lib/square_connect/models/inventory_adjustment.rb', line 46 def created_at @created_at end |
#employee_id ⇒ Object
The Square ID of the [Employee](#type-employee) responsible for the inventory adjustment.
52 53 54 |
# File 'lib/square_connect/models/inventory_adjustment.rb', line 52 def employee_id @employee_id end |
#from_state ⇒ Object
The [InventoryState](#type-inventorystate) of the related quantity of items before the adjustment. See [InventoryState](#type-inventorystate) for possible values
22 23 24 |
# File 'lib/square_connect/models/inventory_adjustment.rb', line 22 def from_state @from_state end |
#goods_receipt_id ⇒ Object
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.
64 65 66 |
# File 'lib/square_connect/models/inventory_adjustment.rb', line 64 def goods_receipt_id @goods_receipt_id end |
#id ⇒ Object
A unique ID generated by Square for the [InventoryAdjustment](#type-inventoryadjustment).
16 17 18 |
# File 'lib/square_connect/models/inventory_adjustment.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.
28 29 30 |
# File 'lib/square_connect/models/inventory_adjustment.rb', line 28 def location_id @location_id end |
#occurred_at ⇒ Object
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.
43 44 45 |
# File 'lib/square_connect/models/inventory_adjustment.rb', line 43 def occurred_at @occurred_at end |
#purchase_order_id ⇒ Object
The read-only Square ID of the purchase order that caused the adjustment. Only relevant for state transitions from the Square for Retail app.
61 62 63 |
# File 'lib/square_connect/models/inventory_adjustment.rb', line 61 def purchase_order_id @purchase_order_id end |
#quantity ⇒ Object
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.
37 38 39 |
# File 'lib/square_connect/models/inventory_adjustment.rb', line 37 def quantity @quantity end |
#reference_id ⇒ Object
An optional ID provided by the application to tie the [InventoryAdjustment](#type-inventoryadjustment) to an external system.
19 20 21 |
# File 'lib/square_connect/models/inventory_adjustment.rb', line 19 def reference_id @reference_id end |
#refund_id ⇒ Object
The read-only Square ID of the [Refund] that caused the adjustment. Only relevant for refund-related state transitions.
58 59 60 |
# File 'lib/square_connect/models/inventory_adjustment.rb', line 58 def refund_id @refund_id end |
#source ⇒ Object
Read-only information about the application that caused the inventory adjustment.
49 50 51 |
# File 'lib/square_connect/models/inventory_adjustment.rb', line 49 def source @source end |
#to_state ⇒ Object
The [InventoryState](#type-inventorystate) of the related quantity of items after the adjustment. See [InventoryState](#type-inventorystate) for possible values
25 26 27 |
# File 'lib/square_connect/models/inventory_adjustment.rb', line 25 def to_state @to_state end |
#total_price_money ⇒ Object
The read-only total price paid for goods associated with the adjustment. Present if and only if ‘to_state` is `SOLD`. Always non-negative.
40 41 42 |
# File 'lib/square_connect/models/inventory_adjustment.rb', line 40 def total_price_money @total_price_money end |
#transaction_id ⇒ Object
The read-only Square ID of the [Transaction] that caused the adjustment. Only relevant for payment-related state transitions.
55 56 57 |
# File 'lib/square_connect/models/inventory_adjustment.rb', line 55 def transaction_id @transaction_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# 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 |
.swagger_types ⇒ Object
Attribute type mapping.
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
# 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 |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
# 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) ⇒ Object
Deserializes the data based on type
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 |
# 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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
330 331 332 333 334 335 336 337 338 339 340 341 342 |
# 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) ⇒ Object
Builds the object from hash
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 |
# 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) ⇒ Boolean
230 231 232 |
# File 'lib/square_connect/models/inventory_adjustment.rb', line 230 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
236 237 238 |
# 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 ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
193 194 195 196 |
# File 'lib/square_connect/models/inventory_adjustment.rb', line 193 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)
310 311 312 |
# File 'lib/square_connect/models/inventory_adjustment.rb', line 310 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
316 317 318 319 320 321 322 323 324 |
# 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 ⇒ String
Returns the string representation of the object
304 305 306 |
# File 'lib/square_connect/models/inventory_adjustment.rb', line 304 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
200 201 202 |
# File 'lib/square_connect/models/inventory_adjustment.rb', line 200 def valid? return true end |