Person.php — Paid Membership Plugin, Ecommerce, User Registration Form, Login Form, User Profile & Restrict Content – ProfilePress 4.17.1

wp-user-avatar / third-party / vendor / stripe / stripe-php / lib / Person.php

wp-user-avatar / third-party / vendor / stripe / stripe-php / lib Last commit date

Person.php

118 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4	namespace ProfilePressVendor\Stripe;
5
6	/**
7	* This is an object representing a person associated with a Stripe account.
8	*
9	* A platform cannot access a person for an account where <a href="/api/accounts/object#account_object-controller-requirement_collection">account.controller.requirement_collection</a> is <code>stripe</code>, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.
10	*
11	* See the <a href="/connect/standard-accounts">Standard onboarding</a> or <a href="/connect/express-accounts">Express onboarding</a> documentation for information about prefilling information and account onboarding steps. Learn more about <a href="/connect/handling-api-verification#person-information">handling identity verification with the API</a>.
12	*
13	* @property string $id Unique identifier for the object.
14	* @property string $object String representing the object's type. Objects of the same type share the same value.
15	* @property null\|string $account The account the person is associated with.
16	* @property null\|\Stripe\StripeObject $additional_tos_acceptances
17	* @property null\|\Stripe\StripeObject $address
18	* @property null\|\Stripe\StripeObject $address_kana The Kana variation of the person's address (Japan only).
19	* @property null\|\Stripe\StripeObject $address_kanji The Kanji variation of the person's address (Japan only).
20	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
21	* @property null\|\Stripe\StripeObject $dob
22	* @property null\|string $email The person's email address.
23	* @property null\|string $first_name The person's first name.
24	* @property null\|string $first_name_kana The Kana variation of the person's first name (Japan only).
25	* @property null\|string $first_name_kanji The Kanji variation of the person's first name (Japan only).
26	* @property null\|string[] $full_name_aliases A list of alternate names or aliases that the person is known by.
27	* @property null\|\Stripe\StripeObject $future_requirements Information about the <a href="https://stripe.com/docs/connect/custom-accounts/future-requirements">upcoming new requirements for this person</a>, including what information needs to be collected, and by when.
28	* @property null\|string $gender The person's gender.
29	* @property null\|bool $id_number_provided Whether the person's <code>id_number</code> was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by <code>ssn_last_4_provided</code>).
30	* @property null\|bool $id_number_secondary_provided Whether the person's <code>id_number_secondary</code> was provided.
31	* @property null\|string $last_name The person's last name.
32	* @property null\|string $last_name_kana The Kana variation of the person's last name (Japan only).
33	* @property null\|string $last_name_kanji The Kanji variation of the person's last name (Japan only).
34	* @property null\|string $maiden_name The person's maiden name.
35	* @property null\|\Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
36	* @property null\|string $nationality The country where the person is a national.
37	* @property null\|string $phone The person's phone number.
38	* @property null\|string $political_exposure Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
39	* @property null\|\Stripe\StripeObject $registered_address
40	* @property null\|\Stripe\StripeObject $relationship
41	* @property null\|\Stripe\StripeObject $requirements Information about the requirements for this person, including what information needs to be collected, and by when.
42	* @property null\|bool $ssn_last_4_provided Whether the last four digits of the person's Social Security number have been provided (U.S. only).
43	* @property null\|\Stripe\StripeObject $verification
44	*/
45	class Person extends ApiResource
46	{
47	const OBJECT_NAME = 'person';
48	const GENDER_FEMALE = 'female';
49	const GENDER_MALE = 'male';
50	const POLITICAL_EXPOSURE_EXISTING = 'existing';
51	const POLITICAL_EXPOSURE_NONE = 'none';
52	const VERIFICATION_STATUS_PENDING = 'pending';
53	const VERIFICATION_STATUS_UNVERIFIED = 'unverified';
54	const VERIFICATION_STATUS_VERIFIED = 'verified';
55	use ApiOperations\Delete;
56	/**
57	* @return string the API URL for this Stripe account reversal
58	*/
59	public function instanceUrl()
60	{
61	$id = $this['id'];
62	$account = $this['account'];
63	if (!$id) {
64	throw new Exception\UnexpectedValueException('Could not determine which URL to request: ' . "class instance has invalid ID: {$id}", null);
65	}
66	$id = Util\Util::utf8($id);
67	$account = Util\Util::utf8($account);
68	$base = Account::classUrl();
69	$accountExtn = \urlencode($account);
70	$extn = \urlencode($id);
71	return "{$base}/{$accountExtn}/persons/{$extn}";
72	}
73	/**
74	* @param array\|string $_id
75	* @param null\|array\|string $_opts
76	*
77	* @throws \Stripe\Exception\BadMethodCallException
78	*/
79	public static function retrieve($_id, $_opts = null)
80	{
81	$msg = 'Persons cannot be retrieved without an account ID. Retrieve ' . "a person using `Account::retrievePerson('account_id', " . "'person_id')`.";
82	throw new Exception\BadMethodCallException($msg);
83	}
84	/**
85	* @param string $_id
86	* @param null\|array $_params
87	* @param null\|array\|string $_options
88	*
89	* @throws \Stripe\Exception\BadMethodCallException
90	*/
91	public static function update($_id, $_params = null, $_options = null)
92	{
93	$msg = 'Persons cannot be updated without an account ID. Update ' . "a person using `Account::updatePerson('account_id', " . "'person_id', \$updateParams)`.";
94	throw new Exception\BadMethodCallException($msg);
95	}
96	/**
97	* @param null\|array\|string $opts
98	*
99	* @throws \Stripe\Exception\ApiErrorException if the request fails
100	*
101	* @return static the saved resource
102	*
103	* @deprecated The `save` method is deprecated and will be removed in a
104	* future major version of the library. Use the static method `update`
105	* on the resource instead.
106	*/
107	public function save($opts = null)
108	{
109	$params = $this->serializeParameters();
110	if (\count($params) > 0) {
111	$url = $this->instanceUrl();
112	list($response, $opts) = $this->_request('post', $url, $params, $opts, ['save']);
113	$this->refreshFrom($response, $opts);
114	}
115	return $this;
116	}
117	}
118