InventoryTransfer.php — WooCommerce Square 2.2.5

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

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

InventoryTransfer.php

510 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	* InventoryTransfer 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 InventoryTransfer 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	'state' => 'string',
30	'from_location_id' => 'string',
31	'to_location_id' => 'string',
32	'catalog_object_id' => 'string',
33	'catalog_object_type' => 'string',
34	'quantity' => 'string',
35	'occurred_at' => 'string',
36	'created_at' => 'string',
37	'source' => '\SquareConnect\Model\SourceApplication',
38	'employee_id' => 'string'
39	);
40
41	/**
42	* Array of attributes where the key is the local name, and the value is the original name
43	* @var string[]
44	*/
45	static $attributeMap = array(
46	'id' => 'id',
47	'reference_id' => 'reference_id',
48	'state' => 'state',
49	'from_location_id' => 'from_location_id',
50	'to_location_id' => 'to_location_id',
51	'catalog_object_id' => 'catalog_object_id',
52	'catalog_object_type' => 'catalog_object_type',
53	'quantity' => 'quantity',
54	'occurred_at' => 'occurred_at',
55	'created_at' => 'created_at',
56	'source' => 'source',
57	'employee_id' => 'employee_id'
58	);
59
60	/**
61	* Array of attributes to setter functions (for deserialization of responses)
62	* @var string[]
63	*/
64	static $setters = array(
65	'id' => 'setId',
66	'reference_id' => 'setReferenceId',
67	'state' => 'setState',
68	'from_location_id' => 'setFromLocationId',
69	'to_location_id' => 'setToLocationId',
70	'catalog_object_id' => 'setCatalogObjectId',
71	'catalog_object_type' => 'setCatalogObjectType',
72	'quantity' => 'setQuantity',
73	'occurred_at' => 'setOccurredAt',
74	'created_at' => 'setCreatedAt',
75	'source' => 'setSource',
76	'employee_id' => 'setEmployeeId'
77	);
78
79	/**
80	* Array of attributes to getter functions (for serialization of requests)
81	* @var string[]
82	*/
83	static $getters = array(
84	'id' => 'getId',
85	'reference_id' => 'getReferenceId',
86	'state' => 'getState',
87	'from_location_id' => 'getFromLocationId',
88	'to_location_id' => 'getToLocationId',
89	'catalog_object_id' => 'getCatalogObjectId',
90	'catalog_object_type' => 'getCatalogObjectType',
91	'quantity' => 'getQuantity',
92	'occurred_at' => 'getOccurredAt',
93	'created_at' => 'getCreatedAt',
94	'source' => 'getSource',
95	'employee_id' => 'getEmployeeId'
96	);
97
98	/**
99	* $id A unique ID generated by Square for the [InventoryTransfer](#type-inventorytransfer).
100	* @var string
101	*/
102	protected $id;
103	/**
104	* $reference_id An optional ID provided by the application to tie the [InventoryTransfer](#type-inventorytransfer) to an external system.
105	* @var string
106	*/
107	protected $reference_id;
108	/**
109	* $state The [InventoryState](#type-inventorystate) for the quantity of items being transfered. See [InventoryState](#type-inventorystate) for possible values
110	* @var string
111	*/
112	protected $state;
113	/**
114	* $from_location_id The Square ID of the [Location](#type-location) where the related quantity of items were tracked before the transfer.
115	* @var string
116	*/
117	protected $from_location_id;
118	/**
119	* $to_location_id The Square ID of the [Location](#type-location) where the related quantity of items were tracked after the transfer.
120	* @var string
121	*/
122	protected $to_location_id;
123	/**
124	* $catalog_object_id The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked.
125	* @var string
126	*/
127	protected $catalog_object_id;
128	/**
129	* $catalog_object_type The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked.Tracking is only supported for the `ITEM_VARIATION` type.
130	* @var string
131	*/
132	protected $catalog_object_type;
133	/**
134	* $quantity The number of items affected by the transfer 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.
135	* @var string
136	*/
137	protected $quantity;
138	/**
139	* $occurred_at A client-generated timestamp in RFC 3339 format that indicates when the transfer 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.
140	* @var string
141	*/
142	protected $occurred_at;
143	/**
144	* $created_at A read-only timestamp in RFC 3339 format that indicates when Square received the transfer request.
145	* @var string
146	*/
147	protected $created_at;
148	/**
149	* $source Read-only information about the application that initiated the inventory transfer.
150	* @var \SquareConnect\Model\SourceApplication
151	*/
152	protected $source;
153	/**
154	* $employee_id The Square ID of the [Employee](#type-employee) responsible for the inventory transfer.
155	* @var string
156	*/
157	protected $employee_id;
158
159	/**
160	* Constructor
161	* @param mixed[] $data Associated array of property value initializing the model
162	*/
163	public function __construct(array $data = null)
164	{
165	if ($data != null) {
166	if (isset($data["id"])) {
167	$this->id = $data["id"];
168	} else {
169	$this->id = null;
170	}
171	if (isset($data["reference_id"])) {
172	$this->reference_id = $data["reference_id"];
173	} else {
174	$this->reference_id = null;
175	}
176	if (isset($data["state"])) {
177	$this->state = $data["state"];
178	} else {
179	$this->state = null;
180	}
181	if (isset($data["from_location_id"])) {
182	$this->from_location_id = $data["from_location_id"];
183	} else {
184	$this->from_location_id = null;
185	}
186	if (isset($data["to_location_id"])) {
187	$this->to_location_id = $data["to_location_id"];
188	} else {
189	$this->to_location_id = null;
190	}
191	if (isset($data["catalog_object_id"])) {
192	$this->catalog_object_id = $data["catalog_object_id"];
193	} else {
194	$this->catalog_object_id = null;
195	}
196	if (isset($data["catalog_object_type"])) {
197	$this->catalog_object_type = $data["catalog_object_type"];
198	} else {
199	$this->catalog_object_type = null;
200	}
201	if (isset($data["quantity"])) {
202	$this->quantity = $data["quantity"];
203	} else {
204	$this->quantity = null;
205	}
206	if (isset($data["occurred_at"])) {
207	$this->occurred_at = $data["occurred_at"];
208	} else {
209	$this->occurred_at = null;
210	}
211	if (isset($data["created_at"])) {
212	$this->created_at = $data["created_at"];
213	} else {
214	$this->created_at = null;
215	}
216	if (isset($data["source"])) {
217	$this->source = $data["source"];
218	} else {
219	$this->source = null;
220	}
221	if (isset($data["employee_id"])) {
222	$this->employee_id = $data["employee_id"];
223	} else {
224	$this->employee_id = null;
225	}
226	}
227	}
228	/**
229	* Gets id
230	* @return string
231	*/
232	public function getId()
233	{
234	return $this->id;
235	}
236
237	/**
238	* Sets id
239	* @param string $id A unique ID generated by Square for the [InventoryTransfer](#type-inventorytransfer).
240	* @return $this
241	*/
242	public function setId($id)
243	{
244	$this->id = $id;
245	return $this;
246	}
247	/**
248	* Gets reference_id
249	* @return string
250	*/
251	public function getReferenceId()
252	{
253	return $this->reference_id;
254	}
255
256	/**
257	* Sets reference_id
258	* @param string $reference_id An optional ID provided by the application to tie the [InventoryTransfer](#type-inventorytransfer) to an external system.
259	* @return $this
260	*/
261	public function setReferenceId($reference_id)
262	{
263	$this->reference_id = $reference_id;
264	return $this;
265	}
266	/**
267	* Gets state
268	* @return string
269	*/
270	public function getState()
271	{
272	return $this->state;
273	}
274
275	/**
276	* Sets state
277	* @param string $state The [InventoryState](#type-inventorystate) for the quantity of items being transfered. See [InventoryState](#type-inventorystate) for possible values
278	* @return $this
279	*/
280	public function setState($state)
281	{
282	$this->state = $state;
283	return $this;
284	}
285	/**
286	* Gets from_location_id
287	* @return string
288	*/
289	public function getFromLocationId()
290	{
291	return $this->from_location_id;
292	}
293
294	/**
295	* Sets from_location_id
296	* @param string $from_location_id The Square ID of the [Location](#type-location) where the related quantity of items were tracked before the transfer.
297	* @return $this
298	*/
299	public function setFromLocationId($from_location_id)
300	{
301	$this->from_location_id = $from_location_id;
302	return $this;
303	}
304	/**
305	* Gets to_location_id
306	* @return string
307	*/
308	public function getToLocationId()
309	{
310	return $this->to_location_id;
311	}
312
313	/**
314	* Sets to_location_id
315	* @param string $to_location_id The Square ID of the [Location](#type-location) where the related quantity of items were tracked after the transfer.
316	* @return $this
317	*/
318	public function setToLocationId($to_location_id)
319	{
320	$this->to_location_id = $to_location_id;
321	return $this;
322	}
323	/**
324	* Gets catalog_object_id
325	* @return string
326	*/
327	public function getCatalogObjectId()
328	{
329	return $this->catalog_object_id;
330	}
331
332	/**
333	* Sets catalog_object_id
334	* @param string $catalog_object_id The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked.
335	* @return $this
336	*/
337	public function setCatalogObjectId($catalog_object_id)
338	{
339	$this->catalog_object_id = $catalog_object_id;
340	return $this;
341	}
342	/**
343	* Gets catalog_object_type
344	* @return string
345	*/
346	public function getCatalogObjectType()
347	{
348	return $this->catalog_object_type;
349	}
350
351	/**
352	* Sets catalog_object_type
353	* @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.
354	* @return $this
355	*/
356	public function setCatalogObjectType($catalog_object_type)
357	{
358	$this->catalog_object_type = $catalog_object_type;
359	return $this;
360	}
361	/**
362	* Gets quantity
363	* @return string
364	*/
365	public function getQuantity()
366	{
367	return $this->quantity;
368	}
369
370	/**
371	* Sets quantity
372	* @param string $quantity The number of items affected by the transfer 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.
373	* @return $this
374	*/
375	public function setQuantity($quantity)
376	{
377	$this->quantity = $quantity;
378	return $this;
379	}
380	/**
381	* Gets occurred_at
382	* @return string
383	*/
384	public function getOccurredAt()
385	{
386	return $this->occurred_at;
387	}
388
389	/**
390	* Sets occurred_at
391	* @param string $occurred_at A client-generated timestamp in RFC 3339 format that indicates when the transfer 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.
392	* @return $this
393	*/
394	public function setOccurredAt($occurred_at)
395	{
396	$this->occurred_at = $occurred_at;
397	return $this;
398	}
399	/**
400	* Gets created_at
401	* @return string
402	*/
403	public function getCreatedAt()
404	{
405	return $this->created_at;
406	}
407
408	/**
409	* Sets created_at
410	* @param string $created_at A read-only timestamp in RFC 3339 format that indicates when Square received the transfer request.
411	* @return $this
412	*/
413	public function setCreatedAt($created_at)
414	{
415	$this->created_at = $created_at;
416	return $this;
417	}
418	/**
419	* Gets source
420	* @return \SquareConnect\Model\SourceApplication
421	*/
422	public function getSource()
423	{
424	return $this->source;
425	}
426
427	/**
428	* Sets source
429	* @param \SquareConnect\Model\SourceApplication $source Read-only information about the application that initiated the inventory transfer.
430	* @return $this
431	*/
432	public function setSource($source)
433	{
434	$this->source = $source;
435	return $this;
436	}
437	/**
438	* Gets employee_id
439	* @return string
440	*/
441	public function getEmployeeId()
442	{
443	return $this->employee_id;
444	}
445
446	/**
447	* Sets employee_id
448	* @param string $employee_id The Square ID of the [Employee](#type-employee) responsible for the inventory transfer.
449	* @return $this
450	*/
451	public function setEmployeeId($employee_id)
452	{
453	$this->employee_id = $employee_id;
454	return $this;
455	}
456	/**
457	* Returns true if offset exists. False otherwise.
458	* @param integer $offset Offset
459	* @return boolean
460	*/
461	public function offsetExists($offset)
462	{
463	return isset($this->$offset);
464	}
465
466	/**
467	* Gets offset.
468	* @param integer $offset Offset
469	* @return mixed
470	*/
471	public function offsetGet($offset)
472	{
473	return $this->$offset;
474	}
475
476	/**
477	* Sets value based on offset.
478	* @param integer $offset Offset
479	* @param mixed $value Value to be set
480	* @return void
481	*/
482	public function offsetSet($offset, $value)
483	{
484	$this->$offset = $value;
485	}
486
487	/**
488	* Unsets offset.
489	* @param integer $offset Offset
490	* @return void
491	*/
492	public function offsetUnset($offset)
493	{
494	unset($this->$offset);
495	}
496
497	/**
498	* Gets the string presentation of the object
499	* @return string
500	*/
501	public function __toString()
502	{
503	if (defined('JSON_PRETTY_PRINT')) {
504	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT);
505	} else {
506	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this));
507	}
508	}
509	}
510