CreateCheckoutRequest.php — WooCommerce Square 2.2.5

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

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

CreateCheckoutRequest.php

411 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	* CreateCheckoutRequest 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 CreateCheckoutRequest implements ArrayAccess
21	{
22	/**
23	* Array of property to type mappings. Used for (de)serialization
24	* @var string[]
25	*/
26	static $swaggerTypes = array(
27	'idempotency_key' => 'string',
28	'order' => '\SquareConnect\Model\CreateOrderRequest',
29	'ask_for_shipping_address' => 'bool',
30	'merchant_support_email' => 'string',
31	'pre_populate_buyer_email' => 'string',
32	'pre_populate_shipping_address' => '\SquareConnect\Model\Address',
33	'redirect_url' => 'string',
34	'additional_recipients' => '\SquareConnect\Model\ChargeRequestAdditionalRecipient[]',
35	'note' => 'string'
36	);
37
38	/**
39	* Array of attributes where the key is the local name, and the value is the original name
40	* @var string[]
41	*/
42	static $attributeMap = array(
43	'idempotency_key' => 'idempotency_key',
44	'order' => 'order',
45	'ask_for_shipping_address' => 'ask_for_shipping_address',
46	'merchant_support_email' => 'merchant_support_email',
47	'pre_populate_buyer_email' => 'pre_populate_buyer_email',
48	'pre_populate_shipping_address' => 'pre_populate_shipping_address',
49	'redirect_url' => 'redirect_url',
50	'additional_recipients' => 'additional_recipients',
51	'note' => 'note'
52	);
53
54	/**
55	* Array of attributes to setter functions (for deserialization of responses)
56	* @var string[]
57	*/
58	static $setters = array(
59	'idempotency_key' => 'setIdempotencyKey',
60	'order' => 'setOrder',
61	'ask_for_shipping_address' => 'setAskForShippingAddress',
62	'merchant_support_email' => 'setMerchantSupportEmail',
63	'pre_populate_buyer_email' => 'setPrePopulateBuyerEmail',
64	'pre_populate_shipping_address' => 'setPrePopulateShippingAddress',
65	'redirect_url' => 'setRedirectUrl',
66	'additional_recipients' => 'setAdditionalRecipients',
67	'note' => 'setNote'
68	);
69
70	/**
71	* Array of attributes to getter functions (for serialization of requests)
72	* @var string[]
73	*/
74	static $getters = array(
75	'idempotency_key' => 'getIdempotencyKey',
76	'order' => 'getOrder',
77	'ask_for_shipping_address' => 'getAskForShippingAddress',
78	'merchant_support_email' => 'getMerchantSupportEmail',
79	'pre_populate_buyer_email' => 'getPrePopulateBuyerEmail',
80	'pre_populate_shipping_address' => 'getPrePopulateShippingAddress',
81	'redirect_url' => 'getRedirectUrl',
82	'additional_recipients' => 'getAdditionalRecipients',
83	'note' => 'getNote'
84	);
85
86	/**
87	* $idempotency_key A unique string that identifies this checkout among others you've created. It can be any valid string but must be unique for every order sent to Square Checkout for a given location ID. The idempotency key is used to avoid processing the same order more than once. If you're unsure whether a particular checkout was created successfully, you can reattempt it with the same idempotency key and all the same other parameters without worrying about creating duplicates. We recommend using a random number/string generator native to the language you are working in to generate strings for your idempotency keys. See [Idempotency](/basics/api101/idempotency) for more information.
88	* @var string
89	*/
90	protected $idempotency_key;
91	/**
92	* $order The order including line items to be checked out.
93	* @var \SquareConnect\Model\CreateOrderRequest
94	*/
95	protected $order;
96	/**
97	* $ask_for_shipping_address If `true`, Square Checkout will collect shipping information on your behalf and store that information with the transaction information in your Square Dashboard. Default: `false`.
98	* @var bool
99	*/
100	protected $ask_for_shipping_address;
101	/**
102	* $merchant_support_email The email address to display on the Square Checkout confirmation page and confirmation email that the buyer can use to contact the merchant. If this value is not set, the confirmation page and email will display the primary email address associated with the merchant's Square account. Default: none; only exists if explicitly set.
103	* @var string
104	*/
105	protected $merchant_support_email;
106	/**
107	* $pre_populate_buyer_email If provided, the buyer's email is pre-populated on the checkout page as an editable text field. Default: none; only exists if explicitly set.
108	* @var string
109	*/
110	protected $pre_populate_buyer_email;
111	/**
112	* $pre_populate_shipping_address If provided, the buyer's shipping info is pre-populated on the checkout page as editable text fields. Default: none; only exists if explicitly set.
113	* @var \SquareConnect\Model\Address
114	*/
115	protected $pre_populate_shipping_address;
116	/**
117	* $redirect_url The URL to redirect to after checkout is completed with `checkoutId`, Square's `orderId`, `transactionId`, and `referenceId` appended as URL parameters. For example, if the provided redirect_url is `http://www.example.com/order-complete`, a successful transaction redirects the customer to: `http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx` If you do not provide a redirect URL, Square Checkout will display an order confirmation page on your behalf; however Square strongly recommends that you provide a redirect URL so you can verify the transaction results and finalize the order through your existing/normal confirmation workflow. Default: none; only exists if explicitly set.
118	* @var string
119	*/
120	protected $redirect_url;
121	/**
122	* $additional_recipients The basic primitive of multi-party transaction. The value is optional. The transaction facilitated by you can be split from here. If you provide this value, the `amount_money` value in your additional_recipients must not be more than 90% of the `total_money` calculated by Square for your order. The `location_id` must be the valid location of the app owner merchant. This field requires `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission. This field is currently not supported in sandbox.
123	* @var \SquareConnect\Model\ChargeRequestAdditionalRecipient[]
124	*/
125	protected $additional_recipients;
126	/**
127	* $note An optional note to associate with the checkout object. This value cannot exceed 60 characters.
128	* @var string
129	*/
130	protected $note;
131
132	/**
133	* Constructor
134	* @param mixed[] $data Associated array of property value initializing the model
135	*/
136	public function __construct(array $data = null)
137	{
138	if ($data != null) {
139	if (isset($data["idempotency_key"])) {
140	$this->idempotency_key = $data["idempotency_key"];
141	} else {
142	$this->idempotency_key = null;
143	}
144	if (isset($data["order"])) {
145	$this->order = $data["order"];
146	} else {
147	$this->order = null;
148	}
149	if (isset($data["ask_for_shipping_address"])) {
150	$this->ask_for_shipping_address = $data["ask_for_shipping_address"];
151	} else {
152	$this->ask_for_shipping_address = null;
153	}
154	if (isset($data["merchant_support_email"])) {
155	$this->merchant_support_email = $data["merchant_support_email"];
156	} else {
157	$this->merchant_support_email = null;
158	}
159	if (isset($data["pre_populate_buyer_email"])) {
160	$this->pre_populate_buyer_email = $data["pre_populate_buyer_email"];
161	} else {
162	$this->pre_populate_buyer_email = null;
163	}
164	if (isset($data["pre_populate_shipping_address"])) {
165	$this->pre_populate_shipping_address = $data["pre_populate_shipping_address"];
166	} else {
167	$this->pre_populate_shipping_address = null;
168	}
169	if (isset($data["redirect_url"])) {
170	$this->redirect_url = $data["redirect_url"];
171	} else {
172	$this->redirect_url = null;
173	}
174	if (isset($data["additional_recipients"])) {
175	$this->additional_recipients = $data["additional_recipients"];
176	} else {
177	$this->additional_recipients = null;
178	}
179	if (isset($data["note"])) {
180	$this->note = $data["note"];
181	} else {
182	$this->note = null;
183	}
184	}
185	}
186	/**
187	* Gets idempotency_key
188	* @return string
189	*/
190	public function getIdempotencyKey()
191	{
192	return $this->idempotency_key;
193	}
194
195	/**
196	* Sets idempotency_key
197	* @param string $idempotency_key A unique string that identifies this checkout among others you've created. It can be any valid string but must be unique for every order sent to Square Checkout for a given location ID. The idempotency key is used to avoid processing the same order more than once. If you're unsure whether a particular checkout was created successfully, you can reattempt it with the same idempotency key and all the same other parameters without worrying about creating duplicates. We recommend using a random number/string generator native to the language you are working in to generate strings for your idempotency keys. See [Idempotency](/basics/api101/idempotency) for more information.
198	* @return $this
199	*/
200	public function setIdempotencyKey($idempotency_key)
201	{
202	$this->idempotency_key = $idempotency_key;
203	return $this;
204	}
205	/**
206	* Gets order
207	* @return \SquareConnect\Model\CreateOrderRequest
208	*/
209	public function getOrder()
210	{
211	return $this->order;
212	}
213
214	/**
215	* Sets order
216	* @param \SquareConnect\Model\CreateOrderRequest $order The order including line items to be checked out.
217	* @return $this
218	*/
219	public function setOrder($order)
220	{
221	$this->order = $order;
222	return $this;
223	}
224	/**
225	* Gets ask_for_shipping_address
226	* @return bool
227	*/
228	public function getAskForShippingAddress()
229	{
230	return $this->ask_for_shipping_address;
231	}
232
233	/**
234	* Sets ask_for_shipping_address
235	* @param bool $ask_for_shipping_address If `true`, Square Checkout will collect shipping information on your behalf and store that information with the transaction information in your Square Dashboard. Default: `false`.
236	* @return $this
237	*/
238	public function setAskForShippingAddress($ask_for_shipping_address)
239	{
240	$this->ask_for_shipping_address = $ask_for_shipping_address;
241	return $this;
242	}
243	/**
244	* Gets merchant_support_email
245	* @return string
246	*/
247	public function getMerchantSupportEmail()
248	{
249	return $this->merchant_support_email;
250	}
251
252	/**
253	* Sets merchant_support_email
254	* @param string $merchant_support_email The email address to display on the Square Checkout confirmation page and confirmation email that the buyer can use to contact the merchant. If this value is not set, the confirmation page and email will display the primary email address associated with the merchant's Square account. Default: none; only exists if explicitly set.
255	* @return $this
256	*/
257	public function setMerchantSupportEmail($merchant_support_email)
258	{
259	$this->merchant_support_email = $merchant_support_email;
260	return $this;
261	}
262	/**
263	* Gets pre_populate_buyer_email
264	* @return string
265	*/
266	public function getPrePopulateBuyerEmail()
267	{
268	return $this->pre_populate_buyer_email;
269	}
270
271	/**
272	* Sets pre_populate_buyer_email
273	* @param string $pre_populate_buyer_email If provided, the buyer's email is pre-populated on the checkout page as an editable text field. Default: none; only exists if explicitly set.
274	* @return $this
275	*/
276	public function setPrePopulateBuyerEmail($pre_populate_buyer_email)
277	{
278	$this->pre_populate_buyer_email = $pre_populate_buyer_email;
279	return $this;
280	}
281	/**
282	* Gets pre_populate_shipping_address
283	* @return \SquareConnect\Model\Address
284	*/
285	public function getPrePopulateShippingAddress()
286	{
287	return $this->pre_populate_shipping_address;
288	}
289
290	/**
291	* Sets pre_populate_shipping_address
292	* @param \SquareConnect\Model\Address $pre_populate_shipping_address If provided, the buyer's shipping info is pre-populated on the checkout page as editable text fields. Default: none; only exists if explicitly set.
293	* @return $this
294	*/
295	public function setPrePopulateShippingAddress($pre_populate_shipping_address)
296	{
297	$this->pre_populate_shipping_address = $pre_populate_shipping_address;
298	return $this;
299	}
300	/**
301	* Gets redirect_url
302	* @return string
303	*/
304	public function getRedirectUrl()
305	{
306	return $this->redirect_url;
307	}
308
309	/**
310	* Sets redirect_url
311	* @param string $redirect_url The URL to redirect to after checkout is completed with `checkoutId`, Square's `orderId`, `transactionId`, and `referenceId` appended as URL parameters. For example, if the provided redirect_url is `http://www.example.com/order-complete`, a successful transaction redirects the customer to: `http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx` If you do not provide a redirect URL, Square Checkout will display an order confirmation page on your behalf; however Square strongly recommends that you provide a redirect URL so you can verify the transaction results and finalize the order through your existing/normal confirmation workflow. Default: none; only exists if explicitly set.
312	* @return $this
313	*/
314	public function setRedirectUrl($redirect_url)
315	{
316	$this->redirect_url = $redirect_url;
317	return $this;
318	}
319	/**
320	* Gets additional_recipients
321	* @return \SquareConnect\Model\ChargeRequestAdditionalRecipient[]
322	*/
323	public function getAdditionalRecipients()
324	{
325	return $this->additional_recipients;
326	}
327
328	/**
329	* Sets additional_recipients
330	* @param \SquareConnect\Model\ChargeRequestAdditionalRecipient[] $additional_recipients The basic primitive of multi-party transaction. The value is optional. The transaction facilitated by you can be split from here. If you provide this value, the `amount_money` value in your additional_recipients must not be more than 90% of the `total_money` calculated by Square for your order. The `location_id` must be the valid location of the app owner merchant. This field requires `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission. This field is currently not supported in sandbox.
331	* @return $this
332	*/
333	public function setAdditionalRecipients($additional_recipients)
334	{
335	$this->additional_recipients = $additional_recipients;
336	return $this;
337	}
338	/**
339	* Gets note
340	* @return string
341	*/
342	public function getNote()
343	{
344	return $this->note;
345	}
346
347	/**
348	* Sets note
349	* @param string $note An optional note to associate with the checkout object. This value cannot exceed 60 characters.
350	* @return $this
351	*/
352	public function setNote($note)
353	{
354	$this->note = $note;
355	return $this;
356	}
357	/**
358	* Returns true if offset exists. False otherwise.
359	* @param integer $offset Offset
360	* @return boolean
361	*/
362	public function offsetExists($offset)
363	{
364	return isset($this->$offset);
365	}
366
367	/**
368	* Gets offset.
369	* @param integer $offset Offset
370	* @return mixed
371	*/
372	public function offsetGet($offset)
373	{
374	return $this->$offset;
375	}
376
377	/**
378	* Sets value based on offset.
379	* @param integer $offset Offset
380	* @param mixed $value Value to be set
381	* @return void
382	*/
383	public function offsetSet($offset, $value)
384	{
385	$this->$offset = $value;
386	}
387
388	/**
389	* Unsets offset.
390	* @param integer $offset Offset
391	* @return void
392	*/
393	public function offsetUnset($offset)
394	{
395	unset($this->$offset);
396	}
397
398	/**
399	* Gets the string presentation of the object
400	* @return string
401	*/
402	public function __toString()
403	{
404	if (defined('JSON_PRETTY_PRINT')) {
405	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT);
406	} else {
407	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this));
408	}
409	}
410	}
411