ApiOperations
6 years ago
Checkout
6 years ago
Error
6 years ago
HttpClient
6 years ago
Issuing
6 years ago
Radar
6 years ago
Reporting
6 years ago
Sigma
6 years ago
Terminal
6 years ago
Util
6 years ago
Account.php
6 years ago
AccountLink.php
6 years ago
AlipayAccount.php
6 years ago
ApiRequestor.php
6 years ago
ApiResource.php
6 years ago
ApiResponse.php
6 years ago
ApplePayDomain.php
6 years ago
ApplicationFee.php
6 years ago
ApplicationFeeRefund.php
6 years ago
Balance.php
6 years ago
BalanceTransaction.php
6 years ago
BankAccount.php
6 years ago
BitcoinReceiver.php
6 years ago
BitcoinTransaction.php
6 years ago
Capability.php
6 years ago
Card.php
6 years ago
Charge.php
6 years ago
Collection.php
6 years ago
CountrySpec.php
6 years ago
Coupon.php
6 years ago
CreditNote.php
6 years ago
Customer.php
6 years ago
CustomerBalanceTransaction.php
6 years ago
Discount.php
6 years ago
Dispute.php
6 years ago
EphemeralKey.php
6 years ago
Event.php
6 years ago
ExchangeRate.php
6 years ago
File.php
6 years ago
FileLink.php
6 years ago
FileUpload.php
6 years ago
Invoice.php
6 years ago
InvoiceItem.php
6 years ago
InvoiceLineItem.php
6 years ago
IssuerFraudRecord.php
6 years ago
LoginLink.php
6 years ago
OAuth.php
6 years ago
Order.php
6 years ago
OrderItem.php
6 years ago
OrderReturn.php
6 years ago
PaymentIntent.php
6 years ago
PaymentMethod.php
6 years ago
Payout.php
6 years ago
Person.php
6 years ago
Plan.php
6 years ago
Product.php
6 years ago
Recipient.php
6 years ago
RecipientTransfer.php
6 years ago
Refund.php
6 years ago
RequestTelemetry.php
6 years ago
Review.php
6 years ago
SKU.php
6 years ago
SetupIntent.php
6 years ago
SingletonApiResource.php
6 years ago
Source.php
6 years ago
SourceTransaction.php
6 years ago
Stripe.php
6 years ago
StripeObject.php
6 years ago
Subscription.php
6 years ago
SubscriptionItem.php
6 years ago
SubscriptionSchedule.php
6 years ago
TaxId.php
6 years ago
TaxRate.php
6 years ago
ThreeDSecure.php
6 years ago
Token.php
6 years ago
Topup.php
6 years ago
Transfer.php
6 years ago
TransferReversal.php
6 years ago
UsageRecord.php
6 years ago
UsageRecordSummary.php
6 years ago
Webhook.php
6 years ago
WebhookEndpoint.php
6 years ago
WebhookSignature.php
6 years ago
Person.php
108 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Stripe; |
| 4 | |
| 5 | /** |
| 6 | * Class Person |
| 7 | * |
| 8 | * @package Stripe |
| 9 | * |
| 10 | * @property string $id |
| 11 | * @property string $object |
| 12 | * @property string $account |
| 13 | * @property mixed $address |
| 14 | * @property mixed $address_kana |
| 15 | * @property mixed $address_kanji |
| 16 | * @property int $created |
| 17 | * @property bool $deleted |
| 18 | * @property mixed $dob |
| 19 | * @property string $email |
| 20 | * @property string $first_name |
| 21 | * @property string $first_name_kana |
| 22 | * @property string $first_name_kanji |
| 23 | * @property string $gender |
| 24 | * @property bool $id_number_provided |
| 25 | * @property string $last_name |
| 26 | * @property string $last_name_kana |
| 27 | * @property string $last_name_kanji |
| 28 | * @property string $maiden_name |
| 29 | * @property StripeObject $metadata |
| 30 | * @property string $phone |
| 31 | * @property mixed $relationship |
| 32 | * @property mixed $requirements |
| 33 | * @property bool $ssn_last_4_provided |
| 34 | * @property mixed $verification |
| 35 | */ |
| 36 | class Person extends ApiResource |
| 37 | { |
| 38 | const OBJECT_NAME = "person"; |
| 39 | |
| 40 | use ApiOperations\Delete; |
| 41 | use ApiOperations\Update; |
| 42 | |
| 43 | /** |
| 44 | * Possible string representations of a person's gender. |
| 45 | * @link https://stripe.com/docs/api/persons/object#person_object-gender |
| 46 | */ |
| 47 | const GENDER_MALE = 'male'; |
| 48 | const GENDER_FEMALE = 'female'; |
| 49 | |
| 50 | /** |
| 51 | * Possible string representations of a person's verification status. |
| 52 | * @link https://stripe.com/docs/api/persons/object#person_object-verification-status |
| 53 | */ |
| 54 | const VERIFICATION_STATUS_PENDING = 'pending'; |
| 55 | const VERIFICATION_STATUS_UNVERIFIED = 'unverified'; |
| 56 | const VERIFICATION_STATUS_VERIFIED = 'verified'; |
| 57 | |
| 58 | /** |
| 59 | * @return string The API URL for this Stripe account reversal. |
| 60 | */ |
| 61 | public function instanceUrl() |
| 62 | { |
| 63 | $id = $this['id']; |
| 64 | $account = $this['account']; |
| 65 | if (!$id) { |
| 66 | throw new Error\InvalidRequest( |
| 67 | "Could not determine which URL to request: " . |
| 68 | "class instance has invalid ID: $id", |
| 69 | null |
| 70 | ); |
| 71 | } |
| 72 | $id = Util\Util::utf8($id); |
| 73 | $account = Util\Util::utf8($account); |
| 74 | |
| 75 | $base = Account::classUrl(); |
| 76 | $accountExtn = urlencode($account); |
| 77 | $extn = urlencode($id); |
| 78 | return "$base/$accountExtn/persons/$extn"; |
| 79 | } |
| 80 | |
| 81 | /** |
| 82 | * @param array|string $_id |
| 83 | * @param array|string|null $_opts |
| 84 | * |
| 85 | * @throws \Stripe\Error\InvalidRequest |
| 86 | */ |
| 87 | public static function retrieve($_id, $_opts = null) |
| 88 | { |
| 89 | $msg = "Persons cannot be accessed without an account ID. " . |
| 90 | "Retrieve a Person using \$account->retrievePerson('person_id') instead."; |
| 91 | throw new Error\InvalidRequest($msg, null); |
| 92 | } |
| 93 | |
| 94 | /** |
| 95 | * @param string $_id |
| 96 | * @param array|null $_params |
| 97 | * @param array|string|null $_options |
| 98 | * |
| 99 | * @throws \Stripe\Error\InvalidRequest |
| 100 | */ |
| 101 | public static function update($_id, $_params = null, $_options = null) |
| 102 | { |
| 103 | $msg = "Persons cannot be accessed without an account ID. " . |
| 104 | "Retrieve a Person using \$account->retrievePerson('person_id') instead."; |
| 105 | throw new Error\InvalidRequest($msg, null); |
| 106 | } |
| 107 | } |
| 108 |