Refund.php — WooCommerce Square 2.2.5

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

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

Refund.php

444 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	* Refund 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 Refund 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	'location_id' => 'string',
29	'transaction_id' => 'string',
30	'tender_id' => 'string',
31	'created_at' => 'string',
32	'reason' => 'string',
33	'amount_money' => '\SquareConnect\Model\Money',
34	'status' => 'string',
35	'processing_fee_money' => '\SquareConnect\Model\Money',
36	'additional_recipients' => '\SquareConnect\Model\AdditionalRecipient[]'
37	);
38
39	/**
40	* Array of attributes where the key is the local name, and the value is the original name
41	* @var string[]
42	*/
43	static $attributeMap = array(
44	'id' => 'id',
45	'location_id' => 'location_id',
46	'transaction_id' => 'transaction_id',
47	'tender_id' => 'tender_id',
48	'created_at' => 'created_at',
49	'reason' => 'reason',
50	'amount_money' => 'amount_money',
51	'status' => 'status',
52	'processing_fee_money' => 'processing_fee_money',
53	'additional_recipients' => 'additional_recipients'
54	);
55
56	/**
57	* Array of attributes to setter functions (for deserialization of responses)
58	* @var string[]
59	*/
60	static $setters = array(
61	'id' => 'setId',
62	'location_id' => 'setLocationId',
63	'transaction_id' => 'setTransactionId',
64	'tender_id' => 'setTenderId',
65	'created_at' => 'setCreatedAt',
66	'reason' => 'setReason',
67	'amount_money' => 'setAmountMoney',
68	'status' => 'setStatus',
69	'processing_fee_money' => 'setProcessingFeeMoney',
70	'additional_recipients' => 'setAdditionalRecipients'
71	);
72
73	/**
74	* Array of attributes to getter functions (for serialization of requests)
75	* @var string[]
76	*/
77	static $getters = array(
78	'id' => 'getId',
79	'location_id' => 'getLocationId',
80	'transaction_id' => 'getTransactionId',
81	'tender_id' => 'getTenderId',
82	'created_at' => 'getCreatedAt',
83	'reason' => 'getReason',
84	'amount_money' => 'getAmountMoney',
85	'status' => 'getStatus',
86	'processing_fee_money' => 'getProcessingFeeMoney',
87	'additional_recipients' => 'getAdditionalRecipients'
88	);
89
90	/**
91	* $id The refund's unique ID.
92	* @var string
93	*/
94	protected $id;
95	/**
96	* $location_id The ID of the refund's associated location.
97	* @var string
98	*/
99	protected $location_id;
100	/**
101	* $transaction_id The ID of the transaction that the refunded tender is part of.
102	* @var string
103	*/
104	protected $transaction_id;
105	/**
106	* $tender_id The ID of the refunded tender.
107	* @var string
108	*/
109	protected $tender_id;
110	/**
111	* $created_at The time when the refund was created, in RFC 3339 format.
112	* @var string
113	*/
114	protected $created_at;
115	/**
116	* $reason The reason for the refund being issued.
117	* @var string
118	*/
119	protected $reason;
120	/**
121	* $amount_money The amount of money refunded to the buyer.
122	* @var \SquareConnect\Model\Money
123	*/
124	protected $amount_money;
125	/**
126	* $status The current status of the refund (`PENDING`, `APPROVED`, `REJECTED`, or `FAILED`). See [RefundStatus](#type-refundstatus) for possible values
127	* @var string
128	*/
129	protected $status;
130	/**
131	* $processing_fee_money The amount of Square processing fee money refunded to the merchant.
132	* @var \SquareConnect\Model\Money
133	*/
134	protected $processing_fee_money;
135	/**
136	* $additional_recipients Additional recipients (other than the merchant) receiving a portion of this refund. For example, fees assessed on a refund of a purchase by a third party integration.
137	* @var \SquareConnect\Model\AdditionalRecipient[]
138	*/
139	protected $additional_recipients;
140
141	/**
142	* Constructor
143	* @param mixed[] $data Associated array of property value initializing the model
144	*/
145	public function __construct(array $data = null)
146	{
147	if ($data != null) {
148	if (isset($data["id"])) {
149	$this->id = $data["id"];
150	} else {
151	$this->id = null;
152	}
153	if (isset($data["location_id"])) {
154	$this->location_id = $data["location_id"];
155	} else {
156	$this->location_id = null;
157	}
158	if (isset($data["transaction_id"])) {
159	$this->transaction_id = $data["transaction_id"];
160	} else {
161	$this->transaction_id = null;
162	}
163	if (isset($data["tender_id"])) {
164	$this->tender_id = $data["tender_id"];
165	} else {
166	$this->tender_id = null;
167	}
168	if (isset($data["created_at"])) {
169	$this->created_at = $data["created_at"];
170	} else {
171	$this->created_at = null;
172	}
173	if (isset($data["reason"])) {
174	$this->reason = $data["reason"];
175	} else {
176	$this->reason = null;
177	}
178	if (isset($data["amount_money"])) {
179	$this->amount_money = $data["amount_money"];
180	} else {
181	$this->amount_money = null;
182	}
183	if (isset($data["status"])) {
184	$this->status = $data["status"];
185	} else {
186	$this->status = null;
187	}
188	if (isset($data["processing_fee_money"])) {
189	$this->processing_fee_money = $data["processing_fee_money"];
190	} else {
191	$this->processing_fee_money = null;
192	}
193	if (isset($data["additional_recipients"])) {
194	$this->additional_recipients = $data["additional_recipients"];
195	} else {
196	$this->additional_recipients = null;
197	}
198	}
199	}
200	/**
201	* Gets id
202	* @return string
203	*/
204	public function getId()
205	{
206	return $this->id;
207	}
208
209	/**
210	* Sets id
211	* @param string $id The refund's unique ID.
212	* @return $this
213	*/
214	public function setId($id)
215	{
216	$this->id = $id;
217	return $this;
218	}
219	/**
220	* Gets location_id
221	* @return string
222	*/
223	public function getLocationId()
224	{
225	return $this->location_id;
226	}
227
228	/**
229	* Sets location_id
230	* @param string $location_id The ID of the refund's associated location.
231	* @return $this
232	*/
233	public function setLocationId($location_id)
234	{
235	$this->location_id = $location_id;
236	return $this;
237	}
238	/**
239	* Gets transaction_id
240	* @return string
241	*/
242	public function getTransactionId()
243	{
244	return $this->transaction_id;
245	}
246
247	/**
248	* Sets transaction_id
249	* @param string $transaction_id The ID of the transaction that the refunded tender is part of.
250	* @return $this
251	*/
252	public function setTransactionId($transaction_id)
253	{
254	$this->transaction_id = $transaction_id;
255	return $this;
256	}
257	/**
258	* Gets tender_id
259	* @return string
260	*/
261	public function getTenderId()
262	{
263	return $this->tender_id;
264	}
265
266	/**
267	* Sets tender_id
268	* @param string $tender_id The ID of the refunded tender.
269	* @return $this
270	*/
271	public function setTenderId($tender_id)
272	{
273	$this->tender_id = $tender_id;
274	return $this;
275	}
276	/**
277	* Gets created_at
278	* @return string
279	*/
280	public function getCreatedAt()
281	{
282	return $this->created_at;
283	}
284
285	/**
286	* Sets created_at
287	* @param string $created_at The time when the refund was created, in RFC 3339 format.
288	* @return $this
289	*/
290	public function setCreatedAt($created_at)
291	{
292	$this->created_at = $created_at;
293	return $this;
294	}
295	/**
296	* Gets reason
297	* @return string
298	*/
299	public function getReason()
300	{
301	return $this->reason;
302	}
303
304	/**
305	* Sets reason
306	* @param string $reason The reason for the refund being issued.
307	* @return $this
308	*/
309	public function setReason($reason)
310	{
311	$this->reason = $reason;
312	return $this;
313	}
314	/**
315	* Gets amount_money
316	* @return \SquareConnect\Model\Money
317	*/
318	public function getAmountMoney()
319	{
320	return $this->amount_money;
321	}
322
323	/**
324	* Sets amount_money
325	* @param \SquareConnect\Model\Money $amount_money The amount of money refunded to the buyer.
326	* @return $this
327	*/
328	public function setAmountMoney($amount_money)
329	{
330	$this->amount_money = $amount_money;
331	return $this;
332	}
333	/**
334	* Gets status
335	* @return string
336	*/
337	public function getStatus()
338	{
339	return $this->status;
340	}
341
342	/**
343	* Sets status
344	* @param string $status The current status of the refund (`PENDING`, `APPROVED`, `REJECTED`, or `FAILED`). See [RefundStatus](#type-refundstatus) for possible values
345	* @return $this
346	*/
347	public function setStatus($status)
348	{
349	$this->status = $status;
350	return $this;
351	}
352	/**
353	* Gets processing_fee_money
354	* @return \SquareConnect\Model\Money
355	*/
356	public function getProcessingFeeMoney()
357	{
358	return $this->processing_fee_money;
359	}
360
361	/**
362	* Sets processing_fee_money
363	* @param \SquareConnect\Model\Money $processing_fee_money The amount of Square processing fee money refunded to the merchant.
364	* @return $this
365	*/
366	public function setProcessingFeeMoney($processing_fee_money)
367	{
368	$this->processing_fee_money = $processing_fee_money;
369	return $this;
370	}
371	/**
372	* Gets additional_recipients
373	* @return \SquareConnect\Model\AdditionalRecipient[]
374	*/
375	public function getAdditionalRecipients()
376	{
377	return $this->additional_recipients;
378	}
379
380	/**
381	* Sets additional_recipients
382	* @param \SquareConnect\Model\AdditionalRecipient[] $additional_recipients Additional recipients (other than the merchant) receiving a portion of this refund. For example, fees assessed on a refund of a purchase by a third party integration.
383	* @return $this
384	*/
385	public function setAdditionalRecipients($additional_recipients)
386	{
387	$this->additional_recipients = $additional_recipients;
388	return $this;
389	}
390	/**
391	* Returns true if offset exists. False otherwise.
392	* @param integer $offset Offset
393	* @return boolean
394	*/
395	public function offsetExists($offset)
396	{
397	return isset($this->$offset);
398	}
399
400	/**
401	* Gets offset.
402	* @param integer $offset Offset
403	* @return mixed
404	*/
405	public function offsetGet($offset)
406	{
407	return $this->$offset;
408	}
409
410	/**
411	* Sets value based on offset.
412	* @param integer $offset Offset
413	* @param mixed $value Value to be set
414	* @return void
415	*/
416	public function offsetSet($offset, $value)
417	{
418	$this->$offset = $value;
419	}
420
421	/**
422	* Unsets offset.
423	* @param integer $offset Offset
424	* @return void
425	*/
426	public function offsetUnset($offset)
427	{
428	unset($this->$offset);
429	}
430
431	/**
432	* Gets the string presentation of the object
433	* @return string
434	*/
435	public function __toString()
436	{
437	if (defined('JSON_PRETTY_PRINT')) {
438	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT);
439	} else {
440	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this));
441	}
442	}
443	}
444