Location.php — WooCommerce Square 2.2.5

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

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

Location.php

906 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	* Location 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 Location 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	'name' => 'string',
29	'address' => '\SquareConnect\Model\Address',
30	'timezone' => 'string',
31	'capabilities' => 'string[]',
32	'status' => 'string',
33	'created_at' => 'string',
34	'merchant_id' => 'string',
35	'country' => 'string',
36	'language_code' => 'string',
37	'currency' => 'string',
38	'phone_number' => 'string',
39	'business_name' => 'string',
40	'type' => 'string',
41	'website_url' => 'string',
42	'business_hours' => '\SquareConnect\Model\BusinessHours',
43	'business_email' => 'string',
44	'description' => 'string',
45	'twitter_username' => 'string',
46	'instagram_username' => 'string',
47	'facebook_url' => 'string',
48	'coordinates' => '\SquareConnect\Model\Coordinates',
49	'logo_url' => 'string',
50	'pos_background_url' => 'string'
51	);
52
53	/**
54	* Array of attributes where the key is the local name, and the value is the original name
55	* @var string[]
56	*/
57	static $attributeMap = array(
58	'id' => 'id',
59	'name' => 'name',
60	'address' => 'address',
61	'timezone' => 'timezone',
62	'capabilities' => 'capabilities',
63	'status' => 'status',
64	'created_at' => 'created_at',
65	'merchant_id' => 'merchant_id',
66	'country' => 'country',
67	'language_code' => 'language_code',
68	'currency' => 'currency',
69	'phone_number' => 'phone_number',
70	'business_name' => 'business_name',
71	'type' => 'type',
72	'website_url' => 'website_url',
73	'business_hours' => 'business_hours',
74	'business_email' => 'business_email',
75	'description' => 'description',
76	'twitter_username' => 'twitter_username',
77	'instagram_username' => 'instagram_username',
78	'facebook_url' => 'facebook_url',
79	'coordinates' => 'coordinates',
80	'logo_url' => 'logo_url',
81	'pos_background_url' => 'pos_background_url'
82	);
83
84	/**
85	* Array of attributes to setter functions (for deserialization of responses)
86	* @var string[]
87	*/
88	static $setters = array(
89	'id' => 'setId',
90	'name' => 'setName',
91	'address' => 'setAddress',
92	'timezone' => 'setTimezone',
93	'capabilities' => 'setCapabilities',
94	'status' => 'setStatus',
95	'created_at' => 'setCreatedAt',
96	'merchant_id' => 'setMerchantId',
97	'country' => 'setCountry',
98	'language_code' => 'setLanguageCode',
99	'currency' => 'setCurrency',
100	'phone_number' => 'setPhoneNumber',
101	'business_name' => 'setBusinessName',
102	'type' => 'setType',
103	'website_url' => 'setWebsiteUrl',
104	'business_hours' => 'setBusinessHours',
105	'business_email' => 'setBusinessEmail',
106	'description' => 'setDescription',
107	'twitter_username' => 'setTwitterUsername',
108	'instagram_username' => 'setInstagramUsername',
109	'facebook_url' => 'setFacebookUrl',
110	'coordinates' => 'setCoordinates',
111	'logo_url' => 'setLogoUrl',
112	'pos_background_url' => 'setPosBackgroundUrl'
113	);
114
115	/**
116	* Array of attributes to getter functions (for serialization of requests)
117	* @var string[]
118	*/
119	static $getters = array(
120	'id' => 'getId',
121	'name' => 'getName',
122	'address' => 'getAddress',
123	'timezone' => 'getTimezone',
124	'capabilities' => 'getCapabilities',
125	'status' => 'getStatus',
126	'created_at' => 'getCreatedAt',
127	'merchant_id' => 'getMerchantId',
128	'country' => 'getCountry',
129	'language_code' => 'getLanguageCode',
130	'currency' => 'getCurrency',
131	'phone_number' => 'getPhoneNumber',
132	'business_name' => 'getBusinessName',
133	'type' => 'getType',
134	'website_url' => 'getWebsiteUrl',
135	'business_hours' => 'getBusinessHours',
136	'business_email' => 'getBusinessEmail',
137	'description' => 'getDescription',
138	'twitter_username' => 'getTwitterUsername',
139	'instagram_username' => 'getInstagramUsername',
140	'facebook_url' => 'getFacebookUrl',
141	'coordinates' => 'getCoordinates',
142	'logo_url' => 'getLogoUrl',
143	'pos_background_url' => 'getPosBackgroundUrl'
144	);
145
146	/**
147	* $id The location's unique ID.
148	* @var string
149	*/
150	protected $id;
151	/**
152	* $name The location's name. Location names are set by the account owner and displayed in the dashboard as the location's nickname
153	* @var string
154	*/
155	protected $name;
156	/**
157	* $address The location's physical address.
158	* @var \SquareConnect\Model\Address
159	*/
160	protected $address;
161	/**
162	* $timezone The [IANA Timezone Database](https://www.iana.org/time-zones) identifier for the location's timezone.
163	* @var string
164	*/
165	protected $timezone;
166	/**
167	* $capabilities Indicates which Square features are enabled for the location. See [LocationCapability](#type-locationcapability) for possible values
168	* @var string[]
169	*/
170	protected $capabilities;
171	/**
172	* $status The location's status See [LocationStatus](#type-locationstatus) for possible values
173	* @var string
174	*/
175	protected $status;
176	/**
177	* $created_at The time when the location was created, in RFC 3339 format.
178	* @var string
179	*/
180	protected $created_at;
181	/**
182	* $merchant_id The identifier of the merchant that owns the location.
183	* @var string
184	*/
185	protected $merchant_id;
186	/**
187	* $country The location's country, in ISO 3166-1-alpha-2 format. See [Country](#type-country) for possible values
188	* @var string
189	*/
190	protected $country;
191	/**
192	* $language_code The language associated with the location in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A).
193	* @var string
194	*/
195	protected $language_code;
196	/**
197	* $currency The currency used for all transactions at this location, specified in __ISO 4217 format__. For example, the currency for a location processing transactions in the United States is 'USD'. See [Currency](#type-currency) for possible values
198	* @var string
199	*/
200	protected $currency;
201	/**
202	* $phone_number The location's phone_number.
203	* @var string
204	*/
205	protected $phone_number;
206	/**
207	* $business_name The location's business_name which is shown to its customers. For example, this is the name printed on its customer's receipts.
208	* @var string
209	*/
210	protected $business_name;
211	/**
212	* $type The location's type, as set by the account owner in the Square dashboard. Typically used to indicate whether or not the location object represents a physical space like a building or mall space. See [LocationType](#type-locationtype) for possible values
213	* @var string
214	*/
215	protected $type;
216	/**
217	* $website_url The location's website, as set by the account owner in the Square dashboard. Default: none; only exists if explicitly set.
218	* @var string
219	*/
220	protected $website_url;
221	/**
222	* $business_hours The hours of operation for a business location. Default: none; only exists if explicitly set.
223	* @var \SquareConnect\Model\BusinessHours
224	*/
225	protected $business_hours;
226	/**
227	* $business_email The email of the location.
228	* @var string
229	*/
230	protected $business_email;
231	/**
232	* $description The business description of the location.
233	* @var string
234	*/
235	protected $description;
236	/**
237	* $twitter_username The Twitter username of the location without the '
238	* @var string
239	*/
240	protected $twitter_username;
241	/**
242	* $instagram_username The Instagram username of the location without the '
243	* @var string
244	*/
245	protected $instagram_username;
246	/**
247	* $facebook_url The Facebook profile URL of the location. The URL should begin with 'facebook.com/'.
248	* @var string
249	*/
250	protected $facebook_url;
251	/**
252	* $coordinates The physical coordinates (latitude and longitude) of the location.
253	* @var \SquareConnect\Model\Coordinates
254	*/
255	protected $coordinates;
256	/**
257	* $logo_url The logo image URL of the location.
258	* @var string
259	*/
260	protected $logo_url;
261	/**
262	* $pos_background_url The Point of Sale background image URL of the location.
263	* @var string
264	*/
265	protected $pos_background_url;
266
267	/**
268	* Constructor
269	* @param mixed[] $data Associated array of property value initializing the model
270	*/
271	public function __construct(array $data = null)
272	{
273	if ($data != null) {
274	if (isset($data["id"])) {
275	$this->id = $data["id"];
276	} else {
277	$this->id = null;
278	}
279	if (isset($data["name"])) {
280	$this->name = $data["name"];
281	} else {
282	$this->name = null;
283	}
284	if (isset($data["address"])) {
285	$this->address = $data["address"];
286	} else {
287	$this->address = null;
288	}
289	if (isset($data["timezone"])) {
290	$this->timezone = $data["timezone"];
291	} else {
292	$this->timezone = null;
293	}
294	if (isset($data["capabilities"])) {
295	$this->capabilities = $data["capabilities"];
296	} else {
297	$this->capabilities = null;
298	}
299	if (isset($data["status"])) {
300	$this->status = $data["status"];
301	} else {
302	$this->status = null;
303	}
304	if (isset($data["created_at"])) {
305	$this->created_at = $data["created_at"];
306	} else {
307	$this->created_at = null;
308	}
309	if (isset($data["merchant_id"])) {
310	$this->merchant_id = $data["merchant_id"];
311	} else {
312	$this->merchant_id = null;
313	}
314	if (isset($data["country"])) {
315	$this->country = $data["country"];
316	} else {
317	$this->country = null;
318	}
319	if (isset($data["language_code"])) {
320	$this->language_code = $data["language_code"];
321	} else {
322	$this->language_code = null;
323	}
324	if (isset($data["currency"])) {
325	$this->currency = $data["currency"];
326	} else {
327	$this->currency = null;
328	}
329	if (isset($data["phone_number"])) {
330	$this->phone_number = $data["phone_number"];
331	} else {
332	$this->phone_number = null;
333	}
334	if (isset($data["business_name"])) {
335	$this->business_name = $data["business_name"];
336	} else {
337	$this->business_name = null;
338	}
339	if (isset($data["type"])) {
340	$this->type = $data["type"];
341	} else {
342	$this->type = null;
343	}
344	if (isset($data["website_url"])) {
345	$this->website_url = $data["website_url"];
346	} else {
347	$this->website_url = null;
348	}
349	if (isset($data["business_hours"])) {
350	$this->business_hours = $data["business_hours"];
351	} else {
352	$this->business_hours = null;
353	}
354	if (isset($data["business_email"])) {
355	$this->business_email = $data["business_email"];
356	} else {
357	$this->business_email = null;
358	}
359	if (isset($data["description"])) {
360	$this->description = $data["description"];
361	} else {
362	$this->description = null;
363	}
364	if (isset($data["twitter_username"])) {
365	$this->twitter_username = $data["twitter_username"];
366	} else {
367	$this->twitter_username = null;
368	}
369	if (isset($data["instagram_username"])) {
370	$this->instagram_username = $data["instagram_username"];
371	} else {
372	$this->instagram_username = null;
373	}
374	if (isset($data["facebook_url"])) {
375	$this->facebook_url = $data["facebook_url"];
376	} else {
377	$this->facebook_url = null;
378	}
379	if (isset($data["coordinates"])) {
380	$this->coordinates = $data["coordinates"];
381	} else {
382	$this->coordinates = null;
383	}
384	if (isset($data["logo_url"])) {
385	$this->logo_url = $data["logo_url"];
386	} else {
387	$this->logo_url = null;
388	}
389	if (isset($data["pos_background_url"])) {
390	$this->pos_background_url = $data["pos_background_url"];
391	} else {
392	$this->pos_background_url = null;
393	}
394	}
395	}
396	/**
397	* Gets id
398	* @return string
399	*/
400	public function getId()
401	{
402	return $this->id;
403	}
404
405	/**
406	* Sets id
407	* @param string $id The location's unique ID.
408	* @return $this
409	*/
410	public function setId($id)
411	{
412	$this->id = $id;
413	return $this;
414	}
415	/**
416	* Gets name
417	* @return string
418	*/
419	public function getName()
420	{
421	return $this->name;
422	}
423
424	/**
425	* Sets name
426	* @param string $name The location's name. Location names are set by the account owner and displayed in the dashboard as the location's nickname
427	* @return $this
428	*/
429	public function setName($name)
430	{
431	$this->name = $name;
432	return $this;
433	}
434	/**
435	* Gets address
436	* @return \SquareConnect\Model\Address
437	*/
438	public function getAddress()
439	{
440	return $this->address;
441	}
442
443	/**
444	* Sets address
445	* @param \SquareConnect\Model\Address $address The location's physical address.
446	* @return $this
447	*/
448	public function setAddress($address)
449	{
450	$this->address = $address;
451	return $this;
452	}
453	/**
454	* Gets timezone
455	* @return string
456	*/
457	public function getTimezone()
458	{
459	return $this->timezone;
460	}
461
462	/**
463	* Sets timezone
464	* @param string $timezone The [IANA Timezone Database](https://www.iana.org/time-zones) identifier for the location's timezone.
465	* @return $this
466	*/
467	public function setTimezone($timezone)
468	{
469	$this->timezone = $timezone;
470	return $this;
471	}
472	/**
473	* Gets capabilities
474	* @return string[]
475	*/
476	public function getCapabilities()
477	{
478	return $this->capabilities;
479	}
480
481	/**
482	* Sets capabilities
483	* @param string[] $capabilities Indicates which Square features are enabled for the location. See [LocationCapability](#type-locationcapability) for possible values
484	* @return $this
485	*/
486	public function setCapabilities($capabilities)
487	{
488	$this->capabilities = $capabilities;
489	return $this;
490	}
491	/**
492	* Gets status
493	* @return string
494	*/
495	public function getStatus()
496	{
497	return $this->status;
498	}
499
500	/**
501	* Sets status
502	* @param string $status The location's status See [LocationStatus](#type-locationstatus) for possible values
503	* @return $this
504	*/
505	public function setStatus($status)
506	{
507	$this->status = $status;
508	return $this;
509	}
510	/**
511	* Gets created_at
512	* @return string
513	*/
514	public function getCreatedAt()
515	{
516	return $this->created_at;
517	}
518
519	/**
520	* Sets created_at
521	* @param string $created_at The time when the location was created, in RFC 3339 format.
522	* @return $this
523	*/
524	public function setCreatedAt($created_at)
525	{
526	$this->created_at = $created_at;
527	return $this;
528	}
529	/**
530	* Gets merchant_id
531	* @return string
532	*/
533	public function getMerchantId()
534	{
535	return $this->merchant_id;
536	}
537
538	/**
539	* Sets merchant_id
540	* @param string $merchant_id The identifier of the merchant that owns the location.
541	* @return $this
542	*/
543	public function setMerchantId($merchant_id)
544	{
545	$this->merchant_id = $merchant_id;
546	return $this;
547	}
548	/**
549	* Gets country
550	* @return string
551	*/
552	public function getCountry()
553	{
554	return $this->country;
555	}
556
557	/**
558	* Sets country
559	* @param string $country The location's country, in ISO 3166-1-alpha-2 format. See [Country](#type-country) for possible values
560	* @return $this
561	*/
562	public function setCountry($country)
563	{
564	$this->country = $country;
565	return $this;
566	}
567	/**
568	* Gets language_code
569	* @return string
570	*/
571	public function getLanguageCode()
572	{
573	return $this->language_code;
574	}
575
576	/**
577	* Sets language_code
578	* @param string $language_code The language associated with the location in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A).
579	* @return $this
580	*/
581	public function setLanguageCode($language_code)
582	{
583	$this->language_code = $language_code;
584	return $this;
585	}
586	/**
587	* Gets currency
588	* @return string
589	*/
590	public function getCurrency()
591	{
592	return $this->currency;
593	}
594
595	/**
596	* Sets currency
597	* @param string $currency The currency used for all transactions at this location, specified in __ISO 4217 format__. For example, the currency for a location processing transactions in the United States is 'USD'. See [Currency](#type-currency) for possible values
598	* @return $this
599	*/
600	public function setCurrency($currency)
601	{
602	$this->currency = $currency;
603	return $this;
604	}
605	/**
606	* Gets phone_number
607	* @return string
608	*/
609	public function getPhoneNumber()
610	{
611	return $this->phone_number;
612	}
613
614	/**
615	* Sets phone_number
616	* @param string $phone_number The location's phone_number.
617	* @return $this
618	*/
619	public function setPhoneNumber($phone_number)
620	{
621	$this->phone_number = $phone_number;
622	return $this;
623	}
624	/**
625	* Gets business_name
626	* @return string
627	*/
628	public function getBusinessName()
629	{
630	return $this->business_name;
631	}
632
633	/**
634	* Sets business_name
635	* @param string $business_name The location's business_name which is shown to its customers. For example, this is the name printed on its customer's receipts.
636	* @return $this
637	*/
638	public function setBusinessName($business_name)
639	{
640	$this->business_name = $business_name;
641	return $this;
642	}
643	/**
644	* Gets type
645	* @return string
646	*/
647	public function getType()
648	{
649	return $this->type;
650	}
651
652	/**
653	* Sets type
654	* @param string $type The location's type, as set by the account owner in the Square dashboard. Typically used to indicate whether or not the location object represents a physical space like a building or mall space. See [LocationType](#type-locationtype) for possible values
655	* @return $this
656	*/
657	public function setType($type)
658	{
659	$this->type = $type;
660	return $this;
661	}
662	/**
663	* Gets website_url
664	* @return string
665	*/
666	public function getWebsiteUrl()
667	{
668	return $this->website_url;
669	}
670
671	/**
672	* Sets website_url
673	* @param string $website_url The location's website, as set by the account owner in the Square dashboard. Default: none; only exists if explicitly set.
674	* @return $this
675	*/
676	public function setWebsiteUrl($website_url)
677	{
678	$this->website_url = $website_url;
679	return $this;
680	}
681	/**
682	* Gets business_hours
683	* @return \SquareConnect\Model\BusinessHours
684	*/
685	public function getBusinessHours()
686	{
687	return $this->business_hours;
688	}
689
690	/**
691	* Sets business_hours
692	* @param \SquareConnect\Model\BusinessHours $business_hours The hours of operation for a business location. Default: none; only exists if explicitly set.
693	* @return $this
694	*/
695	public function setBusinessHours($business_hours)
696	{
697	$this->business_hours = $business_hours;
698	return $this;
699	}
700	/**
701	* Gets business_email
702	* @return string
703	*/
704	public function getBusinessEmail()
705	{
706	return $this->business_email;
707	}
708
709	/**
710	* Sets business_email
711	* @param string $business_email The email of the location.
712	* @return $this
713	*/
714	public function setBusinessEmail($business_email)
715	{
716	$this->business_email = $business_email;
717	return $this;
718	}
719	/**
720	* Gets description
721	* @return string
722	*/
723	public function getDescription()
724	{
725	return $this->description;
726	}
727
728	/**
729	* Sets description
730	* @param string $description The business description of the location.
731	* @return $this
732	*/
733	public function setDescription($description)
734	{
735	$this->description = $description;
736	return $this;
737	}
738	/**
739	* Gets twitter_username
740	* @return string
741	*/
742	public function getTwitterUsername()
743	{
744	return $this->twitter_username;
745	}
746
747	/**
748	* Sets twitter_username
749	* @param string $twitter_username The Twitter username of the location without the '
750	* @return $this
751	*/
752	public function setTwitterUsername($twitter_username)
753	{
754	$this->twitter_username = $twitter_username;
755	return $this;
756	}
757	/**
758	* Gets instagram_username
759	* @return string
760	*/
761	public function getInstagramUsername()
762	{
763	return $this->instagram_username;
764	}
765
766	/**
767	* Sets instagram_username
768	* @param string $instagram_username The Instagram username of the location without the '
769	* @return $this
770	*/
771	public function setInstagramUsername($instagram_username)
772	{
773	$this->instagram_username = $instagram_username;
774	return $this;
775	}
776	/**
777	* Gets facebook_url
778	* @return string
779	*/
780	public function getFacebookUrl()
781	{
782	return $this->facebook_url;
783	}
784
785	/**
786	* Sets facebook_url
787	* @param string $facebook_url The Facebook profile URL of the location. The URL should begin with 'facebook.com/'.
788	* @return $this
789	*/
790	public function setFacebookUrl($facebook_url)
791	{
792	$this->facebook_url = $facebook_url;
793	return $this;
794	}
795	/**
796	* Gets coordinates
797	* @return \SquareConnect\Model\Coordinates
798	*/
799	public function getCoordinates()
800	{
801	return $this->coordinates;
802	}
803
804	/**
805	* Sets coordinates
806	* @param \SquareConnect\Model\Coordinates $coordinates The physical coordinates (latitude and longitude) of the location.
807	* @return $this
808	*/
809	public function setCoordinates($coordinates)
810	{
811	$this->coordinates = $coordinates;
812	return $this;
813	}
814	/**
815	* Gets logo_url
816	* @return string
817	*/
818	public function getLogoUrl()
819	{
820	return $this->logo_url;
821	}
822
823	/**
824	* Sets logo_url
825	* @param string $logo_url The logo image URL of the location.
826	* @return $this
827	*/
828	public function setLogoUrl($logo_url)
829	{
830	$this->logo_url = $logo_url;
831	return $this;
832	}
833	/**
834	* Gets pos_background_url
835	* @return string
836	*/
837	public function getPosBackgroundUrl()
838	{
839	return $this->pos_background_url;
840	}
841
842	/**
843	* Sets pos_background_url
844	* @param string $pos_background_url The Point of Sale background image URL of the location.
845	* @return $this
846	*/
847	public function setPosBackgroundUrl($pos_background_url)
848	{
849	$this->pos_background_url = $pos_background_url;
850	return $this;
851	}
852	/**
853	* Returns true if offset exists. False otherwise.
854	* @param integer $offset Offset
855	* @return boolean
856	*/
857	public function offsetExists($offset)
858	{
859	return isset($this->$offset);
860	}
861
862	/**
863	* Gets offset.
864	* @param integer $offset Offset
865	* @return mixed
866	*/
867	public function offsetGet($offset)
868	{
869	return $this->$offset;
870	}
871
872	/**
873	* Sets value based on offset.
874	* @param integer $offset Offset
875	* @param mixed $value Value to be set
876	* @return void
877	*/
878	public function offsetSet($offset, $value)
879	{
880	$this->$offset = $value;
881	}
882
883	/**
884	* Unsets offset.
885	* @param integer $offset Offset
886	* @return void
887	*/
888	public function offsetUnset($offset)
889	{
890	unset($this->$offset);
891	}
892
893	/**
894	* Gets the string presentation of the object
895	* @return string
896	*/
897	public function __toString()
898	{
899	if (defined('JSON_PRETTY_PRINT')) {
900	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT);
901	} else {
902	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this));
903	}
904	}
905	}
906