V1CashDrawerShift.php — WooCommerce Square 2.2.5

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

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

V1CashDrawerShift.php

741 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	* V1CashDrawerShift 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 V1CashDrawerShift 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	'event_type' => 'string',
29	'opened_at' => 'string',
30	'ended_at' => 'string',
31	'closed_at' => 'string',
32	'employee_ids' => 'string[]',
33	'opening_employee_id' => 'string',
34	'ending_employee_id' => 'string',
35	'closing_employee_id' => 'string',
36	'description' => 'string',
37	'starting_cash_money' => '\SquareConnect\Model\V1Money',
38	'cash_payment_money' => '\SquareConnect\Model\V1Money',
39	'cash_refunds_money' => '\SquareConnect\Model\V1Money',
40	'cash_paid_in_money' => '\SquareConnect\Model\V1Money',
41	'cash_paid_out_money' => '\SquareConnect\Model\V1Money',
42	'expected_cash_money' => '\SquareConnect\Model\V1Money',
43	'closed_cash_money' => '\SquareConnect\Model\V1Money',
44	'device' => '\SquareConnect\Model\Device',
45	'events' => '\SquareConnect\Model\V1CashDrawerEvent[]'
46	);
47
48	/**
49	* Array of attributes where the key is the local name, and the value is the original name
50	* @var string[]
51	*/
52	static $attributeMap = array(
53	'id' => 'id',
54	'event_type' => 'event_type',
55	'opened_at' => 'opened_at',
56	'ended_at' => 'ended_at',
57	'closed_at' => 'closed_at',
58	'employee_ids' => 'employee_ids',
59	'opening_employee_id' => 'opening_employee_id',
60	'ending_employee_id' => 'ending_employee_id',
61	'closing_employee_id' => 'closing_employee_id',
62	'description' => 'description',
63	'starting_cash_money' => 'starting_cash_money',
64	'cash_payment_money' => 'cash_payment_money',
65	'cash_refunds_money' => 'cash_refunds_money',
66	'cash_paid_in_money' => 'cash_paid_in_money',
67	'cash_paid_out_money' => 'cash_paid_out_money',
68	'expected_cash_money' => 'expected_cash_money',
69	'closed_cash_money' => 'closed_cash_money',
70	'device' => 'device',
71	'events' => 'events'
72	);
73
74	/**
75	* Array of attributes to setter functions (for deserialization of responses)
76	* @var string[]
77	*/
78	static $setters = array(
79	'id' => 'setId',
80	'event_type' => 'setEventType',
81	'opened_at' => 'setOpenedAt',
82	'ended_at' => 'setEndedAt',
83	'closed_at' => 'setClosedAt',
84	'employee_ids' => 'setEmployeeIds',
85	'opening_employee_id' => 'setOpeningEmployeeId',
86	'ending_employee_id' => 'setEndingEmployeeId',
87	'closing_employee_id' => 'setClosingEmployeeId',
88	'description' => 'setDescription',
89	'starting_cash_money' => 'setStartingCashMoney',
90	'cash_payment_money' => 'setCashPaymentMoney',
91	'cash_refunds_money' => 'setCashRefundsMoney',
92	'cash_paid_in_money' => 'setCashPaidInMoney',
93	'cash_paid_out_money' => 'setCashPaidOutMoney',
94	'expected_cash_money' => 'setExpectedCashMoney',
95	'closed_cash_money' => 'setClosedCashMoney',
96	'device' => 'setDevice',
97	'events' => 'setEvents'
98	);
99
100	/**
101	* Array of attributes to getter functions (for serialization of requests)
102	* @var string[]
103	*/
104	static $getters = array(
105	'id' => 'getId',
106	'event_type' => 'getEventType',
107	'opened_at' => 'getOpenedAt',
108	'ended_at' => 'getEndedAt',
109	'closed_at' => 'getClosedAt',
110	'employee_ids' => 'getEmployeeIds',
111	'opening_employee_id' => 'getOpeningEmployeeId',
112	'ending_employee_id' => 'getEndingEmployeeId',
113	'closing_employee_id' => 'getClosingEmployeeId',
114	'description' => 'getDescription',
115	'starting_cash_money' => 'getStartingCashMoney',
116	'cash_payment_money' => 'getCashPaymentMoney',
117	'cash_refunds_money' => 'getCashRefundsMoney',
118	'cash_paid_in_money' => 'getCashPaidInMoney',
119	'cash_paid_out_money' => 'getCashPaidOutMoney',
120	'expected_cash_money' => 'getExpectedCashMoney',
121	'closed_cash_money' => 'getClosedCashMoney',
122	'device' => 'getDevice',
123	'events' => 'getEvents'
124	);
125
126	/**
127	* $id The shift's unique ID.
128	* @var string
129	*/
130	protected $id;
131	/**
132	* $event_type The shift's current state. See [V1CashDrawerShiftEventType](#type-v1cashdrawershifteventtype) for possible values
133	* @var string
134	*/
135	protected $event_type;
136	/**
137	* $opened_at The time when the shift began, in ISO 8601 format.
138	* @var string
139	*/
140	protected $opened_at;
141	/**
142	* $ended_at The time when the shift ended, in ISO 8601 format.
143	* @var string
144	*/
145	protected $ended_at;
146	/**
147	* $closed_at The time when the shift was closed, in ISO 8601 format.
148	* @var string
149	*/
150	protected $closed_at;
151	/**
152	* $employee_ids The IDs of all employees that were logged into Square Register at some point during the cash drawer shift.
153	* @var string[]
154	*/
155	protected $employee_ids;
156	/**
157	* $opening_employee_id The ID of the employee that started the cash drawer shift.
158	* @var string
159	*/
160	protected $opening_employee_id;
161	/**
162	* $ending_employee_id The ID of the employee that ended the cash drawer shift.
163	* @var string
164	*/
165	protected $ending_employee_id;
166	/**
167	* $closing_employee_id The ID of the employee that closed the cash drawer shift by auditing the cash drawer's contents.
168	* @var string
169	*/
170	protected $closing_employee_id;
171	/**
172	* $description A description of the cash drawer shift.
173	* @var string
174	*/
175	protected $description;
176	/**
177	* $starting_cash_money The amount of money in the cash drawer at the start of the shift.
178	* @var \SquareConnect\Model\V1Money
179	*/
180	protected $starting_cash_money;
181	/**
182	* $cash_payment_money The amount of money added to the cash drawer from cash payments.
183	* @var \SquareConnect\Model\V1Money
184	*/
185	protected $cash_payment_money;
186	/**
187	* $cash_refunds_money The amount of money removed from the cash drawer from cash refunds. This value is always negative or zero.
188	* @var \SquareConnect\Model\V1Money
189	*/
190	protected $cash_refunds_money;
191	/**
192	* $cash_paid_in_money The amount of money added to the cash drawer for reasons other than cash payments.
193	* @var \SquareConnect\Model\V1Money
194	*/
195	protected $cash_paid_in_money;
196	/**
197	* $cash_paid_out_money The amount of money removed from the cash drawer for reasons other than cash refunds.
198	* @var \SquareConnect\Model\V1Money
199	*/
200	protected $cash_paid_out_money;
201	/**
202	* $expected_cash_money The amount of money that should be in the cash drawer at the end of the shift, based on the shift's other money amounts.
203	* @var \SquareConnect\Model\V1Money
204	*/
205	protected $expected_cash_money;
206	/**
207	* $closed_cash_money The amount of money found in the cash drawer at the end of the shift by an auditing employee.
208	* @var \SquareConnect\Model\V1Money
209	*/
210	protected $closed_cash_money;
211	/**
212	* $device The device running Square Register that was connected to the cash drawer.
213	* @var \SquareConnect\Model\Device
214	*/
215	protected $device;
216	/**
217	* $events All of the events (payments, refunds, and so on) that involved the cash drawer during the shift.
218	* @var \SquareConnect\Model\V1CashDrawerEvent[]
219	*/
220	protected $events;
221
222	/**
223	* Constructor
224	* @param mixed[] $data Associated array of property value initializing the model
225	*/
226	public function __construct(array $data = null)
227	{
228	if ($data != null) {
229	if (isset($data["id"])) {
230	$this->id = $data["id"];
231	} else {
232	$this->id = null;
233	}
234	if (isset($data["event_type"])) {
235	$this->event_type = $data["event_type"];
236	} else {
237	$this->event_type = null;
238	}
239	if (isset($data["opened_at"])) {
240	$this->opened_at = $data["opened_at"];
241	} else {
242	$this->opened_at = null;
243	}
244	if (isset($data["ended_at"])) {
245	$this->ended_at = $data["ended_at"];
246	} else {
247	$this->ended_at = null;
248	}
249	if (isset($data["closed_at"])) {
250	$this->closed_at = $data["closed_at"];
251	} else {
252	$this->closed_at = null;
253	}
254	if (isset($data["employee_ids"])) {
255	$this->employee_ids = $data["employee_ids"];
256	} else {
257	$this->employee_ids = null;
258	}
259	if (isset($data["opening_employee_id"])) {
260	$this->opening_employee_id = $data["opening_employee_id"];
261	} else {
262	$this->opening_employee_id = null;
263	}
264	if (isset($data["ending_employee_id"])) {
265	$this->ending_employee_id = $data["ending_employee_id"];
266	} else {
267	$this->ending_employee_id = null;
268	}
269	if (isset($data["closing_employee_id"])) {
270	$this->closing_employee_id = $data["closing_employee_id"];
271	} else {
272	$this->closing_employee_id = null;
273	}
274	if (isset($data["description"])) {
275	$this->description = $data["description"];
276	} else {
277	$this->description = null;
278	}
279	if (isset($data["starting_cash_money"])) {
280	$this->starting_cash_money = $data["starting_cash_money"];
281	} else {
282	$this->starting_cash_money = null;
283	}
284	if (isset($data["cash_payment_money"])) {
285	$this->cash_payment_money = $data["cash_payment_money"];
286	} else {
287	$this->cash_payment_money = null;
288	}
289	if (isset($data["cash_refunds_money"])) {
290	$this->cash_refunds_money = $data["cash_refunds_money"];
291	} else {
292	$this->cash_refunds_money = null;
293	}
294	if (isset($data["cash_paid_in_money"])) {
295	$this->cash_paid_in_money = $data["cash_paid_in_money"];
296	} else {
297	$this->cash_paid_in_money = null;
298	}
299	if (isset($data["cash_paid_out_money"])) {
300	$this->cash_paid_out_money = $data["cash_paid_out_money"];
301	} else {
302	$this->cash_paid_out_money = null;
303	}
304	if (isset($data["expected_cash_money"])) {
305	$this->expected_cash_money = $data["expected_cash_money"];
306	} else {
307	$this->expected_cash_money = null;
308	}
309	if (isset($data["closed_cash_money"])) {
310	$this->closed_cash_money = $data["closed_cash_money"];
311	} else {
312	$this->closed_cash_money = null;
313	}
314	if (isset($data["device"])) {
315	$this->device = $data["device"];
316	} else {
317	$this->device = null;
318	}
319	if (isset($data["events"])) {
320	$this->events = $data["events"];
321	} else {
322	$this->events = null;
323	}
324	}
325	}
326	/**
327	* Gets id
328	* @return string
329	*/
330	public function getId()
331	{
332	return $this->id;
333	}
334
335	/**
336	* Sets id
337	* @param string $id The shift's unique ID.
338	* @return $this
339	*/
340	public function setId($id)
341	{
342	$this->id = $id;
343	return $this;
344	}
345	/**
346	* Gets event_type
347	* @return string
348	*/
349	public function getEventType()
350	{
351	return $this->event_type;
352	}
353
354	/**
355	* Sets event_type
356	* @param string $event_type The shift's current state. See [V1CashDrawerShiftEventType](#type-v1cashdrawershifteventtype) for possible values
357	* @return $this
358	*/
359	public function setEventType($event_type)
360	{
361	$this->event_type = $event_type;
362	return $this;
363	}
364	/**
365	* Gets opened_at
366	* @return string
367	*/
368	public function getOpenedAt()
369	{
370	return $this->opened_at;
371	}
372
373	/**
374	* Sets opened_at
375	* @param string $opened_at The time when the shift began, in ISO 8601 format.
376	* @return $this
377	*/
378	public function setOpenedAt($opened_at)
379	{
380	$this->opened_at = $opened_at;
381	return $this;
382	}
383	/**
384	* Gets ended_at
385	* @return string
386	*/
387	public function getEndedAt()
388	{
389	return $this->ended_at;
390	}
391
392	/**
393	* Sets ended_at
394	* @param string $ended_at The time when the shift ended, in ISO 8601 format.
395	* @return $this
396	*/
397	public function setEndedAt($ended_at)
398	{
399	$this->ended_at = $ended_at;
400	return $this;
401	}
402	/**
403	* Gets closed_at
404	* @return string
405	*/
406	public function getClosedAt()
407	{
408	return $this->closed_at;
409	}
410
411	/**
412	* Sets closed_at
413	* @param string $closed_at The time when the shift was closed, in ISO 8601 format.
414	* @return $this
415	*/
416	public function setClosedAt($closed_at)
417	{
418	$this->closed_at = $closed_at;
419	return $this;
420	}
421	/**
422	* Gets employee_ids
423	* @return string[]
424	*/
425	public function getEmployeeIds()
426	{
427	return $this->employee_ids;
428	}
429
430	/**
431	* Sets employee_ids
432	* @param string[] $employee_ids The IDs of all employees that were logged into Square Register at some point during the cash drawer shift.
433	* @return $this
434	*/
435	public function setEmployeeIds($employee_ids)
436	{
437	$this->employee_ids = $employee_ids;
438	return $this;
439	}
440	/**
441	* Gets opening_employee_id
442	* @return string
443	*/
444	public function getOpeningEmployeeId()
445	{
446	return $this->opening_employee_id;
447	}
448
449	/**
450	* Sets opening_employee_id
451	* @param string $opening_employee_id The ID of the employee that started the cash drawer shift.
452	* @return $this
453	*/
454	public function setOpeningEmployeeId($opening_employee_id)
455	{
456	$this->opening_employee_id = $opening_employee_id;
457	return $this;
458	}
459	/**
460	* Gets ending_employee_id
461	* @return string
462	*/
463	public function getEndingEmployeeId()
464	{
465	return $this->ending_employee_id;
466	}
467
468	/**
469	* Sets ending_employee_id
470	* @param string $ending_employee_id The ID of the employee that ended the cash drawer shift.
471	* @return $this
472	*/
473	public function setEndingEmployeeId($ending_employee_id)
474	{
475	$this->ending_employee_id = $ending_employee_id;
476	return $this;
477	}
478	/**
479	* Gets closing_employee_id
480	* @return string
481	*/
482	public function getClosingEmployeeId()
483	{
484	return $this->closing_employee_id;
485	}
486
487	/**
488	* Sets closing_employee_id
489	* @param string $closing_employee_id The ID of the employee that closed the cash drawer shift by auditing the cash drawer's contents.
490	* @return $this
491	*/
492	public function setClosingEmployeeId($closing_employee_id)
493	{
494	$this->closing_employee_id = $closing_employee_id;
495	return $this;
496	}
497	/**
498	* Gets description
499	* @return string
500	*/
501	public function getDescription()
502	{
503	return $this->description;
504	}
505
506	/**
507	* Sets description
508	* @param string $description A description of the cash drawer shift.
509	* @return $this
510	*/
511	public function setDescription($description)
512	{
513	$this->description = $description;
514	return $this;
515	}
516	/**
517	* Gets starting_cash_money
518	* @return \SquareConnect\Model\V1Money
519	*/
520	public function getStartingCashMoney()
521	{
522	return $this->starting_cash_money;
523	}
524
525	/**
526	* Sets starting_cash_money
527	* @param \SquareConnect\Model\V1Money $starting_cash_money The amount of money in the cash drawer at the start of the shift.
528	* @return $this
529	*/
530	public function setStartingCashMoney($starting_cash_money)
531	{
532	$this->starting_cash_money = $starting_cash_money;
533	return $this;
534	}
535	/**
536	* Gets cash_payment_money
537	* @return \SquareConnect\Model\V1Money
538	*/
539	public function getCashPaymentMoney()
540	{
541	return $this->cash_payment_money;
542	}
543
544	/**
545	* Sets cash_payment_money
546	* @param \SquareConnect\Model\V1Money $cash_payment_money The amount of money added to the cash drawer from cash payments.
547	* @return $this
548	*/
549	public function setCashPaymentMoney($cash_payment_money)
550	{
551	$this->cash_payment_money = $cash_payment_money;
552	return $this;
553	}
554	/**
555	* Gets cash_refunds_money
556	* @return \SquareConnect\Model\V1Money
557	*/
558	public function getCashRefundsMoney()
559	{
560	return $this->cash_refunds_money;
561	}
562
563	/**
564	* Sets cash_refunds_money
565	* @param \SquareConnect\Model\V1Money $cash_refunds_money The amount of money removed from the cash drawer from cash refunds. This value is always negative or zero.
566	* @return $this
567	*/
568	public function setCashRefundsMoney($cash_refunds_money)
569	{
570	$this->cash_refunds_money = $cash_refunds_money;
571	return $this;
572	}
573	/**
574	* Gets cash_paid_in_money
575	* @return \SquareConnect\Model\V1Money
576	*/
577	public function getCashPaidInMoney()
578	{
579	return $this->cash_paid_in_money;
580	}
581
582	/**
583	* Sets cash_paid_in_money
584	* @param \SquareConnect\Model\V1Money $cash_paid_in_money The amount of money added to the cash drawer for reasons other than cash payments.
585	* @return $this
586	*/
587	public function setCashPaidInMoney($cash_paid_in_money)
588	{
589	$this->cash_paid_in_money = $cash_paid_in_money;
590	return $this;
591	}
592	/**
593	* Gets cash_paid_out_money
594	* @return \SquareConnect\Model\V1Money
595	*/
596	public function getCashPaidOutMoney()
597	{
598	return $this->cash_paid_out_money;
599	}
600
601	/**
602	* Sets cash_paid_out_money
603	* @param \SquareConnect\Model\V1Money $cash_paid_out_money The amount of money removed from the cash drawer for reasons other than cash refunds.
604	* @return $this
605	*/
606	public function setCashPaidOutMoney($cash_paid_out_money)
607	{
608	$this->cash_paid_out_money = $cash_paid_out_money;
609	return $this;
610	}
611	/**
612	* Gets expected_cash_money
613	* @return \SquareConnect\Model\V1Money
614	*/
615	public function getExpectedCashMoney()
616	{
617	return $this->expected_cash_money;
618	}
619
620	/**
621	* Sets expected_cash_money
622	* @param \SquareConnect\Model\V1Money $expected_cash_money The amount of money that should be in the cash drawer at the end of the shift, based on the shift's other money amounts.
623	* @return $this
624	*/
625	public function setExpectedCashMoney($expected_cash_money)
626	{
627	$this->expected_cash_money = $expected_cash_money;
628	return $this;
629	}
630	/**
631	* Gets closed_cash_money
632	* @return \SquareConnect\Model\V1Money
633	*/
634	public function getClosedCashMoney()
635	{
636	return $this->closed_cash_money;
637	}
638
639	/**
640	* Sets closed_cash_money
641	* @param \SquareConnect\Model\V1Money $closed_cash_money The amount of money found in the cash drawer at the end of the shift by an auditing employee.
642	* @return $this
643	*/
644	public function setClosedCashMoney($closed_cash_money)
645	{
646	$this->closed_cash_money = $closed_cash_money;
647	return $this;
648	}
649	/**
650	* Gets device
651	* @return \SquareConnect\Model\Device
652	*/
653	public function getDevice()
654	{
655	return $this->device;
656	}
657
658	/**
659	* Sets device
660	* @param \SquareConnect\Model\Device $device The device running Square Register that was connected to the cash drawer.
661	* @return $this
662	*/
663	public function setDevice($device)
664	{
665	$this->device = $device;
666	return $this;
667	}
668	/**
669	* Gets events
670	* @return \SquareConnect\Model\V1CashDrawerEvent[]
671	*/
672	public function getEvents()
673	{
674	return $this->events;
675	}
676
677	/**
678	* Sets events
679	* @param \SquareConnect\Model\V1CashDrawerEvent[] $events All of the events (payments, refunds, and so on) that involved the cash drawer during the shift.
680	* @return $this
681	*/
682	public function setEvents($events)
683	{
684	$this->events = $events;
685	return $this;
686	}
687	/**
688	* Returns true if offset exists. False otherwise.
689	* @param integer $offset Offset
690	* @return boolean
691	*/
692	public function offsetExists($offset)
693	{
694	return isset($this->$offset);
695	}
696
697	/**
698	* Gets offset.
699	* @param integer $offset Offset
700	* @return mixed
701	*/
702	public function offsetGet($offset)
703	{
704	return $this->$offset;
705	}
706
707	/**
708	* Sets value based on offset.
709	* @param integer $offset Offset
710	* @param mixed $value Value to be set
711	* @return void
712	*/
713	public function offsetSet($offset, $value)
714	{
715	$this->$offset = $value;
716	}
717
718	/**
719	* Unsets offset.
720	* @param integer $offset Offset
721	* @return void
722	*/
723	public function offsetUnset($offset)
724	{
725	unset($this->$offset);
726	}
727
728	/**
729	* Gets the string presentation of the object
730	* @return string
731	*/
732	public function __toString()
733	{
734	if (defined('JSON_PRETTY_PRINT')) {
735	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT);
736	} else {
737	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this));
738	}
739	}
740	}
741