OrderLineItem.php — WooCommerce Square 2.2.5

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

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

OrderLineItem.php

708 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	* OrderLineItem 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 OrderLineItem implements ArrayAccess
21	{
22	/**
23	* Array of property to type mappings. Used for (de)serialization
24	* @var string[]
25	*/
26	static $swaggerTypes = array(
27	'uid' => 'string',
28	'name' => 'string',
29	'quantity' => 'string',
30	'quantity_unit' => '\SquareConnect\Model\OrderQuantityUnit',
31	'note' => 'string',
32	'catalog_object_id' => 'string',
33	'variation_name' => 'string',
34	'modifiers' => '\SquareConnect\Model\OrderLineItemModifier[]',
35	'taxes' => '\SquareConnect\Model\OrderLineItemTax[]',
36	'discounts' => '\SquareConnect\Model\OrderLineItemDiscount[]',
37	'applied_taxes' => '\SquareConnect\Model\OrderLineItemAppliedTax[]',
38	'applied_discounts' => '\SquareConnect\Model\OrderLineItemAppliedDiscount[]',
39	'base_price_money' => '\SquareConnect\Model\Money',
40	'variation_total_price_money' => '\SquareConnect\Model\Money',
41	'gross_sales_money' => '\SquareConnect\Model\Money',
42	'total_tax_money' => '\SquareConnect\Model\Money',
43	'total_discount_money' => '\SquareConnect\Model\Money',
44	'total_money' => '\SquareConnect\Model\Money'
45	);
46
47	/**
48	* Array of attributes where the key is the local name, and the value is the original name
49	* @var string[]
50	*/
51	static $attributeMap = array(
52	'uid' => 'uid',
53	'name' => 'name',
54	'quantity' => 'quantity',
55	'quantity_unit' => 'quantity_unit',
56	'note' => 'note',
57	'catalog_object_id' => 'catalog_object_id',
58	'variation_name' => 'variation_name',
59	'modifiers' => 'modifiers',
60	'taxes' => 'taxes',
61	'discounts' => 'discounts',
62	'applied_taxes' => 'applied_taxes',
63	'applied_discounts' => 'applied_discounts',
64	'base_price_money' => 'base_price_money',
65	'variation_total_price_money' => 'variation_total_price_money',
66	'gross_sales_money' => 'gross_sales_money',
67	'total_tax_money' => 'total_tax_money',
68	'total_discount_money' => 'total_discount_money',
69	'total_money' => 'total_money'
70	);
71
72	/**
73	* Array of attributes to setter functions (for deserialization of responses)
74	* @var string[]
75	*/
76	static $setters = array(
77	'uid' => 'setUid',
78	'name' => 'setName',
79	'quantity' => 'setQuantity',
80	'quantity_unit' => 'setQuantityUnit',
81	'note' => 'setNote',
82	'catalog_object_id' => 'setCatalogObjectId',
83	'variation_name' => 'setVariationName',
84	'modifiers' => 'setModifiers',
85	'taxes' => 'setTaxes',
86	'discounts' => 'setDiscounts',
87	'applied_taxes' => 'setAppliedTaxes',
88	'applied_discounts' => 'setAppliedDiscounts',
89	'base_price_money' => 'setBasePriceMoney',
90	'variation_total_price_money' => 'setVariationTotalPriceMoney',
91	'gross_sales_money' => 'setGrossSalesMoney',
92	'total_tax_money' => 'setTotalTaxMoney',
93	'total_discount_money' => 'setTotalDiscountMoney',
94	'total_money' => 'setTotalMoney'
95	);
96
97	/**
98	* Array of attributes to getter functions (for serialization of requests)
99	* @var string[]
100	*/
101	static $getters = array(
102	'uid' => 'getUid',
103	'name' => 'getName',
104	'quantity' => 'getQuantity',
105	'quantity_unit' => 'getQuantityUnit',
106	'note' => 'getNote',
107	'catalog_object_id' => 'getCatalogObjectId',
108	'variation_name' => 'getVariationName',
109	'modifiers' => 'getModifiers',
110	'taxes' => 'getTaxes',
111	'discounts' => 'getDiscounts',
112	'applied_taxes' => 'getAppliedTaxes',
113	'applied_discounts' => 'getAppliedDiscounts',
114	'base_price_money' => 'getBasePriceMoney',
115	'variation_total_price_money' => 'getVariationTotalPriceMoney',
116	'gross_sales_money' => 'getGrossSalesMoney',
117	'total_tax_money' => 'getTotalTaxMoney',
118	'total_discount_money' => 'getTotalDiscountMoney',
119	'total_money' => 'getTotalMoney'
120	);
121
122	/**
123	* $uid Unique ID that identifies the line item only within this order.
124	* @var string
125	*/
126	protected $uid;
127	/**
128	* $name The name of the line item.
129	* @var string
130	*/
131	protected $name;
132	/**
133	* $quantity The quantity purchased, formatted as a decimal number. For example: `\"3\"`. Line items with a `quantity_unit` can have non-integer quantities. For example: `\"1.70000\"`.
134	* @var string
135	*/
136	protected $quantity;
137	/**
138	* $quantity_unit The unit and precision that this line item's quantity is measured in.
139	* @var \SquareConnect\Model\OrderQuantityUnit
140	*/
141	protected $quantity_unit;
142	/**
143	* $note The note of the line item.
144	* @var string
145	*/
146	protected $note;
147	/**
148	* $catalog_object_id The [CatalogItemVariation](#type-catalogitemvariation) id applied to this line item.
149	* @var string
150	*/
151	protected $catalog_object_id;
152	/**
153	* $variation_name The name of the variation applied to this line item.
154	* @var string
155	*/
156	protected $variation_name;
157	/**
158	* $modifiers The [CatalogModifier](#type-catalogmodifier)s applied to this line item.
159	* @var \SquareConnect\Model\OrderLineItemModifier[]
160	*/
161	protected $modifiers;
162	/**
163	* $taxes A list of taxes applied to this line item. On read or retrieve, this list includes both item-level taxes and any order-level taxes apportioned to this item. When creating an Order, set your item-level taxes in this list. This field has been deprecated in favour of `applied_taxes`. Usage of both this field and `applied_taxes` when creating an order will result in an error. Usage of this field when sending requests to the UpdateOrder endpoint will result in an error.
164	* @var \SquareConnect\Model\OrderLineItemTax[]
165	*/
166	protected $taxes;
167	/**
168	* $discounts A list of discounts applied to this line item. On read or retrieve, this list includes both item-level discounts and any order-level discounts apportioned to this item. When creating an Order, set your item-level discounts in this list. This field has been deprecated in favour of `applied_discounts`. Usage of both this field and `applied_discounts` when creating an order will result in an error. Usage of this field when sending requests to the UpdateOrder endpoint will result in an error.
169	* @var \SquareConnect\Model\OrderLineItemDiscount[]
170	*/
171	protected $discounts;
172	/**
173	* $applied_taxes The list of references to taxes applied to this line item. Each `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level `OrderLineItemTax` applied to the line item. On reads, the amount applied is populated. An `OrderLineItemAppliedTax` will be automatically created on every line item for all `ORDER` scoped taxes added to the order. `OrderLineItemAppliedTax` records for `LINE_ITEM` scoped taxes must be added in requests for the tax to apply to any line items. To change the amount of a tax, modify the referenced top-level tax.
174	* @var \SquareConnect\Model\OrderLineItemAppliedTax[]
175	*/
176	protected $applied_taxes;
177	/**
178	* $applied_discounts The list of references to discounts applied to this line item. Each `OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level `OrderLineItemDiscounts` applied to the line item. On reads, the amount applied is populated. An `OrderLineItemAppliedDiscount` will be automatically created on every line item for all `ORDER` scoped discounts that are added to the order. `OrderLineItemAppliedDiscount` records for `LINE_ITEM` scoped discounts must be added in requests for the discount to apply to any line items. To change the amount of a discount, modify the referenced top-level discount.
179	* @var \SquareConnect\Model\OrderLineItemAppliedDiscount[]
180	*/
181	protected $applied_discounts;
182	/**
183	* $base_price_money The base price for a single unit of the line item.
184	* @var \SquareConnect\Model\Money
185	*/
186	protected $base_price_money;
187	/**
188	* $variation_total_price_money The total price of all item variations sold in this line item. Calculated as `base_price_money` multiplied by `quantity`. Does not include modifiers.
189	* @var \SquareConnect\Model\Money
190	*/
191	protected $variation_total_price_money;
192	/**
193	* $gross_sales_money The amount of money made in gross sales for this line item. Calculated as the sum of the variation's total price and each modifier's total price.
194	* @var \SquareConnect\Model\Money
195	*/
196	protected $gross_sales_money;
197	/**
198	* $total_tax_money The total tax amount of money to collect for the line item.
199	* @var \SquareConnect\Model\Money
200	*/
201	protected $total_tax_money;
202	/**
203	* $total_discount_money The total discount amount of money to collect for the line item.
204	* @var \SquareConnect\Model\Money
205	*/
206	protected $total_discount_money;
207	/**
208	* $total_money The total amount of money to collect for this line item.
209	* @var \SquareConnect\Model\Money
210	*/
211	protected $total_money;
212
213	/**
214	* Constructor
215	* @param mixed[] $data Associated array of property value initializing the model
216	*/
217	public function __construct(array $data = null)
218	{
219	if ($data != null) {
220	if (isset($data["uid"])) {
221	$this->uid = $data["uid"];
222	} else {
223	$this->uid = null;
224	}
225	if (isset($data["name"])) {
226	$this->name = $data["name"];
227	} else {
228	$this->name = null;
229	}
230	if (isset($data["quantity"])) {
231	$this->quantity = $data["quantity"];
232	} else {
233	$this->quantity = null;
234	}
235	if (isset($data["quantity_unit"])) {
236	$this->quantity_unit = $data["quantity_unit"];
237	} else {
238	$this->quantity_unit = null;
239	}
240	if (isset($data["note"])) {
241	$this->note = $data["note"];
242	} else {
243	$this->note = null;
244	}
245	if (isset($data["catalog_object_id"])) {
246	$this->catalog_object_id = $data["catalog_object_id"];
247	} else {
248	$this->catalog_object_id = null;
249	}
250	if (isset($data["variation_name"])) {
251	$this->variation_name = $data["variation_name"];
252	} else {
253	$this->variation_name = null;
254	}
255	if (isset($data["modifiers"])) {
256	$this->modifiers = $data["modifiers"];
257	} else {
258	$this->modifiers = null;
259	}
260	if (isset($data["taxes"])) {
261	$this->taxes = $data["taxes"];
262	} else {
263	$this->taxes = null;
264	}
265	if (isset($data["discounts"])) {
266	$this->discounts = $data["discounts"];
267	} else {
268	$this->discounts = null;
269	}
270	if (isset($data["applied_taxes"])) {
271	$this->applied_taxes = $data["applied_taxes"];
272	} else {
273	$this->applied_taxes = null;
274	}
275	if (isset($data["applied_discounts"])) {
276	$this->applied_discounts = $data["applied_discounts"];
277	} else {
278	$this->applied_discounts = null;
279	}
280	if (isset($data["base_price_money"])) {
281	$this->base_price_money = $data["base_price_money"];
282	} else {
283	$this->base_price_money = null;
284	}
285	if (isset($data["variation_total_price_money"])) {
286	$this->variation_total_price_money = $data["variation_total_price_money"];
287	} else {
288	$this->variation_total_price_money = null;
289	}
290	if (isset($data["gross_sales_money"])) {
291	$this->gross_sales_money = $data["gross_sales_money"];
292	} else {
293	$this->gross_sales_money = null;
294	}
295	if (isset($data["total_tax_money"])) {
296	$this->total_tax_money = $data["total_tax_money"];
297	} else {
298	$this->total_tax_money = null;
299	}
300	if (isset($data["total_discount_money"])) {
301	$this->total_discount_money = $data["total_discount_money"];
302	} else {
303	$this->total_discount_money = null;
304	}
305	if (isset($data["total_money"])) {
306	$this->total_money = $data["total_money"];
307	} else {
308	$this->total_money = null;
309	}
310	}
311	}
312	/**
313	* Gets uid
314	* @return string
315	*/
316	public function getUid()
317	{
318	return $this->uid;
319	}
320
321	/**
322	* Sets uid
323	* @param string $uid Unique ID that identifies the line item only within this order.
324	* @return $this
325	*/
326	public function setUid($uid)
327	{
328	$this->uid = $uid;
329	return $this;
330	}
331	/**
332	* Gets name
333	* @return string
334	*/
335	public function getName()
336	{
337	return $this->name;
338	}
339
340	/**
341	* Sets name
342	* @param string $name The name of the line item.
343	* @return $this
344	*/
345	public function setName($name)
346	{
347	$this->name = $name;
348	return $this;
349	}
350	/**
351	* Gets quantity
352	* @return string
353	*/
354	public function getQuantity()
355	{
356	return $this->quantity;
357	}
358
359	/**
360	* Sets quantity
361	* @param string $quantity The quantity purchased, formatted as a decimal number. For example: `\"3\"`. Line items with a `quantity_unit` can have non-integer quantities. For example: `\"1.70000\"`.
362	* @return $this
363	*/
364	public function setQuantity($quantity)
365	{
366	$this->quantity = $quantity;
367	return $this;
368	}
369	/**
370	* Gets quantity_unit
371	* @return \SquareConnect\Model\OrderQuantityUnit
372	*/
373	public function getQuantityUnit()
374	{
375	return $this->quantity_unit;
376	}
377
378	/**
379	* Sets quantity_unit
380	* @param \SquareConnect\Model\OrderQuantityUnit $quantity_unit The unit and precision that this line item's quantity is measured in.
381	* @return $this
382	*/
383	public function setQuantityUnit($quantity_unit)
384	{
385	$this->quantity_unit = $quantity_unit;
386	return $this;
387	}
388	/**
389	* Gets note
390	* @return string
391	*/
392	public function getNote()
393	{
394	return $this->note;
395	}
396
397	/**
398	* Sets note
399	* @param string $note The note of the line item.
400	* @return $this
401	*/
402	public function setNote($note)
403	{
404	$this->note = $note;
405	return $this;
406	}
407	/**
408	* Gets catalog_object_id
409	* @return string
410	*/
411	public function getCatalogObjectId()
412	{
413	return $this->catalog_object_id;
414	}
415
416	/**
417	* Sets catalog_object_id
418	* @param string $catalog_object_id The [CatalogItemVariation](#type-catalogitemvariation) id applied to this line item.
419	* @return $this
420	*/
421	public function setCatalogObjectId($catalog_object_id)
422	{
423	$this->catalog_object_id = $catalog_object_id;
424	return $this;
425	}
426	/**
427	* Gets variation_name
428	* @return string
429	*/
430	public function getVariationName()
431	{
432	return $this->variation_name;
433	}
434
435	/**
436	* Sets variation_name
437	* @param string $variation_name The name of the variation applied to this line item.
438	* @return $this
439	*/
440	public function setVariationName($variation_name)
441	{
442	$this->variation_name = $variation_name;
443	return $this;
444	}
445	/**
446	* Gets modifiers
447	* @return \SquareConnect\Model\OrderLineItemModifier[]
448	*/
449	public function getModifiers()
450	{
451	return $this->modifiers;
452	}
453
454	/**
455	* Sets modifiers
456	* @param \SquareConnect\Model\OrderLineItemModifier[] $modifiers The [CatalogModifier](#type-catalogmodifier)s applied to this line item.
457	* @return $this
458	*/
459	public function setModifiers($modifiers)
460	{
461	$this->modifiers = $modifiers;
462	return $this;
463	}
464	/**
465	* Gets taxes
466	* @return \SquareConnect\Model\OrderLineItemTax[]
467	*/
468	public function getTaxes()
469	{
470	return $this->taxes;
471	}
472
473	/**
474	* Sets taxes
475	* @param \SquareConnect\Model\OrderLineItemTax[] $taxes A list of taxes applied to this line item. On read or retrieve, this list includes both item-level taxes and any order-level taxes apportioned to this item. When creating an Order, set your item-level taxes in this list. This field has been deprecated in favour of `applied_taxes`. Usage of both this field and `applied_taxes` when creating an order will result in an error. Usage of this field when sending requests to the UpdateOrder endpoint will result in an error.
476	* @return $this
477	*/
478	public function setTaxes($taxes)
479	{
480	$this->taxes = $taxes;
481	return $this;
482	}
483	/**
484	* Gets discounts
485	* @return \SquareConnect\Model\OrderLineItemDiscount[]
486	*/
487	public function getDiscounts()
488	{
489	return $this->discounts;
490	}
491
492	/**
493	* Sets discounts
494	* @param \SquareConnect\Model\OrderLineItemDiscount[] $discounts A list of discounts applied to this line item. On read or retrieve, this list includes both item-level discounts and any order-level discounts apportioned to this item. When creating an Order, set your item-level discounts in this list. This field has been deprecated in favour of `applied_discounts`. Usage of both this field and `applied_discounts` when creating an order will result in an error. Usage of this field when sending requests to the UpdateOrder endpoint will result in an error.
495	* @return $this
496	*/
497	public function setDiscounts($discounts)
498	{
499	$this->discounts = $discounts;
500	return $this;
501	}
502	/**
503	* Gets applied_taxes
504	* @return \SquareConnect\Model\OrderLineItemAppliedTax[]
505	*/
506	public function getAppliedTaxes()
507	{
508	return $this->applied_taxes;
509	}
510
511	/**
512	* Sets applied_taxes
513	* @param \SquareConnect\Model\OrderLineItemAppliedTax[] $applied_taxes The list of references to taxes applied to this line item. Each `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level `OrderLineItemTax` applied to the line item. On reads, the amount applied is populated. An `OrderLineItemAppliedTax` will be automatically created on every line item for all `ORDER` scoped taxes added to the order. `OrderLineItemAppliedTax` records for `LINE_ITEM` scoped taxes must be added in requests for the tax to apply to any line items. To change the amount of a tax, modify the referenced top-level tax.
514	* @return $this
515	*/
516	public function setAppliedTaxes($applied_taxes)
517	{
518	$this->applied_taxes = $applied_taxes;
519	return $this;
520	}
521	/**
522	* Gets applied_discounts
523	* @return \SquareConnect\Model\OrderLineItemAppliedDiscount[]
524	*/
525	public function getAppliedDiscounts()
526	{
527	return $this->applied_discounts;
528	}
529
530	/**
531	* Sets applied_discounts
532	* @param \SquareConnect\Model\OrderLineItemAppliedDiscount[] $applied_discounts The list of references to discounts applied to this line item. Each `OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level `OrderLineItemDiscounts` applied to the line item. On reads, the amount applied is populated. An `OrderLineItemAppliedDiscount` will be automatically created on every line item for all `ORDER` scoped discounts that are added to the order. `OrderLineItemAppliedDiscount` records for `LINE_ITEM` scoped discounts must be added in requests for the discount to apply to any line items. To change the amount of a discount, modify the referenced top-level discount.
533	* @return $this
534	*/
535	public function setAppliedDiscounts($applied_discounts)
536	{
537	$this->applied_discounts = $applied_discounts;
538	return $this;
539	}
540	/**
541	* Gets base_price_money
542	* @return \SquareConnect\Model\Money
543	*/
544	public function getBasePriceMoney()
545	{
546	return $this->base_price_money;
547	}
548
549	/**
550	* Sets base_price_money
551	* @param \SquareConnect\Model\Money $base_price_money The base price for a single unit of the line item.
552	* @return $this
553	*/
554	public function setBasePriceMoney($base_price_money)
555	{
556	$this->base_price_money = $base_price_money;
557	return $this;
558	}
559	/**
560	* Gets variation_total_price_money
561	* @return \SquareConnect\Model\Money
562	*/
563	public function getVariationTotalPriceMoney()
564	{
565	return $this->variation_total_price_money;
566	}
567
568	/**
569	* Sets variation_total_price_money
570	* @param \SquareConnect\Model\Money $variation_total_price_money The total price of all item variations sold in this line item. Calculated as `base_price_money` multiplied by `quantity`. Does not include modifiers.
571	* @return $this
572	*/
573	public function setVariationTotalPriceMoney($variation_total_price_money)
574	{
575	$this->variation_total_price_money = $variation_total_price_money;
576	return $this;
577	}
578	/**
579	* Gets gross_sales_money
580	* @return \SquareConnect\Model\Money
581	*/
582	public function getGrossSalesMoney()
583	{
584	return $this->gross_sales_money;
585	}
586
587	/**
588	* Sets gross_sales_money
589	* @param \SquareConnect\Model\Money $gross_sales_money The amount of money made in gross sales for this line item. Calculated as the sum of the variation's total price and each modifier's total price.
590	* @return $this
591	*/
592	public function setGrossSalesMoney($gross_sales_money)
593	{
594	$this->gross_sales_money = $gross_sales_money;
595	return $this;
596	}
597	/**
598	* Gets total_tax_money
599	* @return \SquareConnect\Model\Money
600	*/
601	public function getTotalTaxMoney()
602	{
603	return $this->total_tax_money;
604	}
605
606	/**
607	* Sets total_tax_money
608	* @param \SquareConnect\Model\Money $total_tax_money The total tax amount of money to collect for the line item.
609	* @return $this
610	*/
611	public function setTotalTaxMoney($total_tax_money)
612	{
613	$this->total_tax_money = $total_tax_money;
614	return $this;
615	}
616	/**
617	* Gets total_discount_money
618	* @return \SquareConnect\Model\Money
619	*/
620	public function getTotalDiscountMoney()
621	{
622	return $this->total_discount_money;
623	}
624
625	/**
626	* Sets total_discount_money
627	* @param \SquareConnect\Model\Money $total_discount_money The total discount amount of money to collect for the line item.
628	* @return $this
629	*/
630	public function setTotalDiscountMoney($total_discount_money)
631	{
632	$this->total_discount_money = $total_discount_money;
633	return $this;
634	}
635	/**
636	* Gets total_money
637	* @return \SquareConnect\Model\Money
638	*/
639	public function getTotalMoney()
640	{
641	return $this->total_money;
642	}
643
644	/**
645	* Sets total_money
646	* @param \SquareConnect\Model\Money $total_money The total amount of money to collect for this line item.
647	* @return $this
648	*/
649	public function setTotalMoney($total_money)
650	{
651	$this->total_money = $total_money;
652	return $this;
653	}
654	/**
655	* Returns true if offset exists. False otherwise.
656	* @param integer $offset Offset
657	* @return boolean
658	*/
659	public function offsetExists($offset)
660	{
661	return isset($this->$offset);
662	}
663
664	/**
665	* Gets offset.
666	* @param integer $offset Offset
667	* @return mixed
668	*/
669	public function offsetGet($offset)
670	{
671	return $this->$offset;
672	}
673
674	/**
675	* Sets value based on offset.
676	* @param integer $offset Offset
677	* @param mixed $value Value to be set
678	* @return void
679	*/
680	public function offsetSet($offset, $value)
681	{
682	$this->$offset = $value;
683	}
684
685	/**
686	* Unsets offset.
687	* @param integer $offset Offset
688	* @return void
689	*/
690	public function offsetUnset($offset)
691	{
692	unset($this->$offset);
693	}
694
695	/**
696	* Gets the string presentation of the object
697	* @return string
698	*/
699	public function __toString()
700	{
701	if (defined('JSON_PRETTY_PRINT')) {
702	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT);
703	} else {
704	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this));
705	}
706	}
707	}
708