ChargeRequest.php — WooCommerce Square 2.2.5

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

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

ChargeRequest.php

576 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	* ChargeRequest 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 ChargeRequest 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	'amount_money' => '\SquareConnect\Model\Money',
29	'card_nonce' => 'string',
30	'customer_card_id' => 'string',
31	'delay_capture' => 'bool',
32	'reference_id' => 'string',
33	'note' => 'string',
34	'customer_id' => 'string',
35	'billing_address' => '\SquareConnect\Model\Address',
36	'shipping_address' => '\SquareConnect\Model\Address',
37	'buyer_email_address' => 'string',
38	'order_id' => 'string',
39	'additional_recipients' => '\SquareConnect\Model\AdditionalRecipient[]',
40	'verification_token' => 'string'
41	);
42
43	/**
44	* Array of attributes where the key is the local name, and the value is the original name
45	* @var string[]
46	*/
47	static $attributeMap = array(
48	'idempotency_key' => 'idempotency_key',
49	'amount_money' => 'amount_money',
50	'card_nonce' => 'card_nonce',
51	'customer_card_id' => 'customer_card_id',
52	'delay_capture' => 'delay_capture',
53	'reference_id' => 'reference_id',
54	'note' => 'note',
55	'customer_id' => 'customer_id',
56	'billing_address' => 'billing_address',
57	'shipping_address' => 'shipping_address',
58	'buyer_email_address' => 'buyer_email_address',
59	'order_id' => 'order_id',
60	'additional_recipients' => 'additional_recipients',
61	'verification_token' => 'verification_token'
62	);
63
64	/**
65	* Array of attributes to setter functions (for deserialization of responses)
66	* @var string[]
67	*/
68	static $setters = array(
69	'idempotency_key' => 'setIdempotencyKey',
70	'amount_money' => 'setAmountMoney',
71	'card_nonce' => 'setCardNonce',
72	'customer_card_id' => 'setCustomerCardId',
73	'delay_capture' => 'setDelayCapture',
74	'reference_id' => 'setReferenceId',
75	'note' => 'setNote',
76	'customer_id' => 'setCustomerId',
77	'billing_address' => 'setBillingAddress',
78	'shipping_address' => 'setShippingAddress',
79	'buyer_email_address' => 'setBuyerEmailAddress',
80	'order_id' => 'setOrderId',
81	'additional_recipients' => 'setAdditionalRecipients',
82	'verification_token' => 'setVerificationToken'
83	);
84
85	/**
86	* Array of attributes to getter functions (for serialization of requests)
87	* @var string[]
88	*/
89	static $getters = array(
90	'idempotency_key' => 'getIdempotencyKey',
91	'amount_money' => 'getAmountMoney',
92	'card_nonce' => 'getCardNonce',
93	'customer_card_id' => 'getCustomerCardId',
94	'delay_capture' => 'getDelayCapture',
95	'reference_id' => 'getReferenceId',
96	'note' => 'getNote',
97	'customer_id' => 'getCustomerId',
98	'billing_address' => 'getBillingAddress',
99	'shipping_address' => 'getShippingAddress',
100	'buyer_email_address' => 'getBuyerEmailAddress',
101	'order_id' => 'getOrderId',
102	'additional_recipients' => 'getAdditionalRecipients',
103	'verification_token' => 'getVerificationToken'
104	);
105
106	/**
107	* $idempotency_key A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency](/basics/api101/idempotency) for more information.
108	* @var string
109	*/
110	protected $idempotency_key;
111	/**
112	* $amount_money The amount of money to charge. Note that you specify the amount in the __smallest denomination of the applicable currency__. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](#workingwithmonetaryamounts) for details. The value of `currency` must match the currency associated with the business that is charging the card.
113	* @var \SquareConnect\Model\Money
114	*/
115	protected $amount_money;
116	/**
117	* $card_nonce A nonce generated from the `SqPaymentForm` that represents the card to charge. The application that provides a nonce to this endpoint must be the _same application_ that generated the nonce with the `SqPaymentForm`. Otherwise, the nonce is invalid. Do not provide a value for this field if you provide a value for `customer_card_id`.
118	* @var string
119	*/
120	protected $card_nonce;
121	/**
122	* $customer_card_id The ID of the customer card on file to charge. Do not provide a value for this field if you provide a value for `card_nonce`. If you provide this value, you _must_ also provide a value for `customer_id`.
123	* @var string
124	*/
125	protected $customer_card_id;
126	/**
127	* $delay_capture If `true`, the request will only perform an Auth on the provided card. You can then later perform either a Capture (with the [CaptureTransaction](#endpoint-capturetransaction) endpoint) or a Void (with the [VoidTransaction](#endpoint-voidtransaction) endpoint). Default value: `false`
128	* @var bool
129	*/
130	protected $delay_capture;
131	/**
132	* $reference_id An optional ID you can associate with the transaction for your own purposes (such as to associate the transaction with an entity ID in your own database). This value cannot exceed 40 characters.
133	* @var string
134	*/
135	protected $reference_id;
136	/**
137	* $note An optional note to associate with the transaction. This value cannot exceed 60 characters.
138	* @var string
139	*/
140	protected $note;
141	/**
142	* $customer_id The ID of the customer to associate this transaction with. This field is required if you provide a value for `customer_card_id`, and optional otherwise.
143	* @var string
144	*/
145	protected $customer_id;
146	/**
147	* $billing_address The buyer's billing address.
148	* @var \SquareConnect\Model\Address
149	*/
150	protected $billing_address;
151	/**
152	* $shipping_address The buyer's shipping address, if available.
153	* @var \SquareConnect\Model\Address
154	*/
155	protected $shipping_address;
156	/**
157	* $buyer_email_address The buyer's email address, if available.
158	* @var string
159	*/
160	protected $buyer_email_address;
161	/**
162	* $order_id The ID of the order to associate with this transaction. If you provide this value, the `amount_money` value of your request must __exactly match__ the value of the order's `total_money` field.
163	* @var string
164	*/
165	protected $order_id;
166	/**
167	* $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 `amount_money` value in the charge request. The `location_id` must be the valid location of the app owner merchant. This field requires the `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission. This field is currently not supported in sandbox.
168	* @var \SquareConnect\Model\AdditionalRecipient[]
169	*/
170	protected $additional_recipients;
171	/**
172	* $verification_token An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity.
173	* @var string
174	*/
175	protected $verification_token;
176
177	/**
178	* Constructor
179	* @param mixed[] $data Associated array of property value initializing the model
180	*/
181	public function __construct(array $data = null)
182	{
183	if ($data != null) {
184	if (isset($data["idempotency_key"])) {
185	$this->idempotency_key = $data["idempotency_key"];
186	} else {
187	$this->idempotency_key = null;
188	}
189	if (isset($data["amount_money"])) {
190	$this->amount_money = $data["amount_money"];
191	} else {
192	$this->amount_money = null;
193	}
194	if (isset($data["card_nonce"])) {
195	$this->card_nonce = $data["card_nonce"];
196	} else {
197	$this->card_nonce = null;
198	}
199	if (isset($data["customer_card_id"])) {
200	$this->customer_card_id = $data["customer_card_id"];
201	} else {
202	$this->customer_card_id = null;
203	}
204	if (isset($data["delay_capture"])) {
205	$this->delay_capture = $data["delay_capture"];
206	} else {
207	$this->delay_capture = null;
208	}
209	if (isset($data["reference_id"])) {
210	$this->reference_id = $data["reference_id"];
211	} else {
212	$this->reference_id = null;
213	}
214	if (isset($data["note"])) {
215	$this->note = $data["note"];
216	} else {
217	$this->note = null;
218	}
219	if (isset($data["customer_id"])) {
220	$this->customer_id = $data["customer_id"];
221	} else {
222	$this->customer_id = null;
223	}
224	if (isset($data["billing_address"])) {
225	$this->billing_address = $data["billing_address"];
226	} else {
227	$this->billing_address = null;
228	}
229	if (isset($data["shipping_address"])) {
230	$this->shipping_address = $data["shipping_address"];
231	} else {
232	$this->shipping_address = null;
233	}
234	if (isset($data["buyer_email_address"])) {
235	$this->buyer_email_address = $data["buyer_email_address"];
236	} else {
237	$this->buyer_email_address = null;
238	}
239	if (isset($data["order_id"])) {
240	$this->order_id = $data["order_id"];
241	} else {
242	$this->order_id = null;
243	}
244	if (isset($data["additional_recipients"])) {
245	$this->additional_recipients = $data["additional_recipients"];
246	} else {
247	$this->additional_recipients = null;
248	}
249	if (isset($data["verification_token"])) {
250	$this->verification_token = $data["verification_token"];
251	} else {
252	$this->verification_token = null;
253	}
254	}
255	}
256	/**
257	* Gets idempotency_key
258	* @return string
259	*/
260	public function getIdempotencyKey()
261	{
262	return $this->idempotency_key;
263	}
264
265	/**
266	* Sets idempotency_key
267	* @param string $idempotency_key A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency](/basics/api101/idempotency) for more information.
268	* @return $this
269	*/
270	public function setIdempotencyKey($idempotency_key)
271	{
272	$this->idempotency_key = $idempotency_key;
273	return $this;
274	}
275	/**
276	* Gets amount_money
277	* @return \SquareConnect\Model\Money
278	*/
279	public function getAmountMoney()
280	{
281	return $this->amount_money;
282	}
283
284	/**
285	* Sets amount_money
286	* @param \SquareConnect\Model\Money $amount_money The amount of money to charge. Note that you specify the amount in the __smallest denomination of the applicable currency__. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](#workingwithmonetaryamounts) for details. The value of `currency` must match the currency associated with the business that is charging the card.
287	* @return $this
288	*/
289	public function setAmountMoney($amount_money)
290	{
291	$this->amount_money = $amount_money;
292	return $this;
293	}
294	/**
295	* Gets card_nonce
296	* @return string
297	*/
298	public function getCardNonce()
299	{
300	return $this->card_nonce;
301	}
302
303	/**
304	* Sets card_nonce
305	* @param string $card_nonce A nonce generated from the `SqPaymentForm` that represents the card to charge. The application that provides a nonce to this endpoint must be the _same application_ that generated the nonce with the `SqPaymentForm`. Otherwise, the nonce is invalid. Do not provide a value for this field if you provide a value for `customer_card_id`.
306	* @return $this
307	*/
308	public function setCardNonce($card_nonce)
309	{
310	$this->card_nonce = $card_nonce;
311	return $this;
312	}
313	/**
314	* Gets customer_card_id
315	* @return string
316	*/
317	public function getCustomerCardId()
318	{
319	return $this->customer_card_id;
320	}
321
322	/**
323	* Sets customer_card_id
324	* @param string $customer_card_id The ID of the customer card on file to charge. Do not provide a value for this field if you provide a value for `card_nonce`. If you provide this value, you _must_ also provide a value for `customer_id`.
325	* @return $this
326	*/
327	public function setCustomerCardId($customer_card_id)
328	{
329	$this->customer_card_id = $customer_card_id;
330	return $this;
331	}
332	/**
333	* Gets delay_capture
334	* @return bool
335	*/
336	public function getDelayCapture()
337	{
338	return $this->delay_capture;
339	}
340
341	/**
342	* Sets delay_capture
343	* @param bool $delay_capture If `true`, the request will only perform an Auth on the provided card. You can then later perform either a Capture (with the [CaptureTransaction](#endpoint-capturetransaction) endpoint) or a Void (with the [VoidTransaction](#endpoint-voidtransaction) endpoint). Default value: `false`
344	* @return $this
345	*/
346	public function setDelayCapture($delay_capture)
347	{
348	$this->delay_capture = $delay_capture;
349	return $this;
350	}
351	/**
352	* Gets reference_id
353	* @return string
354	*/
355	public function getReferenceId()
356	{
357	return $this->reference_id;
358	}
359
360	/**
361	* Sets reference_id
362	* @param string $reference_id An optional ID you can associate with the transaction for your own purposes (such as to associate the transaction with an entity ID in your own database). This value cannot exceed 40 characters.
363	* @return $this
364	*/
365	public function setReferenceId($reference_id)
366	{
367	$this->reference_id = $reference_id;
368	return $this;
369	}
370	/**
371	* Gets note
372	* @return string
373	*/
374	public function getNote()
375	{
376	return $this->note;
377	}
378
379	/**
380	* Sets note
381	* @param string $note An optional note to associate with the transaction. This value cannot exceed 60 characters.
382	* @return $this
383	*/
384	public function setNote($note)
385	{
386	$this->note = $note;
387	return $this;
388	}
389	/**
390	* Gets customer_id
391	* @return string
392	*/
393	public function getCustomerId()
394	{
395	return $this->customer_id;
396	}
397
398	/**
399	* Sets customer_id
400	* @param string $customer_id The ID of the customer to associate this transaction with. This field is required if you provide a value for `customer_card_id`, and optional otherwise.
401	* @return $this
402	*/
403	public function setCustomerId($customer_id)
404	{
405	$this->customer_id = $customer_id;
406	return $this;
407	}
408	/**
409	* Gets billing_address
410	* @return \SquareConnect\Model\Address
411	*/
412	public function getBillingAddress()
413	{
414	return $this->billing_address;
415	}
416
417	/**
418	* Sets billing_address
419	* @param \SquareConnect\Model\Address $billing_address The buyer's billing address.
420	* @return $this
421	*/
422	public function setBillingAddress($billing_address)
423	{
424	$this->billing_address = $billing_address;
425	return $this;
426	}
427	/**
428	* Gets shipping_address
429	* @return \SquareConnect\Model\Address
430	*/
431	public function getShippingAddress()
432	{
433	return $this->shipping_address;
434	}
435
436	/**
437	* Sets shipping_address
438	* @param \SquareConnect\Model\Address $shipping_address The buyer's shipping address, if available.
439	* @return $this
440	*/
441	public function setShippingAddress($shipping_address)
442	{
443	$this->shipping_address = $shipping_address;
444	return $this;
445	}
446	/**
447	* Gets buyer_email_address
448	* @return string
449	*/
450	public function getBuyerEmailAddress()
451	{
452	return $this->buyer_email_address;
453	}
454
455	/**
456	* Sets buyer_email_address
457	* @param string $buyer_email_address The buyer's email address, if available.
458	* @return $this
459	*/
460	public function setBuyerEmailAddress($buyer_email_address)
461	{
462	$this->buyer_email_address = $buyer_email_address;
463	return $this;
464	}
465	/**
466	* Gets order_id
467	* @return string
468	*/
469	public function getOrderId()
470	{
471	return $this->order_id;
472	}
473
474	/**
475	* Sets order_id
476	* @param string $order_id The ID of the order to associate with this transaction. If you provide this value, the `amount_money` value of your request must __exactly match__ the value of the order's `total_money` field.
477	* @return $this
478	*/
479	public function setOrderId($order_id)
480	{
481	$this->order_id = $order_id;
482	return $this;
483	}
484	/**
485	* Gets additional_recipients
486	* @return \SquareConnect\Model\AdditionalRecipient[]
487	*/
488	public function getAdditionalRecipients()
489	{
490	return $this->additional_recipients;
491	}
492
493	/**
494	* Sets additional_recipients
495	* @param \SquareConnect\Model\AdditionalRecipient[] $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 `amount_money` value in the charge request. The `location_id` must be the valid location of the app owner merchant. This field requires the `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission. This field is currently not supported in sandbox.
496	* @return $this
497	*/
498	public function setAdditionalRecipients($additional_recipients)
499	{
500	$this->additional_recipients = $additional_recipients;
501	return $this;
502	}
503	/**
504	* Gets verification_token
505	* @return string
506	*/
507	public function getVerificationToken()
508	{
509	return $this->verification_token;
510	}
511
512	/**
513	* Sets verification_token
514	* @param string $verification_token An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity.
515	* @return $this
516	*/
517	public function setVerificationToken($verification_token)
518	{
519	$this->verification_token = $verification_token;
520	return $this;
521	}
522	/**
523	* Returns true if offset exists. False otherwise.
524	* @param integer $offset Offset
525	* @return boolean
526	*/
527	public function offsetExists($offset)
528	{
529	return isset($this->$offset);
530	}
531
532	/**
533	* Gets offset.
534	* @param integer $offset Offset
535	* @return mixed
536	*/
537	public function offsetGet($offset)
538	{
539	return $this->$offset;
540	}
541
542	/**
543	* Sets value based on offset.
544	* @param integer $offset Offset
545	* @param mixed $value Value to be set
546	* @return void
547	*/
548	public function offsetSet($offset, $value)
549	{
550	$this->$offset = $value;
551	}
552
553	/**
554	* Unsets offset.
555	* @param integer $offset Offset
556	* @return void
557	*/
558	public function offsetUnset($offset)
559	{
560	unset($this->$offset);
561	}
562
563	/**
564	* Gets the string presentation of the object
565	* @return string
566	*/
567	public function __toString()
568	{
569	if (defined('JSON_PRETTY_PRINT')) {
570	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT);
571	} else {
572	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this));
573	}
574	}
575	}
576