V1Item.php — WooCommerce Square 2.2.5

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

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

V1Item.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	* V1Item 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 V1Item 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	'name' => 'string',
29	'description' => 'string',
30	'type' => 'string',
31	'color' => 'string',
32	'abbreviation' => 'string',
33	'visibility' => 'string',
34	'available_online' => 'bool',
35	'master_image' => '\SquareConnect\Model\V1ItemImage',
36	'category' => '\SquareConnect\Model\V1Category',
37	'variations' => '\SquareConnect\Model\V1Variation[]',
38	'modifier_lists' => '\SquareConnect\Model\V1ModifierList[]',
39	'fees' => '\SquareConnect\Model\V1Fee[]',
40	'taxable' => 'bool',
41	'category_id' => 'string',
42	'available_for_pickup' => 'bool',
43	'v2_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	'name' => 'name',
53	'description' => 'description',
54	'type' => 'type',
55	'color' => 'color',
56	'abbreviation' => 'abbreviation',
57	'visibility' => 'visibility',
58	'available_online' => 'available_online',
59	'master_image' => 'master_image',
60	'category' => 'category',
61	'variations' => 'variations',
62	'modifier_lists' => 'modifier_lists',
63	'fees' => 'fees',
64	'taxable' => 'taxable',
65	'category_id' => 'category_id',
66	'available_for_pickup' => 'available_for_pickup',
67	'v2_id' => 'v2_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	'name' => 'setName',
77	'description' => 'setDescription',
78	'type' => 'setType',
79	'color' => 'setColor',
80	'abbreviation' => 'setAbbreviation',
81	'visibility' => 'setVisibility',
82	'available_online' => 'setAvailableOnline',
83	'master_image' => 'setMasterImage',
84	'category' => 'setCategory',
85	'variations' => 'setVariations',
86	'modifier_lists' => 'setModifierLists',
87	'fees' => 'setFees',
88	'taxable' => 'setTaxable',
89	'category_id' => 'setCategoryId',
90	'available_for_pickup' => 'setAvailableForPickup',
91	'v2_id' => 'setV2Id'
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	'name' => 'getName',
101	'description' => 'getDescription',
102	'type' => 'getType',
103	'color' => 'getColor',
104	'abbreviation' => 'getAbbreviation',
105	'visibility' => 'getVisibility',
106	'available_online' => 'getAvailableOnline',
107	'master_image' => 'getMasterImage',
108	'category' => 'getCategory',
109	'variations' => 'getVariations',
110	'modifier_lists' => 'getModifierLists',
111	'fees' => 'getFees',
112	'taxable' => 'getTaxable',
113	'category_id' => 'getCategoryId',
114	'available_for_pickup' => 'getAvailableForPickup',
115	'v2_id' => 'getV2Id'
116	);
117
118	/**
119	* $id The item's ID. Must be unique among all entity IDs ever provided on behalf of the merchant. You can never reuse an ID. This value can include alphanumeric characters, dashes (-), and underscores (_).
120	* @var string
121	*/
122	protected $id;
123	/**
124	* $name The item's name.
125	* @var string
126	*/
127	protected $name;
128	/**
129	* $description The item's description.
130	* @var string
131	*/
132	protected $description;
133	/**
134	* $type The item's type. This value is NORMAL for almost all items. See [V1ItemType](#type-v1itemtype) for possible values
135	* @var string
136	*/
137	protected $type;
138	/**
139	* $color The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values
140	* @var string
141	*/
142	protected $color;
143	/**
144	* $abbreviation The text of the item's display label in Square Register. Only up to the first five characters of the string are used.
145	* @var string
146	*/
147	protected $abbreviation;
148	/**
149	* $visibility Indicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE. See [V1ItemVisibility](#type-v1itemvisibility) for possible values
150	* @var string
151	*/
152	protected $visibility;
153	/**
154	* $available_online If true, the item can be added to shipping orders from the merchant's online store.
155	* @var bool
156	*/
157	protected $available_online;
158	/**
159	* $master_image The item's master image, if any.
160	* @var \SquareConnect\Model\V1ItemImage
161	*/
162	protected $master_image;
163	/**
164	* $category The category the item belongs to, if any.
165	* @var \SquareConnect\Model\V1Category
166	*/
167	protected $category;
168	/**
169	* $variations The item's variations. You must specify at least one variation.
170	* @var \SquareConnect\Model\V1Variation[]
171	*/
172	protected $variations;
173	/**
174	* $modifier_lists The modifier lists that apply to the item, if any.
175	* @var \SquareConnect\Model\V1ModifierList[]
176	*/
177	protected $modifier_lists;
178	/**
179	* $fees The fees that apply to the item, if any.
180	* @var \SquareConnect\Model\V1Fee[]
181	*/
182	protected $fees;
183	/**
184	* $taxable Deprecated. This field is not used.
185	* @var bool
186	*/
187	protected $taxable;
188	/**
189	* $category_id The ID of the item's category, if any.
190	* @var string
191	*/
192	protected $category_id;
193	/**
194	* $available_for_pickup If true, the item can be added to pickup orders from the merchant's online store. Default value: false
195	* @var bool
196	*/
197	protected $available_for_pickup;
198	/**
199	* $v2_id The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.
200	* @var string
201	*/
202	protected $v2_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["name"])) {
217	$this->name = $data["name"];
218	} else {
219	$this->name = null;
220	}
221	if (isset($data["description"])) {
222	$this->description = $data["description"];
223	} else {
224	$this->description = null;
225	}
226	if (isset($data["type"])) {
227	$this->type = $data["type"];
228	} else {
229	$this->type = null;
230	}
231	if (isset($data["color"])) {
232	$this->color = $data["color"];
233	} else {
234	$this->color = null;
235	}
236	if (isset($data["abbreviation"])) {
237	$this->abbreviation = $data["abbreviation"];
238	} else {
239	$this->abbreviation = null;
240	}
241	if (isset($data["visibility"])) {
242	$this->visibility = $data["visibility"];
243	} else {
244	$this->visibility = null;
245	}
246	if (isset($data["available_online"])) {
247	$this->available_online = $data["available_online"];
248	} else {
249	$this->available_online = null;
250	}
251	if (isset($data["master_image"])) {
252	$this->master_image = $data["master_image"];
253	} else {
254	$this->master_image = null;
255	}
256	if (isset($data["category"])) {
257	$this->category = $data["category"];
258	} else {
259	$this->category = null;
260	}
261	if (isset($data["variations"])) {
262	$this->variations = $data["variations"];
263	} else {
264	$this->variations = null;
265	}
266	if (isset($data["modifier_lists"])) {
267	$this->modifier_lists = $data["modifier_lists"];
268	} else {
269	$this->modifier_lists = null;
270	}
271	if (isset($data["fees"])) {
272	$this->fees = $data["fees"];
273	} else {
274	$this->fees = null;
275	}
276	if (isset($data["taxable"])) {
277	$this->taxable = $data["taxable"];
278	} else {
279	$this->taxable = null;
280	}
281	if (isset($data["category_id"])) {
282	$this->category_id = $data["category_id"];
283	} else {
284	$this->category_id = null;
285	}
286	if (isset($data["available_for_pickup"])) {
287	$this->available_for_pickup = $data["available_for_pickup"];
288	} else {
289	$this->available_for_pickup = null;
290	}
291	if (isset($data["v2_id"])) {
292	$this->v2_id = $data["v2_id"];
293	} else {
294	$this->v2_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 The item's ID. Must be unique among all entity IDs ever provided on behalf of the merchant. You can never reuse an ID. This value can include alphanumeric characters, dashes (-), and underscores (_).
310	* @return $this
311	*/
312	public function setId($id)
313	{
314	$this->id = $id;
315	return $this;
316	}
317	/**
318	* Gets name
319	* @return string
320	*/
321	public function getName()
322	{
323	return $this->name;
324	}
325
326	/**
327	* Sets name
328	* @param string $name The item's name.
329	* @return $this
330	*/
331	public function setName($name)
332	{
333	$this->name = $name;
334	return $this;
335	}
336	/**
337	* Gets description
338	* @return string
339	*/
340	public function getDescription()
341	{
342	return $this->description;
343	}
344
345	/**
346	* Sets description
347	* @param string $description The item's description.
348	* @return $this
349	*/
350	public function setDescription($description)
351	{
352	$this->description = $description;
353	return $this;
354	}
355	/**
356	* Gets type
357	* @return string
358	*/
359	public function getType()
360	{
361	return $this->type;
362	}
363
364	/**
365	* Sets type
366	* @param string $type The item's type. This value is NORMAL for almost all items. See [V1ItemType](#type-v1itemtype) for possible values
367	* @return $this
368	*/
369	public function setType($type)
370	{
371	$this->type = $type;
372	return $this;
373	}
374	/**
375	* Gets color
376	* @return string
377	*/
378	public function getColor()
379	{
380	return $this->color;
381	}
382
383	/**
384	* Sets color
385	* @param string $color The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values
386	* @return $this
387	*/
388	public function setColor($color)
389	{
390	$this->color = $color;
391	return $this;
392	}
393	/**
394	* Gets abbreviation
395	* @return string
396	*/
397	public function getAbbreviation()
398	{
399	return $this->abbreviation;
400	}
401
402	/**
403	* Sets abbreviation
404	* @param string $abbreviation The text of the item's display label in Square Register. Only up to the first five characters of the string are used.
405	* @return $this
406	*/
407	public function setAbbreviation($abbreviation)
408	{
409	$this->abbreviation = $abbreviation;
410	return $this;
411	}
412	/**
413	* Gets visibility
414	* @return string
415	*/
416	public function getVisibility()
417	{
418	return $this->visibility;
419	}
420
421	/**
422	* Sets visibility
423	* @param string $visibility Indicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE. See [V1ItemVisibility](#type-v1itemvisibility) for possible values
424	* @return $this
425	*/
426	public function setVisibility($visibility)
427	{
428	$this->visibility = $visibility;
429	return $this;
430	}
431	/**
432	* Gets available_online
433	* @return bool
434	*/
435	public function getAvailableOnline()
436	{
437	return $this->available_online;
438	}
439
440	/**
441	* Sets available_online
442	* @param bool $available_online If true, the item can be added to shipping orders from the merchant's online store.
443	* @return $this
444	*/
445	public function setAvailableOnline($available_online)
446	{
447	$this->available_online = $available_online;
448	return $this;
449	}
450	/**
451	* Gets master_image
452	* @return \SquareConnect\Model\V1ItemImage
453	*/
454	public function getMasterImage()
455	{
456	return $this->master_image;
457	}
458
459	/**
460	* Sets master_image
461	* @param \SquareConnect\Model\V1ItemImage $master_image The item's master image, if any.
462	* @return $this
463	*/
464	public function setMasterImage($master_image)
465	{
466	$this->master_image = $master_image;
467	return $this;
468	}
469	/**
470	* Gets category
471	* @return \SquareConnect\Model\V1Category
472	*/
473	public function getCategory()
474	{
475	return $this->category;
476	}
477
478	/**
479	* Sets category
480	* @param \SquareConnect\Model\V1Category $category The category the item belongs to, if any.
481	* @return $this
482	*/
483	public function setCategory($category)
484	{
485	$this->category = $category;
486	return $this;
487	}
488	/**
489	* Gets variations
490	* @return \SquareConnect\Model\V1Variation[]
491	*/
492	public function getVariations()
493	{
494	return $this->variations;
495	}
496
497	/**
498	* Sets variations
499	* @param \SquareConnect\Model\V1Variation[] $variations The item's variations. You must specify at least one variation.
500	* @return $this
501	*/
502	public function setVariations($variations)
503	{
504	$this->variations = $variations;
505	return $this;
506	}
507	/**
508	* Gets modifier_lists
509	* @return \SquareConnect\Model\V1ModifierList[]
510	*/
511	public function getModifierLists()
512	{
513	return $this->modifier_lists;
514	}
515
516	/**
517	* Sets modifier_lists
518	* @param \SquareConnect\Model\V1ModifierList[] $modifier_lists The modifier lists that apply to the item, if any.
519	* @return $this
520	*/
521	public function setModifierLists($modifier_lists)
522	{
523	$this->modifier_lists = $modifier_lists;
524	return $this;
525	}
526	/**
527	* Gets fees
528	* @return \SquareConnect\Model\V1Fee[]
529	*/
530	public function getFees()
531	{
532	return $this->fees;
533	}
534
535	/**
536	* Sets fees
537	* @param \SquareConnect\Model\V1Fee[] $fees The fees that apply to the item, if any.
538	* @return $this
539	*/
540	public function setFees($fees)
541	{
542	$this->fees = $fees;
543	return $this;
544	}
545	/**
546	* Gets taxable
547	* @return bool
548	*/
549	public function getTaxable()
550	{
551	return $this->taxable;
552	}
553
554	/**
555	* Sets taxable
556	* @param bool $taxable Deprecated. This field is not used.
557	* @return $this
558	*/
559	public function setTaxable($taxable)
560	{
561	$this->taxable = $taxable;
562	return $this;
563	}
564	/**
565	* Gets category_id
566	* @return string
567	*/
568	public function getCategoryId()
569	{
570	return $this->category_id;
571	}
572
573	/**
574	* Sets category_id
575	* @param string $category_id The ID of the item's category, if any.
576	* @return $this
577	*/
578	public function setCategoryId($category_id)
579	{
580	$this->category_id = $category_id;
581	return $this;
582	}
583	/**
584	* Gets available_for_pickup
585	* @return bool
586	*/
587	public function getAvailableForPickup()
588	{
589	return $this->available_for_pickup;
590	}
591
592	/**
593	* Sets available_for_pickup
594	* @param bool $available_for_pickup If true, the item can be added to pickup orders from the merchant's online store. Default value: false
595	* @return $this
596	*/
597	public function setAvailableForPickup($available_for_pickup)
598	{
599	$this->available_for_pickup = $available_for_pickup;
600	return $this;
601	}
602	/**
603	* Gets v2_id
604	* @return string
605	*/
606	public function getV2Id()
607	{
608	return $this->v2_id;
609	}
610
611	/**
612	* Sets v2_id
613	* @param string $v2_id The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.
614	* @return $this
615	*/
616	public function setV2Id($v2_id)
617	{
618	$this->v2_id = $v2_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