V1Variation.php — WooCommerce Square 2.2.5

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

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

V1Variation.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	* V1Variation 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 V1Variation 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	'item_id' => 'string',
30	'ordinal' => 'int',
31	'pricing_type' => 'string',
32	'price_money' => '\SquareConnect\Model\V1Money',
33	'sku' => 'string',
34	'track_inventory' => 'bool',
35	'inventory_alert_type' => 'string',
36	'inventory_alert_threshold' => 'int',
37	'user_data' => 'string',
38	'v2_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	'name' => 'name',
48	'item_id' => 'item_id',
49	'ordinal' => 'ordinal',
50	'pricing_type' => 'pricing_type',
51	'price_money' => 'price_money',
52	'sku' => 'sku',
53	'track_inventory' => 'track_inventory',
54	'inventory_alert_type' => 'inventory_alert_type',
55	'inventory_alert_threshold' => 'inventory_alert_threshold',
56	'user_data' => 'user_data',
57	'v2_id' => 'v2_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	'name' => 'setName',
67	'item_id' => 'setItemId',
68	'ordinal' => 'setOrdinal',
69	'pricing_type' => 'setPricingType',
70	'price_money' => 'setPriceMoney',
71	'sku' => 'setSku',
72	'track_inventory' => 'setTrackInventory',
73	'inventory_alert_type' => 'setInventoryAlertType',
74	'inventory_alert_threshold' => 'setInventoryAlertThreshold',
75	'user_data' => 'setUserData',
76	'v2_id' => 'setV2Id'
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	'name' => 'getName',
86	'item_id' => 'getItemId',
87	'ordinal' => 'getOrdinal',
88	'pricing_type' => 'getPricingType',
89	'price_money' => 'getPriceMoney',
90	'sku' => 'getSku',
91	'track_inventory' => 'getTrackInventory',
92	'inventory_alert_type' => 'getInventoryAlertType',
93	'inventory_alert_threshold' => 'getInventoryAlertThreshold',
94	'user_data' => 'getUserData',
95	'v2_id' => 'getV2Id'
96	);
97
98	/**
99	* $id The item variation's unique ID.
100	* @var string
101	*/
102	protected $id;
103	/**
104	* $name The item variation's name.
105	* @var string
106	*/
107	protected $name;
108	/**
109	* $item_id The ID of the variation's associated item.
110	* @var string
111	*/
112	protected $item_id;
113	/**
114	* $ordinal Indicates the variation's list position when displayed in Square Register and the merchant dashboard. If more than one variation for the same item has the same ordinal value, those variations are displayed in alphabetical order
115	* @var int
116	*/
117	protected $ordinal;
118	/**
119	* $pricing_type Indicates whether the item variation's price is fixed or determined at the time of sale. See [V1VariationPricingType](#type-v1variationpricingtype) for possible values
120	* @var string
121	*/
122	protected $pricing_type;
123	/**
124	* $price_money The item variation's price, if any.
125	* @var \SquareConnect\Model\V1Money
126	*/
127	protected $price_money;
128	/**
129	* $sku The item variation's SKU, if any.
130	* @var string
131	*/
132	protected $sku;
133	/**
134	* $track_inventory If true, inventory tracking is active for the variation.
135	* @var bool
136	*/
137	protected $track_inventory;
138	/**
139	* $inventory_alert_type Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its inventory_alert_threshold. See [V1VariationInventoryAlertType](#type-v1variationinventoryalerttype) for possible values
140	* @var string
141	*/
142	protected $inventory_alert_type;
143	/**
144	* $inventory_alert_threshold If the inventory quantity for the variation is less than or equal to this value and inventory_alert_type is LOW_QUANTITY, the variation displays an alert in the merchant dashboard.
145	* @var int
146	*/
147	protected $inventory_alert_threshold;
148	/**
149	* $user_data Arbitrary metadata associated with the variation. Cannot exceed 255 characters.
150	* @var string
151	*/
152	protected $user_data;
153	/**
154	* $v2_id The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.
155	* @var string
156	*/
157	protected $v2_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["name"])) {
172	$this->name = $data["name"];
173	} else {
174	$this->name = null;
175	}
176	if (isset($data["item_id"])) {
177	$this->item_id = $data["item_id"];
178	} else {
179	$this->item_id = null;
180	}
181	if (isset($data["ordinal"])) {
182	$this->ordinal = $data["ordinal"];
183	} else {
184	$this->ordinal = null;
185	}
186	if (isset($data["pricing_type"])) {
187	$this->pricing_type = $data["pricing_type"];
188	} else {
189	$this->pricing_type = null;
190	}
191	if (isset($data["price_money"])) {
192	$this->price_money = $data["price_money"];
193	} else {
194	$this->price_money = null;
195	}
196	if (isset($data["sku"])) {
197	$this->sku = $data["sku"];
198	} else {
199	$this->sku = null;
200	}
201	if (isset($data["track_inventory"])) {
202	$this->track_inventory = $data["track_inventory"];
203	} else {
204	$this->track_inventory = null;
205	}
206	if (isset($data["inventory_alert_type"])) {
207	$this->inventory_alert_type = $data["inventory_alert_type"];
208	} else {
209	$this->inventory_alert_type = null;
210	}
211	if (isset($data["inventory_alert_threshold"])) {
212	$this->inventory_alert_threshold = $data["inventory_alert_threshold"];
213	} else {
214	$this->inventory_alert_threshold = null;
215	}
216	if (isset($data["user_data"])) {
217	$this->user_data = $data["user_data"];
218	} else {
219	$this->user_data = null;
220	}
221	if (isset($data["v2_id"])) {
222	$this->v2_id = $data["v2_id"];
223	} else {
224	$this->v2_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 The item variation's unique ID.
240	* @return $this
241	*/
242	public function setId($id)
243	{
244	$this->id = $id;
245	return $this;
246	}
247	/**
248	* Gets name
249	* @return string
250	*/
251	public function getName()
252	{
253	return $this->name;
254	}
255
256	/**
257	* Sets name
258	* @param string $name The item variation's name.
259	* @return $this
260	*/
261	public function setName($name)
262	{
263	$this->name = $name;
264	return $this;
265	}
266	/**
267	* Gets item_id
268	* @return string
269	*/
270	public function getItemId()
271	{
272	return $this->item_id;
273	}
274
275	/**
276	* Sets item_id
277	* @param string $item_id The ID of the variation's associated item.
278	* @return $this
279	*/
280	public function setItemId($item_id)
281	{
282	$this->item_id = $item_id;
283	return $this;
284	}
285	/**
286	* Gets ordinal
287	* @return int
288	*/
289	public function getOrdinal()
290	{
291	return $this->ordinal;
292	}
293
294	/**
295	* Sets ordinal
296	* @param int $ordinal Indicates the variation's list position when displayed in Square Register and the merchant dashboard. If more than one variation for the same item has the same ordinal value, those variations are displayed in alphabetical order
297	* @return $this
298	*/
299	public function setOrdinal($ordinal)
300	{
301	$this->ordinal = $ordinal;
302	return $this;
303	}
304	/**
305	* Gets pricing_type
306	* @return string
307	*/
308	public function getPricingType()
309	{
310	return $this->pricing_type;
311	}
312
313	/**
314	* Sets pricing_type
315	* @param string $pricing_type Indicates whether the item variation's price is fixed or determined at the time of sale. See [V1VariationPricingType](#type-v1variationpricingtype) for possible values
316	* @return $this
317	*/
318	public function setPricingType($pricing_type)
319	{
320	$this->pricing_type = $pricing_type;
321	return $this;
322	}
323	/**
324	* Gets price_money
325	* @return \SquareConnect\Model\V1Money
326	*/
327	public function getPriceMoney()
328	{
329	return $this->price_money;
330	}
331
332	/**
333	* Sets price_money
334	* @param \SquareConnect\Model\V1Money $price_money The item variation's price, if any.
335	* @return $this
336	*/
337	public function setPriceMoney($price_money)
338	{
339	$this->price_money = $price_money;
340	return $this;
341	}
342	/**
343	* Gets sku
344	* @return string
345	*/
346	public function getSku()
347	{
348	return $this->sku;
349	}
350
351	/**
352	* Sets sku
353	* @param string $sku The item variation's SKU, if any.
354	* @return $this
355	*/
356	public function setSku($sku)
357	{
358	$this->sku = $sku;
359	return $this;
360	}
361	/**
362	* Gets track_inventory
363	* @return bool
364	*/
365	public function getTrackInventory()
366	{
367	return $this->track_inventory;
368	}
369
370	/**
371	* Sets track_inventory
372	* @param bool $track_inventory If true, inventory tracking is active for the variation.
373	* @return $this
374	*/
375	public function setTrackInventory($track_inventory)
376	{
377	$this->track_inventory = $track_inventory;
378	return $this;
379	}
380	/**
381	* Gets inventory_alert_type
382	* @return string
383	*/
384	public function getInventoryAlertType()
385	{
386	return $this->inventory_alert_type;
387	}
388
389	/**
390	* Sets inventory_alert_type
391	* @param string $inventory_alert_type Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its inventory_alert_threshold. See [V1VariationInventoryAlertType](#type-v1variationinventoryalerttype) for possible values
392	* @return $this
393	*/
394	public function setInventoryAlertType($inventory_alert_type)
395	{
396	$this->inventory_alert_type = $inventory_alert_type;
397	return $this;
398	}
399	/**
400	* Gets inventory_alert_threshold
401	* @return int
402	*/
403	public function getInventoryAlertThreshold()
404	{
405	return $this->inventory_alert_threshold;
406	}
407
408	/**
409	* Sets inventory_alert_threshold
410	* @param int $inventory_alert_threshold If the inventory quantity for the variation is less than or equal to this value and inventory_alert_type is LOW_QUANTITY, the variation displays an alert in the merchant dashboard.
411	* @return $this
412	*/
413	public function setInventoryAlertThreshold($inventory_alert_threshold)
414	{
415	$this->inventory_alert_threshold = $inventory_alert_threshold;
416	return $this;
417	}
418	/**
419	* Gets user_data
420	* @return string
421	*/
422	public function getUserData()
423	{
424	return $this->user_data;
425	}
426
427	/**
428	* Sets user_data
429	* @param string $user_data Arbitrary metadata associated with the variation. Cannot exceed 255 characters.
430	* @return $this
431	*/
432	public function setUserData($user_data)
433	{
434	$this->user_data = $user_data;
435	return $this;
436	}
437	/**
438	* Gets v2_id
439	* @return string
440	*/
441	public function getV2Id()
442	{
443	return $this->v2_id;
444	}
445
446	/**
447	* Sets v2_id
448	* @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.
449	* @return $this
450	*/
451	public function setV2Id($v2_id)
452	{
453	$this->v2_id = $v2_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