Current File : /home/jalalj2hb/www/elearning/application/libraries/Stripe/lib/Person.php
<?php
namespace Stripe;
/**
* This is an object representing a person associated with a Stripe account.
*
* Related guide: <a
* href="https://stripe.com/docs/connect/identity-verification-api#person-information">Handling
* Identity Verification with the API</a>.
*
* @property string $id Unique identifier for the object.
* @property string $object String representing the object's type. Objects of the same type share the same value.
* @property string $account The account the person is associated with.
* @property \Stripe\StripeObject $address
* @property null|\Stripe\StripeObject $address_kana The Kana variation of the person's address (Japan only).
* @property null|\Stripe\StripeObject $address_kanji The Kanji variation of the person's address (Japan only).
* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
* @property \Stripe\StripeObject $dob
* @property null|string $email The person's email address.
* @property null|string $first_name The person's first name.
* @property null|string $first_name_kana The Kana variation of the person's first name (Japan only).
* @property null|string $first_name_kanji The Kanji variation of the person's first name (Japan only).
* @property null|string $gender The person's gender (International regulations require either "male" or "female").
* @property bool $id_number_provided Whether the person's <code>id_number</code> was provided.
* @property null|string $last_name The person's last name.
* @property null|string $last_name_kana The Kana variation of the person's last name (Japan only).
* @property null|string $last_name_kanji The Kanji variation of the person's last name (Japan only).
* @property null|string $maiden_name The person's maiden name.
* @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
* @property null|string $phone The person's phone number.
* @property \Stripe\StripeObject $relationship
* @property null|\Stripe\StripeObject $requirements Information about the requirements for this person, including what information needs to be collected, and by when.
* @property bool $ssn_last_4_provided Whether the last four digits of the person's Social Security number have been provided (U.S. only).
* @property \Stripe\StripeObject $verification
*/
class Person extends ApiResource
{
const OBJECT_NAME = 'person';
use ApiOperations\Delete;
use ApiOperations\Update;
const GENDER_FEMALE = 'female';
const GENDER_MALE = 'male';
const VERIFICATION_STATUS_PENDING = 'pending';
const VERIFICATION_STATUS_UNVERIFIED = 'unverified';
const VERIFICATION_STATUS_VERIFIED = 'verified';
/**
* @return string the API URL for this Stripe account reversal
*/
public function instanceUrl()
{
$id = $this['id'];
$account = $this['account'];
if (!$id) {
throw new Exception\UnexpectedValueException(
'Could not determine which URL to request: ' .
"class instance has invalid ID: {$id}",
null
);
}
$id = Util\Util::utf8($id);
$account = Util\Util::utf8($account);
$base = Account::classUrl();
$accountExtn = \urlencode($account);
$extn = \urlencode($id);
return "{$base}/{$accountExtn}/persons/{$extn}";
}
/**
* @param array|string $_id
* @param null|array|string $_opts
*
* @throws \Stripe\Exception\BadMethodCallException
*/
public static function retrieve($_id, $_opts = null)
{
$msg = 'Persons cannot be retrieved without an account ID. Retrieve ' .
"a person using `Account::retrievePerson('account_id', " .
"'person_id')`.";
throw new Exception\BadMethodCallException($msg);
}
/**
* @param string $_id
* @param null|array $_params
* @param null|array|string $_options
*
* @throws \Stripe\Exception\BadMethodCallException
*/
public static function update($_id, $_params = null, $_options = null)
{
$msg = 'Persons cannot be updated without an account ID. Update ' .
"a person using `Account::updatePerson('account_id', " .
"'person_id', \$updateParams)`.";
throw new Exception\BadMethodCallException($msg);
}
}