SearchCatalogObjectsRequest.php — WooCommerce Square 2.2.5

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

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

SearchCatalogObjectsRequest.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	* SearchCatalogObjectsRequest 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 SearchCatalogObjectsRequest implements ArrayAccess
21	{
22	/**
23	* Array of property to type mappings. Used for (de)serialization
24	* @var string[]
25	*/
26	static $swaggerTypes = array(
27	'cursor' => 'string',
28	'object_types' => 'string[]',
29	'include_deleted_objects' => 'bool',
30	'include_related_objects' => 'bool',
31	'begin_time' => 'string',
32	'query' => '\SquareConnect\Model\CatalogQuery',
33	'limit' => 'int'
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	'cursor' => 'cursor',
42	'object_types' => 'object_types',
43	'include_deleted_objects' => 'include_deleted_objects',
44	'include_related_objects' => 'include_related_objects',
45	'begin_time' => 'begin_time',
46	'query' => 'query',
47	'limit' => 'limit'
48	);
49
50	/**
51	* Array of attributes to setter functions (for deserialization of responses)
52	* @var string[]
53	*/
54	static $setters = array(
55	'cursor' => 'setCursor',
56	'object_types' => 'setObjectTypes',
57	'include_deleted_objects' => 'setIncludeDeletedObjects',
58	'include_related_objects' => 'setIncludeRelatedObjects',
59	'begin_time' => 'setBeginTime',
60	'query' => 'setQuery',
61	'limit' => 'setLimit'
62	);
63
64	/**
65	* Array of attributes to getter functions (for serialization of requests)
66	* @var string[]
67	*/
68	static $getters = array(
69	'cursor' => 'getCursor',
70	'object_types' => 'getObjectTypes',
71	'include_deleted_objects' => 'getIncludeDeletedObjects',
72	'include_related_objects' => 'getIncludeRelatedObjects',
73	'begin_time' => 'getBeginTime',
74	'query' => 'getQuery',
75	'limit' => 'getLimit'
76	);
77
78	/**
79	* $cursor The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/basics/api101/pagination) for more information.
80	* @var string
81	*/
82	protected $cursor;
83	/**
84	* $object_types The desired set of object types to appear in the search results. The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. See [CatalogObjectType](#type-catalogobjecttype) for possible values
85	* @var string[]
86	*/
87	protected $object_types;
88	/**
89	* $include_deleted_objects If `true`, deleted objects will be included in the results. Deleted objects will have their `is_deleted` field set to `true`.
90	* @var bool
91	*/
92	protected $include_deleted_objects;
93	/**
94	* $include_related_objects If `true`, the response will include additional objects that are related to the requested object, as follows: If a [CatalogItem](#type-catalogitem) is returned in the object field of the response, its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, [CatalogImage](#type-catalogimage)s and [CatalogModifierList](#type-catalogmodifierlist)s will be included in the `related_objects` field of the response. If a [CatalogItemVariation](#type-catalogitemvariation) is returned in the object field of the response, its parent [CatalogItem](#type-catalogitem) will be included in the `related_objects` field of the response.
95	* @var bool
96	*/
97	protected $include_related_objects;
98	/**
99	* $begin_time Return objects modified after this [timestamp](#workingwithdates), in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". The timestamp is exclusive - objects with a timestamp equal to `begin_time` will not be included in the response.
100	* @var string
101	*/
102	protected $begin_time;
103	/**
104	* $query A query to be used to filter or sort the results. If no query is specified, the entire catalog will be returned.
105	* @var \SquareConnect\Model\CatalogQuery
106	*/
107	protected $query;
108	/**
109	* $limit A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. If the supplied limit is negative, zero, or is higher than the maximum limit of 1,000, it will be ignored.
110	* @var int
111	*/
112	protected $limit;
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["cursor"])) {
122	$this->cursor = $data["cursor"];
123	} else {
124	$this->cursor = null;
125	}
126	if (isset($data["object_types"])) {
127	$this->object_types = $data["object_types"];
128	} else {
129	$this->object_types = null;
130	}
131	if (isset($data["include_deleted_objects"])) {
132	$this->include_deleted_objects = $data["include_deleted_objects"];
133	} else {
134	$this->include_deleted_objects = null;
135	}
136	if (isset($data["include_related_objects"])) {
137	$this->include_related_objects = $data["include_related_objects"];
138	} else {
139	$this->include_related_objects = null;
140	}
141	if (isset($data["begin_time"])) {
142	$this->begin_time = $data["begin_time"];
143	} else {
144	$this->begin_time = null;
145	}
146	if (isset($data["query"])) {
147	$this->query = $data["query"];
148	} else {
149	$this->query = null;
150	}
151	if (isset($data["limit"])) {
152	$this->limit = $data["limit"];
153	} else {
154	$this->limit = null;
155	}
156	}
157	}
158	/**
159	* Gets cursor
160	* @return string
161	*/
162	public function getCursor()
163	{
164	return $this->cursor;
165	}
166
167	/**
168	* Sets cursor
169	* @param string $cursor The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/basics/api101/pagination) for more information.
170	* @return $this
171	*/
172	public function setCursor($cursor)
173	{
174	$this->cursor = $cursor;
175	return $this;
176	}
177	/**
178	* Gets object_types
179	* @return string[]
180	*/
181	public function getObjectTypes()
182	{
183	return $this->object_types;
184	}
185
186	/**
187	* Sets object_types
188	* @param string[] $object_types The desired set of object types to appear in the search results. The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. See [CatalogObjectType](#type-catalogobjecttype) for possible values
189	* @return $this
190	*/
191	public function setObjectTypes($object_types)
192	{
193	$this->object_types = $object_types;
194	return $this;
195	}
196	/**
197	* Gets include_deleted_objects
198	* @return bool
199	*/
200	public function getIncludeDeletedObjects()
201	{
202	return $this->include_deleted_objects;
203	}
204
205	/**
206	* Sets include_deleted_objects
207	* @param bool $include_deleted_objects If `true`, deleted objects will be included in the results. Deleted objects will have their `is_deleted` field set to `true`.
208	* @return $this
209	*/
210	public function setIncludeDeletedObjects($include_deleted_objects)
211	{
212	$this->include_deleted_objects = $include_deleted_objects;
213	return $this;
214	}
215	/**
216	* Gets include_related_objects
217	* @return bool
218	*/
219	public function getIncludeRelatedObjects()
220	{
221	return $this->include_related_objects;
222	}
223
224	/**
225	* Sets include_related_objects
226	* @param bool $include_related_objects If `true`, the response will include additional objects that are related to the requested object, as follows: If a [CatalogItem](#type-catalogitem) is returned in the object field of the response, its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, [CatalogImage](#type-catalogimage)s and [CatalogModifierList](#type-catalogmodifierlist)s will be included in the `related_objects` field of the response. If a [CatalogItemVariation](#type-catalogitemvariation) is returned in the object field of the response, its parent [CatalogItem](#type-catalogitem) will be included in the `related_objects` field of the response.
227	* @return $this
228	*/
229	public function setIncludeRelatedObjects($include_related_objects)
230	{
231	$this->include_related_objects = $include_related_objects;
232	return $this;
233	}
234	/**
235	* Gets begin_time
236	* @return string
237	*/
238	public function getBeginTime()
239	{
240	return $this->begin_time;
241	}
242
243	/**
244	* Sets begin_time
245	* @param string $begin_time Return objects modified after this [timestamp](#workingwithdates), in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". The timestamp is exclusive - objects with a timestamp equal to `begin_time` will not be included in the response.
246	* @return $this
247	*/
248	public function setBeginTime($begin_time)
249	{
250	$this->begin_time = $begin_time;
251	return $this;
252	}
253	/**
254	* Gets query
255	* @return \SquareConnect\Model\CatalogQuery
256	*/
257	public function getQuery()
258	{
259	return $this->query;
260	}
261
262	/**
263	* Sets query
264	* @param \SquareConnect\Model\CatalogQuery $query A query to be used to filter or sort the results. If no query is specified, the entire catalog will be returned.
265	* @return $this
266	*/
267	public function setQuery($query)
268	{
269	$this->query = $query;
270	return $this;
271	}
272	/**
273	* Gets limit
274	* @return int
275	*/
276	public function getLimit()
277	{
278	return $this->limit;
279	}
280
281	/**
282	* Sets limit
283	* @param int $limit A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. If the supplied limit is negative, zero, or is higher than the maximum limit of 1,000, it will be ignored.
284	* @return $this
285	*/
286	public function setLimit($limit)
287	{
288	$this->limit = $limit;
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