InventoryAdjustment.php — WooCommerce Square 2.2.5

woocommerce-square / vendor / square / connect / lib / Model / InventoryAdjustment.php

woocommerce-square / vendor / square / connect / lib / Model Last commit date

InventoryAdjustment.php

675 lines

1	<?php
2	/**
3	* NOTE: This class is auto generated by the swagger code generator program.
4	* https://github.com/swagger-api/swagger-codegen
5	* Do not edit the class manually.
6	*/
7
8	namespace SquareConnect\Model;
9
10	use \ArrayAccess;
11	/**
12	* InventoryAdjustment Class Doc Comment
13	*
14	* @category Class
15	* @package SquareConnect
16	* @author Square Inc.
17	* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License v2
18	* @link https://squareup.com/developers
19	*/
20	class InventoryAdjustment implements ArrayAccess
21	{
22	/**
23	* Array of property to type mappings. Used for (de)serialization
24	* @var string[]
25	*/
26	static $swaggerTypes = array(
27	'id' => 'string',
28	'reference_id' => 'string',
29	'from_state' => 'string',
30	'to_state' => 'string',
31	'location_id' => 'string',
32	'catalog_object_id' => 'string',
33	'catalog_object_type' => 'string',
34	'quantity' => 'string',
35	'total_price_money' => '\SquareConnect\Model\Money',
36	'occurred_at' => 'string',
37	'created_at' => 'string',
38	'source' => '\SquareConnect\Model\SourceApplication',
39	'employee_id' => 'string',
40	'transaction_id' => 'string',
41	'refund_id' => 'string',
42	'purchase_order_id' => 'string',
43	'goods_receipt_id' => 'string'
44	);
45
46	/**
47	* Array of attributes where the key is the local name, and the value is the original name
48	* @var string[]
49	*/
50	static $attributeMap = array(
51	'id' => 'id',
52	'reference_id' => 'reference_id',
53	'from_state' => 'from_state',
54	'to_state' => 'to_state',
55	'location_id' => 'location_id',
56	'catalog_object_id' => 'catalog_object_id',
57	'catalog_object_type' => 'catalog_object_type',
58	'quantity' => 'quantity',
59	'total_price_money' => 'total_price_money',
60	'occurred_at' => 'occurred_at',
61	'created_at' => 'created_at',
62	'source' => 'source',
63	'employee_id' => 'employee_id',
64	'transaction_id' => 'transaction_id',
65	'refund_id' => 'refund_id',
66	'purchase_order_id' => 'purchase_order_id',
67	'goods_receipt_id' => 'goods_receipt_id'
68	);
69
70	/**
71	* Array of attributes to setter functions (for deserialization of responses)
72	* @var string[]
73	*/
74	static $setters = array(
75	'id' => 'setId',
76	'reference_id' => 'setReferenceId',
77	'from_state' => 'setFromState',
78	'to_state' => 'setToState',
79	'location_id' => 'setLocationId',
80	'catalog_object_id' => 'setCatalogObjectId',
81	'catalog_object_type' => 'setCatalogObjectType',
82	'quantity' => 'setQuantity',
83	'total_price_money' => 'setTotalPriceMoney',
84	'occurred_at' => 'setOccurredAt',
85	'created_at' => 'setCreatedAt',
86	'source' => 'setSource',
87	'employee_id' => 'setEmployeeId',
88	'transaction_id' => 'setTransactionId',
89	'refund_id' => 'setRefundId',
90	'purchase_order_id' => 'setPurchaseOrderId',
91	'goods_receipt_id' => 'setGoodsReceiptId'
92	);
93
94	/**
95	* Array of attributes to getter functions (for serialization of requests)
96	* @var string[]
97	*/
98	static $getters = array(
99	'id' => 'getId',
100	'reference_id' => 'getReferenceId',
101	'from_state' => 'getFromState',
102	'to_state' => 'getToState',
103	'location_id' => 'getLocationId',
104	'catalog_object_id' => 'getCatalogObjectId',
105	'catalog_object_type' => 'getCatalogObjectType',
106	'quantity' => 'getQuantity',
107	'total_price_money' => 'getTotalPriceMoney',
108	'occurred_at' => 'getOccurredAt',
109	'created_at' => 'getCreatedAt',
110	'source' => 'getSource',
111	'employee_id' => 'getEmployeeId',
112	'transaction_id' => 'getTransactionId',
113	'refund_id' => 'getRefundId',
114	'purchase_order_id' => 'getPurchaseOrderId',
115	'goods_receipt_id' => 'getGoodsReceiptId'
116	);
117
118	/**
119	* $id A unique ID generated by Square for the [InventoryAdjustment](#type-inventoryadjustment).
120	* @var string
121	*/
122	protected $id;
123	/**
124	* $reference_id An optional ID provided by the application to tie the [InventoryAdjustment](#type-inventoryadjustment) to an external system.
125	* @var string
126	*/
127	protected $reference_id;
128	/**
129	* $from_state The [InventoryState](#type-inventorystate) of the related quantity of items before the adjustment. See [InventoryState](#type-inventorystate) for possible values
130	* @var string
131	*/
132	protected $from_state;
133	/**
134	* $to_state The [InventoryState](#type-inventorystate) of the related quantity of items after the adjustment. See [InventoryState](#type-inventorystate) for possible values
135	* @var string
136	*/
137	protected $to_state;
138	/**
139	* $location_id The Square ID of the [Location](#type-location) where the related quantity of items are being tracked.
140	* @var string
141	*/
142	protected $location_id;
143	/**
144	* $catalog_object_id The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked.
145	* @var string
146	*/
147	protected $catalog_object_id;
148	/**
149	* $catalog_object_type The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the `ITEM_VARIATION` type.
150	* @var string
151	*/
152	protected $catalog_object_type;
153	/**
154	* $quantity 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.
155	* @var string
156	*/
157	protected $quantity;
158	/**
159	* $total_price_money The read-only total price paid for goods associated with the adjustment. Present if and only if `to_state` is `SOLD`. Always non-negative.
160	* @var \SquareConnect\Model\Money
161	*/
162	protected $total_price_money;
163	/**
164	* $occurred_at 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.
165	* @var string
166	*/
167	protected $occurred_at;
168	/**
169	* $created_at A read-only timestamp in RFC 3339 format that indicates when Square received the adjustment.
170	* @var string
171	*/
172	protected $created_at;
173	/**
174	* $source Read-only information about the application that caused the inventory adjustment.
175	* @var \SquareConnect\Model\SourceApplication
176	*/
177	protected $source;
178	/**
179	* $employee_id The Square ID of the [Employee](#type-employee) responsible for the inventory adjustment.
180	* @var string
181	*/
182	protected $employee_id;
183	/**
184	* $transaction_id The read-only Square ID of the [Transaction][#type-transaction] that caused the adjustment. Only relevant for payment-related state transitions.
185	* @var string
186	*/
187	protected $transaction_id;
188	/**
189	* $refund_id The read-only Square ID of the [Refund][#type-refund] that caused the adjustment. Only relevant for refund-related state transitions.
190	* @var string
191	*/
192	protected $refund_id;
193	/**
194	* $purchase_order_id The read-only Square ID of the purchase order that caused the adjustment. Only relevant for state transitions from the Square for Retail app.
195	* @var string
196	*/
197	protected $purchase_order_id;
198	/**
199	* $goods_receipt_id 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.
200	* @var string
201	*/
202	protected $goods_receipt_id;
203
204	/**
205	* Constructor
206	* @param mixed[] $data Associated array of property value initializing the model
207	*/
208	public function __construct(array $data = null)
209	{
210	if ($data != null) {
211	if (isset($data["id"])) {
212	$this->id = $data["id"];
213	} else {
214	$this->id = null;
215	}
216	if (isset($data["reference_id"])) {
217	$this->reference_id = $data["reference_id"];
218	} else {
219	$this->reference_id = null;
220	}
221	if (isset($data["from_state"])) {
222	$this->from_state = $data["from_state"];
223	} else {
224	$this->from_state = null;
225	}
226	if (isset($data["to_state"])) {
227	$this->to_state = $data["to_state"];
228	} else {
229	$this->to_state = null;
230	}
231	if (isset($data["location_id"])) {
232	$this->location_id = $data["location_id"];
233	} else {
234	$this->location_id = null;
235	}
236	if (isset($data["catalog_object_id"])) {
237	$this->catalog_object_id = $data["catalog_object_id"];
238	} else {
239	$this->catalog_object_id = null;
240	}
241	if (isset($data["catalog_object_type"])) {
242	$this->catalog_object_type = $data["catalog_object_type"];
243	} else {
244	$this->catalog_object_type = null;
245	}
246	if (isset($data["quantity"])) {
247	$this->quantity = $data["quantity"];
248	} else {
249	$this->quantity = null;
250	}
251	if (isset($data["total_price_money"])) {
252	$this->total_price_money = $data["total_price_money"];
253	} else {
254	$this->total_price_money = null;
255	}
256	if (isset($data["occurred_at"])) {
257	$this->occurred_at = $data["occurred_at"];
258	} else {
259	$this->occurred_at = null;
260	}
261	if (isset($data["created_at"])) {
262	$this->created_at = $data["created_at"];
263	} else {
264	$this->created_at = null;
265	}
266	if (isset($data["source"])) {
267	$this->source = $data["source"];
268	} else {
269	$this->source = null;
270	}
271	if (isset($data["employee_id"])) {
272	$this->employee_id = $data["employee_id"];
273	} else {
274	$this->employee_id = null;
275	}
276	if (isset($data["transaction_id"])) {
277	$this->transaction_id = $data["transaction_id"];
278	} else {
279	$this->transaction_id = null;
280	}
281	if (isset($data["refund_id"])) {
282	$this->refund_id = $data["refund_id"];
283	} else {
284	$this->refund_id = null;
285	}
286	if (isset($data["purchase_order_id"])) {
287	$this->purchase_order_id = $data["purchase_order_id"];
288	} else {
289	$this->purchase_order_id = null;
290	}
291	if (isset($data["goods_receipt_id"])) {
292	$this->goods_receipt_id = $data["goods_receipt_id"];
293	} else {
294	$this->goods_receipt_id = null;
295	}
296	}
297	}
298	/**
299	* Gets id
300	* @return string
301	*/
302	public function getId()
303	{
304	return $this->id;
305	}
306
307	/**
308	* Sets id
309	* @param string $id A unique ID generated by Square for the [InventoryAdjustment](#type-inventoryadjustment).
310	* @return $this
311	*/
312	public function setId($id)
313	{
314	$this->id = $id;
315	return $this;
316	}
317	/**
318	* Gets reference_id
319	* @return string
320	*/
321	public function getReferenceId()
322	{
323	return $this->reference_id;
324	}
325
326	/**
327	* Sets reference_id
328	* @param string $reference_id An optional ID provided by the application to tie the [InventoryAdjustment](#type-inventoryadjustment) to an external system.
329	* @return $this
330	*/
331	public function setReferenceId($reference_id)
332	{
333	$this->reference_id = $reference_id;
334	return $this;
335	}
336	/**
337	* Gets from_state
338	* @return string
339	*/
340	public function getFromState()
341	{
342	return $this->from_state;
343	}
344
345	/**
346	* Sets from_state
347	* @param string $from_state The [InventoryState](#type-inventorystate) of the related quantity of items before the adjustment. See [InventoryState](#type-inventorystate) for possible values
348	* @return $this
349	*/
350	public function setFromState($from_state)
351	{
352	$this->from_state = $from_state;
353	return $this;
354	}
355	/**
356	* Gets to_state
357	* @return string
358	*/
359	public function getToState()
360	{
361	return $this->to_state;
362	}
363
364	/**
365	* Sets to_state
366	* @param string $to_state The [InventoryState](#type-inventorystate) of the related quantity of items after the adjustment. See [InventoryState](#type-inventorystate) for possible values
367	* @return $this
368	*/
369	public function setToState($to_state)
370	{
371	$this->to_state = $to_state;
372	return $this;
373	}
374	/**
375	* Gets location_id
376	* @return string
377	*/
378	public function getLocationId()
379	{
380	return $this->location_id;
381	}
382
383	/**
384	* Sets location_id
385	* @param string $location_id The Square ID of the [Location](#type-location) where the related quantity of items are being tracked.
386	* @return $this
387	*/
388	public function setLocationId($location_id)
389	{
390	$this->location_id = $location_id;
391	return $this;
392	}
393	/**
394	* Gets catalog_object_id
395	* @return string
396	*/
397	public function getCatalogObjectId()
398	{
399	return $this->catalog_object_id;
400	}
401
402	/**
403	* Sets catalog_object_id
404	* @param string $catalog_object_id The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked.
405	* @return $this
406	*/
407	public function setCatalogObjectId($catalog_object_id)
408	{
409	$this->catalog_object_id = $catalog_object_id;
410	return $this;
411	}
412	/**
413	* Gets catalog_object_type
414	* @return string
415	*/
416	public function getCatalogObjectType()
417	{
418	return $this->catalog_object_type;
419	}
420
421	/**
422	* Sets catalog_object_type
423	* @param string $catalog_object_type The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the `ITEM_VARIATION` type.
424	* @return $this
425	*/
426	public function setCatalogObjectType($catalog_object_type)
427	{
428	$this->catalog_object_type = $catalog_object_type;
429	return $this;
430	}
431	/**
432	* Gets quantity
433	* @return string
434	*/
435	public function getQuantity()
436	{
437	return $this->quantity;
438	}
439
440	/**
441	* Sets quantity
442	* @param string $quantity 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.
443	* @return $this
444	*/
445	public function setQuantity($quantity)
446	{
447	$this->quantity = $quantity;
448	return $this;
449	}
450	/**
451	* Gets total_price_money
452	* @return \SquareConnect\Model\Money
453	*/
454	public function getTotalPriceMoney()
455	{
456	return $this->total_price_money;
457	}
458
459	/**
460	* Sets total_price_money
461	* @param \SquareConnect\Model\Money $total_price_money The read-only total price paid for goods associated with the adjustment. Present if and only if `to_state` is `SOLD`. Always non-negative.
462	* @return $this
463	*/
464	public function setTotalPriceMoney($total_price_money)
465	{
466	$this->total_price_money = $total_price_money;
467	return $this;
468	}
469	/**
470	* Gets occurred_at
471	* @return string
472	*/
473	public function getOccurredAt()
474	{
475	return $this->occurred_at;
476	}
477
478	/**
479	* Sets occurred_at
480	* @param string $occurred_at 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.
481	* @return $this
482	*/
483	public function setOccurredAt($occurred_at)
484	{
485	$this->occurred_at = $occurred_at;
486	return $this;
487	}
488	/**
489	* Gets created_at
490	* @return string
491	*/
492	public function getCreatedAt()
493	{
494	return $this->created_at;
495	}
496
497	/**
498	* Sets created_at
499	* @param string $created_at A read-only timestamp in RFC 3339 format that indicates when Square received the adjustment.
500	* @return $this
501	*/
502	public function setCreatedAt($created_at)
503	{
504	$this->created_at = $created_at;
505	return $this;
506	}
507	/**
508	* Gets source
509	* @return \SquareConnect\Model\SourceApplication
510	*/
511	public function getSource()
512	{
513	return $this->source;
514	}
515
516	/**
517	* Sets source
518	* @param \SquareConnect\Model\SourceApplication $source Read-only information about the application that caused the inventory adjustment.
519	* @return $this
520	*/
521	public function setSource($source)
522	{
523	$this->source = $source;
524	return $this;
525	}
526	/**
527	* Gets employee_id
528	* @return string
529	*/
530	public function getEmployeeId()
531	{
532	return $this->employee_id;
533	}
534
535	/**
536	* Sets employee_id
537	* @param string $employee_id The Square ID of the [Employee](#type-employee) responsible for the inventory adjustment.
538	* @return $this
539	*/
540	public function setEmployeeId($employee_id)
541	{
542	$this->employee_id = $employee_id;
543	return $this;
544	}
545	/**
546	* Gets transaction_id
547	* @return string
548	*/
549	public function getTransactionId()
550	{
551	return $this->transaction_id;
552	}
553
554	/**
555	* Sets transaction_id
556	* @param string $transaction_id The read-only Square ID of the [Transaction][#type-transaction] that caused the adjustment. Only relevant for payment-related state transitions.
557	* @return $this
558	*/
559	public function setTransactionId($transaction_id)
560	{
561	$this->transaction_id = $transaction_id;
562	return $this;
563	}
564	/**
565	* Gets refund_id
566	* @return string
567	*/
568	public function getRefundId()
569	{
570	return $this->refund_id;
571	}
572
573	/**
574	* Sets refund_id
575	* @param string $refund_id The read-only Square ID of the [Refund][#type-refund] that caused the adjustment. Only relevant for refund-related state transitions.
576	* @return $this
577	*/
578	public function setRefundId($refund_id)
579	{
580	$this->refund_id = $refund_id;
581	return $this;
582	}
583	/**
584	* Gets purchase_order_id
585	* @return string
586	*/
587	public function getPurchaseOrderId()
588	{
589	return $this->purchase_order_id;
590	}
591
592	/**
593	* Sets purchase_order_id
594	* @param string $purchase_order_id The read-only Square ID of the purchase order that caused the adjustment. Only relevant for state transitions from the Square for Retail app.
595	* @return $this
596	*/
597	public function setPurchaseOrderId($purchase_order_id)
598	{
599	$this->purchase_order_id = $purchase_order_id;
600	return $this;
601	}
602	/**
603	* Gets goods_receipt_id
604	* @return string
605	*/
606	public function getGoodsReceiptId()
607	{
608	return $this->goods_receipt_id;
609	}
610
611	/**
612	* Sets goods_receipt_id
613	* @param string $goods_receipt_id 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.
614	* @return $this
615	*/
616	public function setGoodsReceiptId($goods_receipt_id)
617	{
618	$this->goods_receipt_id = $goods_receipt_id;
619	return $this;
620	}
621	/**
622	* Returns true if offset exists. False otherwise.
623	* @param integer $offset Offset
624	* @return boolean
625	*/
626	public function offsetExists($offset)
627	{
628	return isset($this->$offset);
629	}
630
631	/**
632	* Gets offset.
633	* @param integer $offset Offset
634	* @return mixed
635	*/
636	public function offsetGet($offset)
637	{
638	return $this->$offset;
639	}
640
641	/**
642	* Sets value based on offset.
643	* @param integer $offset Offset
644	* @param mixed $value Value to be set
645	* @return void
646	*/
647	public function offsetSet($offset, $value)
648	{
649	$this->$offset = $value;
650	}
651
652	/**
653	* Unsets offset.
654	* @param integer $offset Offset
655	* @return void
656	*/
657	public function offsetUnset($offset)
658	{
659	unset($this->$offset);
660	}
661
662	/**
663	* Gets the string presentation of the object
664	* @return string
665	*/
666	public function __toString()
667	{
668	if (defined('JSON_PRETTY_PRINT')) {
669	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT);
670	} else {
671	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this));
672	}
673	}
674	}
675