BatchRetrieveInventoryChangesRequest.php — WooCommerce Square 2.2.5

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

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

BatchRetrieveInventoryChangesRequest.php

345 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	* BatchRetrieveInventoryChangesRequest 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 BatchRetrieveInventoryChangesRequest implements ArrayAccess
21	{
22	/**
23	* Array of property to type mappings. Used for (de)serialization
24	* @var string[]
25	*/
26	static $swaggerTypes = array(
27	'catalog_object_ids' => 'string[]',
28	'location_ids' => 'string[]',
29	'types' => 'string[]',
30	'states' => 'string[]',
31	'updated_after' => 'string',
32	'updated_before' => 'string',
33	'cursor' => 'string'
34	);
35
36	/**
37	* Array of attributes where the key is the local name, and the value is the original name
38	* @var string[]
39	*/
40	static $attributeMap = array(
41	'catalog_object_ids' => 'catalog_object_ids',
42	'location_ids' => 'location_ids',
43	'types' => 'types',
44	'states' => 'states',
45	'updated_after' => 'updated_after',
46	'updated_before' => 'updated_before',
47	'cursor' => 'cursor'
48	);
49
50	/**
51	* Array of attributes to setter functions (for deserialization of responses)
52	* @var string[]
53	*/
54	static $setters = array(
55	'catalog_object_ids' => 'setCatalogObjectIds',
56	'location_ids' => 'setLocationIds',
57	'types' => 'setTypes',
58	'states' => 'setStates',
59	'updated_after' => 'setUpdatedAfter',
60	'updated_before' => 'setUpdatedBefore',
61	'cursor' => 'setCursor'
62	);
63
64	/**
65	* Array of attributes to getter functions (for serialization of requests)
66	* @var string[]
67	*/
68	static $getters = array(
69	'catalog_object_ids' => 'getCatalogObjectIds',
70	'location_ids' => 'getLocationIds',
71	'types' => 'getTypes',
72	'states' => 'getStates',
73	'updated_after' => 'getUpdatedAfter',
74	'updated_before' => 'getUpdatedBefore',
75	'cursor' => 'getCursor'
76	);
77
78	/**
79	* $catalog_object_ids Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset.
80	* @var string[]
81	*/
82	protected $catalog_object_ids;
83	/**
84	* $location_ids Filters results by [Location](#type-location) ID. Only applied when set. Default: unset.
85	* @var string[]
86	*/
87	protected $location_ids;
88	/**
89	* $types Filters results by [InventoryChangeType](#type-inventorychangetype). Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. See [InventoryChangeType](#type-inventorychangetype) for possible values
90	* @var string[]
91	*/
92	protected $types;
93	/**
94	* $states Filters `ADJUSTMENT` query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. See [InventoryState](#type-inventorystate) for possible values
95	* @var string[]
96	*/
97	protected $states;
98	/**
99	* $updated_after 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`).
100	* @var string
101	*/
102	protected $updated_after;
103	/**
104	* $updated_before 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`).
105	* @var string
106	*/
107	protected $updated_before;
108	/**
109	* $cursor 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.
110	* @var string
111	*/
112	protected $cursor;
113
114	/**
115	* Constructor
116	* @param mixed[] $data Associated array of property value initializing the model
117	*/
118	public function __construct(array $data = null)
119	{
120	if ($data != null) {
121	if (isset($data["catalog_object_ids"])) {
122	$this->catalog_object_ids = $data["catalog_object_ids"];
123	} else {
124	$this->catalog_object_ids = null;
125	}
126	if (isset($data["location_ids"])) {
127	$this->location_ids = $data["location_ids"];
128	} else {
129	$this->location_ids = null;
130	}
131	if (isset($data["types"])) {
132	$this->types = $data["types"];
133	} else {
134	$this->types = null;
135	}
136	if (isset($data["states"])) {
137	$this->states = $data["states"];
138	} else {
139	$this->states = null;
140	}
141	if (isset($data["updated_after"])) {
142	$this->updated_after = $data["updated_after"];
143	} else {
144	$this->updated_after = null;
145	}
146	if (isset($data["updated_before"])) {
147	$this->updated_before = $data["updated_before"];
148	} else {
149	$this->updated_before = null;
150	}
151	if (isset($data["cursor"])) {
152	$this->cursor = $data["cursor"];
153	} else {
154	$this->cursor = null;
155	}
156	}
157	}
158	/**
159	* Gets catalog_object_ids
160	* @return string[]
161	*/
162	public function getCatalogObjectIds()
163	{
164	return $this->catalog_object_ids;
165	}
166
167	/**
168	* Sets catalog_object_ids
169	* @param string[] $catalog_object_ids Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset.
170	* @return $this
171	*/
172	public function setCatalogObjectIds($catalog_object_ids)
173	{
174	$this->catalog_object_ids = $catalog_object_ids;
175	return $this;
176	}
177	/**
178	* Gets location_ids
179	* @return string[]
180	*/
181	public function getLocationIds()
182	{
183	return $this->location_ids;
184	}
185
186	/**
187	* Sets location_ids
188	* @param string[] $location_ids Filters results by [Location](#type-location) ID. Only applied when set. Default: unset.
189	* @return $this
190	*/
191	public function setLocationIds($location_ids)
192	{
193	$this->location_ids = $location_ids;
194	return $this;
195	}
196	/**
197	* Gets types
198	* @return string[]
199	*/
200	public function getTypes()
201	{
202	return $this->types;
203	}
204
205	/**
206	* Sets types
207	* @param string[] $types Filters results by [InventoryChangeType](#type-inventorychangetype). Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. See [InventoryChangeType](#type-inventorychangetype) for possible values
208	* @return $this
209	*/
210	public function setTypes($types)
211	{
212	$this->types = $types;
213	return $this;
214	}
215	/**
216	* Gets states
217	* @return string[]
218	*/
219	public function getStates()
220	{
221	return $this->states;
222	}
223
224	/**
225	* Sets states
226	* @param string[] $states Filters `ADJUSTMENT` query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. See [InventoryState](#type-inventorystate) for possible values
227	* @return $this
228	*/
229	public function setStates($states)
230	{
231	$this->states = $states;
232	return $this;
233	}
234	/**
235	* Gets updated_after
236	* @return string
237	*/
238	public function getUpdatedAfter()
239	{
240	return $this->updated_after;
241	}
242
243	/**
244	* Sets updated_after
245	* @param string $updated_after 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`).
246	* @return $this
247	*/
248	public function setUpdatedAfter($updated_after)
249	{
250	$this->updated_after = $updated_after;
251	return $this;
252	}
253	/**
254	* Gets updated_before
255	* @return string
256	*/
257	public function getUpdatedBefore()
258	{
259	return $this->updated_before;
260	}
261
262	/**
263	* Sets updated_before
264	* @param string $updated_before 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`).
265	* @return $this
266	*/
267	public function setUpdatedBefore($updated_before)
268	{
269	$this->updated_before = $updated_before;
270	return $this;
271	}
272	/**
273	* Gets cursor
274	* @return string
275	*/
276	public function getCursor()
277	{
278	return $this->cursor;
279	}
280
281	/**
282	* Sets cursor
283	* @param string $cursor 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.
284	* @return $this
285	*/
286	public function setCursor($cursor)
287	{
288	$this->cursor = $cursor;
289	return $this;
290	}
291	/**
292	* Returns true if offset exists. False otherwise.
293	* @param integer $offset Offset
294	* @return boolean
295	*/
296	public function offsetExists($offset)
297	{
298	return isset($this->$offset);
299	}
300
301	/**
302	* Gets offset.
303	* @param integer $offset Offset
304	* @return mixed
305	*/
306	public function offsetGet($offset)
307	{
308	return $this->$offset;
309	}
310
311	/**
312	* Sets value based on offset.
313	* @param integer $offset Offset
314	* @param mixed $value Value to be set
315	* @return void
316	*/
317	public function offsetSet($offset, $value)
318	{
319	$this->$offset = $value;
320	}
321
322	/**
323	* Unsets offset.
324	* @param integer $offset Offset
325	* @return void
326	*/
327	public function offsetUnset($offset)
328	{
329	unset($this->$offset);
330	}
331
332	/**
333	* Gets the string presentation of the object
334	* @return string
335	*/
336	public function __toString()
337	{
338	if (defined('JSON_PRETTY_PRINT')) {
339	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT);
340	} else {
341	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this));
342	}
343	}
344	}
345