V1Refund.php — WooCommerce Square 2.2.5

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

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

V1Refund.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	* V1Refund 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 V1Refund implements ArrayAccess
21	{
22	/**
23	* Array of property to type mappings. Used for (de)serialization
24	* @var string[]
25	*/
26	static $swaggerTypes = array(
27	'type' => 'string',
28	'reason' => 'string',
29	'refunded_money' => '\SquareConnect\Model\V1Money',
30	'refunded_processing_fee_money' => '\SquareConnect\Model\V1Money',
31	'refunded_tax_money' => '\SquareConnect\Model\V1Money',
32	'refunded_additive_tax_money' => '\SquareConnect\Model\V1Money',
33	'refunded_additive_tax' => '\SquareConnect\Model\V1PaymentTax[]',
34	'refunded_inclusive_tax_money' => '\SquareConnect\Model\V1Money',
35	'refunded_inclusive_tax' => '\SquareConnect\Model\V1PaymentTax[]',
36	'refunded_tip_money' => '\SquareConnect\Model\V1Money',
37	'refunded_discount_money' => '\SquareConnect\Model\V1Money',
38	'refunded_surcharge_money' => '\SquareConnect\Model\V1Money',
39	'refunded_surcharges' => '\SquareConnect\Model\V1PaymentSurcharge[]',
40	'created_at' => 'string',
41	'processed_at' => 'string',
42	'payment_id' => 'string',
43	'merchant_id' => 'string',
44	'is_exchange' => 'bool'
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	'type' => 'type',
53	'reason' => 'reason',
54	'refunded_money' => 'refunded_money',
55	'refunded_processing_fee_money' => 'refunded_processing_fee_money',
56	'refunded_tax_money' => 'refunded_tax_money',
57	'refunded_additive_tax_money' => 'refunded_additive_tax_money',
58	'refunded_additive_tax' => 'refunded_additive_tax',
59	'refunded_inclusive_tax_money' => 'refunded_inclusive_tax_money',
60	'refunded_inclusive_tax' => 'refunded_inclusive_tax',
61	'refunded_tip_money' => 'refunded_tip_money',
62	'refunded_discount_money' => 'refunded_discount_money',
63	'refunded_surcharge_money' => 'refunded_surcharge_money',
64	'refunded_surcharges' => 'refunded_surcharges',
65	'created_at' => 'created_at',
66	'processed_at' => 'processed_at',
67	'payment_id' => 'payment_id',
68	'merchant_id' => 'merchant_id',
69	'is_exchange' => 'is_exchange'
70	);
71
72	/**
73	* Array of attributes to setter functions (for deserialization of responses)
74	* @var string[]
75	*/
76	static $setters = array(
77	'type' => 'setType',
78	'reason' => 'setReason',
79	'refunded_money' => 'setRefundedMoney',
80	'refunded_processing_fee_money' => 'setRefundedProcessingFeeMoney',
81	'refunded_tax_money' => 'setRefundedTaxMoney',
82	'refunded_additive_tax_money' => 'setRefundedAdditiveTaxMoney',
83	'refunded_additive_tax' => 'setRefundedAdditiveTax',
84	'refunded_inclusive_tax_money' => 'setRefundedInclusiveTaxMoney',
85	'refunded_inclusive_tax' => 'setRefundedInclusiveTax',
86	'refunded_tip_money' => 'setRefundedTipMoney',
87	'refunded_discount_money' => 'setRefundedDiscountMoney',
88	'refunded_surcharge_money' => 'setRefundedSurchargeMoney',
89	'refunded_surcharges' => 'setRefundedSurcharges',
90	'created_at' => 'setCreatedAt',
91	'processed_at' => 'setProcessedAt',
92	'payment_id' => 'setPaymentId',
93	'merchant_id' => 'setMerchantId',
94	'is_exchange' => 'setIsExchange'
95	);
96
97	/**
98	* Array of attributes to getter functions (for serialization of requests)
99	* @var string[]
100	*/
101	static $getters = array(
102	'type' => 'getType',
103	'reason' => 'getReason',
104	'refunded_money' => 'getRefundedMoney',
105	'refunded_processing_fee_money' => 'getRefundedProcessingFeeMoney',
106	'refunded_tax_money' => 'getRefundedTaxMoney',
107	'refunded_additive_tax_money' => 'getRefundedAdditiveTaxMoney',
108	'refunded_additive_tax' => 'getRefundedAdditiveTax',
109	'refunded_inclusive_tax_money' => 'getRefundedInclusiveTaxMoney',
110	'refunded_inclusive_tax' => 'getRefundedInclusiveTax',
111	'refunded_tip_money' => 'getRefundedTipMoney',
112	'refunded_discount_money' => 'getRefundedDiscountMoney',
113	'refunded_surcharge_money' => 'getRefundedSurchargeMoney',
114	'refunded_surcharges' => 'getRefundedSurcharges',
115	'created_at' => 'getCreatedAt',
116	'processed_at' => 'getProcessedAt',
117	'payment_id' => 'getPaymentId',
118	'merchant_id' => 'getMerchantId',
119	'is_exchange' => 'getIsExchange'
120	);
121
122	/**
123	* $type The type of refund See [V1RefundType](#type-v1refundtype) for possible values
124	* @var string
125	*/
126	protected $type;
127	/**
128	* $reason The merchant-specified reason for the refund.
129	* @var string
130	*/
131	protected $reason;
132	/**
133	* $refunded_money The amount of money refunded. This amount is always negative.
134	* @var \SquareConnect\Model\V1Money
135	*/
136	protected $refunded_money;
137	/**
138	* $refunded_processing_fee_money The amount of processing fee money refunded. This amount is always positive.
139	* @var \SquareConnect\Model\V1Money
140	*/
141	protected $refunded_processing_fee_money;
142	/**
143	* $refunded_tax_money The total amount of tax money refunded. This amount is always negative.
144	* @var \SquareConnect\Model\V1Money
145	*/
146	protected $refunded_tax_money;
147	/**
148	* $refunded_additive_tax_money The amount of additive tax money refunded. This amount is always negative.
149	* @var \SquareConnect\Model\V1Money
150	*/
151	protected $refunded_additive_tax_money;
152	/**
153	* $refunded_additive_tax All of the additive taxes associated with the refund.
154	* @var \SquareConnect\Model\V1PaymentTax[]
155	*/
156	protected $refunded_additive_tax;
157	/**
158	* $refunded_inclusive_tax_money The amount of inclusive tax money refunded. This amount is always negative.
159	* @var \SquareConnect\Model\V1Money
160	*/
161	protected $refunded_inclusive_tax_money;
162	/**
163	* $refunded_inclusive_tax All of the inclusive taxes associated with the refund.
164	* @var \SquareConnect\Model\V1PaymentTax[]
165	*/
166	protected $refunded_inclusive_tax;
167	/**
168	* $refunded_tip_money The amount of tip money refunded. This amount is always negative.
169	* @var \SquareConnect\Model\V1Money
170	*/
171	protected $refunded_tip_money;
172	/**
173	* $refunded_discount_money The amount of discount money refunded. This amount is always positive.
174	* @var \SquareConnect\Model\V1Money
175	*/
176	protected $refunded_discount_money;
177	/**
178	* $refunded_surcharge_money The amount of surcharge money refunded. This amount is always negative.
179	* @var \SquareConnect\Model\V1Money
180	*/
181	protected $refunded_surcharge_money;
182	/**
183	* $refunded_surcharges A list of all surcharges associated with the refund.
184	* @var \SquareConnect\Model\V1PaymentSurcharge[]
185	*/
186	protected $refunded_surcharges;
187	/**
188	* $created_at The time when the merchant initiated the refund for Square to process, in ISO 8601 format.
189	* @var string
190	*/
191	protected $created_at;
192	/**
193	* $processed_at The time when Square processed the refund on behalf of the merchant, in ISO 8601 format.
194	* @var string
195	*/
196	protected $processed_at;
197	/**
198	* $payment_id A Square-issued ID associated with the refund. For single-tender refunds, payment_id is the ID of the original payment ID. For split-tender refunds, payment_id is the ID of the original tender. For exchange-based refunds (is_exchange == true), payment_id is the ID of the original payment ID even if the payment includes other tenders.
199	* @var string
200	*/
201	protected $payment_id;
202	/**
203	* $merchant_id
204	* @var string
205	*/
206	protected $merchant_id;
207	/**
208	* $is_exchange Indicates whether or not the refund is associated with an exchange. If is_exchange is true, the refund reflects the value of goods returned in the exchange not the total money refunded.
209	* @var bool
210	*/
211	protected $is_exchange;
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["type"])) {
221	$this->type = $data["type"];
222	} else {
223	$this->type = null;
224	}
225	if (isset($data["reason"])) {
226	$this->reason = $data["reason"];
227	} else {
228	$this->reason = null;
229	}
230	if (isset($data["refunded_money"])) {
231	$this->refunded_money = $data["refunded_money"];
232	} else {
233	$this->refunded_money = null;
234	}
235	if (isset($data["refunded_processing_fee_money"])) {
236	$this->refunded_processing_fee_money = $data["refunded_processing_fee_money"];
237	} else {
238	$this->refunded_processing_fee_money = null;
239	}
240	if (isset($data["refunded_tax_money"])) {
241	$this->refunded_tax_money = $data["refunded_tax_money"];
242	} else {
243	$this->refunded_tax_money = null;
244	}
245	if (isset($data["refunded_additive_tax_money"])) {
246	$this->refunded_additive_tax_money = $data["refunded_additive_tax_money"];
247	} else {
248	$this->refunded_additive_tax_money = null;
249	}
250	if (isset($data["refunded_additive_tax"])) {
251	$this->refunded_additive_tax = $data["refunded_additive_tax"];
252	} else {
253	$this->refunded_additive_tax = null;
254	}
255	if (isset($data["refunded_inclusive_tax_money"])) {
256	$this->refunded_inclusive_tax_money = $data["refunded_inclusive_tax_money"];
257	} else {
258	$this->refunded_inclusive_tax_money = null;
259	}
260	if (isset($data["refunded_inclusive_tax"])) {
261	$this->refunded_inclusive_tax = $data["refunded_inclusive_tax"];
262	} else {
263	$this->refunded_inclusive_tax = null;
264	}
265	if (isset($data["refunded_tip_money"])) {
266	$this->refunded_tip_money = $data["refunded_tip_money"];
267	} else {
268	$this->refunded_tip_money = null;
269	}
270	if (isset($data["refunded_discount_money"])) {
271	$this->refunded_discount_money = $data["refunded_discount_money"];
272	} else {
273	$this->refunded_discount_money = null;
274	}
275	if (isset($data["refunded_surcharge_money"])) {
276	$this->refunded_surcharge_money = $data["refunded_surcharge_money"];
277	} else {
278	$this->refunded_surcharge_money = null;
279	}
280	if (isset($data["refunded_surcharges"])) {
281	$this->refunded_surcharges = $data["refunded_surcharges"];
282	} else {
283	$this->refunded_surcharges = null;
284	}
285	if (isset($data["created_at"])) {
286	$this->created_at = $data["created_at"];
287	} else {
288	$this->created_at = null;
289	}
290	if (isset($data["processed_at"])) {
291	$this->processed_at = $data["processed_at"];
292	} else {
293	$this->processed_at = null;
294	}
295	if (isset($data["payment_id"])) {
296	$this->payment_id = $data["payment_id"];
297	} else {
298	$this->payment_id = null;
299	}
300	if (isset($data["merchant_id"])) {
301	$this->merchant_id = $data["merchant_id"];
302	} else {
303	$this->merchant_id = null;
304	}
305	if (isset($data["is_exchange"])) {
306	$this->is_exchange = $data["is_exchange"];
307	} else {
308	$this->is_exchange = null;
309	}
310	}
311	}
312	/**
313	* Gets type
314	* @return string
315	*/
316	public function getType()
317	{
318	return $this->type;
319	}
320
321	/**
322	* Sets type
323	* @param string $type The type of refund See [V1RefundType](#type-v1refundtype) for possible values
324	* @return $this
325	*/
326	public function setType($type)
327	{
328	$this->type = $type;
329	return $this;
330	}
331	/**
332	* Gets reason
333	* @return string
334	*/
335	public function getReason()
336	{
337	return $this->reason;
338	}
339
340	/**
341	* Sets reason
342	* @param string $reason The merchant-specified reason for the refund.
343	* @return $this
344	*/
345	public function setReason($reason)
346	{
347	$this->reason = $reason;
348	return $this;
349	}
350	/**
351	* Gets refunded_money
352	* @return \SquareConnect\Model\V1Money
353	*/
354	public function getRefundedMoney()
355	{
356	return $this->refunded_money;
357	}
358
359	/**
360	* Sets refunded_money
361	* @param \SquareConnect\Model\V1Money $refunded_money The amount of money refunded. This amount is always negative.
362	* @return $this
363	*/
364	public function setRefundedMoney($refunded_money)
365	{
366	$this->refunded_money = $refunded_money;
367	return $this;
368	}
369	/**
370	* Gets refunded_processing_fee_money
371	* @return \SquareConnect\Model\V1Money
372	*/
373	public function getRefundedProcessingFeeMoney()
374	{
375	return $this->refunded_processing_fee_money;
376	}
377
378	/**
379	* Sets refunded_processing_fee_money
380	* @param \SquareConnect\Model\V1Money $refunded_processing_fee_money The amount of processing fee money refunded. This amount is always positive.
381	* @return $this
382	*/
383	public function setRefundedProcessingFeeMoney($refunded_processing_fee_money)
384	{
385	$this->refunded_processing_fee_money = $refunded_processing_fee_money;
386	return $this;
387	}
388	/**
389	* Gets refunded_tax_money
390	* @return \SquareConnect\Model\V1Money
391	*/
392	public function getRefundedTaxMoney()
393	{
394	return $this->refunded_tax_money;
395	}
396
397	/**
398	* Sets refunded_tax_money
399	* @param \SquareConnect\Model\V1Money $refunded_tax_money The total amount of tax money refunded. This amount is always negative.
400	* @return $this
401	*/
402	public function setRefundedTaxMoney($refunded_tax_money)
403	{
404	$this->refunded_tax_money = $refunded_tax_money;
405	return $this;
406	}
407	/**
408	* Gets refunded_additive_tax_money
409	* @return \SquareConnect\Model\V1Money
410	*/
411	public function getRefundedAdditiveTaxMoney()
412	{
413	return $this->refunded_additive_tax_money;
414	}
415
416	/**
417	* Sets refunded_additive_tax_money
418	* @param \SquareConnect\Model\V1Money $refunded_additive_tax_money The amount of additive tax money refunded. This amount is always negative.
419	* @return $this
420	*/
421	public function setRefundedAdditiveTaxMoney($refunded_additive_tax_money)
422	{
423	$this->refunded_additive_tax_money = $refunded_additive_tax_money;
424	return $this;
425	}
426	/**
427	* Gets refunded_additive_tax
428	* @return \SquareConnect\Model\V1PaymentTax[]
429	*/
430	public function getRefundedAdditiveTax()
431	{
432	return $this->refunded_additive_tax;
433	}
434
435	/**
436	* Sets refunded_additive_tax
437	* @param \SquareConnect\Model\V1PaymentTax[] $refunded_additive_tax All of the additive taxes associated with the refund.
438	* @return $this
439	*/
440	public function setRefundedAdditiveTax($refunded_additive_tax)
441	{
442	$this->refunded_additive_tax = $refunded_additive_tax;
443	return $this;
444	}
445	/**
446	* Gets refunded_inclusive_tax_money
447	* @return \SquareConnect\Model\V1Money
448	*/
449	public function getRefundedInclusiveTaxMoney()
450	{
451	return $this->refunded_inclusive_tax_money;
452	}
453
454	/**
455	* Sets refunded_inclusive_tax_money
456	* @param \SquareConnect\Model\V1Money $refunded_inclusive_tax_money The amount of inclusive tax money refunded. This amount is always negative.
457	* @return $this
458	*/
459	public function setRefundedInclusiveTaxMoney($refunded_inclusive_tax_money)
460	{
461	$this->refunded_inclusive_tax_money = $refunded_inclusive_tax_money;
462	return $this;
463	}
464	/**
465	* Gets refunded_inclusive_tax
466	* @return \SquareConnect\Model\V1PaymentTax[]
467	*/
468	public function getRefundedInclusiveTax()
469	{
470	return $this->refunded_inclusive_tax;
471	}
472
473	/**
474	* Sets refunded_inclusive_tax
475	* @param \SquareConnect\Model\V1PaymentTax[] $refunded_inclusive_tax All of the inclusive taxes associated with the refund.
476	* @return $this
477	*/
478	public function setRefundedInclusiveTax($refunded_inclusive_tax)
479	{
480	$this->refunded_inclusive_tax = $refunded_inclusive_tax;
481	return $this;
482	}
483	/**
484	* Gets refunded_tip_money
485	* @return \SquareConnect\Model\V1Money
486	*/
487	public function getRefundedTipMoney()
488	{
489	return $this->refunded_tip_money;
490	}
491
492	/**
493	* Sets refunded_tip_money
494	* @param \SquareConnect\Model\V1Money $refunded_tip_money The amount of tip money refunded. This amount is always negative.
495	* @return $this
496	*/
497	public function setRefundedTipMoney($refunded_tip_money)
498	{
499	$this->refunded_tip_money = $refunded_tip_money;
500	return $this;
501	}
502	/**
503	* Gets refunded_discount_money
504	* @return \SquareConnect\Model\V1Money
505	*/
506	public function getRefundedDiscountMoney()
507	{
508	return $this->refunded_discount_money;
509	}
510
511	/**
512	* Sets refunded_discount_money
513	* @param \SquareConnect\Model\V1Money $refunded_discount_money The amount of discount money refunded. This amount is always positive.
514	* @return $this
515	*/
516	public function setRefundedDiscountMoney($refunded_discount_money)
517	{
518	$this->refunded_discount_money = $refunded_discount_money;
519	return $this;
520	}
521	/**
522	* Gets refunded_surcharge_money
523	* @return \SquareConnect\Model\V1Money
524	*/
525	public function getRefundedSurchargeMoney()
526	{
527	return $this->refunded_surcharge_money;
528	}
529
530	/**
531	* Sets refunded_surcharge_money
532	* @param \SquareConnect\Model\V1Money $refunded_surcharge_money The amount of surcharge money refunded. This amount is always negative.
533	* @return $this
534	*/
535	public function setRefundedSurchargeMoney($refunded_surcharge_money)
536	{
537	$this->refunded_surcharge_money = $refunded_surcharge_money;
538	return $this;
539	}
540	/**
541	* Gets refunded_surcharges
542	* @return \SquareConnect\Model\V1PaymentSurcharge[]
543	*/
544	public function getRefundedSurcharges()
545	{
546	return $this->refunded_surcharges;
547	}
548
549	/**
550	* Sets refunded_surcharges
551	* @param \SquareConnect\Model\V1PaymentSurcharge[] $refunded_surcharges A list of all surcharges associated with the refund.
552	* @return $this
553	*/
554	public function setRefundedSurcharges($refunded_surcharges)
555	{
556	$this->refunded_surcharges = $refunded_surcharges;
557	return $this;
558	}
559	/**
560	* Gets created_at
561	* @return string
562	*/
563	public function getCreatedAt()
564	{
565	return $this->created_at;
566	}
567
568	/**
569	* Sets created_at
570	* @param string $created_at The time when the merchant initiated the refund for Square to process, in ISO 8601 format.
571	* @return $this
572	*/
573	public function setCreatedAt($created_at)
574	{
575	$this->created_at = $created_at;
576	return $this;
577	}
578	/**
579	* Gets processed_at
580	* @return string
581	*/
582	public function getProcessedAt()
583	{
584	return $this->processed_at;
585	}
586
587	/**
588	* Sets processed_at
589	* @param string $processed_at The time when Square processed the refund on behalf of the merchant, in ISO 8601 format.
590	* @return $this
591	*/
592	public function setProcessedAt($processed_at)
593	{
594	$this->processed_at = $processed_at;
595	return $this;
596	}
597	/**
598	* Gets payment_id
599	* @return string
600	*/
601	public function getPaymentId()
602	{
603	return $this->payment_id;
604	}
605
606	/**
607	* Sets payment_id
608	* @param string $payment_id A Square-issued ID associated with the refund. For single-tender refunds, payment_id is the ID of the original payment ID. For split-tender refunds, payment_id is the ID of the original tender. For exchange-based refunds (is_exchange == true), payment_id is the ID of the original payment ID even if the payment includes other tenders.
609	* @return $this
610	*/
611	public function setPaymentId($payment_id)
612	{
613	$this->payment_id = $payment_id;
614	return $this;
615	}
616	/**
617	* Gets merchant_id
618	* @return string
619	*/
620	public function getMerchantId()
621	{
622	return $this->merchant_id;
623	}
624
625	/**
626	* Sets merchant_id
627	* @param string $merchant_id
628	* @return $this
629	*/
630	public function setMerchantId($merchant_id)
631	{
632	$this->merchant_id = $merchant_id;
633	return $this;
634	}
635	/**
636	* Gets is_exchange
637	* @return bool
638	*/
639	public function getIsExchange()
640	{
641	return $this->is_exchange;
642	}
643
644	/**
645	* Sets is_exchange
646	* @param bool $is_exchange Indicates whether or not the refund is associated with an exchange. If is_exchange is true, the refund reflects the value of goods returned in the exchange not the total money refunded.
647	* @return $this
648	*/
649	public function setIsExchange($is_exchange)
650	{
651	$this->is_exchange = $is_exchange;
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