Shift.php — WooCommerce Square 2.2.5

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

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

Shift.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	* Shift 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 Shift 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	'employee_id' => 'string',
29	'location_id' => 'string',
30	'timezone' => 'string',
31	'start_at' => 'string',
32	'end_at' => 'string',
33	'wage' => '\SquareConnect\Model\ShiftWage',
34	'breaks' => '\SquareConnect\Model\ModelBreak[]',
35	'status' => 'string',
36	'version' => 'int',
37	'created_at' => 'string',
38	'updated_at' => '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	'employee_id' => 'employee_id',
48	'location_id' => 'location_id',
49	'timezone' => 'timezone',
50	'start_at' => 'start_at',
51	'end_at' => 'end_at',
52	'wage' => 'wage',
53	'breaks' => 'breaks',
54	'status' => 'status',
55	'version' => 'version',
56	'created_at' => 'created_at',
57	'updated_at' => 'updated_at'
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	'employee_id' => 'setEmployeeId',
67	'location_id' => 'setLocationId',
68	'timezone' => 'setTimezone',
69	'start_at' => 'setStartAt',
70	'end_at' => 'setEndAt',
71	'wage' => 'setWage',
72	'breaks' => 'setBreaks',
73	'status' => 'setStatus',
74	'version' => 'setVersion',
75	'created_at' => 'setCreatedAt',
76	'updated_at' => 'setUpdatedAt'
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	'employee_id' => 'getEmployeeId',
86	'location_id' => 'getLocationId',
87	'timezone' => 'getTimezone',
88	'start_at' => 'getStartAt',
89	'end_at' => 'getEndAt',
90	'wage' => 'getWage',
91	'breaks' => 'getBreaks',
92	'status' => 'getStatus',
93	'version' => 'getVersion',
94	'created_at' => 'getCreatedAt',
95	'updated_at' => 'getUpdatedAt'
96	);
97
98	/**
99	* $id UUID for this object
100	* @var string
101	*/
102	protected $id;
103	/**
104	* $employee_id The ID of the employee this shift belongs to.
105	* @var string
106	*/
107	protected $employee_id;
108	/**
109	* $location_id The ID of the location this shift occurred at. Should be based on where the employee clocked in.
110	* @var string
111	*/
112	protected $location_id;
113	/**
114	* $timezone Read-only convenience value that is calculated from the location based on `location_id`. Format: the IANA Timezone Database identifier for the location timezone.
115	* @var string
116	*/
117	protected $timezone;
118	/**
119	* $start_at RFC 3339; shifted to location timezone + offset. Precision up to the minute is respected; seconds are truncated.
120	* @var string
121	*/
122	protected $start_at;
123	/**
124	* $end_at RFC 3339; shifted to timezone + offset. Precision up to the minute is respected; seconds are truncated. The `end_at` minute is not counted when the shift length is calculated. For example, a shift from `00:00` to `08:01` is considered an 8 hour shift (midnight to 8am).
125	* @var string
126	*/
127	protected $end_at;
128	/**
129	* $wage Job and pay related information.
130	* @var \SquareConnect\Model\ShiftWage
131	*/
132	protected $wage;
133	/**
134	* $breaks A list of any paid or unpaid breaks that were taken during this shift.
135	* @var \SquareConnect\Model\ModelBreak[]
136	*/
137	protected $breaks;
138	/**
139	* $status Describes working state of the current `Shift`. See [ShiftStatus](#type-shiftstatus) for possible values
140	* @var string
141	*/
142	protected $status;
143	/**
144	* $version Used for resolving concurrency issues; request will fail if version provided does not match server version at time of request. If not provided, Square executes a blind write; potentially overwriting data from another write.
145	* @var int
146	*/
147	protected $version;
148	/**
149	* $created_at A read-only timestamp in RFC 3339 format; presented in UTC.
150	* @var string
151	*/
152	protected $created_at;
153	/**
154	* $updated_at A read-only timestamp in RFC 3339 format; presented in UTC.
155	* @var string
156	*/
157	protected $updated_at;
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["employee_id"])) {
172	$this->employee_id = $data["employee_id"];
173	} else {
174	$this->employee_id = null;
175	}
176	if (isset($data["location_id"])) {
177	$this->location_id = $data["location_id"];
178	} else {
179	$this->location_id = null;
180	}
181	if (isset($data["timezone"])) {
182	$this->timezone = $data["timezone"];
183	} else {
184	$this->timezone = null;
185	}
186	if (isset($data["start_at"])) {
187	$this->start_at = $data["start_at"];
188	} else {
189	$this->start_at = null;
190	}
191	if (isset($data["end_at"])) {
192	$this->end_at = $data["end_at"];
193	} else {
194	$this->end_at = null;
195	}
196	if (isset($data["wage"])) {
197	$this->wage = $data["wage"];
198	} else {
199	$this->wage = null;
200	}
201	if (isset($data["breaks"])) {
202	$this->breaks = $data["breaks"];
203	} else {
204	$this->breaks = null;
205	}
206	if (isset($data["status"])) {
207	$this->status = $data["status"];
208	} else {
209	$this->status = null;
210	}
211	if (isset($data["version"])) {
212	$this->version = $data["version"];
213	} else {
214	$this->version = null;
215	}
216	if (isset($data["created_at"])) {
217	$this->created_at = $data["created_at"];
218	} else {
219	$this->created_at = null;
220	}
221	if (isset($data["updated_at"])) {
222	$this->updated_at = $data["updated_at"];
223	} else {
224	$this->updated_at = 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 UUID for this object
240	* @return $this
241	*/
242	public function setId($id)
243	{
244	$this->id = $id;
245	return $this;
246	}
247	/**
248	* Gets employee_id
249	* @return string
250	*/
251	public function getEmployeeId()
252	{
253	return $this->employee_id;
254	}
255
256	/**
257	* Sets employee_id
258	* @param string $employee_id The ID of the employee this shift belongs to.
259	* @return $this
260	*/
261	public function setEmployeeId($employee_id)
262	{
263	$this->employee_id = $employee_id;
264	return $this;
265	}
266	/**
267	* Gets location_id
268	* @return string
269	*/
270	public function getLocationId()
271	{
272	return $this->location_id;
273	}
274
275	/**
276	* Sets location_id
277	* @param string $location_id The ID of the location this shift occurred at. Should be based on where the employee clocked in.
278	* @return $this
279	*/
280	public function setLocationId($location_id)
281	{
282	$this->location_id = $location_id;
283	return $this;
284	}
285	/**
286	* Gets timezone
287	* @return string
288	*/
289	public function getTimezone()
290	{
291	return $this->timezone;
292	}
293
294	/**
295	* Sets timezone
296	* @param string $timezone Read-only convenience value that is calculated from the location based on `location_id`. Format: the IANA Timezone Database identifier for the location timezone.
297	* @return $this
298	*/
299	public function setTimezone($timezone)
300	{
301	$this->timezone = $timezone;
302	return $this;
303	}
304	/**
305	* Gets start_at
306	* @return string
307	*/
308	public function getStartAt()
309	{
310	return $this->start_at;
311	}
312
313	/**
314	* Sets start_at
315	* @param string $start_at RFC 3339; shifted to location timezone + offset. Precision up to the minute is respected; seconds are truncated.
316	* @return $this
317	*/
318	public function setStartAt($start_at)
319	{
320	$this->start_at = $start_at;
321	return $this;
322	}
323	/**
324	* Gets end_at
325	* @return string
326	*/
327	public function getEndAt()
328	{
329	return $this->end_at;
330	}
331
332	/**
333	* Sets end_at
334	* @param string $end_at RFC 3339; shifted to timezone + offset. Precision up to the minute is respected; seconds are truncated. The `end_at` minute is not counted when the shift length is calculated. For example, a shift from `00:00` to `08:01` is considered an 8 hour shift (midnight to 8am).
335	* @return $this
336	*/
337	public function setEndAt($end_at)
338	{
339	$this->end_at = $end_at;
340	return $this;
341	}
342	/**
343	* Gets wage
344	* @return \SquareConnect\Model\ShiftWage
345	*/
346	public function getWage()
347	{
348	return $this->wage;
349	}
350
351	/**
352	* Sets wage
353	* @param \SquareConnect\Model\ShiftWage $wage Job and pay related information.
354	* @return $this
355	*/
356	public function setWage($wage)
357	{
358	$this->wage = $wage;
359	return $this;
360	}
361	/**
362	* Gets breaks
363	* @return \SquareConnect\Model\ModelBreak[]
364	*/
365	public function getBreaks()
366	{
367	return $this->breaks;
368	}
369
370	/**
371	* Sets breaks
372	* @param \SquareConnect\Model\ModelBreak[] $breaks A list of any paid or unpaid breaks that were taken during this shift.
373	* @return $this
374	*/
375	public function setBreaks($breaks)
376	{
377	$this->breaks = $breaks;
378	return $this;
379	}
380	/**
381	* Gets status
382	* @return string
383	*/
384	public function getStatus()
385	{
386	return $this->status;
387	}
388
389	/**
390	* Sets status
391	* @param string $status Describes working state of the current `Shift`. See [ShiftStatus](#type-shiftstatus) for possible values
392	* @return $this
393	*/
394	public function setStatus($status)
395	{
396	$this->status = $status;
397	return $this;
398	}
399	/**
400	* Gets version
401	* @return int
402	*/
403	public function getVersion()
404	{
405	return $this->version;
406	}
407
408	/**
409	* Sets version
410	* @param int $version Used for resolving concurrency issues; request will fail if version provided does not match server version at time of request. If not provided, Square executes a blind write; potentially overwriting data from another write.
411	* @return $this
412	*/
413	public function setVersion($version)
414	{
415	$this->version = $version;
416	return $this;
417	}
418	/**
419	* Gets created_at
420	* @return string
421	*/
422	public function getCreatedAt()
423	{
424	return $this->created_at;
425	}
426
427	/**
428	* Sets created_at
429	* @param string $created_at A read-only timestamp in RFC 3339 format; presented in UTC.
430	* @return $this
431	*/
432	public function setCreatedAt($created_at)
433	{
434	$this->created_at = $created_at;
435	return $this;
436	}
437	/**
438	* Gets updated_at
439	* @return string
440	*/
441	public function getUpdatedAt()
442	{
443	return $this->updated_at;
444	}
445
446	/**
447	* Sets updated_at
448	* @param string $updated_at A read-only timestamp in RFC 3339 format; presented in UTC.
449	* @return $this
450	*/
451	public function setUpdatedAt($updated_at)
452	{
453	$this->updated_at = $updated_at;
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