V1Discount.php — WooCommerce Square 2.2.5

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

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

V1Discount.php

378 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	* V1Discount 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 V1Discount 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	'rate' => 'string',
30	'amount_money' => '\SquareConnect\Model\V1Money',
31	'discount_type' => 'string',
32	'pin_required' => 'bool',
33	'color' => 'string',
34	'v2_id' => 'string'
35	);
36
37	/**
38	* Array of attributes where the key is the local name, and the value is the original name
39	* @var string[]
40	*/
41	static $attributeMap = array(
42	'id' => 'id',
43	'name' => 'name',
44	'rate' => 'rate',
45	'amount_money' => 'amount_money',
46	'discount_type' => 'discount_type',
47	'pin_required' => 'pin_required',
48	'color' => 'color',
49	'v2_id' => 'v2_id'
50	);
51
52	/**
53	* Array of attributes to setter functions (for deserialization of responses)
54	* @var string[]
55	*/
56	static $setters = array(
57	'id' => 'setId',
58	'name' => 'setName',
59	'rate' => 'setRate',
60	'amount_money' => 'setAmountMoney',
61	'discount_type' => 'setDiscountType',
62	'pin_required' => 'setPinRequired',
63	'color' => 'setColor',
64	'v2_id' => 'setV2Id'
65	);
66
67	/**
68	* Array of attributes to getter functions (for serialization of requests)
69	* @var string[]
70	*/
71	static $getters = array(
72	'id' => 'getId',
73	'name' => 'getName',
74	'rate' => 'getRate',
75	'amount_money' => 'getAmountMoney',
76	'discount_type' => 'getDiscountType',
77	'pin_required' => 'getPinRequired',
78	'color' => 'getColor',
79	'v2_id' => 'getV2Id'
80	);
81
82	/**
83	* $id The discount's unique ID.
84	* @var string
85	*/
86	protected $id;
87	/**
88	* $name The discount's name.
89	* @var string
90	*/
91	protected $name;
92	/**
93	* $rate The rate of the discount, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. This rate is 0 if discount_type is VARIABLE_PERCENTAGE.
94	* @var string
95	*/
96	protected $rate;
97	/**
98	* $amount_money The amount of the discount. This amount is 0 if discount_type is VARIABLE_AMOUNT. This field is not included for rate-based discounts.
99	* @var \SquareConnect\Model\V1Money
100	*/
101	protected $amount_money;
102	/**
103	* $discount_type Indicates whether the discount is a FIXED value or entered at the time of sale. See [V1DiscountDiscountType](#type-v1discountdiscounttype) for possible values
104	* @var string
105	*/
106	protected $discount_type;
107	/**
108	* $pin_required Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment.
109	* @var bool
110	*/
111	protected $pin_required;
112	/**
113	* $color The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1DiscountColor](#type-v1discountcolor) for possible values
114	* @var string
115	*/
116	protected $color;
117	/**
118	* $v2_id The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.
119	* @var string
120	*/
121	protected $v2_id;
122
123	/**
124	* Constructor
125	* @param mixed[] $data Associated array of property value initializing the model
126	*/
127	public function __construct(array $data = null)
128	{
129	if ($data != null) {
130	if (isset($data["id"])) {
131	$this->id = $data["id"];
132	} else {
133	$this->id = null;
134	}
135	if (isset($data["name"])) {
136	$this->name = $data["name"];
137	} else {
138	$this->name = null;
139	}
140	if (isset($data["rate"])) {
141	$this->rate = $data["rate"];
142	} else {
143	$this->rate = null;
144	}
145	if (isset($data["amount_money"])) {
146	$this->amount_money = $data["amount_money"];
147	} else {
148	$this->amount_money = null;
149	}
150	if (isset($data["discount_type"])) {
151	$this->discount_type = $data["discount_type"];
152	} else {
153	$this->discount_type = null;
154	}
155	if (isset($data["pin_required"])) {
156	$this->pin_required = $data["pin_required"];
157	} else {
158	$this->pin_required = null;
159	}
160	if (isset($data["color"])) {
161	$this->color = $data["color"];
162	} else {
163	$this->color = null;
164	}
165	if (isset($data["v2_id"])) {
166	$this->v2_id = $data["v2_id"];
167	} else {
168	$this->v2_id = null;
169	}
170	}
171	}
172	/**
173	* Gets id
174	* @return string
175	*/
176	public function getId()
177	{
178	return $this->id;
179	}
180
181	/**
182	* Sets id
183	* @param string $id The discount's unique ID.
184	* @return $this
185	*/
186	public function setId($id)
187	{
188	$this->id = $id;
189	return $this;
190	}
191	/**
192	* Gets name
193	* @return string
194	*/
195	public function getName()
196	{
197	return $this->name;
198	}
199
200	/**
201	* Sets name
202	* @param string $name The discount's name.
203	* @return $this
204	*/
205	public function setName($name)
206	{
207	$this->name = $name;
208	return $this;
209	}
210	/**
211	* Gets rate
212	* @return string
213	*/
214	public function getRate()
215	{
216	return $this->rate;
217	}
218
219	/**
220	* Sets rate
221	* @param string $rate The rate of the discount, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. This rate is 0 if discount_type is VARIABLE_PERCENTAGE.
222	* @return $this
223	*/
224	public function setRate($rate)
225	{
226	$this->rate = $rate;
227	return $this;
228	}
229	/**
230	* Gets amount_money
231	* @return \SquareConnect\Model\V1Money
232	*/
233	public function getAmountMoney()
234	{
235	return $this->amount_money;
236	}
237
238	/**
239	* Sets amount_money
240	* @param \SquareConnect\Model\V1Money $amount_money The amount of the discount. This amount is 0 if discount_type is VARIABLE_AMOUNT. This field is not included for rate-based discounts.
241	* @return $this
242	*/
243	public function setAmountMoney($amount_money)
244	{
245	$this->amount_money = $amount_money;
246	return $this;
247	}
248	/**
249	* Gets discount_type
250	* @return string
251	*/
252	public function getDiscountType()
253	{
254	return $this->discount_type;
255	}
256
257	/**
258	* Sets discount_type
259	* @param string $discount_type Indicates whether the discount is a FIXED value or entered at the time of sale. See [V1DiscountDiscountType](#type-v1discountdiscounttype) for possible values
260	* @return $this
261	*/
262	public function setDiscountType($discount_type)
263	{
264	$this->discount_type = $discount_type;
265	return $this;
266	}
267	/**
268	* Gets pin_required
269	* @return bool
270	*/
271	public function getPinRequired()
272	{
273	return $this->pin_required;
274	}
275
276	/**
277	* Sets pin_required
278	* @param bool $pin_required Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment.
279	* @return $this
280	*/
281	public function setPinRequired($pin_required)
282	{
283	$this->pin_required = $pin_required;
284	return $this;
285	}
286	/**
287	* Gets color
288	* @return string
289	*/
290	public function getColor()
291	{
292	return $this->color;
293	}
294
295	/**
296	* Sets color
297	* @param string $color The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1DiscountColor](#type-v1discountcolor) for possible values
298	* @return $this
299	*/
300	public function setColor($color)
301	{
302	$this->color = $color;
303	return $this;
304	}
305	/**
306	* Gets v2_id
307	* @return string
308	*/
309	public function getV2Id()
310	{
311	return $this->v2_id;
312	}
313
314	/**
315	* Sets v2_id
316	* @param string $v2_id The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.
317	* @return $this
318	*/
319	public function setV2Id($v2_id)
320	{
321	$this->v2_id = $v2_id;
322	return $this;
323	}
324	/**
325	* Returns true if offset exists. False otherwise.
326	* @param integer $offset Offset
327	* @return boolean
328	*/
329	public function offsetExists($offset)
330	{
331	return isset($this->$offset);
332	}
333
334	/**
335	* Gets offset.
336	* @param integer $offset Offset
337	* @return mixed
338	*/
339	public function offsetGet($offset)
340	{
341	return $this->$offset;
342	}
343
344	/**
345	* Sets value based on offset.
346	* @param integer $offset Offset
347	* @param mixed $value Value to be set
348	* @return void
349	*/
350	public function offsetSet($offset, $value)
351	{
352	$this->$offset = $value;
353	}
354
355	/**
356	* Unsets offset.
357	* @param integer $offset Offset
358	* @return void
359	*/
360	public function offsetUnset($offset)
361	{
362	unset($this->$offset);
363	}
364
365	/**
366	* Gets the string presentation of the object
367	* @return string
368	*/
369	public function __toString()
370	{
371	if (defined('JSON_PRETTY_PRINT')) {
372	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT);
373	} else {
374	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this));
375	}
376	}
377	}
378