1 <?php
2
3 namespace PayPal\Api;
4
5 use PayPal\Common\PayPalModel;
6
7 /**
8 * Class PayerInfo
9 *
10 * A resource representing a information about Payer.
11 *
12 * @package PayPal\Api
13 *
14 * @property string email
15 * @property string external_remember_me_id
16 * @property string buyer_account_number
17 * @property string salutation
18 * @property string first_name
19 * @property string middle_name
20 * @property string last_name
21 * @property string suffix
22 * @property string payer_id
23 * @property string phone
24 * @property string phone_type
25 * @property string birth_date
26 * @property string tax_id
27 * @property string tax_id_type
28 * @property string country_code
29 * @property \PayPal\Api\Address billing_address
30 */
31 class PayerInfo extends PayPalModel
32 {
33 /**
34 * Email address representing the payer. 127 characters max.
35 *
36 * @param string $email
37 *
38 * @return $this
39 */
40 public function setEmail($email)
41 {
42 $this->email = $email;
43 return $this;
44 }
45
46 /**
47 * Email address representing the payer. 127 characters max.
48 *
49 * @return string
50 */
51 public function getEmail()
52 {
53 return $this->email;
54 }
55
56 /**
57 * External Remember Me id representing the payer
58 *
59 * @param string $external_remember_me_id
60 *
61 * @return $this
62 */
63 public function setExternalRememberMeId($external_remember_me_id)
64 {
65 $this->external_remember_me_id = $external_remember_me_id;
66 return $this;
67 }
68
69 /**
70 * External Remember Me id representing the payer
71 *
72 * @return string
73 */
74 public function getExternalRememberMeId()
75 {
76 return $this->external_remember_me_id;
77 }
78
79 /**
80 * Account Number representing the Payer
81 *
82 * @deprecated Use #setBuyerAccountNumberInstead
83 * @param string $account_number
84 *
85 * @return $this
86 */
87 public function setAccountNumber($account_number)
88 {
89 $this->account_number = $account_number;
90 return $this;
91 }
92
93 /**
94 * Account Number representing the Payer
95 *
96 * @deprecated Use #getBuyerAccountNumberInstead
97 *
98 * @deprecated Not publicly available
99 * @return string
100 */
101 public function getAccountNumber()
102 {
103 return $this->account_number;
104 }
105
106 /**
107 * Account Number representing the Payer
108 *
109 * @param string $buyer_account_number
110 *
111 * @return $this
112 */
113 public function setBuyerAccountNumber($buyer_account_number)
114 {
115 $this->buyer_account_number = $buyer_account_number;
116 return $this;
117 }
118
119 /**
120 * Account Number representing the Payer
121 *
122 * @return string
123 */
124 public function getBuyerAccountNumber()
125 {
126 return $this->buyer_account_number;
127 }
128
129 /**
130 * Salutation of the payer.
131 *
132 * @param string $salutation
133 *
134 * @return $this
135 */
136 public function setSalutation($salutation)
137 {
138 $this->salutation = $salutation;
139 return $this;
140 }
141
142 /**
143 * Salutation of the payer.
144 *
145 * @return string
146 */
147 public function getSalutation()
148 {
149 return $this->salutation;
150 }
151
152 /**
153 * First name of the payer.
154 *
155 * @param string $first_name
156 *
157 * @return $this
158 */
159 public function setFirstName($first_name)
160 {
161 $this->first_name = $first_name;
162 return $this;
163 }
164
165 /**
166 * First name of the payer.
167 *
168 * @return string
169 */
170 public function getFirstName()
171 {
172 return $this->first_name;
173 }
174
175 /**
176 * Middle name of the payer.
177 *
178 * @param string $middle_name
179 *
180 * @return $this
181 */
182 public function setMiddleName($middle_name)
183 {
184 $this->middle_name = $middle_name;
185 return $this;
186 }
187
188 /**
189 * Middle name of the payer.
190 *
191 * @return string
192 */
193 public function getMiddleName()
194 {
195 return $this->middle_name;
196 }
197
198 /**
199 * Last name of the payer.
200 *
201 * @param string $last_name
202 *
203 * @return $this
204 */
205 public function setLastName($last_name)
206 {
207 $this->last_name = $last_name;
208 return $this;
209 }
210
211 /**
212 * Last name of the payer.
213 *
214 * @return string
215 */
216 public function getLastName()
217 {
218 return $this->last_name;
219 }
220
221 /**
222 * Suffix of the payer.
223 *
224 * @param string $suffix
225 *
226 * @return $this
227 */
228 public function setSuffix($suffix)
229 {
230 $this->suffix = $suffix;
231 return $this;
232 }
233
234 /**
235 * Suffix of the payer.
236 *
237 * @return string
238 */
239 public function getSuffix()
240 {
241 return $this->suffix;
242 }
243
244 /**
245 * PayPal assigned encrypted Payer ID.
246 *
247 * @param string $payer_id
248 *
249 * @return $this
250 */
251 public function setPayerId($payer_id)
252 {
253 $this->payer_id = $payer_id;
254 return $this;
255 }
256
257 /**
258 * PayPal assigned encrypted Payer ID.
259 *
260 * @return string
261 */
262 public function getPayerId()
263 {
264 return $this->payer_id;
265 }
266
267 /**
268 * Phone number representing the payer. 20 characters max.
269 *
270 * @param string $phone
271 *
272 * @return $this
273 */
274 public function setPhone($phone)
275 {
276 $this->phone = $phone;
277 return $this;
278 }
279
280 /**
281 * Phone number representing the payer. 20 characters max.
282 *
283 * @return string
284 */
285 public function getPhone()
286 {
287 return $this->phone;
288 }
289
290 /**
291 * Phone type
292 * Valid Values: ["HOME", "WORK", "MOBILE", "OTHER"]
293 *
294 * @param string $phone_type
295 *
296 * @return $this
297 */
298 public function setPhoneType($phone_type)
299 {
300 $this->phone_type = $phone_type;
301 return $this;
302 }
303
304 /**
305 * Phone type
306 *
307 * @return string
308 */
309 public function getPhoneType()
310 {
311 return $this->phone_type;
312 }
313
314 /**
315 * Birth date of the Payer in ISO8601 format (yyyy-mm-dd).
316 *
317 * @param string $birth_date
318 *
319 * @return $this
320 */
321 public function setBirthDate($birth_date)
322 {
323 $this->birth_date = $birth_date;
324 return $this;
325 }
326
327 /**
328 * Birth date of the Payer in ISO8601 format (yyyy-mm-dd).
329 *
330 * @return string
331 */
332 public function getBirthDate()
333 {
334 return $this->birth_date;
335 }
336
337 /**
338 * Payer’s tax ID. Only supported when the `payment_method` is set to `paypal`.
339 *
340 * @param string $tax_id
341 *
342 * @return $this
343 */
344 public function setTaxId($tax_id)
345 {
346 $this->tax_id = $tax_id;
347 return $this;
348 }
349
350 /**
351 * Payer’s tax ID. Only supported when the `payment_method` is set to `paypal`.
352 *
353 * @return string
354 */
355 public function getTaxId()
356 {
357 return $this->tax_id;
358 }
359
360 /**
361 * Payer’s tax ID type. Allowed values: `BR_CPF` or `BR_CNPJ`. Only supported when the `payment_method` is set to `paypal`.
362 * Valid Values: ["BR_CPF", "BR_CNPJ"]
363 *
364 * @param string $tax_id_type
365 *
366 * @return $this
367 */
368 public function setTaxIdType($tax_id_type)
369 {
370 $this->tax_id_type = $tax_id_type;
371 return $this;
372 }
373
374 /**
375 * Payer’s tax ID type. Allowed values: `BR_CPF` or `BR_CNPJ`. Only supported when the `payment_method` is set to `paypal`.
376 *
377 * @return string
378 */
379 public function getTaxIdType()
380 {
381 return $this->tax_id_type;
382 }
383
384 /**
385 * Two-letter registered country code of the payer to identify the buyer country.
386 *
387 * @param string $country_code
388 *
389 * @return $this
390 */
391 public function setCountryCode($country_code)
392 {
393 $this->country_code = $country_code;
394 return $this;
395 }
396
397 /**
398 * Two-letter registered country code of the payer to identify the buyer country.
399 *
400 * @return string
401 */
402 public function getCountryCode()
403 {
404 return $this->country_code;
405 }
406
407 /**
408 * Billing address of the Payer.
409 *
410 * @param \PayPal\Api\Address $billing_address
411 *
412 * @return $this
413 */
414 public function setBillingAddress($billing_address)
415 {
416 $this->billing_address = $billing_address;
417 return $this;
418 }
419
420 /**
421 * Billing address of the Payer.
422 *
423 * @return \PayPal\Api\Address
424 */
425 public function getBillingAddress()
426 {
427 return $this->billing_address;
428 }
429
430 /**
431 * @deprecated [DEPRECATED] Use shipping address present in purchase unit or at root level of checkout Session.
432 *
433 * @param \PayPal\Api\ShippingAddress $shipping_address
434 *
435 * @return $this
436 */
437 public function setShippingAddress($shipping_address)
438 {
439 $this->shipping_address = $shipping_address;
440 return $this;
441 }
442
443 /**
444 * @deprecated [DEPRECATED] Use shipping address present in purchase unit or at root level of checkout Session.
445 *
446 * @return \PayPal\Api\ShippingAddress
447 */
448 public function getShippingAddress()
449 {
450 return $this->shipping_address;
451 }
452
453 }
454