This is an object representing a person associated with a Stripe account.
A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account. See the Standard onboarding or Express onboarding documentation for information about platform pre-filling and account onboarding steps.
Related guide: Handling Identity Verification with the API.
- * @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 bool $payouts_enabled Whether Stripe can send payouts to this account. - * @property \Stripe\StripeObject $requirements - * @property null|\Stripe\StripeObject $settings Options for customizing how the account functions within Stripe. - * @property \Stripe\StripeObject $tos_acceptance - * @property string $type The Stripe account type. Can bestandard, express, or custom.
+ * @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 null|\Stripe\StripeObject $business_profile Business information about the account.
+ * @property null|string $business_type The business type.
+ * @property \Stripe\StripeObject $capabilities
+ * @property bool $charges_enabled Whether the account can create live charges.
+ * @property \Stripe\StripeObject $company
+ * @property \Stripe\StripeObject $controller
+ * @property string $country The account's country.
+ * @property int $created Time at which the account was connected. Measured in seconds since the Unix epoch.
+ * @property string $default_currency Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.
+ * @property bool $details_submitted Whether account details have been submitted. Standard accounts cannot receive payouts before this is true.
+ * @property null|string $email An email address associated with the account. You can treat this as metadata: it is not used for authentication or messaging account holders.
+ * @property \Stripe\Collection<\Stripe\BankAccount|\Stripe\Card> $external_accounts External accounts (bank accounts and debit cards) currently attached to this account
+ * @property \Stripe\StripeObject $future_requirements
+ * @property \Stripe\Person $individual This is an object representing a person associated with a Stripe account.
A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account. See the Standard onboarding or Express onboarding documentation for information about platform pre-filling and account onboarding steps.
Related guide: Handling Identity Verification with the API.
+ * @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 bool $payouts_enabled Whether Stripe can send payouts to this account. + * @property \Stripe\StripeObject $requirements + * @property null|\Stripe\StripeObject $settings Options for customizing how the account functions within Stripe. + * @property \Stripe\StripeObject $tos_acceptance + * @property string $type The Stripe account type. Can bestandard, express, or custom.
*/
class Account extends ApiResource
{
- const OBJECT_NAME = 'account';
+ public const OBJECT_NAME = 'account';
use ApiOperations\All;
use ApiOperations\Create;
@@ -46,14 +46,19 @@ class Account extends ApiResource
use ApiOperations\NestedResource;
use ApiOperations\Update;
- const BUSINESS_TYPE_COMPANY = 'company';
- const BUSINESS_TYPE_GOVERNMENT_ENTITY = 'government_entity';
- const BUSINESS_TYPE_INDIVIDUAL = 'individual';
- const BUSINESS_TYPE_NON_PROFIT = 'non_profit';
+ public const BUSINESS_TYPE_COMPANY = 'company';
- const TYPE_CUSTOM = 'custom';
- const TYPE_EXPRESS = 'express';
- const TYPE_STANDARD = 'standard';
+ public const BUSINESS_TYPE_GOVERNMENT_ENTITY = 'government_entity';
+
+ public const BUSINESS_TYPE_INDIVIDUAL = 'individual';
+
+ public const BUSINESS_TYPE_NON_PROFIT = 'non_profit';
+
+ public const TYPE_CUSTOM = 'custom';
+
+ public const TYPE_EXPRESS = 'express';
+
+ public const TYPE_STANDARD = 'standard';
use ApiOperations\Retrieve {
retrieve as protected _retrieve;
@@ -62,7 +67,7 @@ class Account extends ApiResource
public static function getSavedNestedResources()
{
static $savedNestedResources = null;
- if (null === $savedNestedResources) {
+ if ($savedNestedResources === null) {
$savedNestedResources = new Util\Set([
'external_account',
'bank_account',
@@ -74,7 +79,7 @@ class Account extends ApiResource
public function instanceUrl()
{
- if (null === $this['id']) {
+ if ($this['id'] === null) {
return '/v1/account';
}
@@ -82,8 +87,8 @@ class Account extends ApiResource
}
/**
- * @param null|array|string $id the ID of the account to retrieve, or an
- * options array containing an `id` key
+ * @param null|array|string $id the ID of the account to retrieve, or an
+ * options array containing an `id` key
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -92,9 +97,9 @@ class Account extends ApiResource
*/
public static function retrieve($id = null, $opts = null)
{
- if (!$opts && \is_string($id) && 'sk_' === \substr($id, 0, 3)) {
+ if (!$opts && \is_string($id) && \substr($id, 0, 3) === 'sk_') {
$opts = $id;
- $id = null;
+ $id = null;
}
return self::_retrieve($id, $opts);
@@ -106,10 +111,10 @@ class Account extends ApiResource
if (isset($this->_values['legal_entity'])) {
$entity = $this['legal_entity'];
if (isset($entity->_values['additional_owners'])) {
- $owners = $entity['additional_owners'];
- $entityUpdate = isset($update['legal_entity']) ? $update['legal_entity'] : [];
+ $owners = $entity['additional_owners'];
+ $entityUpdate = isset($update['legal_entity']) ? $update['legal_entity'] : [];
$entityUpdate['additional_owners'] = $this->serializeAdditionalOwners($entity, $owners);
- $update['legal_entity'] = $entityUpdate;
+ $update['legal_entity'] = $entityUpdate;
}
}
if (isset($this->_values['individual'])) {
@@ -139,7 +144,7 @@ class Account extends ApiResource
foreach ($additionalOwners as $i => $v) {
$update = ($v instanceof StripeObject) ? $v->serializeParameters() : $v;
- if ([] !== $update) {
+ if ($update !== []) {
if (!$originalValue
|| !\array_key_exists($i, $originalValue)
|| ($update !== $legalEntity->serializeParamsValue($originalValue[$i], null, false, true))) {
@@ -152,7 +157,7 @@ class Account extends ApiResource
}
/**
- * @param null|array $clientId
+ * @param null|array $clientId
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -162,7 +167,7 @@ class Account extends ApiResource
public function deauthorize($clientId = null, $opts = null)
{
$params = [
- 'client_id' => $clientId,
+ 'client_id' => $clientId,
'stripe_user_id' => $this->id,
];
@@ -170,7 +175,7 @@ class Account extends ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -179,18 +184,18 @@ class Account extends ApiResource
*/
public function reject($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/reject';
+ $url = $this->instanceUrl() . '/reject';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
return $this;
}
- const PATH_CAPABILITIES = '/capabilities';
+ public const PATH_CAPABILITIES = '/capabilities';
/**
- * @param string $id the ID of the account on which to retrieve the capabilities
- * @param null|array $params
+ * @param string $id the ID of the account on which to retrieve the capabilities
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -203,9 +208,9 @@ class Account extends ApiResource
}
/**
- * @param string $id the ID of the account to which the capability belongs
- * @param string $capabilityId the ID of the capability to retrieve
- * @param null|array $params
+ * @param string $id the ID of the account to which the capability belongs
+ * @param string $capabilityId the ID of the capability to retrieve
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -218,9 +223,9 @@ class Account extends ApiResource
}
/**
- * @param string $id the ID of the account to which the capability belongs
- * @param string $capabilityId the ID of the capability to update
- * @param null|array $params
+ * @param string $id the ID of the account to which the capability belongs
+ * @param string $capabilityId the ID of the capability to update
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -231,11 +236,12 @@ class Account extends ApiResource
{
return self::_updateNestedResource($id, static::PATH_CAPABILITIES, $capabilityId, $params, $opts);
}
- const PATH_EXTERNAL_ACCOUNTS = '/external_accounts';
+
+ public const PATH_EXTERNAL_ACCOUNTS = '/external_accounts';
/**
- * @param string $id the ID of the account on which to retrieve the external accounts
- * @param null|array $params
+ * @param string $id the ID of the account on which to retrieve the external accounts
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -248,8 +254,8 @@ class Account extends ApiResource
}
/**
- * @param string $id the ID of the account on which to create the external account
- * @param null|array $params
+ * @param string $id the ID of the account on which to create the external account
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -262,9 +268,9 @@ class Account extends ApiResource
}
/**
- * @param string $id the ID of the account to which the external account belongs
- * @param string $externalAccountId the ID of the external account to delete
- * @param null|array $params
+ * @param string $id the ID of the account to which the external account belongs
+ * @param string $externalAccountId the ID of the external account to delete
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -277,9 +283,9 @@ class Account extends ApiResource
}
/**
- * @param string $id the ID of the account to which the external account belongs
- * @param string $externalAccountId the ID of the external account to retrieve
- * @param null|array $params
+ * @param string $id the ID of the account to which the external account belongs
+ * @param string $externalAccountId the ID of the external account to retrieve
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -292,9 +298,9 @@ class Account extends ApiResource
}
/**
- * @param string $id the ID of the account to which the external account belongs
- * @param string $externalAccountId the ID of the external account to update
- * @param null|array $params
+ * @param string $id the ID of the account to which the external account belongs
+ * @param string $externalAccountId the ID of the external account to update
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -305,11 +311,12 @@ class Account extends ApiResource
{
return self::_updateNestedResource($id, static::PATH_EXTERNAL_ACCOUNTS, $externalAccountId, $params, $opts);
}
- const PATH_LOGIN_LINKS = '/login_links';
+
+ public const PATH_LOGIN_LINKS = '/login_links';
/**
- * @param string $id the ID of the account on which to create the login link
- * @param null|array $params
+ * @param string $id the ID of the account on which to create the login link
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -320,11 +327,12 @@ class Account extends ApiResource
{
return self::_createNestedResource($id, static::PATH_LOGIN_LINKS, $params, $opts);
}
- const PATH_PERSONS = '/persons';
+
+ public const PATH_PERSONS = '/persons';
/**
- * @param string $id the ID of the account on which to retrieve the persons
- * @param null|array $params
+ * @param string $id the ID of the account on which to retrieve the persons
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -337,8 +345,8 @@ class Account extends ApiResource
}
/**
- * @param string $id the ID of the account on which to create the person
- * @param null|array $params
+ * @param string $id the ID of the account on which to create the person
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -351,9 +359,9 @@ class Account extends ApiResource
}
/**
- * @param string $id the ID of the account to which the person belongs
- * @param string $personId the ID of the person to delete
- * @param null|array $params
+ * @param string $id the ID of the account to which the person belongs
+ * @param string $personId the ID of the person to delete
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -366,9 +374,9 @@ class Account extends ApiResource
}
/**
- * @param string $id the ID of the account to which the person belongs
- * @param string $personId the ID of the person to retrieve
- * @param null|array $params
+ * @param string $id the ID of the account to which the person belongs
+ * @param string $personId the ID of the person to retrieve
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -381,9 +389,9 @@ class Account extends ApiResource
}
/**
- * @param string $id the ID of the account to which the person belongs
- * @param string $personId the ID of the person to update
- * @param null|array $params
+ * @param string $id the ID of the account to which the person belongs
+ * @param string $personId the ID of the person to update
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/AccountLink.php b/Stripe/Stripe/AccountLink.php
index 24a9e68..cd50a83 100755
--- a/Stripe/Stripe/AccountLink.php
+++ b/Stripe/Stripe/AccountLink.php
@@ -1,4 +1,4 @@
-Connect
* Onboarding.
*
- * @property string $object String representing the object's type. Objects of the same type share the same value.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property int $expires_at The timestamp at which this account link will expire.
- * @property string $url The URL for the account link.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property int $expires_at The timestamp at which this account link will expire.
+ * @property string $url The URL for the account link.
*/
class AccountLink extends ApiResource
{
- const OBJECT_NAME = 'account_link';
+ public const OBJECT_NAME = 'account_link';
use ApiOperations\Create;
}
diff --git a/Stripe/Stripe/ApiOperations/All.php b/Stripe/Stripe/ApiOperations/All.php
index ff2955d..f21d4e8 100755
--- a/Stripe/Stripe/ApiOperations/All.php
+++ b/Stripe/Stripe/ApiOperations/All.php
@@ -1,4 +1,4 @@
-json, $opts);
+ $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
if (!($obj instanceof \Stripe\Collection)) {
throw new \Stripe\Exception\UnexpectedValueException(
'Expected type ' . \Stripe\Collection::class . ', got "' . \get_class($obj) . '" instead.'
diff --git a/Stripe/Stripe/ApiOperations/Create.php b/Stripe/Stripe/ApiOperations/Create.php
index c435132..0d0b55c 100755
--- a/Stripe/Stripe/ApiOperations/Create.php
+++ b/Stripe/Stripe/ApiOperations/Create.php
@@ -1,4 +1,4 @@
-json, $opts);
+ $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
diff --git a/Stripe/Stripe/ApiOperations/Delete.php b/Stripe/Stripe/ApiOperations/Delete.php
index c6082ff..06d52f2 100755
--- a/Stripe/Stripe/ApiOperations/Delete.php
+++ b/Stripe/Stripe/ApiOperations/Delete.php
@@ -1,4 +1,4 @@
-instanceUrl();
+ $url = $this->instanceUrl();
list($response, $opts) = $this->_request('delete', $url, $params, $opts);
$this->refreshFrom($response, $opts);
diff --git a/Stripe/Stripe/ApiOperations/NestedResource.php b/Stripe/Stripe/ApiOperations/NestedResource.php
index 180cacd..fe9c1df 100755
--- a/Stripe/Stripe/ApiOperations/NestedResource.php
+++ b/Stripe/Stripe/ApiOperations/NestedResource.php
@@ -1,4 +1,4 @@
-json, $opts);
+ $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
}
/**
- * @param string $id
- * @param string $nestedPath
+ * @param string $id
+ * @param string $nestedPath
* @param null|string $nestedId
*
* @return string
@@ -38,7 +38,7 @@ trait NestedResource
protected static function _nestedResourceUrl($id, $nestedPath, $nestedId = null)
{
$url = static::resourceUrl($id) . $nestedPath;
- if (null !== $nestedId) {
+ if ($nestedId !== null) {
$url .= "/{$nestedId}";
}
@@ -46,9 +46,9 @@ trait NestedResource
}
/**
- * @param string $id
- * @param string $nestedPath
- * @param null|array $params
+ * @param string $id
+ * @param string $nestedPath
+ * @param null|array $params
* @param null|array|string $options
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -63,10 +63,10 @@ trait NestedResource
}
/**
- * @param string $id
- * @param string $nestedPath
- * @param null|string $nestedId
- * @param null|array $params
+ * @param string $id
+ * @param string $nestedPath
+ * @param null|string $nestedId
+ * @param null|array $params
* @param null|array|string $options
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -81,10 +81,10 @@ trait NestedResource
}
/**
- * @param string $id
- * @param string $nestedPath
- * @param null|string $nestedId
- * @param null|array $params
+ * @param string $id
+ * @param string $nestedPath
+ * @param null|string $nestedId
+ * @param null|array $params
* @param null|array|string $options
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -99,10 +99,10 @@ trait NestedResource
}
/**
- * @param string $id
- * @param string $nestedPath
- * @param null|string $nestedId
- * @param null|array $params
+ * @param string $id
+ * @param string $nestedPath
+ * @param null|string $nestedId
+ * @param null|array $params
* @param null|array|string $options
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -117,9 +117,9 @@ trait NestedResource
}
/**
- * @param string $id
- * @param string $nestedPath
- * @param null|array $params
+ * @param string $id
+ * @param string $nestedPath
+ * @param null|array $params
* @param null|array|string $options
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/ApiOperations/Request.php b/Stripe/Stripe/ApiOperations/Request.php
index a60ca79..1b36a8b 100755
--- a/Stripe/Stripe/ApiOperations/Request.php
+++ b/Stripe/Stripe/ApiOperations/Request.php
@@ -1,4 +1,4 @@
-_opts->merge($options);
+ $opts = $this->_opts->merge($options);
list($resp, $options) = static::_staticRequest($method, $url, $params, $opts);
$this->setLastResponse($resp);
@@ -46,24 +46,24 @@ trait Request
}
/**
- * @param string $method HTTP method ('get', 'post', etc.)
- * @param string $url URL for the request
- * @param callable $readBodyChunk function that will receive chunks of data from a successful request body
- * @param array $params list of parameters for the request
+ * @param string $method HTTP method ('get', 'post', etc.)
+ * @param string $url URL for the request
+ * @param callable $readBodyChunk function that will receive chunks of data from a successful request body
+ * @param array $params list of parameters for the request
* @param null|array|string $options
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*/
- protected function _requestStream($method, $url, $readBodyChunk, $params = [], $options = null)
+ protected function _requestStream($method, $url, $readBodyChunk, $params = [], $options = null) : void
{
$opts = $this->_opts->merge($options);
static::_staticStreamingRequest($method, $url, $readBodyChunk, $params, $opts);
}
/**
- * @param string $method HTTP method ('get', 'post', etc.)
- * @param string $url URL for the request
- * @param array $params list of parameters for the request
+ * @param string $method HTTP method ('get', 'post', etc.)
+ * @param string $url URL for the request
+ * @param array $params list of parameters for the request
* @param null|array|string $options
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -72,9 +72,9 @@ trait Request
*/
protected static function _staticRequest($method, $url, $params, $options)
{
- $opts = \Stripe\Util\RequestOptions::parse($options);
- $baseUrl = isset($opts->apiBase) ? $opts->apiBase : static::baseUrl();
- $requestor = new \Stripe\ApiRequestor($opts->apiKey, $baseUrl);
+ $opts = \Stripe\Util\RequestOptions::parse($options);
+ $baseUrl = isset($opts->apiBase) ? $opts->apiBase : static::baseUrl();
+ $requestor = new \Stripe\ApiRequestor($opts->apiKey, $baseUrl);
list($response, $opts->apiKey) = $requestor->request($method, $url, $params, $opts->headers);
$opts->discardNonPersistentHeaders();
@@ -82,18 +82,18 @@ trait Request
}
/**
- * @param string $method HTTP method ('get', 'post', etc.)
- * @param string $url URL for the request
- * @param callable $readBodyChunk function that will receive chunks of data from a successful request body
- * @param array $params list of parameters for the request
+ * @param string $method HTTP method ('get', 'post', etc.)
+ * @param string $url URL for the request
+ * @param callable $readBodyChunk function that will receive chunks of data from a successful request body
+ * @param array $params list of parameters for the request
* @param null|array|string $options
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*/
- protected static function _staticStreamingRequest($method, $url, $readBodyChunk, $params, $options)
+ protected static function _staticStreamingRequest($method, $url, $readBodyChunk, $params, $options) : void
{
- $opts = \Stripe\Util\RequestOptions::parse($options);
- $baseUrl = isset($opts->apiBase) ? $opts->apiBase : static::baseUrl();
+ $opts = \Stripe\Util\RequestOptions::parse($options);
+ $baseUrl = isset($opts->apiBase) ? $opts->apiBase : static::baseUrl();
$requestor = new \Stripe\ApiRequestor($opts->apiKey, $baseUrl);
$requestor->requestStream($method, $url, $readBodyChunk, $params, $opts->headers);
}
diff --git a/Stripe/Stripe/ApiOperations/Retrieve.php b/Stripe/Stripe/ApiOperations/Retrieve.php
index 5170afb..b204d71 100755
--- a/Stripe/Stripe/ApiOperations/Retrieve.php
+++ b/Stripe/Stripe/ApiOperations/Retrieve.php
@@ -1,4 +1,4 @@
-refresh();
diff --git a/Stripe/Stripe/ApiOperations/Search.php b/Stripe/Stripe/ApiOperations/Search.php
index 09472eb..e4947db 100755
--- a/Stripe/Stripe/ApiOperations/Search.php
+++ b/Stripe/Stripe/ApiOperations/Search.php
@@ -1,4 +1,4 @@
-json, $opts);
+ $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
if (!($obj instanceof \Stripe\SearchResult)) {
throw new \Stripe\Exception\UnexpectedValueException(
'Expected type ' . \Stripe\SearchResult::class . ', got "' . \get_class($obj) . '" instead.'
diff --git a/Stripe/Stripe/ApiOperations/SingletonRetrieve.php b/Stripe/Stripe/ApiOperations/SingletonRetrieve.php
index baae67e..52fa91a 100755
--- a/Stripe/Stripe/ApiOperations/SingletonRetrieve.php
+++ b/Stripe/Stripe/ApiOperations/SingletonRetrieve.php
@@ -1,4 +1,4 @@
-refresh();
diff --git a/Stripe/Stripe/ApiOperations/Update.php b/Stripe/Stripe/ApiOperations/Update.php
index 9fde1e4..6d8f5fd 100755
--- a/Stripe/Stripe/ApiOperations/Update.php
+++ b/Stripe/Stripe/ApiOperations/Update.php
@@ -1,4 +1,4 @@
-json, $opts);
+ $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
@@ -46,7 +46,7 @@ trait Update
{
$params = $this->serializeParameters();
if (\count($params) > 0) {
- $url = $this->instanceUrl();
+ $url = $this->instanceUrl();
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
}
diff --git a/Stripe/Stripe/ApiRequestor.php b/Stripe/Stripe/ApiRequestor.php
index 7162e33..3602230 100755
--- a/Stripe/Stripe/ApiRequestor.php
+++ b/Stripe/Stripe/ApiRequestor.php
@@ -1,4 +1,4 @@
- [
- 'request_id' => $requestTelemetry->requestId,
+ 'request_id' => $requestTelemetry->requestId,
'request_duration_ms' => $requestTelemetry->requestDuration,
],
];
$result = \json_encode($payload);
- if (false !== $result) {
+ if ($result !== false) {
return $result;
}
Stripe::getLogger()->error('Serializing telemetry payload failed!');
@@ -87,10 +88,10 @@ class ApiRequestor
if ($d instanceof ApiResource) {
return Util\Util::utf8($d->id);
}
- if (true === $d) {
+ if ($d === true) {
return 'true';
}
- if (false === $d) {
+ if ($d === false) {
return 'false';
}
if (\is_array($d)) {
@@ -117,12 +118,11 @@ class ApiRequestor
*/
public function request($method, $url, $params = null, $headers = null)
{
- $params = $params ?: [];
- $headers = $headers ?: [];
- list($rbody, $rcode, $rheaders, $myApiKey) =
- $this->_requestRaw($method, $url, $params, $headers);
- $json = $this->_interpretResponse($rbody, $rcode, $rheaders);
- $resp = new ApiResponse($rbody, $rcode, $rheaders, $json);
+ $params = $params ?: [];
+ $headers = $headers ?: [];
+ list($rbody, $rcode, $rheaders, $myApiKey) = $this->_requestRaw($method, $url, $params, $headers);
+ $json = $this->_interpretResponse($rbody, $rcode, $rheaders);
+ $resp = new ApiResponse($rbody, $rcode, $rheaders, $json);
return [$resp, $myApiKey];
}
@@ -130,33 +130,32 @@ class ApiRequestor
/**
* @param string $method
* @param string $url
- * @param callable $readBodyChunkCallable
+ * @param callable $readBodyChunkCallable
* @param null|array $params
* @param null|array $headers
*
* @throws Exception\ApiErrorException
*/
- public function requestStream($method, $url, $readBodyChunkCallable, $params = null, $headers = null)
+ public function requestStream($method, $url, $readBodyChunkCallable, $params = null, $headers = null) : void
{
- $params = $params ?: [];
- $headers = $headers ?: [];
- list($rbody, $rcode, $rheaders, $myApiKey) =
- $this->_requestRawStreaming($method, $url, $params, $headers, $readBodyChunkCallable);
+ $params = $params ?: [];
+ $headers = $headers ?: [];
+ list($rbody, $rcode, $rheaders, $myApiKey) = $this->_requestRawStreaming($method, $url, $params, $headers, $readBodyChunkCallable);
if ($rcode >= 300) {
$this->_interpretResponse($rbody, $rcode, $rheaders);
}
}
/**
- * @param string $rbody a JSON string
- * @param int $rcode
- * @param array $rheaders
- * @param array $resp
+ * @param string $rbody a JSON string
+ * @param int $rcode
+ * @param array $rheaders
+ * @param array $resp
*
* @throws Exception\UnexpectedValueException
* @throws Exception\ApiErrorException
*/
- public function handleErrorResponse($rbody, $rcode, $rheaders, $resp)
+ public function handleErrorResponse($rbody, $rcode, $rheaders, $resp) : void
{
if (!\is_array($resp) || !isset($resp['error'])) {
$msg = "Invalid response object from API: {$rbody} "
@@ -191,39 +190,34 @@ class ApiRequestor
*/
private static function _specificAPIError($rbody, $rcode, $rheaders, $resp, $errorData)
{
- $msg = isset($errorData['message']) ? $errorData['message'] : null;
- $param = isset($errorData['param']) ? $errorData['param'] : null;
- $code = isset($errorData['code']) ? $errorData['code'] : null;
- $type = isset($errorData['type']) ? $errorData['type'] : null;
+ $msg = isset($errorData['message']) ? $errorData['message'] : null;
+ $param = isset($errorData['param']) ? $errorData['param'] : null;
+ $code = isset($errorData['code']) ? $errorData['code'] : null;
+ $type = isset($errorData['type']) ? $errorData['type'] : null;
$declineCode = isset($errorData['decline_code']) ? $errorData['decline_code'] : null;
switch ($rcode) {
case 400:
// 'rate_limit' code is deprecated, but left here for backwards compatibility
// for API versions earlier than 2015-09-08
- if ('rate_limit' === $code) {
+ if ($code === 'rate_limit') {
return Exception\RateLimitException::factory($msg, $rcode, $rbody, $resp, $rheaders, $code, $param);
}
- if ('idempotency_error' === $type) {
+ if ($type === 'idempotency_error') {
return Exception\IdempotencyException::factory($msg, $rcode, $rbody, $resp, $rheaders, $code);
}
// no break
case 404:
return Exception\InvalidRequestException::factory($msg, $rcode, $rbody, $resp, $rheaders, $code, $param);
-
case 401:
return Exception\AuthenticationException::factory($msg, $rcode, $rbody, $resp, $rheaders, $code);
-
case 402:
return Exception\CardException::factory($msg, $rcode, $rbody, $resp, $rheaders, $code, $declineCode, $param);
-
case 403:
return Exception\PermissionException::factory($msg, $rcode, $rbody, $resp, $rheaders, $code);
-
case 429:
return Exception\RateLimitException::factory($msg, $rcode, $rbody, $resp, $rheaders, $code, $param);
-
default:
return Exception\UnknownApiErrorException::factory($msg, $rcode, $rbody, $resp, $rheaders, $code);
}
@@ -247,22 +241,16 @@ class ApiRequestor
switch ($errorCode) {
case 'invalid_client':
return Exception\OAuth\InvalidClientException::factory($description, $rcode, $rbody, $resp, $rheaders, $errorCode);
-
case 'invalid_grant':
return Exception\OAuth\InvalidGrantException::factory($description, $rcode, $rbody, $resp, $rheaders, $errorCode);
-
case 'invalid_request':
return Exception\OAuth\InvalidRequestException::factory($description, $rcode, $rbody, $resp, $rheaders, $errorCode);
-
case 'invalid_scope':
return Exception\OAuth\InvalidScopeException::factory($description, $rcode, $rbody, $resp, $rheaders, $errorCode);
-
case 'unsupported_grant_type':
return Exception\OAuth\UnsupportedGrantTypeException::factory($description, $rcode, $rbody, $resp, $rheaders, $errorCode);
-
case 'unsupported_response_type':
return Exception\OAuth\UnsupportedResponseTypeException::factory($description, $rcode, $rbody, $resp, $rheaders, $errorCode);
-
default:
return Exception\OAuth\UnknownOAuthErrorException::factory($description, $rcode, $rbody, $resp, $rheaders, $errorCode);
}
@@ -277,12 +265,12 @@ class ApiRequestor
*/
private static function _formatAppInfo($appInfo)
{
- if (null !== $appInfo) {
+ if ($appInfo !== null) {
$string = $appInfo['name'];
- if (null !== $appInfo['version']) {
+ if ($appInfo['version'] !== null) {
$string .= '/' . $appInfo['version'];
}
- if (null !== $appInfo['url']) {
+ if ($appInfo['url'] !== null) {
$string .= ' (' . $appInfo['url'] . ')';
}
@@ -296,7 +284,7 @@ class ApiRequestor
* @static
*
* @param string $disableFunctionsOutput - String value of the 'disable_function' setting, as output by \ini_get('disable_functions')
- * @param string $functionName - Name of the function we are interesting in seeing whether or not it is disabled
+ * @param string $functionName - Name of the function we are interesting in seeing whether or not it is disabled
*
* @return bool
*/
@@ -324,30 +312,30 @@ class ApiRequestor
{
$uaString = 'Stripe/v1 PhpBindings/' . Stripe::VERSION;
- $langVersion = \PHP_VERSION;
+ $langVersion = \PHP_VERSION;
$uname_disabled = static::_isDisabled(\ini_get('disable_functions'), 'php_uname');
- $uname = $uname_disabled ? '(disabled)' : \php_uname();
+ $uname = $uname_disabled ? '(disabled)' : \php_uname();
$appInfo = Stripe::getAppInfo();
- $ua = [
+ $ua = [
'bindings_version' => Stripe::VERSION,
- 'lang' => 'php',
- 'lang_version' => $langVersion,
- 'publisher' => 'stripe',
- 'uname' => $uname,
+ 'lang' => 'php',
+ 'lang_version' => $langVersion,
+ 'publisher' => 'stripe',
+ 'uname' => $uname,
];
if ($clientInfo) {
$ua = \array_merge($clientInfo, $ua);
}
- if (null !== $appInfo) {
+ if ($appInfo !== null) {
$uaString .= ' ' . self::_formatAppInfo($appInfo);
$ua['application'] = $appInfo;
}
return [
'X-Stripe-Client-User-Agent' => \json_encode($ua),
- 'User-Agent' => $uaString,
- 'Authorization' => 'Bearer ' . $apiKey,
+ 'User-Agent' => $uaString,
+ 'Authorization' => 'Bearer ' . $apiKey,
];
}
@@ -390,8 +378,8 @@ class ApiRequestor
}
}
- $absUrl = $this->_apiBase . $url;
- $params = self::_encodeObjects($params);
+ $absUrl = $this->_apiBase . $url;
+ $params = self::_encodeObjects($params);
$defaultHeaders = $this->_defaultHeaders($myApiKey, $clientUAInfo);
if (Stripe::$apiVersion) {
$defaultHeaders['Stripe-Version'] = Stripe::$apiVersion;
@@ -401,14 +389,14 @@ class ApiRequestor
$defaultHeaders['Stripe-Account'] = Stripe::$accountId;
}
- if (Stripe::$enableTelemetry && null !== self::$requestTelemetry) {
+ if (Stripe::$enableTelemetry && self::$requestTelemetry !== null) {
$defaultHeaders['X-Stripe-Client-Telemetry'] = self::_telemetryJson(self::$requestTelemetry);
}
$hasFile = false;
foreach ($params as $k => $v) {
if (\is_resource($v)) {
- $hasFile = true;
+ $hasFile = true;
$params[$k] = self::_processResourceParam($v);
} elseif ($v instanceof \CURLFile) {
$hasFile = true;
@@ -422,7 +410,7 @@ class ApiRequestor
}
$combinedHeaders = \array_merge($defaultHeaders, $headers);
- $rawHeaders = [];
+ $rawHeaders = [];
foreach ($combinedHeaders as $header => $value) {
$rawHeaders[] = $header . ': ' . $value;
@@ -434,8 +422,8 @@ class ApiRequestor
/**
* @param string $method
* @param string $url
- * @param array $params
- * @param array $headers
+ * @param array $params
+ * @param array $headers
*
* @throws Exception\AuthenticationException
* @throws Exception\ApiConnectionException
@@ -458,7 +446,7 @@ class ApiRequestor
if (isset($rheaders['request-id'])
&& \is_string($rheaders['request-id'])
- && '' !== $rheaders['request-id']) {
+ && $rheaders['request-id'] !== '') {
self::$requestTelemetry = new RequestTelemetry(
$rheaders['request-id'],
Util\Util::currentTimeMillis() - $requestStartMs
@@ -469,10 +457,10 @@ class ApiRequestor
}
/**
- * @param string $method
- * @param string $url
- * @param array $params
- * @param array $headers
+ * @param string $method
+ * @param string $url
+ * @param array $params
+ * @param array $headers
* @param callable $readBodyChunkCallable
*
* @throws Exception\AuthenticationException
@@ -497,7 +485,7 @@ class ApiRequestor
if (isset($rheaders['request-id'])
&& \is_string($rheaders['request-id'])
- && '' !== $rheaders['request-id']) {
+ && $rheaders['request-id'] !== '') {
self::$requestTelemetry = new RequestTelemetry(
$rheaders['request-id'],
Util\Util::currentTimeMillis() - $requestStartMs
@@ -516,14 +504,14 @@ class ApiRequestor
*/
private function _processResourceParam($resource)
{
- if ('stream' !== \get_resource_type($resource)) {
+ if (\get_resource_type($resource) !== 'stream') {
throw new Exception\InvalidArgumentException(
'Attempted to upload a resource that is not a stream'
);
}
$metaData = \stream_get_meta_data($resource);
- if ('plainfile' !== $metaData['wrapper_type']) {
+ if ($metaData['wrapper_type'] !== 'plainfile') {
throw new Exception\InvalidArgumentException(
'Only plainfile resource streams are supported'
);
@@ -545,9 +533,9 @@ class ApiRequestor
*/
private function _interpretResponse($rbody, $rcode, $rheaders)
{
- $resp = \json_decode($rbody, true);
+ $resp = \json_decode($rbody, true);
$jsonError = \json_last_error();
- if (null === $resp && \JSON_ERROR_NONE !== $jsonError) {
+ if ($resp === null && $jsonError !== \JSON_ERROR_NONE) {
$msg = "Invalid response body from API: {$rbody} "
. "(HTTP response code was {$rcode}, json_last_error() was {$jsonError})";
@@ -566,7 +554,7 @@ class ApiRequestor
*
* @param HttpClient\ClientInterface $client
*/
- public static function setHttpClient($client)
+ public static function setHttpClient($client) : void
{
self::$_httpClient = $client;
}
@@ -576,7 +564,7 @@ class ApiRequestor
*
* @param HttpClient\StreamingClientInterface $client
*/
- public static function setStreamingHttpClient($client)
+ public static function setStreamingHttpClient($client) : void
{
self::$_streamingHttpClient = $client;
}
@@ -586,7 +574,7 @@ class ApiRequestor
*
* Resets any stateful telemetry data
*/
- public static function resetTelemetry()
+ public static function resetTelemetry() : void
{
self::$requestTelemetry = null;
}
diff --git a/Stripe/Stripe/ApiResource.php b/Stripe/Stripe/ApiResource.php
index 25c6b84..77ac7dd 100755
--- a/Stripe/Stripe/ApiResource.php
+++ b/Stripe/Stripe/ApiResource.php
@@ -1,4 +1,4 @@
-{$k};
if ((static::getSavedNestedResources()->includes($k))
- && ($v instanceof ApiResource)) {
+ && ($v instanceof self)) {
$v->saveWithParent = true;
}
}
@@ -53,7 +53,7 @@ abstract class ApiResource extends StripeObject
public function refresh()
{
$requestor = new ApiRequestor($this->_opts->apiKey, static::baseUrl());
- $url = $this->instanceUrl();
+ $url = $this->instanceUrl();
list($response, $this->_opts->apiKey) = $requestor->request(
'get',
@@ -98,14 +98,14 @@ abstract class ApiResource extends StripeObject
*/
public static function resourceUrl($id)
{
- if (null === $id) {
- $class = static::class;
+ if ($id === null) {
+ $class = static::class;
$message = 'Could not determine which URL to request: '
. "{$class} instance has invalid ID: {$id}";
throw new Exception\UnexpectedValueException($message);
}
- $id = Util\Util::utf8($id);
+ $id = Util\Util::utf8($id);
$base = static::classUrl();
$extn = \urlencode($id);
diff --git a/Stripe/Stripe/ApiResponse.php b/Stripe/Stripe/ApiResponse.php
index e7ee2e9..9bf76cf 100755
--- a/Stripe/Stripe/ApiResponse.php
+++ b/Stripe/Stripe/ApiResponse.php
@@ -1,4 +1,4 @@
-body = $body;
- $this->code = $code;
+ $this->body = $body;
+ $this->code = $code;
$this->headers = $headers;
- $this->json = $json;
+ $this->json = $json;
}
}
diff --git a/Stripe/Stripe/ApplePayDomain.php b/Stripe/Stripe/ApplePayDomain.php
index 5f9489d..2c5d75d 100755
--- a/Stripe/Stripe/ApplePayDomain.php
+++ b/Stripe/Stripe/ApplePayDomain.php
@@ -1,19 +1,19 @@
-true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
*/
class ApplePayDomain extends ApiResource
{
- const OBJECT_NAME = 'apple_pay_domain';
+ public const OBJECT_NAME = 'apple_pay_domain';
use ApiOperations\All;
use ApiOperations\Create;
@@ -22,7 +22,7 @@ class ApplePayDomain extends ApiResource
/**
* @return string The class URL for this resource. It needs to be special
- * cased because it doesn't fit into the standard resource pattern.
+ * cased because it doesn't fit into the standard resource pattern.
*/
public static function classUrl()
{
diff --git a/Stripe/Stripe/ApplicationFee.php b/Stripe/Stripe/ApplicationFee.php
index 2a53204..1cce006 100755
--- a/Stripe/Stripe/ApplicationFee.php
+++ b/Stripe/Stripe/ApplicationFee.php
@@ -1,38 +1,38 @@
-ISO currency code, in lowercase. Must be a supported currency.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|string|\Stripe\Charge $originating_transaction ID of the corresponding charge on the platform account, if this fee was the result of a charge using the destination parameter.
- * @property bool $refunded Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.
- * @property \Stripe\Collection<\Stripe\StripeObject> $refunds A list of refunds that have been applied to the fee.
+ * @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|\Stripe\Account $account ID of the Stripe account this fee was taken from.
+ * @property int $amount Amount earned, in %s.
+ * @property int $amount_refunded Amount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued)
+ * @property string|\Stripe\StripeObject $application ID of the Connect application that earned the fee.
+ * @property null|string|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).
+ * @property string|\Stripe\Charge $charge ID of the charge that the application fee was taken from.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|string|\Stripe\Charge $originating_transaction ID of the corresponding charge on the platform account, if this fee was the result of a charge using the destination parameter.
+ * @property bool $refunded Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.
+ * @property \Stripe\Collection<\Stripe\StripeObject> $refunds A list of refunds that have been applied to the fee.
*/
class ApplicationFee extends ApiResource
{
- const OBJECT_NAME = 'application_fee';
+ public const OBJECT_NAME = 'application_fee';
use ApiOperations\All;
use ApiOperations\NestedResource;
use ApiOperations\Retrieve;
- const PATH_REFUNDS = '/refunds';
+ public const PATH_REFUNDS = '/refunds';
/**
- * @param string $id the ID of the application fee on which to retrieve the fee refunds
- * @param null|array $params
+ * @param string $id the ID of the application fee on which to retrieve the fee refunds
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -45,8 +45,8 @@ class ApplicationFee extends ApiResource
}
/**
- * @param string $id the ID of the application fee on which to create the fee refund
- * @param null|array $params
+ * @param string $id the ID of the application fee on which to create the fee refund
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -59,9 +59,9 @@ class ApplicationFee extends ApiResource
}
/**
- * @param string $id the ID of the application fee to which the fee refund belongs
- * @param string $refundId the ID of the fee refund to retrieve
- * @param null|array $params
+ * @param string $id the ID of the application fee to which the fee refund belongs
+ * @param string $refundId the ID of the fee refund to retrieve
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -74,9 +74,9 @@ class ApplicationFee extends ApiResource
}
/**
- * @param string $id the ID of the application fee to which the fee refund belongs
- * @param string $refundId the ID of the fee refund to update
- * @param null|array $params
+ * @param string $id the ID of the application fee to which the fee refund belongs
+ * @param string $refundId the ID of the fee refund to update
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/ApplicationFeeRefund.php b/Stripe/Stripe/ApplicationFeeRefund.php
index dc7c34b..d02c8bf 100755
--- a/Stripe/Stripe/ApplicationFeeRefund.php
+++ b/Stripe/Stripe/ApplicationFeeRefund.php
@@ -1,4 +1,4 @@
-Refunding
* Application Fees.
*
- * @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 int $amount Amount, in %s.
+ * @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 int $amount Amount, in %s.
* @property null|string|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact on your account balance.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property string|\Stripe\ApplicationFee $fee ID of the application fee that was refunded.
- * @property null|\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 int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string|\Stripe\ApplicationFee $fee ID of the application fee that was refunded.
+ * @property null|\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.
*/
class ApplicationFeeRefund extends ApiResource
{
- const OBJECT_NAME = 'fee_refund';
+ public const OBJECT_NAME = 'fee_refund';
use ApiOperations\Update {
save as protected _save;
@@ -35,7 +35,7 @@ class ApplicationFeeRefund extends ApiResource
*/
public function instanceUrl()
{
- $id = $this['id'];
+ $id = $this['id'];
$fee = $this['fee'];
if (!$id) {
throw new Exception\UnexpectedValueException(
@@ -44,12 +44,12 @@ class ApplicationFeeRefund extends ApiResource
null
);
}
- $id = Util\Util::utf8($id);
+ $id = Util\Util::utf8($id);
$fee = Util\Util::utf8($fee);
- $base = ApplicationFee::classUrl();
+ $base = ApplicationFee::classUrl();
$feeExtn = \urlencode($fee);
- $extn = \urlencode($id);
+ $extn = \urlencode($id);
return "{$base}/{$feeExtn}/refunds/{$extn}";
}
diff --git a/Stripe/Stripe/Apps/Secret.php b/Stripe/Stripe/Apps/Secret.php
index bd0d777..4068e4d 100755
--- a/Stripe/Stripe/Apps/Secret.php
+++ b/Stripe/Stripe/Apps/Secret.php
@@ -1,4 +1,4 @@
-Store
* data between page reloads.
*
- * @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 int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property null|int $expires_at The Unix timestamp for the expiry time of the secret, after which the secret deletes.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property string $name A name for the secret that's unique within the scope.
- * @property null|string $payload The plaintext secret value to be stored.
+ * @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 int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|int $expires_at The Unix timestamp for the expiry time of the secret, after which the secret deletes.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string $name A name for the secret that's unique within the scope.
+ * @property null|string $payload The plaintext secret value to be stored.
* @property \Stripe\StripeObject $scope
*/
class Secret extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'apps.secret';
+ public const OBJECT_NAME = 'apps.secret';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -51,16 +51,16 @@ class Secret extends \Stripe\ApiResource
*/
public static function deleteWhere($params = null, $opts = null)
{
- $url = static::classUrl() . '/delete';
+ $url = static::classUrl() . '/delete';
list($response, $opts) = static::_staticRequest('post', $url, $params, $opts);
- $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
+ $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -69,9 +69,9 @@ class Secret extends \Stripe\ApiResource
*/
public static function find($params = null, $opts = null)
{
- $url = static::classUrl() . '/find';
+ $url = static::classUrl() . '/find';
list($response, $opts) = static::_staticRequest('get', $url, $params, $opts);
- $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
+ $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
diff --git a/Stripe/Stripe/Balance.php b/Stripe/Stripe/Balance.php
index 4c14a88..38fe767 100755
--- a/Stripe/Stripe/Balance.php
+++ b/Stripe/Stripe/Balance.php
@@ -1,4 +1,4 @@
-Understanding Connect
* Account Balances.
*
- * @property string $object String representing the object's type. Objects of the same type share the same value.
- * @property \Stripe\StripeObject[] $available Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the Transfers API or Payouts API. The available balance for each currency and payment type can be found in the source_types property.
- * @property \Stripe\StripeObject[] $connect_reserved Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the source_types property.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property \Stripe\StripeObject[] $available Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the Transfers API or Payouts API. The available balance for each currency and payment type can be found in the source_types property.
+ * @property \Stripe\StripeObject[] $connect_reserved Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the source_types property.
* @property \Stripe\StripeObject[] $instant_available Funds that can be paid out using Instant Payouts.
- * @property \Stripe\StripeObject $issuing
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property \Stripe\StripeObject[] $pending Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the source_types property.
+ * @property \Stripe\StripeObject $issuing
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject[] $pending Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the source_types property.
*/
class Balance extends SingletonApiResource
{
- const OBJECT_NAME = 'balance';
+ public const OBJECT_NAME = 'balance';
use ApiOperations\SingletonRetrieve;
}
diff --git a/Stripe/Stripe/BalanceTransaction.php b/Stripe/Stripe/BalanceTransaction.php
index d7ddea4..9342d39 100755
--- a/Stripe/Stripe/BalanceTransaction.php
+++ b/Stripe/Stripe/BalanceTransaction.php
@@ -1,4 +1,4 @@
-Balance
* Transaction Types.
*
- * @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 int $amount Gross amount of the transaction, in %s.
- * @property int $available_on The date the transaction's net funds will become available in the Stripe balance.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
- * @property null|float $exchange_rate The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the amount in currency A, times exchange_rate, would be the amount in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's amount would be 1000 and currency would be eur. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's amount would be 1234, currency would be usd, and exchange_rate would be 1.234.
- * @property int $fee Fees (in %s) paid for this transaction.
- * @property \Stripe\StripeObject[] $fee_details Detailed breakdown of fees (in %s) paid for this transaction.
- * @property int $net Net amount of the transaction, in %s.
- * @property string $reporting_category Learn more about how reporting categories can help you understand balance transactions from an accounting perspective.
- * @property null|string|\Stripe\StripeObject $source The Stripe object to which this transaction is related.
- * @property string $status If the transaction's net funds are available in the Stripe balance yet. Either available or pending.
- * @property string $type Transaction type: adjustment, advance, advance_funding, anticipation_repayment, application_fee, application_fee_refund, charge, connect_collection_transfer, contribution, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, issuing_transaction, payment, payment_failure_refund, payment_refund, payout, payout_cancel, payout_failure, refund, refund_failure, reserve_transaction, reserved_funds, stripe_fee, stripe_fx_fee, tax_fee, topup, topup_reversal, transfer, transfer_cancel, transfer_failure, or transfer_refund. Learn more about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider reporting_category instead.
+ * @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 int $amount Gross amount of the transaction, in %s.
+ * @property int $available_on The date the transaction's net funds will become available in the Stripe balance.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
+ * @property null|float $exchange_rate The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the amount in currency A, times exchange_rate, would be the amount in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's amount would be 1000 and currency would be eur. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's amount would be 1234, currency would be usd, and exchange_rate would be 1.234.
+ * @property int $fee Fees (in %s) paid for this transaction.
+ * @property \Stripe\StripeObject[] $fee_details Detailed breakdown of fees (in %s) paid for this transaction.
+ * @property int $net Net amount of the transaction, in %s.
+ * @property string $reporting_category Learn more about how reporting categories can help you understand balance transactions from an accounting perspective.
+ * @property null|string|\Stripe\StripeObject $source The Stripe object to which this transaction is related.
+ * @property string $status If the transaction's net funds are available in the Stripe balance yet. Either available or pending.
+ * @property string $type Transaction type: adjustment, advance, advance_funding, anticipation_repayment, application_fee, application_fee_refund, charge, connect_collection_transfer, contribution, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, issuing_transaction, payment, payment_failure_refund, payment_refund, payout, payout_cancel, payout_failure, refund, refund_failure, reserve_transaction, reserved_funds, stripe_fee, stripe_fx_fee, tax_fee, topup, topup_reversal, transfer, transfer_cancel, transfer_failure, or transfer_refund. Learn more about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider reporting_category instead.
*/
class BalanceTransaction extends ApiResource
{
- const OBJECT_NAME = 'balance_transaction';
+ public const OBJECT_NAME = 'balance_transaction';
use ApiOperations\All;
use ApiOperations\Retrieve;
- const TYPE_ADJUSTMENT = 'adjustment';
- const TYPE_ADVANCE = 'advance';
- const TYPE_ADVANCE_FUNDING = 'advance_funding';
- const TYPE_ANTICIPATION_REPAYMENT = 'anticipation_repayment';
- const TYPE_APPLICATION_FEE = 'application_fee';
- const TYPE_APPLICATION_FEE_REFUND = 'application_fee_refund';
- const TYPE_CHARGE = 'charge';
- const TYPE_CONNECT_COLLECTION_TRANSFER = 'connect_collection_transfer';
- const TYPE_CONTRIBUTION = 'contribution';
- const TYPE_ISSUING_AUTHORIZATION_HOLD = 'issuing_authorization_hold';
- const TYPE_ISSUING_AUTHORIZATION_RELEASE = 'issuing_authorization_release';
- const TYPE_ISSUING_DISPUTE = 'issuing_dispute';
- const TYPE_ISSUING_TRANSACTION = 'issuing_transaction';
- const TYPE_PAYMENT = 'payment';
- const TYPE_PAYMENT_FAILURE_REFUND = 'payment_failure_refund';
- const TYPE_PAYMENT_REFUND = 'payment_refund';
- const TYPE_PAYOUT = 'payout';
- const TYPE_PAYOUT_CANCEL = 'payout_cancel';
- const TYPE_PAYOUT_FAILURE = 'payout_failure';
- const TYPE_REFUND = 'refund';
- const TYPE_REFUND_FAILURE = 'refund_failure';
- const TYPE_RESERVE_TRANSACTION = 'reserve_transaction';
- const TYPE_RESERVED_FUNDS = 'reserved_funds';
- const TYPE_STRIPE_FEE = 'stripe_fee';
- const TYPE_STRIPE_FX_FEE = 'stripe_fx_fee';
- const TYPE_TAX_FEE = 'tax_fee';
- const TYPE_TOPUP = 'topup';
- const TYPE_TOPUP_REVERSAL = 'topup_reversal';
- const TYPE_TRANSFER = 'transfer';
- const TYPE_TRANSFER_CANCEL = 'transfer_cancel';
- const TYPE_TRANSFER_FAILURE = 'transfer_failure';
- const TYPE_TRANSFER_REFUND = 'transfer_refund';
+ public const TYPE_ADJUSTMENT = 'adjustment';
+
+ public const TYPE_ADVANCE = 'advance';
+
+ public const TYPE_ADVANCE_FUNDING = 'advance_funding';
+
+ public const TYPE_ANTICIPATION_REPAYMENT = 'anticipation_repayment';
+
+ public const TYPE_APPLICATION_FEE = 'application_fee';
+
+ public const TYPE_APPLICATION_FEE_REFUND = 'application_fee_refund';
+
+ public const TYPE_CHARGE = 'charge';
+
+ public const TYPE_CONNECT_COLLECTION_TRANSFER = 'connect_collection_transfer';
+
+ public const TYPE_CONTRIBUTION = 'contribution';
+
+ public const TYPE_ISSUING_AUTHORIZATION_HOLD = 'issuing_authorization_hold';
+
+ public const TYPE_ISSUING_AUTHORIZATION_RELEASE = 'issuing_authorization_release';
+
+ public const TYPE_ISSUING_DISPUTE = 'issuing_dispute';
+
+ public const TYPE_ISSUING_TRANSACTION = 'issuing_transaction';
+
+ public const TYPE_PAYMENT = 'payment';
+
+ public const TYPE_PAYMENT_FAILURE_REFUND = 'payment_failure_refund';
+
+ public const TYPE_PAYMENT_REFUND = 'payment_refund';
+
+ public const TYPE_PAYOUT = 'payout';
+
+ public const TYPE_PAYOUT_CANCEL = 'payout_cancel';
+
+ public const TYPE_PAYOUT_FAILURE = 'payout_failure';
+
+ public const TYPE_REFUND = 'refund';
+
+ public const TYPE_REFUND_FAILURE = 'refund_failure';
+
+ public const TYPE_RESERVE_TRANSACTION = 'reserve_transaction';
+
+ public const TYPE_RESERVED_FUNDS = 'reserved_funds';
+
+ public const TYPE_STRIPE_FEE = 'stripe_fee';
+
+ public const TYPE_STRIPE_FX_FEE = 'stripe_fx_fee';
+
+ public const TYPE_TAX_FEE = 'tax_fee';
+
+ public const TYPE_TOPUP = 'topup';
+
+ public const TYPE_TOPUP_REVERSAL = 'topup_reversal';
+
+ public const TYPE_TRANSFER = 'transfer';
+
+ public const TYPE_TRANSFER_CANCEL = 'transfer_cancel';
+
+ public const TYPE_TRANSFER_FAILURE = 'transfer_failure';
+
+ public const TYPE_TRANSFER_REFUND = 'transfer_refund';
}
diff --git a/Stripe/Stripe/BankAccount.php b/Stripe/Stripe/BankAccount.php
index 57fd19b..a83f9a5 100755
--- a/Stripe/Stripe/BankAccount.php
+++ b/Stripe/Stripe/BankAccount.php
@@ -1,4 +1,4 @@
-Bank Debits and
* Transfers.
*
- * @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 null|string|\Stripe\Account $account The ID of the account that the bank account is associated with.
- * @property null|string $account_holder_name The name of the person or business that owns the bank account.
- * @property null|string $account_holder_type The type of entity that holds the account. This can be either individual or company.
- * @property null|string $account_type The bank account type. This can only be checking or savings in most countries. In Japan, this can only be futsu or toza.
- * @property null|string[] $available_payout_methods A set of available payout methods for this bank account. Only values from this set should be passed as the method when creating a payout.
- * @property null|string $bank_name Name of the bank associated with the routing number (e.g., WELLS FARGO).
- * @property string $country Two-letter ISO code representing the country the bank account is located in.
- * @property string $currency Three-letter ISO code for the currency paid out to the bank account.
- * @property null|string|\Stripe\Customer $customer The ID of the customer that the bank account is associated with.
- * @property null|bool $default_for_currency Whether this bank account is the default external account for its currency.
- * @property null|string $fingerprint Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
- * @property string $last4 The last four digits of the bank account number.
- * @property null|\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 $routing_number The routing transit number for the bank account.
- * @property string $status For bank accounts, possible values are new, validated, verified, verification_failed, or errored. A bank account that hasn't had any activity or validation performed is new. If Stripe can determine that the bank account exists, its status will be validated. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be verified. If the verification failed for any reason, such as microdeposit failure, the status will be verification_failed. If a transfer sent to this bank account fails, we'll set the status to errored and will not continue to send transfers until the bank details are updated.
For external accounts, possible values are new and errored. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to errored and transfers are stopped until account details are updated.
individual or company.
+ * @property null|string $account_type The bank account type. This can only be checking or savings in most countries. In Japan, this can only be futsu or toza.
+ * @property null|string[] $available_payout_methods A set of available payout methods for this bank account. Only values from this set should be passed as the method when creating a payout.
+ * @property null|string $bank_name Name of the bank associated with the routing number (e.g., WELLS FARGO).
+ * @property string $country Two-letter ISO code representing the country the bank account is located in.
+ * @property string $currency Three-letter ISO code for the currency paid out to the bank account.
+ * @property null|string|\Stripe\Customer $customer The ID of the customer that the bank account is associated with.
+ * @property null|bool $default_for_currency Whether this bank account is the default external account for its currency.
+ * @property null|string $fingerprint Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
+ * @property string $last4 The last four digits of the bank account number.
+ * @property null|\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 $routing_number The routing transit number for the bank account.
+ * @property string $status For bank accounts, possible values are new, validated, verified, verification_failed, or errored. A bank account that hasn't had any activity or validation performed is new. If Stripe can determine that the bank account exists, its status will be validated. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be verified. If the verification failed for any reason, such as microdeposit failure, the status will be verification_failed. If a transfer sent to this bank account fails, we'll set the status to errored and will not continue to send transfers until the bank details are updated.
For external accounts, possible values are new and errored. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to errored and transfers are stopped until account details are updated.
true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property \Stripe\StripeObject $login_page
- * @property null|\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 int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch.
+ * @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 bool $active Whether the configuration is active and can be used to create portal sessions.
+ * @property null|string|\Stripe\StripeObject $application ID of the Connect Application that created the configuration.
+ * @property \Stripe\StripeObject $business_profile
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|string $default_return_url The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the session.
+ * @property \Stripe\StripeObject $features
+ * @property bool $is_default Whether the configuration is the default. If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $login_page
+ * @property null|\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 int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch.
*/
class Configuration extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'billing_portal.configuration';
+ public const OBJECT_NAME = 'billing_portal.configuration';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
diff --git a/Stripe/Stripe/BillingPortal/Session.php b/Stripe/Stripe/BillingPortal/Session.php
index 243e845..a9b272b 100755
--- a/Stripe/Stripe/BillingPortal/Session.php
+++ b/Stripe/Stripe/BillingPortal/Session.php
@@ -1,4 +1,4 @@
-integration
* guide.
*
- * @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 $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|\Stripe\BillingPortal\Configuration $configuration The configuration used by this session, describing the features available.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $customer The ID of the customer for this session.
- * @property null|\Stripe\StripeObject $flow Information about a specific flow for the customer to go through.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|string $locale The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s preferred_locales or browser’s locale is used.
- * @property null|string $on_behalf_of The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this on_behalf_of account appear in the portal. For more information, see the docs. Use the Accounts API to modify the on_behalf_of account's branding settings, which the portal displays.
- * @property null|string $return_url The URL to redirect customers to when they click on the portal's link to return to your website.
- * @property string $url The short-lived URL of the session that gives customers access to the customer portal.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $customer The ID of the customer for this session.
+ * @property null|\Stripe\StripeObject $flow Information about a specific flow for the customer to go through.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|string $locale The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s preferred_locales or browser’s locale is used.
+ * @property null|string $on_behalf_of The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this on_behalf_of account appear in the portal. For more information, see the docs. Use the Accounts API to modify the on_behalf_of account's branding settings, which the portal displays.
+ * @property null|string $return_url The URL to redirect customers to when they click on the portal's link to return to your website.
+ * @property string $url The short-lived URL of the session that gives customers access to the customer portal.
*/
class Session extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'billing_portal.session';
+ public const OBJECT_NAME = 'billing_portal.session';
use \Stripe\ApiOperations\Create;
}
diff --git a/Stripe/Stripe/Capability.php b/Stripe/Stripe/Capability.php
index f675d71..4cbd615 100755
--- a/Stripe/Stripe/Capability.php
+++ b/Stripe/Stripe/Capability.php
@@ -1,4 +1,4 @@
-Account
* capabilities.
*
- * @property string $id The identifier for the capability.
- * @property string $object String representing the object's type. Objects of the same type share the same value.
- * @property string|\Stripe\Account $account The account for which the capability enables functionality.
- * @property \Stripe\StripeObject $future_requirements
- * @property bool $requested Whether the capability has been requested.
- * @property null|int $requested_at Time at which the capability was requested. Measured in seconds since the Unix epoch.
- * @property \Stripe\StripeObject $requirements
- * @property string $status The status of the capability. Can be active, inactive, pending, or unrequested.
+ * @property string $id The identifier for the capability.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property string|\Stripe\Account $account The account for which the capability enables functionality.
+ * @property \Stripe\StripeObject $future_requirements
+ * @property bool $requested Whether the capability has been requested.
+ * @property null|int $requested_at Time at which the capability was requested. Measured in seconds since the Unix epoch.
+ * @property \Stripe\StripeObject $requirements
+ * @property string $status The status of the capability. Can be active, inactive, pending, or unrequested.
*/
class Capability extends ApiResource
{
- const OBJECT_NAME = 'capability';
+ public const OBJECT_NAME = 'capability';
use ApiOperations\Update;
- const STATUS_ACTIVE = 'active';
- const STATUS_INACTIVE = 'inactive';
- const STATUS_PENDING = 'pending';
- const STATUS_UNREQUESTED = 'unrequested';
+ public const STATUS_ACTIVE = 'active';
+
+ public const STATUS_INACTIVE = 'inactive';
+
+ public const STATUS_PENDING = 'pending';
+
+ public const STATUS_UNREQUESTED = 'unrequested';
/**
* @return string the API URL for this Stripe account reversal
*/
public function instanceUrl()
{
- $id = $this['id'];
+ $id = $this['id'];
$account = $this['account'];
if (!$id) {
throw new Exception\UnexpectedValueException(
@@ -45,23 +48,23 @@ class Capability extends ApiResource
null
);
}
- $id = Util\Util::utf8($id);
+ $id = Util\Util::utf8($id);
$account = Util\Util::utf8($account);
- $base = Account::classUrl();
+ $base = Account::classUrl();
$accountExtn = \urlencode($account);
- $extn = \urlencode($id);
+ $extn = \urlencode($id);
return "{$base}/{$accountExtn}/capabilities/{$extn}";
}
/**
- * @param array|string $_id
+ * @param array|string $_id
* @param null|array|string $_opts
*
* @throws \Stripe\Exception\BadMethodCallException
*/
- public static function retrieve($_id, $_opts = null)
+ public static function retrieve($_id, $_opts = null) : void
{
$msg = 'Capabilities cannot be retrieved without an account ID. ' .
'Retrieve a capability using `Account::retrieveCapability(' .
@@ -71,13 +74,13 @@ class Capability extends ApiResource
}
/**
- * @param string $_id
- * @param null|array $_params
+ * @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)
+ public static function update($_id, $_params = null, $_options = null) : void
{
$msg = 'Capabilities cannot be updated without an account ID. ' .
'Update a capability using `Account::updateCapability(' .
diff --git a/Stripe/Stripe/Card.php b/Stripe/Stripe/Card.php
index 939523b..071590f 100755
--- a/Stripe/Stripe/Card.php
+++ b/Stripe/Stripe/Card.php
@@ -1,4 +1,4 @@
-Card Payments
* with Sources.
*
- * @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 null|string|\Stripe\Account $account The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.
- * @property null|string $address_city City/District/Suburb/Town/Village.
- * @property null|string $address_country Billing address country, if provided when creating card.
- * @property null|string $address_line1 Address line 1 (Street address/PO Box/Company name).
- * @property null|string $address_line1_check If address_line1 was provided, results of the check: pass, fail, unavailable, or unchecked.
- * @property null|string $address_line2 Address line 2 (Apartment/Suite/Unit/Building).
- * @property null|string $address_state State/County/Province/Region.
- * @property null|string $address_zip ZIP or postal code.
- * @property null|string $address_zip_check If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked.
- * @property null|string[] $available_payout_methods A set of available payout methods for this card. Only values from this set should be passed as the method when creating a payout.
- * @property string $brand Card brand. Can be American Express, Diners Club, Discover, JCB, MasterCard, UnionPay, Visa, or Unknown.
- * @property null|string $country Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
- * @property null|string $currency Three-letter ISO code for currency. Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency.
- * @property null|string|\Stripe\Customer $customer The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
- * @property null|string $cvc_check If a CVC was provided, results of the check: pass, fail, unavailable, or unchecked. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see Check if a card is valid without a charge.
- * @property null|bool $default_for_currency Whether this card is the default external account for its currency.
- * @property null|string $dynamic_last4 (For tokenized numbers only.) The last four digits of the device account number.
- * @property int $exp_month Two-digit number representing the card's expiration month.
- * @property int $exp_year Four-digit number representing the card's expiration year.
- * @property null|string $fingerprint Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.
- * @property string $funding Card funding type. Can becredit, debit, prepaid, or unknown.
- * @property string $last4 The last four digits of the card.
- * @property null|\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 $name Cardholder name.
- * @property null|string $status For external accounts, possible values are new and errored. If a transfer fails, the status is set to errored and transfers are stopped until account details are updated.
- * @property null|string $tokenization_method If the card number is tokenized, this is the method that was used. Can be android_pay (includes Google Pay), apple_pay, masterpass, visa_checkout, or null.
+ * @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 null|string|\Stripe\Account $account The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.
+ * @property null|string $address_city City/District/Suburb/Town/Village.
+ * @property null|string $address_country Billing address country, if provided when creating card.
+ * @property null|string $address_line1 Address line 1 (Street address/PO Box/Company name).
+ * @property null|string $address_line1_check If address_line1 was provided, results of the check: pass, fail, unavailable, or unchecked.
+ * @property null|string $address_line2 Address line 2 (Apartment/Suite/Unit/Building).
+ * @property null|string $address_state State/County/Province/Region.
+ * @property null|string $address_zip ZIP or postal code.
+ * @property null|string $address_zip_check If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked.
+ * @property null|string[] $available_payout_methods A set of available payout methods for this card. Only values from this set should be passed as the method when creating a payout.
+ * @property string $brand Card brand. Can be American Express, Diners Club, Discover, JCB, MasterCard, UnionPay, Visa, or Unknown.
+ * @property null|string $country Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
+ * @property null|string $currency Three-letter ISO code for currency. Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency.
+ * @property null|string|\Stripe\Customer $customer The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
+ * @property null|string $cvc_check If a CVC was provided, results of the check: pass, fail, unavailable, or unchecked. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see Check if a card is valid without a charge.
+ * @property null|bool $default_for_currency Whether this card is the default external account for its currency.
+ * @property null|string $dynamic_last4 (For tokenized numbers only.) The last four digits of the device account number.
+ * @property int $exp_month Two-digit number representing the card's expiration month.
+ * @property int $exp_year Four-digit number representing the card's expiration year.
+ * @property null|string $fingerprint Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.
+ * @property string $funding Card funding type. Can becredit, debit, prepaid, or unknown.
+ * @property string $last4 The last four digits of the card.
+ * @property null|\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 $name Cardholder name.
+ * @property null|string $status For external accounts, possible values are new and errored. If a transfer fails, the status is set to errored and transfers are stopped until account details are updated.
+ * @property null|string $tokenization_method If the card number is tokenized, this is the method that was used. Can be android_pay (includes Google Pay), apple_pay, masterpass, visa_checkout, or null.
*/
class Card extends ApiResource
{
- const OBJECT_NAME = 'card';
+ public const OBJECT_NAME = 'card';
use ApiOperations\Delete;
use ApiOperations\Update;
@@ -53,62 +53,69 @@ class Card extends ApiResource
*
* @see https://stripe.com/docs/api/cards/object#card_object-cvc_check
*/
- const CVC_CHECK_FAIL = 'fail';
- const CVC_CHECK_PASS = 'pass';
- const CVC_CHECK_UNAVAILABLE = 'unavailable';
- const CVC_CHECK_UNCHECKED = 'unchecked';
+ public const CVC_CHECK_FAIL = 'fail';
+
+ public const CVC_CHECK_PASS = 'pass';
+
+ public const CVC_CHECK_UNAVAILABLE = 'unavailable';
+
+ public const CVC_CHECK_UNCHECKED = 'unchecked';
/**
* Possible string representations of the funding of the card.
*
* @see https://stripe.com/docs/api/cards/object#card_object-funding
*/
- const FUNDING_CREDIT = 'credit';
- const FUNDING_DEBIT = 'debit';
- const FUNDING_PREPAID = 'prepaid';
- const FUNDING_UNKNOWN = 'unknown';
+ public const FUNDING_CREDIT = 'credit';
+
+ public const FUNDING_DEBIT = 'debit';
+
+ public const FUNDING_PREPAID = 'prepaid';
+
+ public const FUNDING_UNKNOWN = 'unknown';
/**
* Possible string representations of the tokenization method when using Apple Pay or Google Pay.
*
* @see https://stripe.com/docs/api/cards/object#card_object-tokenization_method
*/
- const TOKENIZATION_METHOD_APPLE_PAY = 'apple_pay';
- const TOKENIZATION_METHOD_GOOGLE_PAY = 'google_pay';
+ public const TOKENIZATION_METHOD_APPLE_PAY = 'apple_pay';
+
+ public const TOKENIZATION_METHOD_GOOGLE_PAY = 'google_pay';
/**
* @return string The instance URL for this resource. It needs to be special
- * cased because cards are nested resources that may belong to different
- * top-level resources.
+ * cased because cards are nested resources that may belong to different
+ * top-level resources.
*/
public function instanceUrl()
{
if ($this['customer']) {
- $base = Customer::classUrl();
+ $base = Customer::classUrl();
$parent = $this['customer'];
- $path = 'sources';
+ $path = 'sources';
} elseif ($this['account']) {
- $base = Account::classUrl();
+ $base = Account::classUrl();
$parent = $this['account'];
- $path = 'external_accounts';
+ $path = 'external_accounts';
} else {
$msg = 'Cards cannot be accessed without a customer ID, or account ID.';
throw new Exception\UnexpectedValueException($msg);
}
$parentExtn = \urlencode(Util\Util::utf8($parent));
- $extn = \urlencode(Util\Util::utf8($this['id']));
+ $extn = \urlencode(Util\Util::utf8($this['id']));
return "{$base}/{$parentExtn}/{$path}/{$extn}";
}
/**
- * @param array|string $_id
+ * @param array|string $_id
* @param null|array|string $_opts
*
* @throws \Stripe\Exception\BadMethodCallException
*/
- public static function retrieve($_id, $_opts = null)
+ public static function retrieve($_id, $_opts = null) : void
{
$msg = 'Cards cannot be retrieved without a customer ID or an ' .
'account ID. Retrieve a card using ' .
@@ -119,13 +126,13 @@ class Card extends ApiResource
}
/**
- * @param string $_id
- * @param null|array $_params
+ * @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)
+ public static function update($_id, $_params = null, $_options = null) : void
{
$msg = 'Cards cannot be updated without a customer ID or an ' .
'account ID. Update a card using ' .
diff --git a/Stripe/Stripe/CashBalance.php b/Stripe/Stripe/CashBalance.php
index 3e73961..0a30594 100755
--- a/Stripe/Stripe/CashBalance.php
+++ b/Stripe/Stripe/CashBalance.php
@@ -1,4 +1,4 @@
-smallest currency unit.
- * @property string $customer The ID of the customer whose cash balance this object represents.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property \Stripe\StripeObject $settings
+ * @property string $customer The ID of the customer whose cash balance this object represents.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $settings
*/
class CashBalance extends ApiResource
{
- const OBJECT_NAME = 'cash_balance';
+ public const OBJECT_NAME = 'cash_balance';
/**
* @return string the API URL for this balance transaction
@@ -27,19 +27,19 @@ class CashBalance extends ApiResource
$customer = $this['customer'];
$customer = Util\Util::utf8($customer);
- $base = Customer::classUrl();
+ $base = Customer::classUrl();
$customerExtn = \urlencode($customer);
return "{$base}/{$customerExtn}/cash_balance";
}
/**
- * @param array|string $_id
+ * @param array|string $_id
* @param null|array|string $_opts
*
* @throws \Stripe\Exception\BadMethodCallException
*/
- public static function retrieve($_id, $_opts = null)
+ public static function retrieve($_id, $_opts = null) : void
{
$msg = 'Customer Cash Balance cannot be retrieved without a ' .
'customer ID. Retrieve a Customer Cash Balance using ' .
@@ -49,13 +49,13 @@ class CashBalance extends ApiResource
}
/**
- * @param string $_id
- * @param null|array $_params
+ * @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)
+ public static function update($_id, $_params = null, $_options = null) : void
{
$msg = 'Customer Cash Balance cannot be updated without a ' .
'customer ID. Retrieve a Customer Cash Balance using ' .
diff --git a/Stripe/Stripe/Charge.php b/Stripe/Stripe/Charge.php
index 428ef66..1dba14a 100755
--- a/Stripe/Stripe/Charge.php
+++ b/Stripe/Stripe/Charge.php
@@ -1,4 +1,4 @@
-Accept a
* payment with the Charges API.
*
- * @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 \Stripe\StripeObject $alternate_statement_descriptors
- * @property int $amount Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
- * @property int $amount_captured Amount in %s captured (can be less than the amount attribute on the charge if a partial capture was made).
- * @property int $amount_refunded Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued).
- * @property null|string|\Stripe\StripeObject $application ID of the Connect application that created the charge.
- * @property null|string|\Stripe\ApplicationFee $application_fee The application fee (if any) for the charge. See the Connect documentation for details.
- * @property null|int $application_fee_amount The amount of the application fee (if any) requested for the charge. See the Connect documentation for details.
- * @property string $authorization_code Authorization code on the charge.
- * @property null|string|\Stripe\BalanceTransaction $balance_transaction ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).
- * @property \Stripe\StripeObject $billing_details
- * @property null|string $calculated_statement_descriptor The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined.
- * @property bool $captured If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property null|string|\Stripe\Customer $customer ID of the customer this charge is for if one exists.
- * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
- * @property null|string|\Stripe\Account $destination ID of an existing, connected Stripe account to transfer funds to if transfer_data was specified in the charge request.
- * @property null|string|\Stripe\Dispute $dispute Details about the dispute if the charge has been disputed.
- * @property bool $disputed Whether the charge has been disputed.
- * @property null|string|\Stripe\BalanceTransaction $failure_balance_transaction ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.
- * @property null|string $failure_code Error code explaining reason for charge failure if available (see the errors section for a list of codes).
- * @property null|string $failure_message Message to user further explaining reason for charge failure if available.
- * @property null|\Stripe\StripeObject $fraud_details Information on fraud assessments for the charge.
- * @property null|string|\Stripe\Invoice $invoice ID of the invoice this charge is for if one exists.
- * @property \Stripe\StripeObject $level3
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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|\Stripe\Account $on_behalf_of The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the Connect documentation for details.
- * @property null|\Stripe\StripeObject $outcome Details about whether the payment was accepted, and why. See understanding declines for details.
- * @property bool $paid true if the charge succeeded, or was successfully authorized for later capture.
- * @property null|string|\Stripe\PaymentIntent $payment_intent ID of the PaymentIntent associated with this charge, if one exists.
- * @property null|string $payment_method ID of the payment method used in this charge.
- * @property null|\Stripe\StripeObject $payment_method_details Details about the payment method at the time of the transaction.
- * @property \Stripe\StripeObject $radar_options Options to configure Radar. See Radar Session for more information.
- * @property null|string $receipt_email This is the email address that the receipt for this charge was sent to.
- * @property null|string $receipt_number This is the transaction number that appears on email receipts sent for this charge. This attribute will be null until a receipt has been sent.
- * @property null|string $receipt_url This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.
- * @property bool $refunded Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
- * @property null|\Stripe\Collection<\Stripe\Refund> $refunds A list of refunds that have been applied to the charge.
- * @property null|string|\Stripe\Review $review ID of the review associated with this charge if one exists.
- * @property null|\Stripe\StripeObject $shipping Shipping information for the charge.
- * @property null|\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source $source This is a legacy field that will be removed in the future. It contains the Source, Card, or BankAccount object used for the charge. For details about the payment method used for this charge, refer to payment_method or payment_method_details instead.
- * @property null|string|\Stripe\Transfer $source_transfer The transfer ID which created this charge. Only present if the charge came from another Stripe account. See the Connect documentation for details.
- * @property null|string $statement_descriptor For card charges, use statement_descriptor_suffix instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.
- * @property null|string $statement_descriptor_suffix Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
- * @property string $status The status of the payment is either succeeded, pending, or failed.
- * @property string|\Stripe\Transfer $transfer ID of the transfer to the destination account (only applicable if the charge was created using the destination parameter).
- * @property null|\Stripe\StripeObject $transfer_data An optional dictionary including the account to automatically transfer to as part of a destination charge. See the Connect documentation for details.
- * @property null|string $transfer_group A string that identifies this transaction as part of a group. See the Connect documentation for details.
+ * @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 \Stripe\StripeObject $alternate_statement_descriptors
+ * @property int $amount Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
+ * @property int $amount_captured Amount in %s captured (can be less than the amount attribute on the charge if a partial capture was made).
+ * @property int $amount_refunded Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued).
+ * @property null|string|\Stripe\StripeObject $application ID of the Connect application that created the charge.
+ * @property null|string|\Stripe\ApplicationFee $application_fee The application fee (if any) for the charge. See the Connect documentation for details.
+ * @property null|int $application_fee_amount The amount of the application fee (if any) requested for the charge. See the Connect documentation for details.
+ * @property string $authorization_code Authorization code on the charge.
+ * @property null|string|\Stripe\BalanceTransaction $balance_transaction ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).
+ * @property \Stripe\StripeObject $billing_details
+ * @property null|string $calculated_statement_descriptor The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined.
+ * @property bool $captured If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property null|string|\Stripe\Customer $customer ID of the customer this charge is for if one exists.
+ * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
+ * @property null|string|\Stripe\Account $destination ID of an existing, connected Stripe account to transfer funds to if transfer_data was specified in the charge request.
+ * @property null|string|\Stripe\Dispute $dispute Details about the dispute if the charge has been disputed.
+ * @property bool $disputed Whether the charge has been disputed.
+ * @property null|string|\Stripe\BalanceTransaction $failure_balance_transaction ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.
+ * @property null|string $failure_code Error code explaining reason for charge failure if available (see the errors section for a list of codes).
+ * @property null|string $failure_message Message to user further explaining reason for charge failure if available.
+ * @property null|\Stripe\StripeObject $fraud_details Information on fraud assessments for the charge.
+ * @property null|string|\Stripe\Invoice $invoice ID of the invoice this charge is for if one exists.
+ * @property \Stripe\StripeObject $level3
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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|\Stripe\Account $on_behalf_of The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the Connect documentation for details.
+ * @property null|\Stripe\StripeObject $outcome Details about whether the payment was accepted, and why. See understanding declines for details.
+ * @property bool $paid true if the charge succeeded, or was successfully authorized for later capture.
+ * @property null|string|\Stripe\PaymentIntent $payment_intent ID of the PaymentIntent associated with this charge, if one exists.
+ * @property null|string $payment_method ID of the payment method used in this charge.
+ * @property null|\Stripe\StripeObject $payment_method_details Details about the payment method at the time of the transaction.
+ * @property \Stripe\StripeObject $radar_options Options to configure Radar. See Radar Session for more information.
+ * @property null|string $receipt_email This is the email address that the receipt for this charge was sent to.
+ * @property null|string $receipt_number This is the transaction number that appears on email receipts sent for this charge. This attribute will be null until a receipt has been sent.
+ * @property null|string $receipt_url This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.
+ * @property bool $refunded Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
+ * @property null|\Stripe\Collection<\Stripe\Refund> $refunds A list of refunds that have been applied to the charge.
+ * @property null|string|\Stripe\Review $review ID of the review associated with this charge if one exists.
+ * @property null|\Stripe\StripeObject $shipping Shipping information for the charge.
+ * @property null|\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source $source This is a legacy field that will be removed in the future. It contains the Source, Card, or BankAccount object used for the charge. For details about the payment method used for this charge, refer to payment_method or payment_method_details instead.
+ * @property null|string|\Stripe\Transfer $source_transfer The transfer ID which created this charge. Only present if the charge came from another Stripe account. See the Connect documentation for details.
+ * @property null|string $statement_descriptor For card charges, use statement_descriptor_suffix instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.
+ * @property null|string $statement_descriptor_suffix Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
+ * @property string $status The status of the payment is either succeeded, pending, or failed.
+ * @property string|\Stripe\Transfer $transfer ID of the transfer to the destination account (only applicable if the charge was created using the destination parameter).
+ * @property null|\Stripe\StripeObject $transfer_data An optional dictionary including the account to automatically transfer to as part of a destination charge. See the Connect documentation for details.
+ * @property null|string $transfer_group A string that identifies this transaction as part of a group. See the Connect documentation for details.
*/
class Charge extends ApiResource
{
- const OBJECT_NAME = 'charge';
+ public const OBJECT_NAME = 'charge';
use ApiOperations\All;
use ApiOperations\Create;
@@ -75,9 +75,11 @@ class Charge extends ApiResource
use ApiOperations\Search;
use ApiOperations\Update;
- const STATUS_FAILED = 'failed';
- const STATUS_PENDING = 'pending';
- const STATUS_SUCCEEDED = 'succeeded';
+ public const STATUS_FAILED = 'failed';
+
+ public const STATUS_PENDING = 'pending';
+
+ public const STATUS_SUCCEEDED = 'succeeded';
/**
* Possible string representations of decline codes.
@@ -85,55 +87,100 @@ class Charge extends ApiResource
*
* @see https://stripe.com/docs/declines/codes
*/
- const DECLINED_AUTHENTICATION_REQUIRED = 'authentication_required';
- const DECLINED_APPROVE_WITH_ID = 'approve_with_id';
- const DECLINED_CALL_ISSUER = 'call_issuer';
- const DECLINED_CARD_NOT_SUPPORTED = 'card_not_supported';
- const DECLINED_CARD_VELOCITY_EXCEEDED = 'card_velocity_exceeded';
- const DECLINED_CURRENCY_NOT_SUPPORTED = 'currency_not_supported';
- const DECLINED_DO_NOT_HONOR = 'do_not_honor';
- const DECLINED_DO_NOT_TRY_AGAIN = 'do_not_try_again';
- const DECLINED_DUPLICATED_TRANSACTION = 'duplicate_transaction';
- const DECLINED_EXPIRED_CARD = 'expired_card';
- const DECLINED_FRAUDULENT = 'fraudulent';
- const DECLINED_GENERIC_DECLINE = 'generic_decline';
- const DECLINED_INCORRECT_NUMBER = 'incorrect_number';
- const DECLINED_INCORRECT_CVC = 'incorrect_cvc';
- const DECLINED_INCORRECT_PIN = 'incorrect_pin';
- const DECLINED_INCORRECT_ZIP = 'incorrect_zip';
- const DECLINED_INSUFFICIENT_FUNDS = 'insufficient_funds';
- const DECLINED_INVALID_ACCOUNT = 'invalid_account';
- const DECLINED_INVALID_AMOUNT = 'invalid_amount';
- const DECLINED_INVALID_CVC = 'invalid_cvc';
- const DECLINED_INVALID_EXPIRY_YEAR = 'invalid_expiry_year';
- const DECLINED_INVALID_NUMBER = 'invalid_number';
- const DECLINED_INVALID_PIN = 'invalid_pin';
- const DECLINED_ISSUER_NOT_AVAILABLE = 'issuer_not_available';
- const DECLINED_LOST_CARD = 'lost_card';
- const DECLINED_MERCHANT_BLACKLIST = 'merchant_blacklist';
- const DECLINED_NEW_ACCOUNT_INFORMATION_AVAILABLE = 'new_account_information_available';
- const DECLINED_NO_ACTION_TAKEN = 'no_action_taken';
- const DECLINED_NOT_PERMITTED = 'not_permitted';
- const DECLINED_OFFLINE_PIN_REQUIRED = 'offline_pin_required';
- const DECLINED_ONLINE_OR_OFFLINE_PIN_REQUIRED = 'online_or_offline_pin_required';
- const DECLINED_PICKUP_CARD = 'pickup_card';
- const DECLINED_PIN_TRY_EXCEEDED = 'pin_try_exceeded';
- const DECLINED_PROCESSING_ERROR = 'processing_error';
- const DECLINED_REENTER_TRANSACTION = 'reenter_transaction';
- const DECLINED_RESTRICTED_CARD = 'restricted_card';
- const DECLINED_REVOCATION_OF_ALL_AUTHORIZATIONS = 'revocation_of_all_authorizations';
- const DECLINED_REVOCATION_OF_AUTHORIZATION = 'revocation_of_authorization';
- const DECLINED_SECURITY_VIOLATION = 'security_violation';
- const DECLINED_SERVICE_NOT_ALLOWED = 'service_not_allowed';
- const DECLINED_STOLEN_CARD = 'stolen_card';
- const DECLINED_STOP_PAYMENT_ORDER = 'stop_payment_order';
- const DECLINED_TESTMODE_DECLINE = 'testmode_decline';
- const DECLINED_TRANSACTION_NOT_ALLOWED = 'transaction_not_allowed';
- const DECLINED_TRY_AGAIN_LATER = 'try_again_later';
- const DECLINED_WITHDRAWAL_COUNT_LIMIT_EXCEEDED = 'withdrawal_count_limit_exceeded';
+ public const DECLINED_AUTHENTICATION_REQUIRED = 'authentication_required';
+
+ public const DECLINED_APPROVE_WITH_ID = 'approve_with_id';
+
+ public const DECLINED_CALL_ISSUER = 'call_issuer';
+
+ public const DECLINED_CARD_NOT_SUPPORTED = 'card_not_supported';
+
+ public const DECLINED_CARD_VELOCITY_EXCEEDED = 'card_velocity_exceeded';
+
+ public const DECLINED_CURRENCY_NOT_SUPPORTED = 'currency_not_supported';
+
+ public const DECLINED_DO_NOT_HONOR = 'do_not_honor';
+
+ public const DECLINED_DO_NOT_TRY_AGAIN = 'do_not_try_again';
+
+ public const DECLINED_DUPLICATED_TRANSACTION = 'duplicate_transaction';
+
+ public const DECLINED_EXPIRED_CARD = 'expired_card';
+
+ public const DECLINED_FRAUDULENT = 'fraudulent';
+
+ public const DECLINED_GENERIC_DECLINE = 'generic_decline';
+
+ public const DECLINED_INCORRECT_NUMBER = 'incorrect_number';
+
+ public const DECLINED_INCORRECT_CVC = 'incorrect_cvc';
+
+ public const DECLINED_INCORRECT_PIN = 'incorrect_pin';
+
+ public const DECLINED_INCORRECT_ZIP = 'incorrect_zip';
+
+ public const DECLINED_INSUFFICIENT_FUNDS = 'insufficient_funds';
+
+ public const DECLINED_INVALID_ACCOUNT = 'invalid_account';
+
+ public const DECLINED_INVALID_AMOUNT = 'invalid_amount';
+
+ public const DECLINED_INVALID_CVC = 'invalid_cvc';
+
+ public const DECLINED_INVALID_EXPIRY_YEAR = 'invalid_expiry_year';
+
+ public const DECLINED_INVALID_NUMBER = 'invalid_number';
+
+ public const DECLINED_INVALID_PIN = 'invalid_pin';
+
+ public const DECLINED_ISSUER_NOT_AVAILABLE = 'issuer_not_available';
+
+ public const DECLINED_LOST_CARD = 'lost_card';
+
+ public const DECLINED_MERCHANT_BLACKLIST = 'merchant_blacklist';
+
+ public const DECLINED_NEW_ACCOUNT_INFORMATION_AVAILABLE = 'new_account_information_available';
+
+ public const DECLINED_NO_ACTION_TAKEN = 'no_action_taken';
+
+ public const DECLINED_NOT_PERMITTED = 'not_permitted';
+
+ public const DECLINED_OFFLINE_PIN_REQUIRED = 'offline_pin_required';
+
+ public const DECLINED_ONLINE_OR_OFFLINE_PIN_REQUIRED = 'online_or_offline_pin_required';
+
+ public const DECLINED_PICKUP_CARD = 'pickup_card';
+
+ public const DECLINED_PIN_TRY_EXCEEDED = 'pin_try_exceeded';
+
+ public const DECLINED_PROCESSING_ERROR = 'processing_error';
+
+ public const DECLINED_REENTER_TRANSACTION = 'reenter_transaction';
+
+ public const DECLINED_RESTRICTED_CARD = 'restricted_card';
+
+ public const DECLINED_REVOCATION_OF_ALL_AUTHORIZATIONS = 'revocation_of_all_authorizations';
+
+ public const DECLINED_REVOCATION_OF_AUTHORIZATION = 'revocation_of_authorization';
+
+ public const DECLINED_SECURITY_VIOLATION = 'security_violation';
+
+ public const DECLINED_SERVICE_NOT_ALLOWED = 'service_not_allowed';
+
+ public const DECLINED_STOLEN_CARD = 'stolen_card';
+
+ public const DECLINED_STOP_PAYMENT_ORDER = 'stop_payment_order';
+
+ public const DECLINED_TESTMODE_DECLINE = 'testmode_decline';
+
+ public const DECLINED_TRANSACTION_NOT_ALLOWED = 'transaction_not_allowed';
+
+ public const DECLINED_TRY_AGAIN_LATER = 'try_again_later';
+
+ public const DECLINED_WITHDRAWAL_COUNT_LIMIT_EXCEEDED = 'withdrawal_count_limit_exceeded';
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -142,7 +189,7 @@ class Charge extends ApiResource
*/
public function capture($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/capture';
+ $url = $this->instanceUrl() . '/capture';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -150,7 +197,7 @@ class Charge extends ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Checkout/Session.php b/Stripe/Stripe/Checkout/Session.php
index f2efa59..d48620e 100755
--- a/Stripe/Stripe/Checkout/Session.php
+++ b/Stripe/Stripe/Checkout/Session.php
@@ -1,4 +1,4 @@
-Checkout
* Quickstart.
*
- * @property string $id Unique identifier for the object. Used to pass to redirectToCheckout in Stripe.js.
- * @property string $object String representing the object's type. Objects of the same type share the same value.
- * @property null|\Stripe\StripeObject $after_expiration When set, provides configuration for actions to take if this Checkout Session expires.
- * @property null|bool $allow_promotion_codes Enables user redeemable promotion codes.
- * @property null|int $amount_subtotal Total of all items before discounts or taxes are applied.
- * @property null|int $amount_total Total of all items after discounts and taxes are applied.
- * @property \Stripe\StripeObject $automatic_tax
- * @property null|string $billing_address_collection Describes whether Checkout should collect the customer's billing address.
- * @property null|string $cancel_url If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.
- * @property null|string $client_reference_id A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the Session with your internal systems.
- * @property null|\Stripe\StripeObject $consent Results of consent_collection for this session.
- * @property null|\Stripe\StripeObject $consent_collection When set, provides configuration for the Checkout Session to gather active consent from customers.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property null|string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property \Stripe\StripeObject $custom_text
- * @property null|string|\Stripe\Customer $customer The ID of the customer for this Session. For Checkout Sessions in payment or subscription mode, Checkout will create a new customer object based on information provided during the payment flow unless an existing customer was provided when the Session was created.
- * @property null|string $customer_creation Configure whether a Checkout Session creates a Customer when the Checkout Session completes.
- * @property null|\Stripe\StripeObject $customer_details The customer details including the customer's tax exempt status and the customer's tax IDs. Only the customer's email is present on Sessions in setup mode.
- * @property null|string $customer_email If provided, this value will be used when the Customer object is created. If not provided, customers will be asked to enter their email address. Use this parameter to prefill customer data if you already have an email on file. To access information about the customer once the payment flow is complete, use the customer attribute.
- * @property int $expires_at The timestamp at which the Checkout Session will expire.
- * @property null|string|\Stripe\Invoice $invoice ID of the invoice created by the Checkout Session, if it exists.
- * @property null|\Stripe\StripeObject $invoice_creation Details on the state of invoice creation for the Checkout Session.
- * @property \Stripe\Collection<\Stripe\LineItem> $line_items The line items purchased by the customer.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|string $locale The IETF language tag of the locale Checkout is displayed in. If blank or auto, the browser's locale is used.
- * @property null|\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 string $mode The mode of the Checkout Session.
- * @property null|string|\Stripe\PaymentIntent $payment_intent The ID of the PaymentIntent for Checkout Sessions in payment mode.
- * @property null|string|\Stripe\PaymentLink $payment_link The ID of the Payment Link that created this Session.
- * @property null|string $payment_method_collection Configure whether a Checkout Session should collect a payment method.
- * @property null|\Stripe\StripeObject $payment_method_options Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.
- * @property string[] $payment_method_types A list of the types of payment methods (e.g. card) this Checkout Session is allowed to accept.
- * @property string $payment_status The payment status of the Checkout Session, one of paid, unpaid, or no_payment_required. You can use this value to decide when to fulfill your customer's order.
- * @property \Stripe\StripeObject $phone_number_collection
- * @property null|string $recovered_from The ID of the original expired Checkout Session that triggered the recovery flow.
- * @property null|string|\Stripe\SetupIntent $setup_intent The ID of the SetupIntent for Checkout Sessions in setup mode.
- * @property null|\Stripe\StripeObject $shipping_address_collection When set, provides configuration for Checkout to collect a shipping address from a customer.
- * @property null|\Stripe\StripeObject $shipping_cost The details of the customer cost of shipping, including the customer chosen ShippingRate.
- * @property null|\Stripe\StripeObject $shipping_details Shipping information for this Checkout Session.
- * @property \Stripe\StripeObject[] $shipping_options The shipping rate options applied to this Session.
- * @property null|string $status The status of the Checkout Session, one of open, complete, or expired.
- * @property null|string $submit_type Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button. submit_type can only be specified on Checkout Sessions in payment mode, but not Checkout Sessions in subscription or setup mode.
- * @property null|string|\Stripe\Subscription $subscription The ID of the subscription for Checkout Sessions in subscription mode.
- * @property string $success_url The URL the customer will be directed to after the payment or subscription creation is successful.
- * @property \Stripe\StripeObject $tax_id_collection
- * @property null|\Stripe\StripeObject $total_details Tax and discount details for the computed total amount.
- * @property null|string $url The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. If you’re using Custom Domains, the URL will use your subdomain. Otherwise, it’ll use checkout.stripe.com. This value is only present when the session is active.
+ * @property string $id Unique identifier for the object. Used to pass to redirectToCheckout in Stripe.js.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property null|\Stripe\StripeObject $after_expiration When set, provides configuration for actions to take if this Checkout Session expires.
+ * @property null|bool $allow_promotion_codes Enables user redeemable promotion codes.
+ * @property null|int $amount_subtotal Total of all items before discounts or taxes are applied.
+ * @property null|int $amount_total Total of all items after discounts and taxes are applied.
+ * @property \Stripe\StripeObject $automatic_tax
+ * @property null|string $billing_address_collection Describes whether Checkout should collect the customer's billing address.
+ * @property null|string $cancel_url If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.
+ * @property null|string $client_reference_id A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the Session with your internal systems.
+ * @property null|\Stripe\StripeObject $consent Results of consent_collection for this session.
+ * @property null|\Stripe\StripeObject $consent_collection When set, provides configuration for the Checkout Session to gather active consent from customers.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property \Stripe\StripeObject $custom_text
+ * @property null|string|\Stripe\Customer $customer The ID of the customer for this Session. For Checkout Sessions in payment or subscription mode, Checkout will create a new customer object based on information provided during the payment flow unless an existing customer was provided when the Session was created.
+ * @property null|string $customer_creation Configure whether a Checkout Session creates a Customer when the Checkout Session completes.
+ * @property null|\Stripe\StripeObject $customer_details The customer details including the customer's tax exempt status and the customer's tax IDs. Only the customer's email is present on Sessions in setup mode.
+ * @property null|string $customer_email If provided, this value will be used when the Customer object is created. If not provided, customers will be asked to enter their email address. Use this parameter to prefill customer data if you already have an email on file. To access information about the customer once the payment flow is complete, use the customer attribute.
+ * @property int $expires_at The timestamp at which the Checkout Session will expire.
+ * @property null|string|\Stripe\Invoice $invoice ID of the invoice created by the Checkout Session, if it exists.
+ * @property null|\Stripe\StripeObject $invoice_creation Details on the state of invoice creation for the Checkout Session.
+ * @property \Stripe\Collection<\Stripe\LineItem> $line_items The line items purchased by the customer.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|string $locale The IETF language tag of the locale Checkout is displayed in. If blank or auto, the browser's locale is used.
+ * @property null|\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 string $mode The mode of the Checkout Session.
+ * @property null|string|\Stripe\PaymentIntent $payment_intent The ID of the PaymentIntent for Checkout Sessions in payment mode.
+ * @property null|string|\Stripe\PaymentLink $payment_link The ID of the Payment Link that created this Session.
+ * @property null|string $payment_method_collection Configure whether a Checkout Session should collect a payment method.
+ * @property null|\Stripe\StripeObject $payment_method_options Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.
+ * @property string[] $payment_method_types A list of the types of payment methods (e.g. card) this Checkout Session is allowed to accept.
+ * @property string $payment_status The payment status of the Checkout Session, one of paid, unpaid, or no_payment_required. You can use this value to decide when to fulfill your customer's order.
+ * @property \Stripe\StripeObject $phone_number_collection
+ * @property null|string $recovered_from The ID of the original expired Checkout Session that triggered the recovery flow.
+ * @property null|string|\Stripe\SetupIntent $setup_intent The ID of the SetupIntent for Checkout Sessions in setup mode.
+ * @property null|\Stripe\StripeObject $shipping_address_collection When set, provides configuration for Checkout to collect a shipping address from a customer.
+ * @property null|\Stripe\StripeObject $shipping_cost The details of the customer cost of shipping, including the customer chosen ShippingRate.
+ * @property null|\Stripe\StripeObject $shipping_details Shipping information for this Checkout Session.
+ * @property \Stripe\StripeObject[] $shipping_options The shipping rate options applied to this Session.
+ * @property null|string $status The status of the Checkout Session, one of open, complete, or expired.
+ * @property null|string $submit_type Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button. submit_type can only be specified on Checkout Sessions in payment mode, but not Checkout Sessions in subscription or setup mode.
+ * @property null|string|\Stripe\Subscription $subscription The ID of the subscription for Checkout Sessions in subscription mode.
+ * @property string $success_url The URL the customer will be directed to after the payment or subscription creation is successful.
+ * @property \Stripe\StripeObject $tax_id_collection
+ * @property null|\Stripe\StripeObject $total_details Tax and discount details for the computed total amount.
+ * @property null|string $url The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. If you’re using Custom Domains, the URL will use your subdomain. Otherwise, it’ll use checkout.stripe.com. This value is only present when the session is active.
*/
class Session extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'checkout.session';
+ public const OBJECT_NAME = 'checkout.session';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
- const BILLING_ADDRESS_COLLECTION_AUTO = 'auto';
- const BILLING_ADDRESS_COLLECTION_REQUIRED = 'required';
+ public const BILLING_ADDRESS_COLLECTION_AUTO = 'auto';
- const CUSTOMER_CREATION_ALWAYS = 'always';
- const CUSTOMER_CREATION_IF_REQUIRED = 'if_required';
+ public const BILLING_ADDRESS_COLLECTION_REQUIRED = 'required';
- const MODE_PAYMENT = 'payment';
- const MODE_SETUP = 'setup';
- const MODE_SUBSCRIPTION = 'subscription';
+ public const CUSTOMER_CREATION_ALWAYS = 'always';
- const PAYMENT_METHOD_COLLECTION_ALWAYS = 'always';
- const PAYMENT_METHOD_COLLECTION_IF_REQUIRED = 'if_required';
+ public const CUSTOMER_CREATION_IF_REQUIRED = 'if_required';
- const PAYMENT_STATUS_NO_PAYMENT_REQUIRED = 'no_payment_required';
- const PAYMENT_STATUS_PAID = 'paid';
- const PAYMENT_STATUS_UNPAID = 'unpaid';
+ public const MODE_PAYMENT = 'payment';
- const STATUS_COMPLETE = 'complete';
- const STATUS_EXPIRED = 'expired';
- const STATUS_OPEN = 'open';
+ public const MODE_SETUP = 'setup';
- const SUBMIT_TYPE_AUTO = 'auto';
- const SUBMIT_TYPE_BOOK = 'book';
- const SUBMIT_TYPE_DONATE = 'donate';
- const SUBMIT_TYPE_PAY = 'pay';
+ public const MODE_SUBSCRIPTION = 'subscription';
+
+ public const PAYMENT_METHOD_COLLECTION_ALWAYS = 'always';
+
+ public const PAYMENT_METHOD_COLLECTION_IF_REQUIRED = 'if_required';
+
+ public const PAYMENT_STATUS_NO_PAYMENT_REQUIRED = 'no_payment_required';
+
+ public const PAYMENT_STATUS_PAID = 'paid';
+
+ public const PAYMENT_STATUS_UNPAID = 'unpaid';
+
+ public const STATUS_COMPLETE = 'complete';
+
+ public const STATUS_EXPIRED = 'expired';
+
+ public const STATUS_OPEN = 'open';
+
+ public const SUBMIT_TYPE_AUTO = 'auto';
+
+ public const SUBMIT_TYPE_BOOK = 'book';
+
+ public const SUBMIT_TYPE_DONATE = 'donate';
+
+ public const SUBMIT_TYPE_PAY = 'pay';
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -115,7 +127,7 @@ class Session extends \Stripe\ApiResource
*/
public function expire($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/expire';
+ $url = $this->instanceUrl() . '/expire';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -123,8 +135,8 @@ class Session extends \Stripe\ApiResource
}
/**
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -133,9 +145,9 @@ class Session extends \Stripe\ApiResource
*/
public static function allLineItems($id, $params = null, $opts = null)
{
- $url = static::resourceUrl($id) . '/line_items';
+ $url = static::resourceUrl($id) . '/line_items';
list($response, $opts) = static::_staticRequest('get', $url, $params, $opts);
- $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
+ $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
diff --git a/Stripe/Stripe/Collection.php b/Stripe/Stripe/Collection.php
index 67da085..9a7d0c7 100755
--- a/Stripe/Stripe/Collection.php
+++ b/Stripe/Stripe/Collection.php
@@ -1,4 +1,4 @@
-
*
- * @property string $object
- * @property string $url
- * @property bool $has_more
+ * @property string $object
+ * @property string $url
+ * @property bool $has_more
* @property TStripeObject[] $data
*/
class Collection extends StripeObject implements \Countable, \IteratorAggregate
{
- const OBJECT_NAME = 'list';
+ public const OBJECT_NAME = 'list';
use ApiOperations\Request;
@@ -45,7 +45,7 @@ class Collection extends StripeObject implements \Countable, \IteratorAggregate
*
* @param array $filters the filters
*/
- public function setFilters($filters)
+ public function setFilters($filters) : void
{
$this->filters = $filters;
}
@@ -68,7 +68,7 @@ class Collection extends StripeObject implements \Countable, \IteratorAggregate
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws Exception\ApiErrorException
@@ -81,10 +81,10 @@ class Collection extends StripeObject implements \Countable, \IteratorAggregate
list($url, $params) = $this->extractPathAndUpdateParams($params);
list($response, $opts) = $this->_request('get', $url, $params, $opts);
- $obj = Util\Util::convertToStripeObject($response, $opts);
- if (!($obj instanceof \Stripe\Collection)) {
+ $obj = Util\Util::convertToStripeObject($response, $opts);
+ if (!($obj instanceof self)) {
throw new \Stripe\Exception\UnexpectedValueException(
- 'Expected type ' . \Stripe\Collection::class . ', got "' . \get_class($obj) . '" instead.'
+ 'Expected type ' . self::class . ', got "' . \get_class($obj) . '" instead.'
);
}
$obj->setFilters($params);
@@ -93,7 +93,7 @@ class Collection extends StripeObject implements \Countable, \IteratorAggregate
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws Exception\ApiErrorException
@@ -111,8 +111,8 @@ class Collection extends StripeObject implements \Countable, \IteratorAggregate
}
/**
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws Exception\ApiErrorException
@@ -124,8 +124,8 @@ class Collection extends StripeObject implements \Countable, \IteratorAggregate
self::_validateParams($params);
list($url, $params) = $this->extractPathAndUpdateParams($params);
- $id = Util\Util::utf8($id);
- $extn = \urlencode($id);
+ $id = Util\Util::utf8($id);
+ $extn = \urlencode($id);
list($response, $opts) = $this->_request(
'get',
"{$url}/{$extn}",
@@ -147,7 +147,7 @@ class Collection extends StripeObject implements \Countable, \IteratorAggregate
/**
* @return \ArrayIterator an iterator that can be used to iterate
- * across objects in the current page
+ * across objects in the current page
*/
#[\ReturnTypeWillChange]
public function getIterator()
@@ -157,7 +157,7 @@ class Collection extends StripeObject implements \Countable, \IteratorAggregate
/**
* @return \ArrayIterator an iterator that can be used to iterate
- * backwards across objects in the current page
+ * backwards across objects in the current page
*/
public function getReverseIterator()
{
@@ -166,9 +166,9 @@ class Collection extends StripeObject implements \Countable, \IteratorAggregate
/**
* @return \Generator|TStripeObject[] A generator that can be used to
- * iterate across all objects across all pages. As page boundaries are
- * encountered, the next page will be fetched automatically for
- * continued iteration.
+ * iterate across all objects across all pages. As page boundaries are
+ * encountered, the next page will be fetched automatically for
+ * continued iteration.
*/
public function autoPagingIterator()
{
@@ -206,7 +206,7 @@ class Collection extends StripeObject implements \Countable, \IteratorAggregate
*/
public static function emptyCollection($opts = null)
{
- return Collection::constructFrom(['data' => []], $opts);
+ return self::constructFrom(['data' => []], $opts);
}
/**
@@ -225,7 +225,7 @@ class Collection extends StripeObject implements \Countable, \IteratorAggregate
* This method will try to respect the limit of the current page. If none
* was given, the default limit will be fetched again.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @return Collectionstripe payment method refers to charging through your platform.
- * @property string[] $supported_transfer_countries Countries that can accept transfers from the specified country.
+ * @property string[] $supported_payment_currencies Currencies that can be accepted in the specified country (for payments).
+ * @property string[] $supported_payment_methods Payment methods available in the specified country. You may need to enable some payment methods (e.g., ACH) on your account before they appear in this list. The stripe payment method refers to charging through your platform.
+ * @property string[] $supported_transfer_countries Countries that can accept transfers from the specified country.
* @property \Stripe\StripeObject $verification_fields
*/
class CountrySpec extends ApiResource
{
- const OBJECT_NAME = 'country_spec';
+ public const OBJECT_NAME = 'country_spec';
use ApiOperations\All;
use ApiOperations\Retrieve;
diff --git a/Stripe/Stripe/Coupon.php b/Stripe/Stripe/Coupon.php
index ce9b611..b198bd5 100755
--- a/Stripe/Stripe/Coupon.php
+++ b/Stripe/Stripe/Coupon.php
@@ -1,4 +1,4 @@
-charges or payment intents.
*
- * @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 null|int $amount_off Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.
- * @property \Stripe\StripeObject $applies_to
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property null|string $currency If amount_off has been set, the three-letter ISO code for the currency of the amount to take off.
- * @property \Stripe\StripeObject $currency_options Coupons defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
- * @property string $duration One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.
- * @property null|int $duration_in_months If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|int $max_redemptions Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
- * @property null|\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 $name Name of the coupon displayed to customers on for instance invoices or receipts.
- * @property null|float $percent_off Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a %s100 invoice %s50 instead.
- * @property null|int $redeem_by Date after which the coupon can no longer be redeemed.
- * @property int $times_redeemed Number of times this coupon has been applied to a customer.
- * @property bool $valid Taking account of the above properties, whether this coupon can still be applied to a customer.
+ * @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 null|int $amount_off Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.
+ * @property \Stripe\StripeObject $applies_to
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|string $currency If amount_off has been set, the three-letter ISO code for the currency of the amount to take off.
+ * @property \Stripe\StripeObject $currency_options Coupons defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
+ * @property string $duration One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.
+ * @property null|int $duration_in_months If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|int $max_redemptions Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
+ * @property null|\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 $name Name of the coupon displayed to customers on for instance invoices or receipts.
+ * @property null|float $percent_off Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a %s100 invoice %s50 instead.
+ * @property null|int $redeem_by Date after which the coupon can no longer be redeemed.
+ * @property int $times_redeemed Number of times this coupon has been applied to a customer.
+ * @property bool $valid Taking account of the above properties, whether this coupon can still be applied to a customer.
*/
class Coupon extends ApiResource
{
- const OBJECT_NAME = 'coupon';
+ public const OBJECT_NAME = 'coupon';
use ApiOperations\All;
use ApiOperations\Create;
diff --git a/Stripe/Stripe/CreditNote.php b/Stripe/Stripe/CreditNote.php
index b950087..9a57329 100755
--- a/Stripe/Stripe/CreditNote.php
+++ b/Stripe/Stripe/CreditNote.php
@@ -1,4 +1,4 @@
-Credit Notes.
*
- * @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 int $amount The integer amount in %s representing the total amount of the credit note, including tax.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property string|\Stripe\Customer $customer ID of the customer.
+ * @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 int $amount The integer amount in %s representing the total amount of the credit note, including tax.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string|\Stripe\Customer $customer ID of the customer.
* @property null|string|\Stripe\CustomerBalanceTransaction $customer_balance_transaction Customer balance transaction related to this credit note.
- * @property int $discount_amount The integer amount in %s representing the total amount of discount that was credited.
- * @property \Stripe\StripeObject[] $discount_amounts The aggregate amounts calculated per discount for all line items.
- * @property string|\Stripe\Invoice $invoice ID of the invoice.
- * @property \Stripe\Collection<\Stripe\CreditNoteLineItem> $lines Line items that make up the credit note
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|string $memo Customer-facing text that appears on the credit note PDF.
- * @property null|\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 string $number A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
- * @property null|int $out_of_band_amount Amount that was credited outside of Stripe.
- * @property string $pdf The link to download the PDF of the credit note.
- * @property null|string $reason Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
- * @property null|string|\Stripe\Refund $refund Refund related to this credit note.
- * @property string $status Status of this credit note, one of issued or void. Learn more about voiding credit notes.
- * @property int $subtotal The integer amount in %s representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
- * @property null|int $subtotal_excluding_tax The integer amount in %s representing the amount of the credit note, excluding all tax and invoice level discounts.
- * @property \Stripe\StripeObject[] $tax_amounts The aggregate amounts calculated per tax rate for all line items.
- * @property int $total The integer amount in %s representing the total amount of the credit note, including tax and all discount.
- * @property null|int $total_excluding_tax The integer amount in %s representing the total amount of the credit note, excluding tax, but including discounts.
- * @property string $type Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.
- * @property null|int $voided_at The time that the credit note was voided.
+ * @property int $discount_amount The integer amount in %s representing the total amount of discount that was credited.
+ * @property \Stripe\StripeObject[] $discount_amounts The aggregate amounts calculated per discount for all line items.
+ * @property string|\Stripe\Invoice $invoice ID of the invoice.
+ * @property \Stripe\Collection<\Stripe\CreditNoteLineItem> $lines Line items that make up the credit note
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|string $memo Customer-facing text that appears on the credit note PDF.
+ * @property null|\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 string $number A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
+ * @property null|int $out_of_band_amount Amount that was credited outside of Stripe.
+ * @property string $pdf The link to download the PDF of the credit note.
+ * @property null|string $reason Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
+ * @property null|string|\Stripe\Refund $refund Refund related to this credit note.
+ * @property string $status Status of this credit note, one of issued or void. Learn more about voiding credit notes.
+ * @property int $subtotal The integer amount in %s representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
+ * @property null|int $subtotal_excluding_tax The integer amount in %s representing the amount of the credit note, excluding all tax and invoice level discounts.
+ * @property \Stripe\StripeObject[] $tax_amounts The aggregate amounts calculated per tax rate for all line items.
+ * @property int $total The integer amount in %s representing the total amount of the credit note, including tax and all discount.
+ * @property null|int $total_excluding_tax The integer amount in %s representing the total amount of the credit note, excluding tax, but including discounts.
+ * @property string $type Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.
+ * @property null|int $voided_at The time that the credit note was voided.
*/
class CreditNote extends ApiResource
{
- const OBJECT_NAME = 'credit_note';
+ public const OBJECT_NAME = 'credit_note';
use ApiOperations\All;
use ApiOperations\Create;
@@ -49,19 +49,24 @@ class CreditNote extends ApiResource
use ApiOperations\Retrieve;
use ApiOperations\Update;
- const REASON_DUPLICATE = 'duplicate';
- const REASON_FRAUDULENT = 'fraudulent';
- const REASON_ORDER_CHANGE = 'order_change';
- const REASON_PRODUCT_UNSATISFACTORY = 'product_unsatisfactory';
+ public const REASON_DUPLICATE = 'duplicate';
- const STATUS_ISSUED = 'issued';
- const STATUS_VOID = 'void';
+ public const REASON_FRAUDULENT = 'fraudulent';
- const TYPE_POST_PAYMENT = 'post_payment';
- const TYPE_PRE_PAYMENT = 'pre_payment';
+ public const REASON_ORDER_CHANGE = 'order_change';
+
+ public const REASON_PRODUCT_UNSATISFACTORY = 'product_unsatisfactory';
+
+ public const STATUS_ISSUED = 'issued';
+
+ public const STATUS_VOID = 'void';
+
+ public const TYPE_POST_PAYMENT = 'post_payment';
+
+ public const TYPE_PRE_PAYMENT = 'pre_payment';
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -70,16 +75,16 @@ class CreditNote extends ApiResource
*/
public static function preview($params = null, $opts = null)
{
- $url = static::classUrl() . '/preview';
+ $url = static::classUrl() . '/preview';
list($response, $opts) = static::_staticRequest('get', $url, $params, $opts);
- $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
+ $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -88,16 +93,16 @@ class CreditNote extends ApiResource
*/
public static function previewLines($params = null, $opts = null)
{
- $url = static::classUrl() . '/preview/lines';
+ $url = static::classUrl() . '/preview/lines';
list($response, $opts) = static::_staticRequest('get', $url, $params, $opts);
- $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
+ $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -106,18 +111,18 @@ class CreditNote extends ApiResource
*/
public function voidCreditNote($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/void';
+ $url = $this->instanceUrl() . '/void';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
return $this;
}
- const PATH_LINES = '/lines';
+ public const PATH_LINES = '/lines';
/**
- * @param string $id the ID of the credit note on which to retrieve the credit note line items
- * @param null|array $params
+ * @param string $id the ID of the credit note on which to retrieve the credit note line items
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/CreditNoteLineItem.php b/Stripe/Stripe/CreditNoteLineItem.php
index 6b2ca2e..7fa827d 100755
--- a/Stripe/Stripe/CreditNoteLineItem.php
+++ b/Stripe/Stripe/CreditNoteLineItem.php
@@ -1,28 +1,28 @@
-true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|int $quantity The number of units of product being credited.
- * @property \Stripe\StripeObject[] $tax_amounts The amount of tax calculated per tax rate for this line item
- * @property \Stripe\TaxRate[] $tax_rates The tax rates which apply to the line item.
- * @property string $type The type of the credit note line item, one of invoice_line_item or custom_line_item. When the type is invoice_line_item there is an additional invoice_line_item property on the resource the value of which is the id of the credited line item on the invoice.
- * @property null|int $unit_amount The cost of each unit of product being credited.
- * @property null|string $unit_amount_decimal Same as unit_amount, but contains a decimal value with at most 12 decimal places.
- * @property null|string $unit_amount_excluding_tax The amount in %s representing the unit amount being credited for this line item, excluding all tax and discounts.
+ * @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 int $amount The integer amount in %s representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.
+ * @property null|int $amount_excluding_tax The integer amount in %s representing the amount being credited for this line item, excluding all tax and discounts.
+ * @property null|string $description Description of the item being credited.
+ * @property int $discount_amount The integer amount in %s representing the discount being credited for this line item.
+ * @property \Stripe\StripeObject[] $discount_amounts The amount of discount calculated per discount for this line item
+ * @property string $invoice_line_item ID of the invoice line item being credited
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|int $quantity The number of units of product being credited.
+ * @property \Stripe\StripeObject[] $tax_amounts The amount of tax calculated per tax rate for this line item
+ * @property \Stripe\TaxRate[] $tax_rates The tax rates which apply to the line item.
+ * @property string $type The type of the credit note line item, one of invoice_line_item or custom_line_item. When the type is invoice_line_item there is an additional invoice_line_item property on the resource the value of which is the id of the credited line item on the invoice.
+ * @property null|int $unit_amount The cost of each unit of product being credited.
+ * @property null|string $unit_amount_decimal Same as unit_amount, but contains a decimal value with at most 12 decimal places.
+ * @property null|string $unit_amount_excluding_tax The amount in %s representing the unit amount being credited for this line item, excluding all tax and discounts.
*/
class CreditNoteLineItem extends ApiResource
{
- const OBJECT_NAME = 'credit_note_line_item';
+ public const OBJECT_NAME = 'credit_note_line_item';
}
diff --git a/Stripe/Stripe/Customer.php b/Stripe/Stripe/Customer.php
index 3c3413c..93922c3 100755
--- a/Stripe/Stripe/Customer.php
+++ b/Stripe/Stripe/Customer.php
@@ -1,4 +1,4 @@
-Save a card during
* payment.
*
- * @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 null|\Stripe\StripeObject $address The customer's address.
- * @property int $balance Current balance, if any, being stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized.
- * @property null|\Stripe\CashBalance $cash_balance The current funds being held by Stripe on behalf of the customer. These funds can be applied towards payment intents with source "cash_balance". The settings[reconciliation_mode] field describes whether these funds are applied to such payment intents manually or automatically.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property null|string $currency Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.
- * @property null|string|\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source $default_source ID of the default payment source for the customer.
If you are using payment methods created via the PaymentMethods API, see the invoice_settings.default_payment_method field instead.
- * @property null|bool $delinquentWhen the customer's latest invoice is billed by charging automatically, delinquent is true if the invoice's latest charge failed. When the customer's latest invoice is billed by sending an invoice, delinquent is true if the invoice isn't paid by its due date.
If an invoice is marked uncollectible by dunning, delinquent doesn't get reset to false.
true if the object exists in live mode or the value false if the object exists in test mode.
- * @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 $name The customer's full name or business name.
- * @property int $next_invoice_sequence The suffix of the customer's next invoice number, e.g., 0001.
- * @property null|string $phone The customer's phone number.
- * @property null|string[] $preferred_locales The customer's preferred locales (languages), ordered by preference.
- * @property null|\Stripe\StripeObject $shipping Mailing and shipping address for the customer. Appears on invoices emailed to this customer.
- * @property \Stripe\Collection<\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source> $sources The customer's payment sources, if any.
- * @property \Stripe\Collection<\Stripe\Subscription> $subscriptions The customer's current subscriptions, if any.
- * @property \Stripe\StripeObject $tax
- * @property null|string $tax_exempt Describes the customer's tax exemption status. One of none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the text "Reverse charge".
- * @property \Stripe\Collection<\Stripe\TaxId> $tax_ids The customer's tax IDs.
- * @property null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this customer belongs to.
+ * @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 null|\Stripe\StripeObject $address The customer's address.
+ * @property int $balance Current balance, if any, being stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized.
+ * @property null|\Stripe\CashBalance $cash_balance The current funds being held by Stripe on behalf of the customer. These funds can be applied towards payment intents with source "cash_balance". The settings[reconciliation_mode] field describes whether these funds are applied to such payment intents manually or automatically.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|string $currency Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.
+ * @property null|string|\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source $default_source ID of the default payment source for the customer.
If you are using payment methods created via the PaymentMethods API, see the invoice_settings.default_payment_method field instead.
+ * @property null|bool $delinquentWhen the customer's latest invoice is billed by charging automatically, delinquent is true if the invoice's latest charge failed. When the customer's latest invoice is billed by sending an invoice, delinquent is true if the invoice isn't paid by its due date.
If an invoice is marked uncollectible by dunning, delinquent doesn't get reset to false.
true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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 $name The customer's full name or business name.
+ * @property int $next_invoice_sequence The suffix of the customer's next invoice number, e.g., 0001.
+ * @property null|string $phone The customer's phone number.
+ * @property null|string[] $preferred_locales The customer's preferred locales (languages), ordered by preference.
+ * @property null|\Stripe\StripeObject $shipping Mailing and shipping address for the customer. Appears on invoices emailed to this customer.
+ * @property \Stripe\Collection<\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source> $sources The customer's payment sources, if any.
+ * @property \Stripe\Collection<\Stripe\Subscription> $subscriptions The customer's current subscriptions, if any.
+ * @property \Stripe\StripeObject $tax
+ * @property null|string $tax_exempt Describes the customer's tax exemption status. One of none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the text "Reverse charge".
+ * @property \Stripe\Collection<\Stripe\TaxId> $tax_ids The customer's tax IDs.
+ * @property null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this customer belongs to.
*/
class Customer extends ApiResource
{
- const OBJECT_NAME = 'customer';
+ public const OBJECT_NAME = 'customer';
use ApiOperations\All;
use ApiOperations\Create;
@@ -53,14 +53,16 @@ class Customer extends ApiResource
use ApiOperations\Search;
use ApiOperations\Update;
- const TAX_EXEMPT_EXEMPT = 'exempt';
- const TAX_EXEMPT_NONE = 'none';
- const TAX_EXEMPT_REVERSE = 'reverse';
+ public const TAX_EXEMPT_EXEMPT = 'exempt';
+
+ public const TAX_EXEMPT_NONE = 'none';
+
+ public const TAX_EXEMPT_REVERSE = 'reverse';
public static function getSavedNestedResources()
{
static $savedNestedResources = null;
- if (null === $savedNestedResources) {
+ if ($savedNestedResources === null) {
$savedNestedResources = new Util\Set([
'source',
]);
@@ -70,14 +72,14 @@ class Customer extends ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @return \Stripe\Customer the updated customer
*/
public function deleteDiscount($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/discount';
+ $url = $this->instanceUrl() . '/discount';
list($response, $opts) = $this->_request('delete', $url, $params, $opts);
$this->refreshFrom(['discount' => null], $opts, true);
@@ -85,8 +87,8 @@ class Customer extends ApiResource
}
/**
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -95,17 +97,17 @@ class Customer extends ApiResource
*/
public static function allPaymentMethods($id, $params = null, $opts = null)
{
- $url = static::resourceUrl($id) . '/payment_methods';
+ $url = static::resourceUrl($id) . '/payment_methods';
list($response, $opts) = static::_staticRequest('get', $url, $params, $opts);
- $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
+ $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
}
/**
- * @param string $payment_method
- * @param null|array $params
+ * @param string $payment_method
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -114,16 +116,16 @@ class Customer extends ApiResource
*/
public function retrievePaymentMethod($payment_method, $params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/payment_methods/' . $payment_method;
+ $url = $this->instanceUrl() . '/payment_methods/' . $payment_method;
list($response, $opts) = $this->_request('get', $url, $params, $opts);
- $obj = \Stripe\Util\Util::convertToStripeObject($response, $opts);
+ $obj = \Stripe\Util\Util::convertToStripeObject($response, $opts);
$obj->setLastResponse($response);
return $obj;
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -137,13 +139,13 @@ class Customer extends ApiResource
return self::_searchResource($url, $params, $opts);
}
- const PATH_CASH_BALANCE = '/cash_balance';
+ public const PATH_CASH_BALANCE = '/cash_balance';
/**
- * @param string $id the ID of the customer to which the cash balance belongs
- * @param null|array $params
+ * @param string $id the ID of the customer to which the cash balance belongs
+ * @param null|array $params
* @param null|array|string $opts
- * @param mixed $cashBalanceId
+ * @param mixed $cashBalanceId
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
@@ -155,10 +157,10 @@ class Customer extends ApiResource
}
/**
- * @param string $id the ID of the customer to which the cash balance belongs
- * @param null|array $params
+ * @param string $id the ID of the customer to which the cash balance belongs
+ * @param null|array $params
* @param null|array|string $opts
- * @param mixed $cashBalanceId
+ * @param mixed $cashBalanceId
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
@@ -168,11 +170,12 @@ class Customer extends ApiResource
{
return self::_updateNestedResource($id, static::PATH_CASH_BALANCE, $params, $opts);
}
- const PATH_BALANCE_TRANSACTIONS = '/balance_transactions';
+
+ public const PATH_BALANCE_TRANSACTIONS = '/balance_transactions';
/**
- * @param string $id the ID of the customer on which to retrieve the customer balance transactions
- * @param null|array $params
+ * @param string $id the ID of the customer on which to retrieve the customer balance transactions
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -185,8 +188,8 @@ class Customer extends ApiResource
}
/**
- * @param string $id the ID of the customer on which to create the customer balance transaction
- * @param null|array $params
+ * @param string $id the ID of the customer on which to create the customer balance transaction
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -199,9 +202,9 @@ class Customer extends ApiResource
}
/**
- * @param string $id the ID of the customer to which the customer balance transaction belongs
- * @param string $balanceTransactionId the ID of the customer balance transaction to retrieve
- * @param null|array $params
+ * @param string $id the ID of the customer to which the customer balance transaction belongs
+ * @param string $balanceTransactionId the ID of the customer balance transaction to retrieve
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -214,9 +217,9 @@ class Customer extends ApiResource
}
/**
- * @param string $id the ID of the customer to which the customer balance transaction belongs
- * @param string $balanceTransactionId the ID of the customer balance transaction to update
- * @param null|array $params
+ * @param string $id the ID of the customer to which the customer balance transaction belongs
+ * @param string $balanceTransactionId the ID of the customer balance transaction to update
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -227,11 +230,12 @@ class Customer extends ApiResource
{
return self::_updateNestedResource($id, static::PATH_BALANCE_TRANSACTIONS, $balanceTransactionId, $params, $opts);
}
- const PATH_CASH_BALANCE_TRANSACTIONS = '/cash_balance_transactions';
+
+ public const PATH_CASH_BALANCE_TRANSACTIONS = '/cash_balance_transactions';
/**
- * @param string $id the ID of the customer on which to retrieve the customer cash balance transactions
- * @param null|array $params
+ * @param string $id the ID of the customer on which to retrieve the customer cash balance transactions
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -244,9 +248,9 @@ class Customer extends ApiResource
}
/**
- * @param string $id the ID of the customer to which the customer cash balance transaction belongs
- * @param string $cashBalanceTransactionId the ID of the customer cash balance transaction to retrieve
- * @param null|array $params
+ * @param string $id the ID of the customer to which the customer cash balance transaction belongs
+ * @param string $cashBalanceTransactionId the ID of the customer cash balance transaction to retrieve
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -257,11 +261,12 @@ class Customer extends ApiResource
{
return self::_retrieveNestedResource($id, static::PATH_CASH_BALANCE_TRANSACTIONS, $cashBalanceTransactionId, $params, $opts);
}
- const PATH_SOURCES = '/sources';
+
+ public const PATH_SOURCES = '/sources';
/**
- * @param string $id the ID of the customer on which to retrieve the payment sources
- * @param null|array $params
+ * @param string $id the ID of the customer on which to retrieve the payment sources
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -274,8 +279,8 @@ class Customer extends ApiResource
}
/**
- * @param string $id the ID of the customer on which to create the payment source
- * @param null|array $params
+ * @param string $id the ID of the customer on which to create the payment source
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -288,9 +293,9 @@ class Customer extends ApiResource
}
/**
- * @param string $id the ID of the customer to which the payment source belongs
- * @param string $sourceId the ID of the payment source to delete
- * @param null|array $params
+ * @param string $id the ID of the customer to which the payment source belongs
+ * @param string $sourceId the ID of the payment source to delete
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -303,9 +308,9 @@ class Customer extends ApiResource
}
/**
- * @param string $id the ID of the customer to which the payment source belongs
- * @param string $sourceId the ID of the payment source to retrieve
- * @param null|array $params
+ * @param string $id the ID of the customer to which the payment source belongs
+ * @param string $sourceId the ID of the payment source to retrieve
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -318,9 +323,9 @@ class Customer extends ApiResource
}
/**
- * @param string $id the ID of the customer to which the payment source belongs
- * @param string $sourceId the ID of the payment source to update
- * @param null|array $params
+ * @param string $id the ID of the customer to which the payment source belongs
+ * @param string $sourceId the ID of the payment source to update
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -331,11 +336,12 @@ class Customer extends ApiResource
{
return self::_updateNestedResource($id, static::PATH_SOURCES, $sourceId, $params, $opts);
}
- const PATH_TAX_IDS = '/tax_ids';
+
+ public const PATH_TAX_IDS = '/tax_ids';
/**
- * @param string $id the ID of the customer on which to retrieve the tax ids
- * @param null|array $params
+ * @param string $id the ID of the customer on which to retrieve the tax ids
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -348,8 +354,8 @@ class Customer extends ApiResource
}
/**
- * @param string $id the ID of the customer on which to create the tax id
- * @param null|array $params
+ * @param string $id the ID of the customer on which to create the tax id
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -362,9 +368,9 @@ class Customer extends ApiResource
}
/**
- * @param string $id the ID of the customer to which the tax id belongs
- * @param string $taxIdId the ID of the tax id to delete
- * @param null|array $params
+ * @param string $id the ID of the customer to which the tax id belongs
+ * @param string $taxIdId the ID of the tax id to delete
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -377,9 +383,9 @@ class Customer extends ApiResource
}
/**
- * @param string $id the ID of the customer to which the tax id belongs
- * @param string $taxIdId the ID of the tax id to retrieve
- * @param null|array $params
+ * @param string $id the ID of the customer to which the tax id belongs
+ * @param string $taxIdId the ID of the tax id to retrieve
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/CustomerBalanceTransaction.php b/Stripe/Stripe/CustomerBalanceTransaction.php
index 02cc1f4..97eb13f 100755
--- a/Stripe/Stripe/CustomerBalanceTransaction.php
+++ b/Stripe/Stripe/CustomerBalanceTransaction.php
@@ -1,4 +1,4 @@
-Customer Balance to
* learn more.
*
- * @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 int $amount The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's balance.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property null|string|\Stripe\CreditNote $credit_note The ID of the credit note (if any) related to the transaction.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property string|\Stripe\Customer $customer The ID of the customer the transaction belongs to.
- * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
- * @property int $ending_balance The customer's balance after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice.
- * @property null|string|\Stripe\Invoice $invoice The ID of the invoice (if any) related to the transaction.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|\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 string $type Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_overpaid, invoice_too_large, invoice_too_small, unspent_receiver_credit, or unapplied_from_invoice. See the Customer Balance page to learn more about transaction types.
+ * @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 int $amount The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's balance.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|string|\Stripe\CreditNote $credit_note The ID of the credit note (if any) related to the transaction.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string|\Stripe\Customer $customer The ID of the customer the transaction belongs to.
+ * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
+ * @property int $ending_balance The customer's balance after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice.
+ * @property null|string|\Stripe\Invoice $invoice The ID of the invoice (if any) related to the transaction.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|\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 string $type Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_overpaid, invoice_too_large, invoice_too_small, unspent_receiver_credit, or unapplied_from_invoice. See the Customer Balance page to learn more about transaction types.
*/
class CustomerBalanceTransaction extends ApiResource
{
- const OBJECT_NAME = 'customer_balance_transaction';
+ public const OBJECT_NAME = 'customer_balance_transaction';
- const TYPE_ADJUSTMENT = 'adjustment';
- const TYPE_APPLIED_TO_INVOICE = 'applied_to_invoice';
- const TYPE_CREDIT_NOTE = 'credit_note';
- const TYPE_INITIAL = 'initial';
- const TYPE_INVOICE_OVERPAID = 'invoice_overpaid';
- const TYPE_INVOICE_TOO_LARGE = 'invoice_too_large';
- const TYPE_INVOICE_TOO_SMALL = 'invoice_too_small';
- const TYPE_UNSPENT_RECEIVER_CREDIT = 'unspent_receiver_credit';
+ public const TYPE_ADJUSTMENT = 'adjustment';
- const TYPE_ADJUSTEMENT = 'adjustment';
+ public const TYPE_APPLIED_TO_INVOICE = 'applied_to_invoice';
+
+ public const TYPE_CREDIT_NOTE = 'credit_note';
+
+ public const TYPE_INITIAL = 'initial';
+
+ public const TYPE_INVOICE_OVERPAID = 'invoice_overpaid';
+
+ public const TYPE_INVOICE_TOO_LARGE = 'invoice_too_large';
+
+ public const TYPE_INVOICE_TOO_SMALL = 'invoice_too_small';
+
+ public const TYPE_UNSPENT_RECEIVER_CREDIT = 'unspent_receiver_credit';
+
+ public const TYPE_ADJUSTEMENT = 'adjustment';
/**
* @return string the API URL for this balance transaction
*/
public function instanceUrl()
{
- $id = $this['id'];
+ $id = $this['id'];
$customer = $this['customer'];
if (!$id) {
throw new Exception\UnexpectedValueException(
@@ -59,23 +66,23 @@ class CustomerBalanceTransaction extends ApiResource
null
);
}
- $id = Util\Util::utf8($id);
+ $id = Util\Util::utf8($id);
$customer = Util\Util::utf8($customer);
- $base = Customer::classUrl();
+ $base = Customer::classUrl();
$customerExtn = \urlencode($customer);
- $extn = \urlencode($id);
+ $extn = \urlencode($id);
return "{$base}/{$customerExtn}/balance_transactions/{$extn}";
}
/**
- * @param array|string $_id
+ * @param array|string $_id
* @param null|array|string $_opts
*
* @throws \Stripe\Exception\BadMethodCallException
*/
- public static function retrieve($_id, $_opts = null)
+ public static function retrieve($_id, $_opts = null) : void
{
$msg = 'Customer Balance Transactions cannot be retrieved without a ' .
'customer ID. Retrieve a Customer Balance Transaction using ' .
@@ -86,13 +93,13 @@ class CustomerBalanceTransaction extends ApiResource
}
/**
- * @param string $_id
- * @param null|array $_params
+ * @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)
+ public static function update($_id, $_params = null, $_options = null) : void
{
$msg = 'Customer Balance Transactions cannot be updated without a ' .
'customer ID. Update a Customer Balance Transaction using ' .
diff --git a/Stripe/Stripe/CustomerCashBalanceTransaction.php b/Stripe/Stripe/CustomerCashBalanceTransaction.php
index 143875a..b21b77e 100755
--- a/Stripe/Stripe/CustomerCashBalanceTransaction.php
+++ b/Stripe/Stripe/CustomerCashBalanceTransaction.php
@@ -1,4 +1,4 @@
-ISO currency code, in lowercase. Must be a supported currency.
- * @property string|\Stripe\Customer $customer The customer whose available cash balance changed as a result of this transaction.
- * @property int $ending_balance The total available cash balance for the specified currency after this transaction was applied. Represented in the smallest currency unit.
- * @property \Stripe\StripeObject $funded
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property int $net_amount The amount by which the cash balance changed, represented in the smallest currency unit. A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.
- * @property \Stripe\StripeObject $refunded_from_payment
- * @property string $type The type of the cash balance transaction. One of applied_to_payment, unapplied_from_payment, refunded_from_payment, funded, return_initiated, or return_canceled. New types may be added in future. See Customer Balance to learn more about these types.
- * @property \Stripe\StripeObject $unapplied_from_payment
+ * @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 \Stripe\StripeObject $applied_to_payment
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string|\Stripe\Customer $customer The customer whose available cash balance changed as a result of this transaction.
+ * @property int $ending_balance The total available cash balance for the specified currency after this transaction was applied. Represented in the smallest currency unit.
+ * @property \Stripe\StripeObject $funded
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property int $net_amount The amount by which the cash balance changed, represented in the smallest currency unit. A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.
+ * @property \Stripe\StripeObject $refunded_from_payment
+ * @property string $type The type of the cash balance transaction. One of applied_to_payment, unapplied_from_payment, refunded_from_payment, funded, return_initiated, or return_canceled. New types may be added in future. See Customer Balance to learn more about these types.
+ * @property \Stripe\StripeObject $unapplied_from_payment
*/
class CustomerCashBalanceTransaction extends ApiResource
{
- const OBJECT_NAME = 'customer_cash_balance_transaction';
+ public const OBJECT_NAME = 'customer_cash_balance_transaction';
use ApiOperations\All;
use ApiOperations\Retrieve;
- const TYPE_APPLIED_TO_PAYMENT = 'applied_to_payment';
- const TYPE_FUNDED = 'funded';
- const TYPE_REFUNDED_FROM_PAYMENT = 'refunded_from_payment';
- const TYPE_RETURN_CANCELED = 'return_canceled';
- const TYPE_RETURN_INITIATED = 'return_initiated';
- const TYPE_UNAPPLIED_FROM_PAYMENT = 'unapplied_from_payment';
+ public const TYPE_APPLIED_TO_PAYMENT = 'applied_to_payment';
+
+ public const TYPE_FUNDED = 'funded';
+
+ public const TYPE_REFUNDED_FROM_PAYMENT = 'refunded_from_payment';
+
+ public const TYPE_RETURN_CANCELED = 'return_canceled';
+
+ public const TYPE_RETURN_INITIATED = 'return_initiated';
+
+ public const TYPE_UNAPPLIED_FROM_PAYMENT = 'unapplied_from_payment';
}
diff --git a/Stripe/Stripe/Discount.php b/Stripe/Stripe/Discount.php
index dbc5d4b..848a28d 100755
--- a/Stripe/Stripe/Discount.php
+++ b/Stripe/Stripe/Discount.php
@@ -1,23 +1,23 @@
-Disputes and
* Fraud.
*
- * @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 int $amount Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed).
- * @property \Stripe\BalanceTransaction[] $balance_transactions List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.
- * @property string|\Stripe\Charge $charge ID of the charge that was disputed.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property \Stripe\StripeObject $evidence
- * @property \Stripe\StripeObject $evidence_details
- * @property bool $is_charge_refundable If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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 $network_reason_code Network-dependent reason code for the dispute.
- * @property null|string|\Stripe\PaymentIntent $payment_intent ID of the PaymentIntent that was disputed.
- * @property string $reason Reason given by cardholder for dispute. Possible values are bank_cannot_process, check_returned, credit_not_processed, customer_initiated, debit_not_authorized, duplicate, fraudulent, general, incorrect_account_details, insufficient_funds, product_not_received, product_unacceptable, subscription_canceled, or unrecognized. Read more about dispute reasons.
- * @property string $status Current status of dispute. Possible values are warning_needs_response, warning_under_review, warning_closed, needs_response, under_review, charge_refunded, won, or lost.
+ * @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 int $amount Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed).
+ * @property \Stripe\BalanceTransaction[] $balance_transactions List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.
+ * @property string|\Stripe\Charge $charge ID of the charge that was disputed.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property \Stripe\StripeObject $evidence
+ * @property \Stripe\StripeObject $evidence_details
+ * @property bool $is_charge_refundable If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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 $network_reason_code Network-dependent reason code for the dispute.
+ * @property null|string|\Stripe\PaymentIntent $payment_intent ID of the PaymentIntent that was disputed.
+ * @property string $reason Reason given by cardholder for dispute. Possible values are bank_cannot_process, check_returned, credit_not_processed, customer_initiated, debit_not_authorized, duplicate, fraudulent, general, incorrect_account_details, insufficient_funds, product_not_received, product_unacceptable, subscription_canceled, or unrecognized. Read more about dispute reasons.
+ * @property string $status Current status of dispute. Possible values are warning_needs_response, warning_under_review, warning_closed, needs_response, under_review, charge_refunded, won, or lost.
*/
class Dispute extends ApiResource
{
- const OBJECT_NAME = 'dispute';
+ public const OBJECT_NAME = 'dispute';
use ApiOperations\All;
use ApiOperations\Retrieve;
use ApiOperations\Update;
- const REASON_BANK_CANNOT_PROCESS = 'bank_cannot_process';
- const REASON_CHECK_RETURNED = 'check_returned';
- const REASON_CREDIT_NOT_PROCESSED = 'credit_not_processed';
- const REASON_CUSTOMER_INITIATED = 'customer_initiated';
- const REASON_DEBIT_NOT_AUTHORIZED = 'debit_not_authorized';
- const REASON_DUPLICATE = 'duplicate';
- const REASON_FRAUDULENT = 'fraudulent';
- const REASON_GENERAL = 'general';
- const REASON_INCORRECT_ACCOUNT_DETAILS = 'incorrect_account_details';
- const REASON_INSUFFICIENT_FUNDS = 'insufficient_funds';
- const REASON_PRODUCT_NOT_RECEIVED = 'product_not_received';
- const REASON_PRODUCT_UNACCEPTABLE = 'product_unacceptable';
- const REASON_SUBSCRIPTION_CANCELED = 'subscription_canceled';
- const REASON_UNRECOGNIZED = 'unrecognized';
+ public const REASON_BANK_CANNOT_PROCESS = 'bank_cannot_process';
- const STATUS_CHARGE_REFUNDED = 'charge_refunded';
- const STATUS_LOST = 'lost';
- const STATUS_NEEDS_RESPONSE = 'needs_response';
- const STATUS_UNDER_REVIEW = 'under_review';
- const STATUS_WARNING_CLOSED = 'warning_closed';
- const STATUS_WARNING_NEEDS_RESPONSE = 'warning_needs_response';
- const STATUS_WARNING_UNDER_REVIEW = 'warning_under_review';
- const STATUS_WON = 'won';
+ public const REASON_CHECK_RETURNED = 'check_returned';
+
+ public const REASON_CREDIT_NOT_PROCESSED = 'credit_not_processed';
+
+ public const REASON_CUSTOMER_INITIATED = 'customer_initiated';
+
+ public const REASON_DEBIT_NOT_AUTHORIZED = 'debit_not_authorized';
+
+ public const REASON_DUPLICATE = 'duplicate';
+
+ public const REASON_FRAUDULENT = 'fraudulent';
+
+ public const REASON_GENERAL = 'general';
+
+ public const REASON_INCORRECT_ACCOUNT_DETAILS = 'incorrect_account_details';
+
+ public const REASON_INSUFFICIENT_FUNDS = 'insufficient_funds';
+
+ public const REASON_PRODUCT_NOT_RECEIVED = 'product_not_received';
+
+ public const REASON_PRODUCT_UNACCEPTABLE = 'product_unacceptable';
+
+ public const REASON_SUBSCRIPTION_CANCELED = 'subscription_canceled';
+
+ public const REASON_UNRECOGNIZED = 'unrecognized';
+
+ public const STATUS_CHARGE_REFUNDED = 'charge_refunded';
+
+ public const STATUS_LOST = 'lost';
+
+ public const STATUS_NEEDS_RESPONSE = 'needs_response';
+
+ public const STATUS_UNDER_REVIEW = 'under_review';
+
+ public const STATUS_WARNING_CLOSED = 'warning_closed';
+
+ public const STATUS_WARNING_NEEDS_RESPONSE = 'warning_needs_response';
+
+ public const STATUS_WARNING_UNDER_REVIEW = 'warning_under_review';
+
+ public const STATUS_WON = 'won';
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -73,7 +93,7 @@ class Dispute extends ApiResource
*/
public function close($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/close';
+ $url = $this->instanceUrl() . '/close';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
diff --git a/Stripe/Stripe/EphemeralKey.php b/Stripe/Stripe/EphemeralKey.php
index ee8ecde..cd68c14 100755
--- a/Stripe/Stripe/EphemeralKey.php
+++ b/Stripe/Stripe/EphemeralKey.php
@@ -1,20 +1,20 @@
-true if the object exists in live mode or the value false if the object exists in test mode.
- * @property string $secret The key's secret. You can use this value to make authorized requests to the Stripe API.
+ * @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 int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property int $expires Time at which the key will expire. Measured in seconds since the Unix epoch.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string $secret The key's secret. You can use this value to make authorized requests to the Stripe API.
*/
class EphemeralKey extends ApiResource
{
- const OBJECT_NAME = 'ephemeral_key';
+ public const OBJECT_NAME = 'ephemeral_key';
use ApiOperations\Create {
create as protected _create;
@@ -23,11 +23,11 @@ class EphemeralKey extends ApiResource
use ApiOperations\Delete;
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\InvalidArgumentException if stripe_version is missing
- * @throws \Stripe\Exception\ApiErrorException if the request fails
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\EphemeralKey the created key
*/
diff --git a/Stripe/Stripe/ErrorObject.php b/Stripe/Stripe/ErrorObject.php
index 3385aac..ba6f7eb 100755
--- a/Stripe/Stripe/ErrorObject.php
+++ b/Stripe/Stripe/ErrorObject.php
@@ -1,39 +1,39 @@
- null,
- 'code' => null,
- 'decline_code' => null,
- 'doc_url' => null,
- 'message' => null,
- 'param' => null,
+ 'charge' => null,
+ 'code' => null,
+ 'decline_code' => null,
+ 'doc_url' => null,
+ 'message' => null,
+ 'param' => null,
'payment_intent' => null,
'payment_method' => null,
- 'setup_intent' => null,
- 'source' => null,
- 'type' => null,
+ 'setup_intent' => null,
+ 'source' => null,
+ 'type' => null,
], $values);
parent::refreshFrom($values, $opts, $partial);
}
diff --git a/Stripe/Stripe/Event.php b/Stripe/Stripe/Event.php
index c934ec2..bbfbdb7 100755
--- a/Stripe/Stripe/Event.php
+++ b/Stripe/Stripe/Event.php
@@ -1,4 +1,4 @@
-data. Note: This property is populated only for events on or after October 31, 2014.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property \Stripe\StripeObject $data
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property int $pending_webhooks Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified.
- * @property null|\Stripe\StripeObject $request Information on the API request that instigated the event.
- * @property string $type Description of the event (e.g., invoice.created or charge.refunded).
+ * @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 connected account that originated the event.
+ * @property null|string $api_version The Stripe API version used to render data. Note: This property is populated only for events on or after October 31, 2014.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property \Stripe\StripeObject $data
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property int $pending_webhooks Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified.
+ * @property null|\Stripe\StripeObject $request Information on the API request that instigated the event.
+ * @property string $type Description of the event (e.g., invoice.created or charge.refunded).
*/
class Event extends ApiResource
{
- const OBJECT_NAME = 'event';
+ public const OBJECT_NAME = 'event';
use ApiOperations\All;
use ApiOperations\Retrieve;
- const ACCOUNT_APPLICATION_AUTHORIZED = 'account.application.authorized';
- const ACCOUNT_APPLICATION_DEAUTHORIZED = 'account.application.deauthorized';
- const ACCOUNT_EXTERNAL_ACCOUNT_CREATED = 'account.external_account.created';
- const ACCOUNT_EXTERNAL_ACCOUNT_DELETED = 'account.external_account.deleted';
- const ACCOUNT_EXTERNAL_ACCOUNT_UPDATED = 'account.external_account.updated';
- const ACCOUNT_UPDATED = 'account.updated';
- const APPLICATION_FEE_CREATED = 'application_fee.created';
- const APPLICATION_FEE_REFUND_UPDATED = 'application_fee.refund.updated';
- const APPLICATION_FEE_REFUNDED = 'application_fee.refunded';
- const BALANCE_AVAILABLE = 'balance.available';
- const BILLING_PORTAL_CONFIGURATION_CREATED = 'billing_portal.configuration.created';
- const BILLING_PORTAL_CONFIGURATION_UPDATED = 'billing_portal.configuration.updated';
- const BILLING_PORTAL_SESSION_CREATED = 'billing_portal.session.created';
- const CAPABILITY_UPDATED = 'capability.updated';
- const CASH_BALANCE_FUNDS_AVAILABLE = 'cash_balance.funds_available';
- const CHARGE_CAPTURED = 'charge.captured';
- const CHARGE_DISPUTE_CLOSED = 'charge.dispute.closed';
- const CHARGE_DISPUTE_CREATED = 'charge.dispute.created';
- const CHARGE_DISPUTE_FUNDS_REINSTATED = 'charge.dispute.funds_reinstated';
- const CHARGE_DISPUTE_FUNDS_WITHDRAWN = 'charge.dispute.funds_withdrawn';
- const CHARGE_DISPUTE_UPDATED = 'charge.dispute.updated';
- const CHARGE_EXPIRED = 'charge.expired';
- const CHARGE_FAILED = 'charge.failed';
- const CHARGE_PENDING = 'charge.pending';
- const CHARGE_REFUND_UPDATED = 'charge.refund.updated';
- const CHARGE_REFUNDED = 'charge.refunded';
- const CHARGE_SUCCEEDED = 'charge.succeeded';
- const CHARGE_UPDATED = 'charge.updated';
- const CHECKOUT_SESSION_ASYNC_PAYMENT_FAILED = 'checkout.session.async_payment_failed';
- const CHECKOUT_SESSION_ASYNC_PAYMENT_SUCCEEDED = 'checkout.session.async_payment_succeeded';
- const CHECKOUT_SESSION_COMPLETED = 'checkout.session.completed';
- const CHECKOUT_SESSION_EXPIRED = 'checkout.session.expired';
- const COUPON_CREATED = 'coupon.created';
- const COUPON_DELETED = 'coupon.deleted';
- const COUPON_UPDATED = 'coupon.updated';
- const CREDIT_NOTE_CREATED = 'credit_note.created';
- const CREDIT_NOTE_UPDATED = 'credit_note.updated';
- const CREDIT_NOTE_VOIDED = 'credit_note.voided';
- const CUSTOMER_CREATED = 'customer.created';
- const CUSTOMER_DELETED = 'customer.deleted';
- const CUSTOMER_DISCOUNT_CREATED = 'customer.discount.created';
- const CUSTOMER_DISCOUNT_DELETED = 'customer.discount.deleted';
- const CUSTOMER_DISCOUNT_UPDATED = 'customer.discount.updated';
- const CUSTOMER_SOURCE_CREATED = 'customer.source.created';
- const CUSTOMER_SOURCE_DELETED = 'customer.source.deleted';
- const CUSTOMER_SOURCE_EXPIRING = 'customer.source.expiring';
- const CUSTOMER_SOURCE_UPDATED = 'customer.source.updated';
- const CUSTOMER_SUBSCRIPTION_CREATED = 'customer.subscription.created';
- const CUSTOMER_SUBSCRIPTION_DELETED = 'customer.subscription.deleted';
- const CUSTOMER_SUBSCRIPTION_PENDING_UPDATE_APPLIED = 'customer.subscription.pending_update_applied';
- const CUSTOMER_SUBSCRIPTION_PENDING_UPDATE_EXPIRED = 'customer.subscription.pending_update_expired';
- const CUSTOMER_SUBSCRIPTION_TRIAL_WILL_END = 'customer.subscription.trial_will_end';
- const CUSTOMER_SUBSCRIPTION_UPDATED = 'customer.subscription.updated';
- const CUSTOMER_TAX_ID_CREATED = 'customer.tax_id.created';
- const CUSTOMER_TAX_ID_DELETED = 'customer.tax_id.deleted';
- const CUSTOMER_TAX_ID_UPDATED = 'customer.tax_id.updated';
- const CUSTOMER_UPDATED = 'customer.updated';
- const CUSTOMER_CASH_BALANCE_TRANSACTION_CREATED = 'customer_cash_balance_transaction.created';
- const FILE_CREATED = 'file.created';
- const FINANCIAL_CONNECTIONS_ACCOUNT_CREATED = 'financial_connections.account.created';
- const FINANCIAL_CONNECTIONS_ACCOUNT_DEACTIVATED = 'financial_connections.account.deactivated';
- const FINANCIAL_CONNECTIONS_ACCOUNT_DISCONNECTED = 'financial_connections.account.disconnected';
- const FINANCIAL_CONNECTIONS_ACCOUNT_REACTIVATED = 'financial_connections.account.reactivated';
- const FINANCIAL_CONNECTIONS_ACCOUNT_REFRESHED_BALANCE = 'financial_connections.account.refreshed_balance';
- const IDENTITY_VERIFICATION_SESSION_CANCELED = 'identity.verification_session.canceled';
- const IDENTITY_VERIFICATION_SESSION_CREATED = 'identity.verification_session.created';
- const IDENTITY_VERIFICATION_SESSION_PROCESSING = 'identity.verification_session.processing';
- const IDENTITY_VERIFICATION_SESSION_REDACTED = 'identity.verification_session.redacted';
- const IDENTITY_VERIFICATION_SESSION_REQUIRES_INPUT = 'identity.verification_session.requires_input';
- const IDENTITY_VERIFICATION_SESSION_VERIFIED = 'identity.verification_session.verified';
- const INVOICE_CREATED = 'invoice.created';
- const INVOICE_DELETED = 'invoice.deleted';
- const INVOICE_FINALIZATION_FAILED = 'invoice.finalization_failed';
- const INVOICE_FINALIZED = 'invoice.finalized';
- const INVOICE_MARKED_UNCOLLECTIBLE = 'invoice.marked_uncollectible';
- const INVOICE_PAID = 'invoice.paid';
- const INVOICE_PAYMENT_ACTION_REQUIRED = 'invoice.payment_action_required';
- const INVOICE_PAYMENT_FAILED = 'invoice.payment_failed';
- const INVOICE_PAYMENT_SUCCEEDED = 'invoice.payment_succeeded';
- const INVOICE_SENT = 'invoice.sent';
- const INVOICE_UPCOMING = 'invoice.upcoming';
- const INVOICE_UPDATED = 'invoice.updated';
- const INVOICE_VOIDED = 'invoice.voided';
- const INVOICEITEM_CREATED = 'invoiceitem.created';
- const INVOICEITEM_DELETED = 'invoiceitem.deleted';
- const INVOICEITEM_UPDATED = 'invoiceitem.updated';
- const ISSUING_AUTHORIZATION_CREATED = 'issuing_authorization.created';
- const ISSUING_AUTHORIZATION_REQUEST = 'issuing_authorization.request';
- const ISSUING_AUTHORIZATION_UPDATED = 'issuing_authorization.updated';
- const ISSUING_CARD_CREATED = 'issuing_card.created';
- const ISSUING_CARD_UPDATED = 'issuing_card.updated';
- const ISSUING_CARDHOLDER_CREATED = 'issuing_cardholder.created';
- const ISSUING_CARDHOLDER_UPDATED = 'issuing_cardholder.updated';
- const ISSUING_DISPUTE_CLOSED = 'issuing_dispute.closed';
- const ISSUING_DISPUTE_CREATED = 'issuing_dispute.created';
- const ISSUING_DISPUTE_FUNDS_REINSTATED = 'issuing_dispute.funds_reinstated';
- const ISSUING_DISPUTE_SUBMITTED = 'issuing_dispute.submitted';
- const ISSUING_DISPUTE_UPDATED = 'issuing_dispute.updated';
- const ISSUING_TRANSACTION_CREATED = 'issuing_transaction.created';
- const ISSUING_TRANSACTION_UPDATED = 'issuing_transaction.updated';
- const MANDATE_UPDATED = 'mandate.updated';
- const ORDER_CREATED = 'order.created';
- const PAYMENT_INTENT_AMOUNT_CAPTURABLE_UPDATED = 'payment_intent.amount_capturable_updated';
- const PAYMENT_INTENT_CANCELED = 'payment_intent.canceled';
- const PAYMENT_INTENT_CREATED = 'payment_intent.created';
- const PAYMENT_INTENT_PARTIALLY_FUNDED = 'payment_intent.partially_funded';
- const PAYMENT_INTENT_PAYMENT_FAILED = 'payment_intent.payment_failed';
- const PAYMENT_INTENT_PROCESSING = 'payment_intent.processing';
- const PAYMENT_INTENT_REQUIRES_ACTION = 'payment_intent.requires_action';
- const PAYMENT_INTENT_SUCCEEDED = 'payment_intent.succeeded';
- const PAYMENT_LINK_CREATED = 'payment_link.created';
- const PAYMENT_LINK_UPDATED = 'payment_link.updated';
- const PAYMENT_METHOD_ATTACHED = 'payment_method.attached';
- const PAYMENT_METHOD_AUTOMATICALLY_UPDATED = 'payment_method.automatically_updated';
- const PAYMENT_METHOD_DETACHED = 'payment_method.detached';
- const PAYMENT_METHOD_UPDATED = 'payment_method.updated';
- const PAYOUT_CANCELED = 'payout.canceled';
- const PAYOUT_CREATED = 'payout.created';
- const PAYOUT_FAILED = 'payout.failed';
- const PAYOUT_PAID = 'payout.paid';
- const PAYOUT_UPDATED = 'payout.updated';
- const PERSON_CREATED = 'person.created';
- const PERSON_DELETED = 'person.deleted';
- const PERSON_UPDATED = 'person.updated';
- const PLAN_CREATED = 'plan.created';
- const PLAN_DELETED = 'plan.deleted';
- const PLAN_UPDATED = 'plan.updated';
- const PRICE_CREATED = 'price.created';
- const PRICE_DELETED = 'price.deleted';
- const PRICE_UPDATED = 'price.updated';
- const PRODUCT_CREATED = 'product.created';
- const PRODUCT_DELETED = 'product.deleted';
- const PRODUCT_UPDATED = 'product.updated';
- const PROMOTION_CODE_CREATED = 'promotion_code.created';
- const PROMOTION_CODE_UPDATED = 'promotion_code.updated';
- const QUOTE_ACCEPTED = 'quote.accepted';
- const QUOTE_CANCELED = 'quote.canceled';
- const QUOTE_CREATED = 'quote.created';
- const QUOTE_FINALIZED = 'quote.finalized';
- const RADAR_EARLY_FRAUD_WARNING_CREATED = 'radar.early_fraud_warning.created';
- const RADAR_EARLY_FRAUD_WARNING_UPDATED = 'radar.early_fraud_warning.updated';
- const RECIPIENT_CREATED = 'recipient.created';
- const RECIPIENT_DELETED = 'recipient.deleted';
- const RECIPIENT_UPDATED = 'recipient.updated';
- const REPORTING_REPORT_RUN_FAILED = 'reporting.report_run.failed';
- const REPORTING_REPORT_RUN_SUCCEEDED = 'reporting.report_run.succeeded';
- const REPORTING_REPORT_TYPE_UPDATED = 'reporting.report_type.updated';
- const REVIEW_CLOSED = 'review.closed';
- const REVIEW_OPENED = 'review.opened';
- const SETUP_INTENT_CANCELED = 'setup_intent.canceled';
- const SETUP_INTENT_CREATED = 'setup_intent.created';
- const SETUP_INTENT_REQUIRES_ACTION = 'setup_intent.requires_action';
- const SETUP_INTENT_SETUP_FAILED = 'setup_intent.setup_failed';
- const SETUP_INTENT_SUCCEEDED = 'setup_intent.succeeded';
- const SIGMA_SCHEDULED_QUERY_RUN_CREATED = 'sigma.scheduled_query_run.created';
- const SKU_CREATED = 'sku.created';
- const SKU_DELETED = 'sku.deleted';
- const SKU_UPDATED = 'sku.updated';
- const SOURCE_CANCELED = 'source.canceled';
- const SOURCE_CHARGEABLE = 'source.chargeable';
- const SOURCE_FAILED = 'source.failed';
- const SOURCE_MANDATE_NOTIFICATION = 'source.mandate_notification';
- const SOURCE_REFUND_ATTRIBUTES_REQUIRED = 'source.refund_attributes_required';
- const SOURCE_TRANSACTION_CREATED = 'source.transaction.created';
- const SOURCE_TRANSACTION_UPDATED = 'source.transaction.updated';
- const SUBSCRIPTION_SCHEDULE_ABORTED = 'subscription_schedule.aborted';
- const SUBSCRIPTION_SCHEDULE_CANCELED = 'subscription_schedule.canceled';
- const SUBSCRIPTION_SCHEDULE_COMPLETED = 'subscription_schedule.completed';
- const SUBSCRIPTION_SCHEDULE_CREATED = 'subscription_schedule.created';
- const SUBSCRIPTION_SCHEDULE_EXPIRING = 'subscription_schedule.expiring';
- const SUBSCRIPTION_SCHEDULE_RELEASED = 'subscription_schedule.released';
- const SUBSCRIPTION_SCHEDULE_UPDATED = 'subscription_schedule.updated';
- const TAX_RATE_CREATED = 'tax_rate.created';
- const TAX_RATE_UPDATED = 'tax_rate.updated';
- const TERMINAL_READER_ACTION_FAILED = 'terminal.reader.action_failed';
- const TERMINAL_READER_ACTION_SUCCEEDED = 'terminal.reader.action_succeeded';
- const TEST_HELPERS_TEST_CLOCK_ADVANCING = 'test_helpers.test_clock.advancing';
- const TEST_HELPERS_TEST_CLOCK_CREATED = 'test_helpers.test_clock.created';
- const TEST_HELPERS_TEST_CLOCK_DELETED = 'test_helpers.test_clock.deleted';
- const TEST_HELPERS_TEST_CLOCK_INTERNAL_FAILURE = 'test_helpers.test_clock.internal_failure';
- const TEST_HELPERS_TEST_CLOCK_READY = 'test_helpers.test_clock.ready';
- const TOPUP_CANCELED = 'topup.canceled';
- const TOPUP_CREATED = 'topup.created';
- const TOPUP_FAILED = 'topup.failed';
- const TOPUP_REVERSED = 'topup.reversed';
- const TOPUP_SUCCEEDED = 'topup.succeeded';
- const TRANSFER_CREATED = 'transfer.created';
- const TRANSFER_REVERSED = 'transfer.reversed';
- const TRANSFER_UPDATED = 'transfer.updated';
- const TREASURY_CREDIT_REVERSAL_CREATED = 'treasury.credit_reversal.created';
- const TREASURY_CREDIT_REVERSAL_POSTED = 'treasury.credit_reversal.posted';
- const TREASURY_DEBIT_REVERSAL_COMPLETED = 'treasury.debit_reversal.completed';
- const TREASURY_DEBIT_REVERSAL_CREATED = 'treasury.debit_reversal.created';
- const TREASURY_DEBIT_REVERSAL_INITIAL_CREDIT_GRANTED = 'treasury.debit_reversal.initial_credit_granted';
- const TREASURY_FINANCIAL_ACCOUNT_CLOSED = 'treasury.financial_account.closed';
- const TREASURY_FINANCIAL_ACCOUNT_CREATED = 'treasury.financial_account.created';
- const TREASURY_FINANCIAL_ACCOUNT_FEATURES_STATUS_UPDATED = 'treasury.financial_account.features_status_updated';
- const TREASURY_INBOUND_TRANSFER_CANCELED = 'treasury.inbound_transfer.canceled';
- const TREASURY_INBOUND_TRANSFER_CREATED = 'treasury.inbound_transfer.created';
- const TREASURY_INBOUND_TRANSFER_FAILED = 'treasury.inbound_transfer.failed';
- const TREASURY_INBOUND_TRANSFER_SUCCEEDED = 'treasury.inbound_transfer.succeeded';
- const TREASURY_OUTBOUND_PAYMENT_CANCELED = 'treasury.outbound_payment.canceled';
- const TREASURY_OUTBOUND_PAYMENT_CREATED = 'treasury.outbound_payment.created';
- const TREASURY_OUTBOUND_PAYMENT_EXPECTED_ARRIVAL_DATE_UPDATED = 'treasury.outbound_payment.expected_arrival_date_updated';
- const TREASURY_OUTBOUND_PAYMENT_FAILED = 'treasury.outbound_payment.failed';
- const TREASURY_OUTBOUND_PAYMENT_POSTED = 'treasury.outbound_payment.posted';
- const TREASURY_OUTBOUND_PAYMENT_RETURNED = 'treasury.outbound_payment.returned';
- const TREASURY_OUTBOUND_TRANSFER_CANCELED = 'treasury.outbound_transfer.canceled';
- const TREASURY_OUTBOUND_TRANSFER_CREATED = 'treasury.outbound_transfer.created';
- const TREASURY_OUTBOUND_TRANSFER_EXPECTED_ARRIVAL_DATE_UPDATED = 'treasury.outbound_transfer.expected_arrival_date_updated';
- const TREASURY_OUTBOUND_TRANSFER_FAILED = 'treasury.outbound_transfer.failed';
- const TREASURY_OUTBOUND_TRANSFER_POSTED = 'treasury.outbound_transfer.posted';
- const TREASURY_OUTBOUND_TRANSFER_RETURNED = 'treasury.outbound_transfer.returned';
- const TREASURY_RECEIVED_CREDIT_CREATED = 'treasury.received_credit.created';
- const TREASURY_RECEIVED_CREDIT_FAILED = 'treasury.received_credit.failed';
- const TREASURY_RECEIVED_CREDIT_SUCCEEDED = 'treasury.received_credit.succeeded';
- const TREASURY_RECEIVED_DEBIT_CREATED = 'treasury.received_debit.created';
+ public const ACCOUNT_APPLICATION_AUTHORIZED = 'account.application.authorized';
+
+ public const ACCOUNT_APPLICATION_DEAUTHORIZED = 'account.application.deauthorized';
+
+ public const ACCOUNT_EXTERNAL_ACCOUNT_CREATED = 'account.external_account.created';
+
+ public const ACCOUNT_EXTERNAL_ACCOUNT_DELETED = 'account.external_account.deleted';
+
+ public const ACCOUNT_EXTERNAL_ACCOUNT_UPDATED = 'account.external_account.updated';
+
+ public const ACCOUNT_UPDATED = 'account.updated';
+
+ public const APPLICATION_FEE_CREATED = 'application_fee.created';
+
+ public const APPLICATION_FEE_REFUND_UPDATED = 'application_fee.refund.updated';
+
+ public const APPLICATION_FEE_REFUNDED = 'application_fee.refunded';
+
+ public const BALANCE_AVAILABLE = 'balance.available';
+
+ public const BILLING_PORTAL_CONFIGURATION_CREATED = 'billing_portal.configuration.created';
+
+ public const BILLING_PORTAL_CONFIGURATION_UPDATED = 'billing_portal.configuration.updated';
+
+ public const BILLING_PORTAL_SESSION_CREATED = 'billing_portal.session.created';
+
+ public const CAPABILITY_UPDATED = 'capability.updated';
+
+ public const CASH_BALANCE_FUNDS_AVAILABLE = 'cash_balance.funds_available';
+
+ public const CHARGE_CAPTURED = 'charge.captured';
+
+ public const CHARGE_DISPUTE_CLOSED = 'charge.dispute.closed';
+
+ public const CHARGE_DISPUTE_CREATED = 'charge.dispute.created';
+
+ public const CHARGE_DISPUTE_FUNDS_REINSTATED = 'charge.dispute.funds_reinstated';
+
+ public const CHARGE_DISPUTE_FUNDS_WITHDRAWN = 'charge.dispute.funds_withdrawn';
+
+ public const CHARGE_DISPUTE_UPDATED = 'charge.dispute.updated';
+
+ public const CHARGE_EXPIRED = 'charge.expired';
+
+ public const CHARGE_FAILED = 'charge.failed';
+
+ public const CHARGE_PENDING = 'charge.pending';
+
+ public const CHARGE_REFUND_UPDATED = 'charge.refund.updated';
+
+ public const CHARGE_REFUNDED = 'charge.refunded';
+
+ public const CHARGE_SUCCEEDED = 'charge.succeeded';
+
+ public const CHARGE_UPDATED = 'charge.updated';
+
+ public const CHECKOUT_SESSION_ASYNC_PAYMENT_FAILED = 'checkout.session.async_payment_failed';
+
+ public const CHECKOUT_SESSION_ASYNC_PAYMENT_SUCCEEDED = 'checkout.session.async_payment_succeeded';
+
+ public const CHECKOUT_SESSION_COMPLETED = 'checkout.session.completed';
+
+ public const CHECKOUT_SESSION_EXPIRED = 'checkout.session.expired';
+
+ public const COUPON_CREATED = 'coupon.created';
+
+ public const COUPON_DELETED = 'coupon.deleted';
+
+ public const COUPON_UPDATED = 'coupon.updated';
+
+ public const CREDIT_NOTE_CREATED = 'credit_note.created';
+
+ public const CREDIT_NOTE_UPDATED = 'credit_note.updated';
+
+ public const CREDIT_NOTE_VOIDED = 'credit_note.voided';
+
+ public const CUSTOMER_CREATED = 'customer.created';
+
+ public const CUSTOMER_DELETED = 'customer.deleted';
+
+ public const CUSTOMER_DISCOUNT_CREATED = 'customer.discount.created';
+
+ public const CUSTOMER_DISCOUNT_DELETED = 'customer.discount.deleted';
+
+ public const CUSTOMER_DISCOUNT_UPDATED = 'customer.discount.updated';
+
+ public const CUSTOMER_SOURCE_CREATED = 'customer.source.created';
+
+ public const CUSTOMER_SOURCE_DELETED = 'customer.source.deleted';
+
+ public const CUSTOMER_SOURCE_EXPIRING = 'customer.source.expiring';
+
+ public const CUSTOMER_SOURCE_UPDATED = 'customer.source.updated';
+
+ public const CUSTOMER_SUBSCRIPTION_CREATED = 'customer.subscription.created';
+
+ public const CUSTOMER_SUBSCRIPTION_DELETED = 'customer.subscription.deleted';
+
+ public const CUSTOMER_SUBSCRIPTION_PENDING_UPDATE_APPLIED = 'customer.subscription.pending_update_applied';
+
+ public const CUSTOMER_SUBSCRIPTION_PENDING_UPDATE_EXPIRED = 'customer.subscription.pending_update_expired';
+
+ public const CUSTOMER_SUBSCRIPTION_TRIAL_WILL_END = 'customer.subscription.trial_will_end';
+
+ public const CUSTOMER_SUBSCRIPTION_UPDATED = 'customer.subscription.updated';
+
+ public const CUSTOMER_TAX_ID_CREATED = 'customer.tax_id.created';
+
+ public const CUSTOMER_TAX_ID_DELETED = 'customer.tax_id.deleted';
+
+ public const CUSTOMER_TAX_ID_UPDATED = 'customer.tax_id.updated';
+
+ public const CUSTOMER_UPDATED = 'customer.updated';
+
+ public const CUSTOMER_CASH_BALANCE_TRANSACTION_CREATED = 'customer_cash_balance_transaction.created';
+
+ public const FILE_CREATED = 'file.created';
+
+ public const FINANCIAL_CONNECTIONS_ACCOUNT_CREATED = 'financial_connections.account.created';
+
+ public const FINANCIAL_CONNECTIONS_ACCOUNT_DEACTIVATED = 'financial_connections.account.deactivated';
+
+ public const FINANCIAL_CONNECTIONS_ACCOUNT_DISCONNECTED = 'financial_connections.account.disconnected';
+
+ public const FINANCIAL_CONNECTIONS_ACCOUNT_REACTIVATED = 'financial_connections.account.reactivated';
+
+ public const FINANCIAL_CONNECTIONS_ACCOUNT_REFRESHED_BALANCE = 'financial_connections.account.refreshed_balance';
+
+ public const IDENTITY_VERIFICATION_SESSION_CANCELED = 'identity.verification_session.canceled';
+
+ public const IDENTITY_VERIFICATION_SESSION_CREATED = 'identity.verification_session.created';
+
+ public const IDENTITY_VERIFICATION_SESSION_PROCESSING = 'identity.verification_session.processing';
+
+ public const IDENTITY_VERIFICATION_SESSION_REDACTED = 'identity.verification_session.redacted';
+
+ public const IDENTITY_VERIFICATION_SESSION_REQUIRES_INPUT = 'identity.verification_session.requires_input';
+
+ public const IDENTITY_VERIFICATION_SESSION_VERIFIED = 'identity.verification_session.verified';
+
+ public const INVOICE_CREATED = 'invoice.created';
+
+ public const INVOICE_DELETED = 'invoice.deleted';
+
+ public const INVOICE_FINALIZATION_FAILED = 'invoice.finalization_failed';
+
+ public const INVOICE_FINALIZED = 'invoice.finalized';
+
+ public const INVOICE_MARKED_UNCOLLECTIBLE = 'invoice.marked_uncollectible';
+
+ public const INVOICE_PAID = 'invoice.paid';
+
+ public const INVOICE_PAYMENT_ACTION_REQUIRED = 'invoice.payment_action_required';
+
+ public const INVOICE_PAYMENT_FAILED = 'invoice.payment_failed';
+
+ public const INVOICE_PAYMENT_SUCCEEDED = 'invoice.payment_succeeded';
+
+ public const INVOICE_SENT = 'invoice.sent';
+
+ public const INVOICE_UPCOMING = 'invoice.upcoming';
+
+ public const INVOICE_UPDATED = 'invoice.updated';
+
+ public const INVOICE_VOIDED = 'invoice.voided';
+
+ public const INVOICEITEM_CREATED = 'invoiceitem.created';
+
+ public const INVOICEITEM_DELETED = 'invoiceitem.deleted';
+
+ public const INVOICEITEM_UPDATED = 'invoiceitem.updated';
+
+ public const ISSUING_AUTHORIZATION_CREATED = 'issuing_authorization.created';
+
+ public const ISSUING_AUTHORIZATION_REQUEST = 'issuing_authorization.request';
+
+ public const ISSUING_AUTHORIZATION_UPDATED = 'issuing_authorization.updated';
+
+ public const ISSUING_CARD_CREATED = 'issuing_card.created';
+
+ public const ISSUING_CARD_UPDATED = 'issuing_card.updated';
+
+ public const ISSUING_CARDHOLDER_CREATED = 'issuing_cardholder.created';
+
+ public const ISSUING_CARDHOLDER_UPDATED = 'issuing_cardholder.updated';
+
+ public const ISSUING_DISPUTE_CLOSED = 'issuing_dispute.closed';
+
+ public const ISSUING_DISPUTE_CREATED = 'issuing_dispute.created';
+
+ public const ISSUING_DISPUTE_FUNDS_REINSTATED = 'issuing_dispute.funds_reinstated';
+
+ public const ISSUING_DISPUTE_SUBMITTED = 'issuing_dispute.submitted';
+
+ public const ISSUING_DISPUTE_UPDATED = 'issuing_dispute.updated';
+
+ public const ISSUING_TRANSACTION_CREATED = 'issuing_transaction.created';
+
+ public const ISSUING_TRANSACTION_UPDATED = 'issuing_transaction.updated';
+
+ public const MANDATE_UPDATED = 'mandate.updated';
+
+ public const ORDER_CREATED = 'order.created';
+
+ public const PAYMENT_INTENT_AMOUNT_CAPTURABLE_UPDATED = 'payment_intent.amount_capturable_updated';
+
+ public const PAYMENT_INTENT_CANCELED = 'payment_intent.canceled';
+
+ public const PAYMENT_INTENT_CREATED = 'payment_intent.created';
+
+ public const PAYMENT_INTENT_PARTIALLY_FUNDED = 'payment_intent.partially_funded';
+
+ public const PAYMENT_INTENT_PAYMENT_FAILED = 'payment_intent.payment_failed';
+
+ public const PAYMENT_INTENT_PROCESSING = 'payment_intent.processing';
+
+ public const PAYMENT_INTENT_REQUIRES_ACTION = 'payment_intent.requires_action';
+
+ public const PAYMENT_INTENT_SUCCEEDED = 'payment_intent.succeeded';
+
+ public const PAYMENT_LINK_CREATED = 'payment_link.created';
+
+ public const PAYMENT_LINK_UPDATED = 'payment_link.updated';
+
+ public const PAYMENT_METHOD_ATTACHED = 'payment_method.attached';
+
+ public const PAYMENT_METHOD_AUTOMATICALLY_UPDATED = 'payment_method.automatically_updated';
+
+ public const PAYMENT_METHOD_DETACHED = 'payment_method.detached';
+
+ public const PAYMENT_METHOD_UPDATED = 'payment_method.updated';
+
+ public const PAYOUT_CANCELED = 'payout.canceled';
+
+ public const PAYOUT_CREATED = 'payout.created';
+
+ public const PAYOUT_FAILED = 'payout.failed';
+
+ public const PAYOUT_PAID = 'payout.paid';
+
+ public const PAYOUT_UPDATED = 'payout.updated';
+
+ public const PERSON_CREATED = 'person.created';
+
+ public const PERSON_DELETED = 'person.deleted';
+
+ public const PERSON_UPDATED = 'person.updated';
+
+ public const PLAN_CREATED = 'plan.created';
+
+ public const PLAN_DELETED = 'plan.deleted';
+
+ public const PLAN_UPDATED = 'plan.updated';
+
+ public const PRICE_CREATED = 'price.created';
+
+ public const PRICE_DELETED = 'price.deleted';
+
+ public const PRICE_UPDATED = 'price.updated';
+
+ public const PRODUCT_CREATED = 'product.created';
+
+ public const PRODUCT_DELETED = 'product.deleted';
+
+ public const PRODUCT_UPDATED = 'product.updated';
+
+ public const PROMOTION_CODE_CREATED = 'promotion_code.created';
+
+ public const PROMOTION_CODE_UPDATED = 'promotion_code.updated';
+
+ public const QUOTE_ACCEPTED = 'quote.accepted';
+
+ public const QUOTE_CANCELED = 'quote.canceled';
+
+ public const QUOTE_CREATED = 'quote.created';
+
+ public const QUOTE_FINALIZED = 'quote.finalized';
+
+ public const RADAR_EARLY_FRAUD_WARNING_CREATED = 'radar.early_fraud_warning.created';
+
+ public const RADAR_EARLY_FRAUD_WARNING_UPDATED = 'radar.early_fraud_warning.updated';
+
+ public const RECIPIENT_CREATED = 'recipient.created';
+
+ public const RECIPIENT_DELETED = 'recipient.deleted';
+
+ public const RECIPIENT_UPDATED = 'recipient.updated';
+
+ public const REPORTING_REPORT_RUN_FAILED = 'reporting.report_run.failed';
+
+ public const REPORTING_REPORT_RUN_SUCCEEDED = 'reporting.report_run.succeeded';
+
+ public const REPORTING_REPORT_TYPE_UPDATED = 'reporting.report_type.updated';
+
+ public const REVIEW_CLOSED = 'review.closed';
+
+ public const REVIEW_OPENED = 'review.opened';
+
+ public const SETUP_INTENT_CANCELED = 'setup_intent.canceled';
+
+ public const SETUP_INTENT_CREATED = 'setup_intent.created';
+
+ public const SETUP_INTENT_REQUIRES_ACTION = 'setup_intent.requires_action';
+
+ public const SETUP_INTENT_SETUP_FAILED = 'setup_intent.setup_failed';
+
+ public const SETUP_INTENT_SUCCEEDED = 'setup_intent.succeeded';
+
+ public const SIGMA_SCHEDULED_QUERY_RUN_CREATED = 'sigma.scheduled_query_run.created';
+
+ public const SKU_CREATED = 'sku.created';
+
+ public const SKU_DELETED = 'sku.deleted';
+
+ public const SKU_UPDATED = 'sku.updated';
+
+ public const SOURCE_CANCELED = 'source.canceled';
+
+ public const SOURCE_CHARGEABLE = 'source.chargeable';
+
+ public const SOURCE_FAILED = 'source.failed';
+
+ public const SOURCE_MANDATE_NOTIFICATION = 'source.mandate_notification';
+
+ public const SOURCE_REFUND_ATTRIBUTES_REQUIRED = 'source.refund_attributes_required';
+
+ public const SOURCE_TRANSACTION_CREATED = 'source.transaction.created';
+
+ public const SOURCE_TRANSACTION_UPDATED = 'source.transaction.updated';
+
+ public const SUBSCRIPTION_SCHEDULE_ABORTED = 'subscription_schedule.aborted';
+
+ public const SUBSCRIPTION_SCHEDULE_CANCELED = 'subscription_schedule.canceled';
+
+ public const SUBSCRIPTION_SCHEDULE_COMPLETED = 'subscription_schedule.completed';
+
+ public const SUBSCRIPTION_SCHEDULE_CREATED = 'subscription_schedule.created';
+
+ public const SUBSCRIPTION_SCHEDULE_EXPIRING = 'subscription_schedule.expiring';
+
+ public const SUBSCRIPTION_SCHEDULE_RELEASED = 'subscription_schedule.released';
+
+ public const SUBSCRIPTION_SCHEDULE_UPDATED = 'subscription_schedule.updated';
+
+ public const TAX_RATE_CREATED = 'tax_rate.created';
+
+ public const TAX_RATE_UPDATED = 'tax_rate.updated';
+
+ public const TERMINAL_READER_ACTION_FAILED = 'terminal.reader.action_failed';
+
+ public const TERMINAL_READER_ACTION_SUCCEEDED = 'terminal.reader.action_succeeded';
+
+ public const TEST_HELPERS_TEST_CLOCK_ADVANCING = 'test_helpers.test_clock.advancing';
+
+ public const TEST_HELPERS_TEST_CLOCK_CREATED = 'test_helpers.test_clock.created';
+
+ public const TEST_HELPERS_TEST_CLOCK_DELETED = 'test_helpers.test_clock.deleted';
+
+ public const TEST_HELPERS_TEST_CLOCK_INTERNAL_FAILURE = 'test_helpers.test_clock.internal_failure';
+
+ public const TEST_HELPERS_TEST_CLOCK_READY = 'test_helpers.test_clock.ready';
+
+ public const TOPUP_CANCELED = 'topup.canceled';
+
+ public const TOPUP_CREATED = 'topup.created';
+
+ public const TOPUP_FAILED = 'topup.failed';
+
+ public const TOPUP_REVERSED = 'topup.reversed';
+
+ public const TOPUP_SUCCEEDED = 'topup.succeeded';
+
+ public const TRANSFER_CREATED = 'transfer.created';
+
+ public const TRANSFER_REVERSED = 'transfer.reversed';
+
+ public const TRANSFER_UPDATED = 'transfer.updated';
+
+ public const TREASURY_CREDIT_REVERSAL_CREATED = 'treasury.credit_reversal.created';
+
+ public const TREASURY_CREDIT_REVERSAL_POSTED = 'treasury.credit_reversal.posted';
+
+ public const TREASURY_DEBIT_REVERSAL_COMPLETED = 'treasury.debit_reversal.completed';
+
+ public const TREASURY_DEBIT_REVERSAL_CREATED = 'treasury.debit_reversal.created';
+
+ public const TREASURY_DEBIT_REVERSAL_INITIAL_CREDIT_GRANTED = 'treasury.debit_reversal.initial_credit_granted';
+
+ public const TREASURY_FINANCIAL_ACCOUNT_CLOSED = 'treasury.financial_account.closed';
+
+ public const TREASURY_FINANCIAL_ACCOUNT_CREATED = 'treasury.financial_account.created';
+
+ public const TREASURY_FINANCIAL_ACCOUNT_FEATURES_STATUS_UPDATED = 'treasury.financial_account.features_status_updated';
+
+ public const TREASURY_INBOUND_TRANSFER_CANCELED = 'treasury.inbound_transfer.canceled';
+
+ public const TREASURY_INBOUND_TRANSFER_CREATED = 'treasury.inbound_transfer.created';
+
+ public const TREASURY_INBOUND_TRANSFER_FAILED = 'treasury.inbound_transfer.failed';
+
+ public const TREASURY_INBOUND_TRANSFER_SUCCEEDED = 'treasury.inbound_transfer.succeeded';
+
+ public const TREASURY_OUTBOUND_PAYMENT_CANCELED = 'treasury.outbound_payment.canceled';
+
+ public const TREASURY_OUTBOUND_PAYMENT_CREATED = 'treasury.outbound_payment.created';
+
+ public const TREASURY_OUTBOUND_PAYMENT_EXPECTED_ARRIVAL_DATE_UPDATED = 'treasury.outbound_payment.expected_arrival_date_updated';
+
+ public const TREASURY_OUTBOUND_PAYMENT_FAILED = 'treasury.outbound_payment.failed';
+
+ public const TREASURY_OUTBOUND_PAYMENT_POSTED = 'treasury.outbound_payment.posted';
+
+ public const TREASURY_OUTBOUND_PAYMENT_RETURNED = 'treasury.outbound_payment.returned';
+
+ public const TREASURY_OUTBOUND_TRANSFER_CANCELED = 'treasury.outbound_transfer.canceled';
+
+ public const TREASURY_OUTBOUND_TRANSFER_CREATED = 'treasury.outbound_transfer.created';
+
+ public const TREASURY_OUTBOUND_TRANSFER_EXPECTED_ARRIVAL_DATE_UPDATED = 'treasury.outbound_transfer.expected_arrival_date_updated';
+
+ public const TREASURY_OUTBOUND_TRANSFER_FAILED = 'treasury.outbound_transfer.failed';
+
+ public const TREASURY_OUTBOUND_TRANSFER_POSTED = 'treasury.outbound_transfer.posted';
+
+ public const TREASURY_OUTBOUND_TRANSFER_RETURNED = 'treasury.outbound_transfer.returned';
+
+ public const TREASURY_RECEIVED_CREDIT_CREATED = 'treasury.received_credit.created';
+
+ public const TREASURY_RECEIVED_CREDIT_FAILED = 'treasury.received_credit.failed';
+
+ public const TREASURY_RECEIVED_CREDIT_SUCCEEDED = 'treasury.received_credit.succeeded';
+
+ public const TREASURY_RECEIVED_DEBIT_CREATED = 'treasury.received_debit.created';
}
diff --git a/Stripe/Stripe/Exception/ApiConnectionException.php b/Stripe/Stripe/Exception/ApiConnectionException.php
index 33f2ede..0b14886 100755
--- a/Stripe/Stripe/Exception/ApiConnectionException.php
+++ b/Stripe/Stripe/Exception/ApiConnectionException.php
@@ -1,4 +1,4 @@
-error = $error;
}
@@ -87,7 +93,7 @@ abstract class ApiErrorException extends \Exception implements ExceptionInterfac
*
* @param null|string $httpBody
*/
- public function setHttpBody($httpBody)
+ public function setHttpBody($httpBody) : void
{
$this->httpBody = $httpBody;
}
@@ -107,7 +113,7 @@ abstract class ApiErrorException extends \Exception implements ExceptionInterfac
*
* @param null|array|\Stripe\Util\CaseInsensitiveArray $httpHeaders
*/
- public function setHttpHeaders($httpHeaders)
+ public function setHttpHeaders($httpHeaders) : void
{
$this->httpHeaders = $httpHeaders;
}
@@ -127,7 +133,7 @@ abstract class ApiErrorException extends \Exception implements ExceptionInterfac
*
* @param null|int $httpStatus
*/
- public function setHttpStatus($httpStatus)
+ public function setHttpStatus($httpStatus) : void
{
$this->httpStatus = $httpStatus;
}
@@ -147,7 +153,7 @@ abstract class ApiErrorException extends \Exception implements ExceptionInterfac
*
* @param null|arraycsv, pdf, jpg, or png).
- * @property null|string $url The URL from which the file can be downloaded using your live secret API key.
+ * @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 int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|int $expires_at The time at which the file expires and is no longer available in epoch seconds.
+ * @property null|string $filename A filename for the file, suitable for saving to a filesystem.
+ * @property null|\Stripe\Collection<\Stripe\FileLink> $links A list of file links that point at this file.
+ * @property string $purpose The purpose of the uploaded file.
+ * @property int $size The size in bytes of the file object.
+ * @property null|string $title A user friendly title for the document.
+ * @property null|string $type The type of the file returned (e.g., csv, pdf, jpg, or png).
+ * @property null|string $url The URL from which the file can be downloaded using your live secret API key.
*/
class File extends ApiResource
{
- const OBJECT_NAME = 'file';
+ public const OBJECT_NAME = 'file';
use ApiOperations\All;
use ApiOperations\Retrieve;
- const PURPOSE_ACCOUNT_REQUIREMENT = 'account_requirement';
- const PURPOSE_ADDITIONAL_VERIFICATION = 'additional_verification';
- const PURPOSE_BUSINESS_ICON = 'business_icon';
- const PURPOSE_BUSINESS_LOGO = 'business_logo';
- const PURPOSE_CUSTOMER_SIGNATURE = 'customer_signature';
- const PURPOSE_DISPUTE_EVIDENCE = 'dispute_evidence';
- const PURPOSE_DOCUMENT_PROVIDER_IDENTITY_DOCUMENT = 'document_provider_identity_document';
- const PURPOSE_FINANCE_REPORT_RUN = 'finance_report_run';
- const PURPOSE_IDENTITY_DOCUMENT = 'identity_document';
- const PURPOSE_IDENTITY_DOCUMENT_DOWNLOADABLE = 'identity_document_downloadable';
- const PURPOSE_PCI_DOCUMENT = 'pci_document';
- const PURPOSE_SELFIE = 'selfie';
- const PURPOSE_SIGMA_SCHEDULED_QUERY = 'sigma_scheduled_query';
- const PURPOSE_TAX_DOCUMENT_USER_UPLOAD = 'tax_document_user_upload';
- const PURPOSE_TERMINAL_READER_SPLASHSCREEN = 'terminal_reader_splashscreen';
+ public const PURPOSE_ACCOUNT_REQUIREMENT = 'account_requirement';
+
+ public const PURPOSE_ADDITIONAL_VERIFICATION = 'additional_verification';
+
+ public const PURPOSE_BUSINESS_ICON = 'business_icon';
+
+ public const PURPOSE_BUSINESS_LOGO = 'business_logo';
+
+ public const PURPOSE_CUSTOMER_SIGNATURE = 'customer_signature';
+
+ public const PURPOSE_DISPUTE_EVIDENCE = 'dispute_evidence';
+
+ public const PURPOSE_DOCUMENT_PROVIDER_IDENTITY_DOCUMENT = 'document_provider_identity_document';
+
+ public const PURPOSE_FINANCE_REPORT_RUN = 'finance_report_run';
+
+ public const PURPOSE_IDENTITY_DOCUMENT = 'identity_document';
+
+ public const PURPOSE_IDENTITY_DOCUMENT_DOWNLOADABLE = 'identity_document_downloadable';
+
+ public const PURPOSE_PCI_DOCUMENT = 'pci_document';
+
+ public const PURPOSE_SELFIE = 'selfie';
+
+ public const PURPOSE_SIGMA_SCHEDULED_QUERY = 'sigma_scheduled_query';
+
+ public const PURPOSE_TAX_DOCUMENT_USER_UPLOAD = 'tax_document_user_upload';
+
+ public const PURPOSE_TERMINAL_READER_SPLASHSCREEN = 'terminal_reader_splashscreen';
// This resource can have two different object names. In latter API
// versions, only `file` is used, but since stripe-php may be used with
// any API version, we need to support deserializing the older
// `file_upload` object into the same class.
- const OBJECT_NAME_ALT = 'file_upload';
+ public const OBJECT_NAME_ALT = 'file_upload';
use ApiOperations\Create {
create as protected _create;
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -71,7 +85,7 @@ class File extends ApiResource
public static function create($params = null, $opts = null)
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
- if (null === $opts->apiBase) {
+ if ($opts->apiBase === null) {
$opts->apiBase = Stripe::$apiUploadBase;
}
// Manually flatten params, otherwise curl's multipart encoder will
diff --git a/Stripe/Stripe/FileLink.php b/Stripe/Stripe/FileLink.php
index ce3b10b..c8a961f 100755
--- a/Stripe/Stripe/FileLink.php
+++ b/Stripe/Stripe/FileLink.php
@@ -1,4 +1,4 @@
-FileLink. FileLinks contain a URL that
* can be used to retrieve the contents of the file without authentication.
*
- * @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 int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property bool $expired Whether this link is already expired.
- * @property null|int $expires_at Time at which the link expires.
- * @property string|\Stripe\File $file The file object this link points to.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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 $url The publicly accessible URL to download the file.
+ * @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 int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property bool $expired Whether this link is already expired.
+ * @property null|int $expires_at Time at which the link expires.
+ * @property string|\Stripe\File $file The file object this link points to.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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 $url The publicly accessible URL to download the file.
*/
class FileLink extends ApiResource
{
- const OBJECT_NAME = 'file_link';
+ public const OBJECT_NAME = 'file_link';
use ApiOperations\All;
use ApiOperations\Create;
diff --git a/Stripe/Stripe/FinancialConnections/Account.php b/Stripe/Stripe/FinancialConnections/Account.php
index 0fc4e26..e072a0f 100755
--- a/Stripe/Stripe/FinancialConnections/Account.php
+++ b/Stripe/Stripe/FinancialConnections/Account.php
@@ -1,4 +1,4 @@
-subcategory.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property null|string $display_name A human-readable name that has been assigned to this account, either by the account holder or by the institution.
- * @property string $institution_name The name of the institution that holds this account.
- * @property null|string $last4 The last 4 digits of the account number. If present, this will be 4 numeric characters.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|string|\Stripe\FinancialConnections\AccountOwnership $ownership The most recent information about the account's owners.
- * @property null|\Stripe\StripeObject $ownership_refresh The state of the most recent attempt to refresh the account owners.
- * @property null|string[] $permissions The list of permissions granted by this account.
- * @property string $status The status of the link to the account.
- * @property string $subcategory If category is cash, one of:
- checking - savings - other
If category is credit, one of:
- mortgage - line_of_credit - credit_card - other
If category is investment or other, this will be other.
subcategory.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|string $display_name A human-readable name that has been assigned to this account, either by the account holder or by the institution.
+ * @property string $institution_name The name of the institution that holds this account.
+ * @property null|string $last4 The last 4 digits of the account number. If present, this will be 4 numeric characters.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|string|\Stripe\FinancialConnections\AccountOwnership $ownership The most recent information about the account's owners.
+ * @property null|\Stripe\StripeObject $ownership_refresh The state of the most recent attempt to refresh the account owners.
+ * @property null|string[] $permissions The list of permissions granted by this account.
+ * @property string $status The status of the link to the account.
+ * @property string $subcategory If category is cash, one of:
- checking - savings - other
If category is credit, one of:
- mortgage - line_of_credit - credit_card - other
If category is investment or other, this will be other.
true if the object exists in live mode or the value false if the object exists in test mode.
- * @property string[] $permissions Permissions requested for accounts collected during this session.
- * @property string $return_url For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
+ * @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 null|\Stripe\StripeObject $account_holder The account holder for whom accounts are collected in this session.
+ * @property \Stripe\Collection<\Stripe\FinancialConnections\Account> $accounts The accounts that were collected as part of this Session.
+ * @property string $client_secret A value that will be passed to the client to launch the authentication flow.
+ * @property \Stripe\StripeObject $filters
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string[] $permissions Permissions requested for accounts collected during this session.
+ * @property string $return_url For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
*/
class Session extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'financial_connections.session';
+ public const OBJECT_NAME = 'financial_connections.session';
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
diff --git a/Stripe/Stripe/FundingInstructions.php b/Stripe/Stripe/FundingInstructions.php
index af79991..b842d88 100755
--- a/Stripe/Stripe/FundingInstructions.php
+++ b/Stripe/Stripe/FundingInstructions.php
@@ -1,4 +1,4 @@
-Customer
* Balance - Funding Instructions to learn more.
*
- * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
* @property \Stripe\StripeObject $bank_transfer
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property string $funding_type The funding_type of the returned instructions
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string $funding_type The funding_type of the returned instructions
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
*/
class FundingInstructions extends ApiResource
{
- const OBJECT_NAME = 'funding_instructions';
+ public const OBJECT_NAME = 'funding_instructions';
- const FUNDING_TYPE_BANK_TRANSFER = 'bank_transfer';
+ public const FUNDING_TYPE_BANK_TRANSFER = 'bank_transfer';
}
diff --git a/Stripe/Stripe/HttpClient/ClientInterface.php b/Stripe/Stripe/HttpClient/ClientInterface.php
index 3c7861e..c2002d9 100755
--- a/Stripe/Stripe/HttpClient/ClientInterface.php
+++ b/Stripe/Stripe/HttpClient/ClientInterface.php
@@ -1,22 +1,22 @@
-defaultOptions = $defaultOptions;
+ $this->defaultOptions = $defaultOptions;
$this->randomGenerator = $randomGenerator ?: new Util\RandomGenerator();
$this->initUserAgentInfo();
@@ -80,12 +80,12 @@ class CurlClient implements ClientInterface, StreamingClientInterface
$this->closeCurlHandle();
}
- public function initUserAgentInfo()
+ public function initUserAgentInfo() : void
{
- $curlVersion = \curl_version();
+ $curlVersion = \curl_version();
$this->userAgentInfo = [
'httplib' => 'curl ' . $curlVersion['version'],
- 'ssllib' => $curlVersion['ssl_version'],
+ 'ssllib' => $curlVersion['ssl_version'],
];
}
@@ -110,7 +110,7 @@ class CurlClient implements ClientInterface, StreamingClientInterface
/**
* @param bool $enable
*/
- public function setEnablePersistentConnections($enable)
+ public function setEnablePersistentConnections($enable) : void
{
$this->enablePersistentConnections = $enable;
}
@@ -126,7 +126,7 @@ class CurlClient implements ClientInterface, StreamingClientInterface
/**
* @param bool $enable
*/
- public function setEnableHttp2($enable)
+ public function setEnableHttp2($enable) : void
{
$this->enableHttp2 = $enable;
}
@@ -154,17 +154,19 @@ class CurlClient implements ClientInterface, StreamingClientInterface
*
* @param null|callable $requestStatusCallback
*/
- public function setRequestStatusCallback($requestStatusCallback)
+ public function setRequestStatusCallback($requestStatusCallback) : void
{
$this->requestStatusCallback = $requestStatusCallback;
}
// USER DEFINED TIMEOUTS
- const DEFAULT_TIMEOUT = 80;
- const DEFAULT_CONNECT_TIMEOUT = 30;
+ public const DEFAULT_TIMEOUT = 80;
+
+ public const DEFAULT_CONNECT_TIMEOUT = 30;
private $timeout = self::DEFAULT_TIMEOUT;
+
private $connectTimeout = self::DEFAULT_CONNECT_TIMEOUT;
public function setTimeout($seconds)
@@ -209,7 +211,7 @@ class CurlClient implements ClientInterface, StreamingClientInterface
$params = Util\Util::objectsToIds($params);
- if ('get' === $method) {
+ if ($method === 'get') {
if ($hasFile) {
throw new Exception\UnexpectedValueException(
'Issuing a GET request with a file parameter'
@@ -218,16 +220,16 @@ class CurlClient implements ClientInterface, StreamingClientInterface
$opts[\CURLOPT_HTTPGET] = 1;
if (\count($params) > 0) {
$encoded = Util\Util::encodeParameters($params);
- $absUrl = "{$absUrl}?{$encoded}";
+ $absUrl = "{$absUrl}?{$encoded}";
}
- } elseif ('post' === $method) {
- $opts[\CURLOPT_POST] = 1;
+ } elseif ($method === 'post') {
+ $opts[\CURLOPT_POST] = 1;
$opts[\CURLOPT_POSTFIELDS] = $hasFile ? $params : Util\Util::encodeParameters($params);
- } elseif ('delete' === $method) {
+ } elseif ($method === 'delete') {
$opts[\CURLOPT_CUSTOMREQUEST] = 'DELETE';
if (\count($params) > 0) {
$encoded = Util\Util::encodeParameters($params);
- $absUrl = "{$absUrl}?{$encoded}";
+ $absUrl = "{$absUrl}?{$encoded}";
}
} else {
throw new Exception\UnexpectedValueException("Unrecognized method {$method}");
@@ -235,7 +237,7 @@ class CurlClient implements ClientInterface, StreamingClientInterface
// It is only safe to retry network failures on POST requests if we
// add an Idempotency-Key header
- if (('post' === $method) && (Stripe::$maxNetworkRetries > 0)) {
+ if (($method === 'post') && (Stripe::$maxNetworkRetries > 0)) {
if (!$this->hasHeader($headers, 'Idempotency-Key')) {
$headers[] = 'Idempotency-Key: ' . $this->randomGenerator->uuid();
}
@@ -255,13 +257,13 @@ class CurlClient implements ClientInterface, StreamingClientInterface
// sending an empty `Expect:` header.
$headers[] = 'Expect: ';
- $absUrl = Util\Util::utf8($absUrl);
- $opts[\CURLOPT_URL] = $absUrl;
+ $absUrl = Util\Util::utf8($absUrl);
+ $opts[\CURLOPT_URL] = $absUrl;
$opts[\CURLOPT_RETURNTRANSFER] = true;
$opts[\CURLOPT_CONNECTTIMEOUT] = $this->connectTimeout;
- $opts[\CURLOPT_TIMEOUT] = $this->timeout;
- $opts[\CURLOPT_HTTPHEADER] = $headers;
- $opts[\CURLOPT_CAINFO] = Stripe::getCABundlePath();
+ $opts[\CURLOPT_TIMEOUT] = $this->timeout;
+ $opts[\CURLOPT_HTTPHEADER] = $headers;
+ $opts[\CURLOPT_CAINFO] = Stripe::getCABundlePath();
if (!Stripe::getVerifySslCerts()) {
$opts[\CURLOPT_SSL_VERIFYPEER] = false;
}
@@ -296,7 +298,7 @@ class CurlClient implements ClientInterface, StreamingClientInterface
{
list($opts, $absUrl) = $this->constructRequest($method, $absUrl, $headers, $params, $hasFile);
- $opts[\CURLOPT_RETURNTRANSFER] = false;
+ $opts[\CURLOPT_RETURNTRANSFER] = false;
list($rbody, $rcode, $rheaders) = $this->executeStreamingRequestWithRetries($opts, $absUrl, $readBodyChunk);
return [$rbody, $rcode, $rheaders];
@@ -315,21 +317,21 @@ class CurlClient implements ClientInterface, StreamingClientInterface
* headers it receives, return a "writeCallback" that describes what to do
* with the incoming HTTP response body.
*
- * @param array $opts
+ * @param array $opts
* @param callable $determineWriteCallback
*
* @return array
*/
private function useHeadersToDetermineWriteCallback($opts, $determineWriteCallback)
{
- $rheaders = new Util\CaseInsensitiveArray();
+ $rheaders = new Util\CaseInsensitiveArray();
$headerCallback = function ($curl, $header_line) use (&$rheaders) {
return self::parseLineIntoHeaderArray($header_line, $rheaders);
};
- $writeCallback = null;
+ $writeCallback = null;
$writeCallbackWrapper = function ($curl, $data) use (&$writeCallback, &$rheaders, &$determineWriteCallback) {
- if (null === $writeCallback) {
+ if ($writeCallback === null) {
$writeCallback = \call_user_func_array($determineWriteCallback, [$rheaders]);
}
@@ -341,10 +343,10 @@ class CurlClient implements ClientInterface, StreamingClientInterface
private static function parseLineIntoHeaderArray($line, &$headers)
{
- if (false === \strpos($line, ':')) {
+ if (\strpos($line, ':') === false) {
return \strlen($line);
}
- list($key, $value) = \explode(':', \trim($line), 2);
+ list($key, $value) = \explode(':', \trim($line), 2);
$headers[\trim($key)] = \trim($value);
return \strlen($line);
@@ -358,8 +360,8 @@ class CurlClient implements ClientInterface, StreamingClientInterface
* 2. Does not retry if a network error occurs while streaming the
* body of a successful response.
*
- * @param array $opts cURL options
- * @param string $absUrl
+ * @param array $opts cURL options
+ * @param string $absUrl
* @param callable $readBodyChunk
*
* @return array
@@ -384,7 +386,7 @@ class CurlClient implements ClientInterface, StreamingClientInterface
/** @var null|array */
$lastRHeaders = null;
- $errno = null;
+ $errno = null;
$message = null;
$determineWriteCallback = function ($rheaders) use (
@@ -397,7 +399,7 @@ class CurlClient implements ClientInterface, StreamingClientInterface
&$errno
) {
$lastRHeaders = $rheaders;
- $errno = \curl_errno($this->curlHandle);
+ $errno = \curl_errno($this->curlHandle);
$rcode = \curl_getinfo($this->curlHandle, \CURLINFO_HTTP_CODE);
@@ -436,16 +438,16 @@ class CurlClient implements ClientInterface, StreamingClientInterface
while (true) {
list($headerCallback, $writeCallback) = $this->useHeadersToDetermineWriteCallback($opts, $determineWriteCallback);
- $opts[\CURLOPT_HEADERFUNCTION] = $headerCallback;
- $opts[\CURLOPT_WRITEFUNCTION] = $writeCallback;
+ $opts[\CURLOPT_HEADERFUNCTION] = $headerCallback;
+ $opts[\CURLOPT_WRITEFUNCTION] = $writeCallback;
$shouldRetry = false;
- $rbody = null;
+ $rbody = null;
$this->resetCurlHandle();
\curl_setopt_array($this->curlHandle, $opts);
$result = \curl_exec($this->curlHandle);
- $errno = \curl_errno($this->curlHandle);
- if (0 !== $errno) {
+ $errno = \curl_errno($this->curlHandle);
+ if ($errno !== 0) {
$message = \curl_error($this->curlHandle);
}
if (!$this->getEnablePersistentConnections()) {
@@ -468,7 +470,7 @@ class CurlClient implements ClientInterface, StreamingClientInterface
}
}
- if (0 !== $errno) {
+ if ($errno !== 0) {
$this->handleCurlError($absUrl, $errno, $message, $numRetries);
}
@@ -476,7 +478,7 @@ class CurlClient implements ClientInterface, StreamingClientInterface
}
/**
- * @param array $opts cURL options
+ * @param array $opts cURL options
* @param string $absUrl
*/
public function executeRequestWithRetries($opts, $absUrl)
@@ -484,12 +486,12 @@ class CurlClient implements ClientInterface, StreamingClientInterface
$numRetries = 0;
while (true) {
- $rcode = 0;
- $errno = 0;
+ $rcode = 0;
+ $errno = 0;
$message = null;
// Create a callback to capture HTTP headers for the response
- $rheaders = new Util\CaseInsensitiveArray();
+ $rheaders = new Util\CaseInsensitiveArray();
$headerCallback = function ($curl, $header_line) use (&$rheaders) {
return CurlClient::parseLineIntoHeaderArray($header_line, $rheaders);
};
@@ -499,8 +501,8 @@ class CurlClient implements ClientInterface, StreamingClientInterface
\curl_setopt_array($this->curlHandle, $opts);
$rbody = \curl_exec($this->curlHandle);
- if (false === $rbody) {
- $errno = \curl_errno($this->curlHandle);
+ if ($rbody === false) {
+ $errno = \curl_errno($this->curlHandle);
$message = \curl_error($this->curlHandle);
} else {
$rcode = \curl_getinfo($this->curlHandle, \CURLINFO_HTTP_CODE);
@@ -527,7 +529,7 @@ class CurlClient implements ClientInterface, StreamingClientInterface
}
}
- if (false === $rbody) {
+ if ($rbody === false) {
$this->handleCurlError($absUrl, $errno, $message, $numRetries);
}
@@ -536,13 +538,13 @@ class CurlClient implements ClientInterface, StreamingClientInterface
/**
* @param string $url
- * @param int $errno
+ * @param int $errno
* @param string $message
- * @param int $numRetries
+ * @param int $numRetries
*
* @throws Exception\ApiConnectionException
*/
- private function handleCurlError($url, $errno, $message, $numRetries)
+ private function handleCurlError($url, $errno, $message, $numRetries) : void
{
switch ($errno) {
case \CURLE_COULDNT_CONNECT:
@@ -554,7 +556,6 @@ class CurlClient implements ClientInterface, StreamingClientInterface
. 'https://twitter.com/stripestatus, or';
break;
-
case \CURLE_SSL_CACERT:
case \CURLE_SSL_PEER_CERTIFICATE:
$msg = "Could not verify Stripe's SSL certificate. Please make sure "
@@ -563,7 +564,6 @@ class CurlClient implements ClientInterface, StreamingClientInterface
. 'If this problem persists,';
break;
-
default:
$msg = 'Unexpected error communicating with Stripe. '
. 'If this problem persists,';
@@ -584,10 +584,10 @@ class CurlClient implements ClientInterface, StreamingClientInterface
* socket errors that may represent an intermittent problem and some special
* HTTP statuses.
*
- * @param int $errno
- * @param int $rcode
+ * @param int $errno
+ * @param int $rcode
* @param array|\Stripe\Util\CaseInsensitiveArray $rheaders
- * @param int $numRetries
+ * @param int $numRetries
*
* @return bool
*/
@@ -598,30 +598,30 @@ class CurlClient implements ClientInterface, StreamingClientInterface
}
// Retry on timeout-related problems (either on open or read).
- if (\CURLE_OPERATION_TIMEOUTED === $errno) {
+ if ($errno === \CURLE_OPERATION_TIMEOUTED) {
return true;
}
// Destination refused the connection, the connection was reset, or a
// variety of other connection failures. This could occur from a single
// saturated server, so retry in case it's intermittent.
- if (\CURLE_COULDNT_CONNECT === $errno) {
+ if ($errno === \CURLE_COULDNT_CONNECT) {
return true;
}
// The API may ask us not to retry (eg; if doing so would be a no-op)
// or advise us to retry (eg; in cases of lock timeouts); we defer to that.
if (isset($rheaders['stripe-should-retry'])) {
- if ('false' === $rheaders['stripe-should-retry']) {
+ if ($rheaders['stripe-should-retry'] === 'false') {
return false;
}
- if ('true' === $rheaders['stripe-should-retry']) {
+ if ($rheaders['stripe-should-retry'] === 'true') {
return true;
}
}
// 409 Conflict
- if (409 === $rcode) {
+ if ($rcode === 409) {
return true;
}
@@ -640,7 +640,7 @@ class CurlClient implements ClientInterface, StreamingClientInterface
/**
* Provides the number of seconds to wait before retrying a request.
*
- * @param int $numRetries
+ * @param int $numRetries
* @param array|\Stripe\Util\CaseInsensitiveArray $rheaders
*
* @return int
@@ -674,7 +674,7 @@ class CurlClient implements ClientInterface, StreamingClientInterface
/**
* Initializes the curl handle. If already initialized, the handle is closed first.
*/
- private function initCurlHandle()
+ private function initCurlHandle() : void
{
$this->closeCurlHandle();
$this->curlHandle = \curl_init();
@@ -683,9 +683,9 @@ class CurlClient implements ClientInterface, StreamingClientInterface
/**
* Closes the curl handle if initialized. Do nothing if already closed.
*/
- private function closeCurlHandle()
+ private function closeCurlHandle() : void
{
- if (null !== $this->curlHandle) {
+ if ($this->curlHandle !== null) {
\curl_close($this->curlHandle);
$this->curlHandle = null;
}
@@ -695,9 +695,9 @@ class CurlClient implements ClientInterface, StreamingClientInterface
* Resets the curl handle. If the handle is not already initialized, or if persistent
* connections are disabled, the handle is reinitialized instead.
*/
- private function resetCurlHandle()
+ private function resetCurlHandle() : void
{
- if (null !== $this->curlHandle && $this->getEnablePersistentConnections()) {
+ if ($this->curlHandle !== null && $this->getEnablePersistentConnections()) {
\curl_reset($this->curlHandle);
} else {
$this->initCurlHandle();
@@ -722,14 +722,14 @@ class CurlClient implements ClientInterface, StreamingClientInterface
* Checks if a list of headers contains a specific header name.
*
* @param string[] $headers
- * @param string $name
+ * @param string $name
*
* @return bool
*/
private function hasHeader($headers, $name)
{
foreach ($headers as $header) {
- if (0 === \strncasecmp($header, "{$name}: ", \strlen($name) + 2)) {
+ if (\strncasecmp($header, "{$name}: ", \strlen($name) + 2) === 0) {
return true;
}
}
diff --git a/Stripe/Stripe/HttpClient/StreamingClientInterface.php b/Stripe/Stripe/HttpClient/StreamingClientInterface.php
index 482f9a1..6ba8ec0 100755
--- a/Stripe/Stripe/HttpClient/StreamingClientInterface.php
+++ b/Stripe/Stripe/HttpClient/StreamingClientInterface.php
@@ -1,23 +1,23 @@
-Accessing
* verification results.
*
- * @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 int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property \Stripe\StripeObject $document Result from a document check
- * @property \Stripe\StripeObject $id_number Result from an id_number check
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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 int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property \Stripe\StripeObject $document Result from a document check
+ * @property \Stripe\StripeObject $id_number Result from an id_number check
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
* @property \Stripe\StripeObject $options
- * @property \Stripe\StripeObject $selfie Result from a selfie check
- * @property string $type Type of report.
- * @property null|string $verification_session ID of the VerificationSession that created this report.
+ * @property \Stripe\StripeObject $selfie Result from a selfie check
+ * @property string $type Type of report.
+ * @property null|string $verification_session ID of the VerificationSession that created this report.
*/
class VerificationReport extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'identity.verification_report';
+ public const OBJECT_NAME = 'identity.verification_report';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
- const TYPE_DOCUMENT = 'document';
- const TYPE_ID_NUMBER = 'id_number';
+ public const TYPE_DOCUMENT = 'document';
+
+ public const TYPE_ID_NUMBER = 'id_number';
}
diff --git a/Stripe/Stripe/Identity/VerificationSession.php b/Stripe/Stripe/Identity/VerificationSession.php
index 180e509..bf694a9 100755
--- a/Stripe/Stripe/Identity/VerificationSession.php
+++ b/Stripe/Stripe/Identity/VerificationSession.php
@@ -1,4 +1,4 @@
-The Verification
* Sessions API
*
- * @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 null|string $client_secret The short-lived client secret used by Stripe.js to show a verification modal inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on passing the client secret to the frontend to learn more.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property null|\Stripe\StripeObject $last_error If present, this property tells you the last error encountered when processing the verification.
+ * @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 null|string $client_secret The short-lived client secret used by Stripe.js to show a verification modal inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on passing the client secret to the frontend to learn more.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|\Stripe\StripeObject $last_error If present, this property tells you the last error encountered when processing the verification.
* @property null|string|\Stripe\Identity\VerificationReport $last_verification_report ID of the most recent VerificationReport. Learn more about accessing detailed verification results.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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 \Stripe\StripeObject $options
- * @property null|\Stripe\StripeObject $redaction Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.
- * @property string $status Status of this VerificationSession. Learn more about the lifecycle of sessions.
- * @property string $type The type of verification check to be performed.
- * @property null|string $url The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on verifying identity documents to learn how to redirect users to Stripe.
- * @property null|\Stripe\StripeObject $verified_outputs The user’s verified data.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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 \Stripe\StripeObject $options
+ * @property null|\Stripe\StripeObject $redaction Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.
+ * @property string $status Status of this VerificationSession. Learn more about the lifecycle of sessions.
+ * @property string $type The type of verification check to be performed.
+ * @property null|string $url The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on verifying identity documents to learn how to redirect users to Stripe.
+ * @property null|\Stripe\StripeObject $verified_outputs The user’s verified data.
*/
class VerificationSession extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'identity.verification_session';
+ public const OBJECT_NAME = 'identity.verification_session';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
- const STATUS_CANCELED = 'canceled';
- const STATUS_PROCESSING = 'processing';
- const STATUS_REQUIRES_INPUT = 'requires_input';
- const STATUS_VERIFIED = 'verified';
+ public const STATUS_CANCELED = 'canceled';
- const TYPE_DOCUMENT = 'document';
- const TYPE_ID_NUMBER = 'id_number';
+ public const STATUS_PROCESSING = 'processing';
+
+ public const STATUS_REQUIRES_INPUT = 'requires_input';
+
+ public const STATUS_VERIFIED = 'verified';
+
+ public const TYPE_DOCUMENT = 'document';
+
+ public const TYPE_ID_NUMBER = 'id_number';
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -62,7 +66,7 @@ class VerificationSession extends \Stripe\ApiResource
*/
public function cancel($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/cancel';
+ $url = $this->instanceUrl() . '/cancel';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -70,7 +74,7 @@ class VerificationSession extends \Stripe\ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -79,7 +83,7 @@ class VerificationSession extends \Stripe\ApiResource
*/
public function redact($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/redact';
+ $url = $this->instanceUrl() . '/redact';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
diff --git a/Stripe/Stripe/Invoice.php b/Stripe/Stripe/Invoice.php
index 4907242..cf42df3 100755
--- a/Stripe/Stripe/Invoice.php
+++ b/Stripe/Stripe/Invoice.php
@@ -1,4 +1,4 @@
-Send
* Invoices to Customers.
*
- * @property string $id Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See Retrieve an upcoming invoice for more details.
- * @property string $object String representing the object's type. Objects of the same type share the same value.
- * @property null|string $account_country The country of the business associated with this invoice, most often the business creating the invoice.
- * @property null|string $account_name The public name of the business associated with this invoice, most often the business creating the invoice.
- * @property null|(string|\Stripe\TaxId)[] $account_tax_ids The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
- * @property int $amount_due Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.
- * @property int $amount_paid The amount, in %s, that was paid.
- * @property int $amount_remaining The difference between amount_due and amount_paid, in %s.
- * @property null|string|\Stripe\StripeObject $application ID of the Connect Application that created the invoice.
- * @property null|int $application_fee_amount The fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid.
- * @property int $attempt_count Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule.
- * @property bool $attempted Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.
- * @property bool $auto_advance Controls whether Stripe will perform automatic collection of the invoice. When false, the invoice's state will not automatically advance without an explicit action.
- * @property \Stripe\StripeObject $automatic_tax
- * @property null|string $billing_reason Indicates the reason why the invoice was created. subscription_cycle indicates an invoice created by a subscription advancing into a new period. subscription_create indicates an invoice created due to creating a subscription. subscription_update indicates an invoice created due to updating a subscription. subscription is set for all old invoices to indicate either a change to a subscription or a period advancement. manual is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The upcoming value is reserved for simulated invoices per the upcoming invoice endpoint. subscription_threshold indicates an invoice created due to a billing threshold being reached.
- * @property null|string|\Stripe\Charge $charge ID of the latest charge generated for this invoice, if any.
- * @property string $collection_method Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property null|\Stripe\StripeObject[] $custom_fields Custom fields displayed on the invoice.
- * @property null|string|\Stripe\Customer $customer The ID of the customer who will be billed.
- * @property null|\Stripe\StripeObject $customer_address The customer's address. Until the invoice is finalized, this field will equal customer.address. Once the invoice is finalized, this field will no longer be updated.
- * @property null|string $customer_email The customer's email. Until the invoice is finalized, this field will equal customer.email. Once the invoice is finalized, this field will no longer be updated.
- * @property null|string $customer_name The customer's name. Until the invoice is finalized, this field will equal customer.name. Once the invoice is finalized, this field will no longer be updated.
- * @property null|string $customer_phone The customer's phone number. Until the invoice is finalized, this field will equal customer.phone. Once the invoice is finalized, this field will no longer be updated.
- * @property null|\Stripe\StripeObject $customer_shipping The customer's shipping information. Until the invoice is finalized, this field will equal customer.shipping. Once the invoice is finalized, this field will no longer be updated.
- * @property null|string $customer_tax_exempt The customer's tax exempt status. Until the invoice is finalized, this field will equal customer.tax_exempt. Once the invoice is finalized, this field will no longer be updated.
- * @property null|\Stripe\StripeObject[] $customer_tax_ids The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as customer.tax_ids. Once the invoice is finalized, this field will no longer be updated.
- * @property null|string|\Stripe\PaymentMethod $default_payment_method ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
- * @property null|string|\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source $default_source ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
- * @property \Stripe\TaxRate[] $default_tax_rates The tax rates applied to this invoice, if any.
- * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
- * @property null|\Stripe\Discount $discount Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts.
- * @property null|(string|\Stripe\Discount)[] $discounts The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
- * @property null|int $due_date The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.
- * @property null|int $ending_balance Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
- * @property null|string $footer Footer displayed on the invoice.
- * @property null|\Stripe\StripeObject $from_invoice Details of the invoice that was cloned. See the revision documentation for more details.
- * @property null|string $hosted_invoice_url The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
- * @property null|string $invoice_pdf The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
- * @property null|\Stripe\StripeObject $last_finalization_error The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
- * @property null|string|\Stripe\Invoice $latest_revision The ID of the most recent non-draft revision of this invoice
- * @property \Stripe\Collection<\Stripe\InvoiceLineItem> $lines The individual line items that make up the invoice. lines is sorted as follows: invoice items in reverse chronological order, followed by the subscription, if any.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|\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|int $next_payment_attempt The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.
- * @property null|string $number A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
- * @property null|string|\Stripe\Account $on_behalf_of The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
- * @property bool $paid Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance.
- * @property bool $paid_out_of_band Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe.
- * @property null|string|\Stripe\PaymentIntent $payment_intent The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent.
- * @property \Stripe\StripeObject $payment_settings
- * @property int $period_end End of the usage period during which invoice items were added to this invoice.
- * @property int $period_start Start of the usage period during which invoice items were added to this invoice.
- * @property int $post_payment_credit_notes_amount Total amount of all post-payment credit notes issued for this invoice.
- * @property int $pre_payment_credit_notes_amount Total amount of all pre-payment credit notes issued for this invoice.
- * @property null|string|\Stripe\Quote $quote The quote this invoice was generated from.
- * @property null|string $receipt_number This is the transaction number that appears on email receipts sent for this invoice.
- * @property null|\Stripe\StripeObject $rendering_options Options for invoice PDF rendering.
- * @property int $starting_balance Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
- * @property null|string $statement_descriptor Extra information about an invoice for the customer's credit card statement.
- * @property null|string $status The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more
- * @property \Stripe\StripeObject $status_transitions
- * @property null|string|\Stripe\Subscription $subscription The subscription that this invoice was prepared for, if any.
- * @property int $subscription_proration_date Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
- * @property int $subtotal Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
- * @property null|int $subtotal_excluding_tax The integer amount in %s representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
- * @property null|int $tax The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.
- * @property null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this invoice belongs to.
- * @property \Stripe\StripeObject $threshold_reason
- * @property int $total Total after discounts and taxes.
- * @property null|\Stripe\StripeObject[] $total_discount_amounts The aggregate amounts calculated per discount across all line items.
- * @property null|int $total_excluding_tax The integer amount in %s representing the total amount of the invoice including all discounts but excluding all tax.
- * @property \Stripe\StripeObject[] $total_tax_amounts The aggregate amounts calculated per tax rate for all line items.
- * @property null|\Stripe\StripeObject $transfer_data The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice.
- * @property null|int $webhooks_delivered_at Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
+ * @property string $id Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See Retrieve an upcoming invoice for more details.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property null|string $account_country The country of the business associated with this invoice, most often the business creating the invoice.
+ * @property null|string $account_name The public name of the business associated with this invoice, most often the business creating the invoice.
+ * @property null|(string|\Stripe\TaxId)[] $account_tax_ids The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
+ * @property int $amount_due Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.
+ * @property int $amount_paid The amount, in %s, that was paid.
+ * @property int $amount_remaining The difference between amount_due and amount_paid, in %s.
+ * @property null|string|\Stripe\StripeObject $application ID of the Connect Application that created the invoice.
+ * @property null|int $application_fee_amount The fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid.
+ * @property int $attempt_count Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule.
+ * @property bool $attempted Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.
+ * @property bool $auto_advance Controls whether Stripe will perform automatic collection of the invoice. When false, the invoice's state will not automatically advance without an explicit action.
+ * @property \Stripe\StripeObject $automatic_tax
+ * @property null|string $billing_reason Indicates the reason why the invoice was created. subscription_cycle indicates an invoice created by a subscription advancing into a new period. subscription_create indicates an invoice created due to creating a subscription. subscription_update indicates an invoice created due to updating a subscription. subscription is set for all old invoices to indicate either a change to a subscription or a period advancement. manual is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The upcoming value is reserved for simulated invoices per the upcoming invoice endpoint. subscription_threshold indicates an invoice created due to a billing threshold being reached.
+ * @property null|string|\Stripe\Charge $charge ID of the latest charge generated for this invoice, if any.
+ * @property string $collection_method Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property null|\Stripe\StripeObject[] $custom_fields Custom fields displayed on the invoice.
+ * @property null|string|\Stripe\Customer $customer The ID of the customer who will be billed.
+ * @property null|\Stripe\StripeObject $customer_address The customer's address. Until the invoice is finalized, this field will equal customer.address. Once the invoice is finalized, this field will no longer be updated.
+ * @property null|string $customer_email The customer's email. Until the invoice is finalized, this field will equal customer.email. Once the invoice is finalized, this field will no longer be updated.
+ * @property null|string $customer_name The customer's name. Until the invoice is finalized, this field will equal customer.name. Once the invoice is finalized, this field will no longer be updated.
+ * @property null|string $customer_phone The customer's phone number. Until the invoice is finalized, this field will equal customer.phone. Once the invoice is finalized, this field will no longer be updated.
+ * @property null|\Stripe\StripeObject $customer_shipping The customer's shipping information. Until the invoice is finalized, this field will equal customer.shipping. Once the invoice is finalized, this field will no longer be updated.
+ * @property null|string $customer_tax_exempt The customer's tax exempt status. Until the invoice is finalized, this field will equal customer.tax_exempt. Once the invoice is finalized, this field will no longer be updated.
+ * @property null|\Stripe\StripeObject[] $customer_tax_ids The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as customer.tax_ids. Once the invoice is finalized, this field will no longer be updated.
+ * @property null|string|\Stripe\PaymentMethod $default_payment_method ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
+ * @property null|string|\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source $default_source ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
+ * @property \Stripe\TaxRate[] $default_tax_rates The tax rates applied to this invoice, if any.
+ * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
+ * @property null|\Stripe\Discount $discount Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts.
+ * @property null|(string|\Stripe\Discount)[] $discounts The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
+ * @property null|int $due_date The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.
+ * @property null|int $ending_balance Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
+ * @property null|string $footer Footer displayed on the invoice.
+ * @property null|\Stripe\StripeObject $from_invoice Details of the invoice that was cloned. See the revision documentation for more details.
+ * @property null|string $hosted_invoice_url The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
+ * @property null|string $invoice_pdf The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
+ * @property null|\Stripe\StripeObject $last_finalization_error The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
+ * @property null|string|\Stripe\Invoice $latest_revision The ID of the most recent non-draft revision of this invoice
+ * @property \Stripe\Collection<\Stripe\InvoiceLineItem> $lines The individual line items that make up the invoice. lines is sorted as follows: invoice items in reverse chronological order, followed by the subscription, if any.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|\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|int $next_payment_attempt The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.
+ * @property null|string $number A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
+ * @property null|string|\Stripe\Account $on_behalf_of The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
+ * @property bool $paid Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance.
+ * @property bool $paid_out_of_band Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe.
+ * @property null|string|\Stripe\PaymentIntent $payment_intent The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent.
+ * @property \Stripe\StripeObject $payment_settings
+ * @property int $period_end End of the usage period during which invoice items were added to this invoice.
+ * @property int $period_start Start of the usage period during which invoice items were added to this invoice.
+ * @property int $post_payment_credit_notes_amount Total amount of all post-payment credit notes issued for this invoice.
+ * @property int $pre_payment_credit_notes_amount Total amount of all pre-payment credit notes issued for this invoice.
+ * @property null|string|\Stripe\Quote $quote The quote this invoice was generated from.
+ * @property null|string $receipt_number This is the transaction number that appears on email receipts sent for this invoice.
+ * @property null|\Stripe\StripeObject $rendering_options Options for invoice PDF rendering.
+ * @property int $starting_balance Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
+ * @property null|string $statement_descriptor Extra information about an invoice for the customer's credit card statement.
+ * @property null|string $status The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more
+ * @property \Stripe\StripeObject $status_transitions
+ * @property null|string|\Stripe\Subscription $subscription The subscription that this invoice was prepared for, if any.
+ * @property int $subscription_proration_date Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
+ * @property int $subtotal Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
+ * @property null|int $subtotal_excluding_tax The integer amount in %s representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
+ * @property null|int $tax The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.
+ * @property null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this invoice belongs to.
+ * @property \Stripe\StripeObject $threshold_reason
+ * @property int $total Total after discounts and taxes.
+ * @property null|\Stripe\StripeObject[] $total_discount_amounts The aggregate amounts calculated per discount across all line items.
+ * @property null|int $total_excluding_tax The integer amount in %s representing the total amount of the invoice including all discounts but excluding all tax.
+ * @property \Stripe\StripeObject[] $total_tax_amounts The aggregate amounts calculated per tax rate for all line items.
+ * @property null|\Stripe\StripeObject $transfer_data The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice.
+ * @property null|int $webhooks_delivered_at Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
*/
class Invoice extends ApiResource
{
- const OBJECT_NAME = 'invoice';
+ public const OBJECT_NAME = 'invoice';
use ApiOperations\All;
use ApiOperations\Create;
@@ -130,31 +130,46 @@ class Invoice extends ApiResource
use ApiOperations\Search;
use ApiOperations\Update;
- const BILLING_CHARGE_AUTOMATICALLY = 'charge_automatically';
- const BILLING_SEND_INVOICE = 'send_invoice';
+ public const BILLING_CHARGE_AUTOMATICALLY = 'charge_automatically';
- const BILLING_REASON_AUTOMATIC_PENDING_INVOICE_ITEM_INVOICE = 'automatic_pending_invoice_item_invoice';
- const BILLING_REASON_MANUAL = 'manual';
- const BILLING_REASON_QUOTE_ACCEPT = 'quote_accept';
- const BILLING_REASON_SUBSCRIPTION = 'subscription';
- const BILLING_REASON_SUBSCRIPTION_CREATE = 'subscription_create';
- const BILLING_REASON_SUBSCRIPTION_CYCLE = 'subscription_cycle';
- const BILLING_REASON_SUBSCRIPTION_THRESHOLD = 'subscription_threshold';
- const BILLING_REASON_SUBSCRIPTION_UPDATE = 'subscription_update';
- const BILLING_REASON_UPCOMING = 'upcoming';
+ public const BILLING_SEND_INVOICE = 'send_invoice';
- const COLLECTION_METHOD_CHARGE_AUTOMATICALLY = 'charge_automatically';
- const COLLECTION_METHOD_SEND_INVOICE = 'send_invoice';
+ public const BILLING_REASON_AUTOMATIC_PENDING_INVOICE_ITEM_INVOICE = 'automatic_pending_invoice_item_invoice';
- const STATUS_DELETED = 'deleted';
- const STATUS_DRAFT = 'draft';
- const STATUS_OPEN = 'open';
- const STATUS_PAID = 'paid';
- const STATUS_UNCOLLECTIBLE = 'uncollectible';
- const STATUS_VOID = 'void';
+ public const BILLING_REASON_MANUAL = 'manual';
+
+ public const BILLING_REASON_QUOTE_ACCEPT = 'quote_accept';
+
+ public const BILLING_REASON_SUBSCRIPTION = 'subscription';
+
+ public const BILLING_REASON_SUBSCRIPTION_CREATE = 'subscription_create';
+
+ public const BILLING_REASON_SUBSCRIPTION_CYCLE = 'subscription_cycle';
+
+ public const BILLING_REASON_SUBSCRIPTION_THRESHOLD = 'subscription_threshold';
+
+ public const BILLING_REASON_SUBSCRIPTION_UPDATE = 'subscription_update';
+
+ public const BILLING_REASON_UPCOMING = 'upcoming';
+
+ public const COLLECTION_METHOD_CHARGE_AUTOMATICALLY = 'charge_automatically';
+
+ public const COLLECTION_METHOD_SEND_INVOICE = 'send_invoice';
+
+ public const STATUS_DELETED = 'deleted';
+
+ public const STATUS_DRAFT = 'draft';
+
+ public const STATUS_OPEN = 'open';
+
+ public const STATUS_PAID = 'paid';
+
+ public const STATUS_UNCOLLECTIBLE = 'uncollectible';
+
+ public const STATUS_VOID = 'void';
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -163,7 +178,7 @@ class Invoice extends ApiResource
*/
public function finalizeInvoice($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/finalize';
+ $url = $this->instanceUrl() . '/finalize';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -171,7 +186,7 @@ class Invoice extends ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -180,7 +195,7 @@ class Invoice extends ApiResource
*/
public function markUncollectible($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/mark_uncollectible';
+ $url = $this->instanceUrl() . '/mark_uncollectible';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -188,7 +203,7 @@ class Invoice extends ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -197,7 +212,7 @@ class Invoice extends ApiResource
*/
public function pay($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/pay';
+ $url = $this->instanceUrl() . '/pay';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -205,7 +220,7 @@ class Invoice extends ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -214,7 +229,7 @@ class Invoice extends ApiResource
*/
public function sendInvoice($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/send';
+ $url = $this->instanceUrl() . '/send';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -222,7 +237,7 @@ class Invoice extends ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -231,16 +246,16 @@ class Invoice extends ApiResource
*/
public static function upcoming($params = null, $opts = null)
{
- $url = static::classUrl() . '/upcoming';
+ $url = static::classUrl() . '/upcoming';
list($response, $opts) = static::_staticRequest('get', $url, $params, $opts);
- $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
+ $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -249,16 +264,16 @@ class Invoice extends ApiResource
*/
public static function upcomingLines($params = null, $opts = null)
{
- $url = static::classUrl() . '/upcoming/lines';
+ $url = static::classUrl() . '/upcoming/lines';
list($response, $opts) = static::_staticRequest('get', $url, $params, $opts);
- $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
+ $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -267,7 +282,7 @@ class Invoice extends ApiResource
*/
public function voidInvoice($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/void';
+ $url = $this->instanceUrl() . '/void';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -275,7 +290,7 @@ class Invoice extends ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -289,11 +304,11 @@ class Invoice extends ApiResource
return self::_searchResource($url, $params, $opts);
}
- const PATH_LINES = '/lines';
+ public const PATH_LINES = '/lines';
/**
- * @param string $id the ID of the invoice on which to retrieve the line items
- * @param null|array $params
+ * @param string $id the ID of the invoice on which to retrieve the line items
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/InvoiceItem.php b/Stripe/Stripe/InvoiceItem.php
index 76eae06..ac318b5 100755
--- a/Stripe/Stripe/InvoiceItem.php
+++ b/Stripe/Stripe/InvoiceItem.php
@@ -1,4 +1,4 @@
-Subscription
* Invoices.
*
- * @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 int $amount Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property string|\Stripe\Customer $customer The ID of the customer who will be billed when this invoice item is billed.
- * @property int $date Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
- * @property bool $discountable If true, discounts will apply to this invoice item. Always false for prorations.
- * @property null|(string|\Stripe\Discount)[] $discounts The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
- * @property null|string|\Stripe\Invoice $invoice The ID of the invoice this invoice item belongs to.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|\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 \Stripe\StripeObject $period
- * @property null|\Stripe\Plan $plan If the invoice item is a proration, the plan of the subscription that the proration was computed for.
- * @property null|\Stripe\Price $price The price of the invoice item.
- * @property bool $proration Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
- * @property int $quantity Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
- * @property null|string|\Stripe\Subscription $subscription The subscription that this invoice item has been created for, if any.
- * @property string $subscription_item The subscription item that this invoice item has been created for, if any.
- * @property null|\Stripe\TaxRate[] $tax_rates The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.
- * @property null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this invoice item belongs to.
- * @property null|int $unit_amount Unit amount (in the currency specified) of the invoice item.
- * @property null|string $unit_amount_decimal Same as unit_amount, but contains a decimal value with at most 12 decimal places.
+ * @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 int $amount Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string|\Stripe\Customer $customer The ID of the customer who will be billed when this invoice item is billed.
+ * @property int $date Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
+ * @property bool $discountable If true, discounts will apply to this invoice item. Always false for prorations.
+ * @property null|(string|\Stripe\Discount)[] $discounts The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
+ * @property null|string|\Stripe\Invoice $invoice The ID of the invoice this invoice item belongs to.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|\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 \Stripe\StripeObject $period
+ * @property null|\Stripe\Plan $plan If the invoice item is a proration, the plan of the subscription that the proration was computed for.
+ * @property null|\Stripe\Price $price The price of the invoice item.
+ * @property bool $proration Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
+ * @property int $quantity Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
+ * @property null|string|\Stripe\Subscription $subscription The subscription that this invoice item has been created for, if any.
+ * @property string $subscription_item The subscription item that this invoice item has been created for, if any.
+ * @property null|\Stripe\TaxRate[] $tax_rates The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.
+ * @property null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this invoice item belongs to.
+ * @property null|int $unit_amount Unit amount (in the currency specified) of the invoice item.
+ * @property null|string $unit_amount_decimal Same as unit_amount, but contains a decimal value with at most 12 decimal places.
*/
class InvoiceItem extends ApiResource
{
- const OBJECT_NAME = 'invoiceitem';
+ public const OBJECT_NAME = 'invoiceitem';
use ApiOperations\All;
use ApiOperations\Create;
diff --git a/Stripe/Stripe/InvoiceLineItem.php b/Stripe/Stripe/InvoiceLineItem.php
index e5c123b..9186877 100755
--- a/Stripe/Stripe/InvoiceLineItem.php
+++ b/Stripe/Stripe/InvoiceLineItem.php
@@ -1,36 +1,36 @@
-ISO currency code, in lowercase. Must be a supported currency.
- * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
- * @property null|\Stripe\StripeObject[] $discount_amounts The amount of discount calculated per discount for this line item.
- * @property bool $discountable If true, discounts will apply to this line item. Always false for prorations.
- * @property null|(string|\Stripe\Discount)[] $discounts The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
- * @property string $invoice_item The ID of the invoice item associated with this line item if any.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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. Note that for line items with type=subscription this will reflect the metadata of the subscription that caused the line item to be created.
- * @property \Stripe\StripeObject $period
- * @property null|\Stripe\Plan $plan The plan of the subscription, if the line item is a subscription or a proration.
- * @property null|\Stripe\Price $price The price of the line item.
- * @property bool $proration Whether this is a proration.
- * @property null|\Stripe\StripeObject $proration_details Additional details for proration line items
- * @property null|int $quantity The quantity of the subscription, if the line item is a subscription or a proration.
- * @property null|string $subscription The subscription that the invoice item pertains to, if any.
- * @property string $subscription_item The subscription item that generated this invoice item. Left empty if the line item is not an explicit result of a subscription.
- * @property \Stripe\StripeObject[] $tax_amounts The amount of tax calculated per tax rate for this line item
- * @property \Stripe\TaxRate[] $tax_rates The tax rates which apply to the line item.
- * @property string $type A string identifying the type of the source of this line item, either an invoiceitem or a subscription.
- * @property null|string $unit_amount_excluding_tax The amount in %s representing the unit amount for this line item, excluding all tax and discounts.
+ * @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 int $amount The amount, in %s.
+ * @property null|int $amount_excluding_tax The integer amount in %s representing the amount for this line item, excluding all tax and discounts.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
+ * @property null|\Stripe\StripeObject[] $discount_amounts The amount of discount calculated per discount for this line item.
+ * @property bool $discountable If true, discounts will apply to this line item. Always false for prorations.
+ * @property null|(string|\Stripe\Discount)[] $discounts The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
+ * @property string $invoice_item The ID of the invoice item associated with this line item if any.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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. Note that for line items with type=subscription this will reflect the metadata of the subscription that caused the line item to be created.
+ * @property \Stripe\StripeObject $period
+ * @property null|\Stripe\Plan $plan The plan of the subscription, if the line item is a subscription or a proration.
+ * @property null|\Stripe\Price $price The price of the line item.
+ * @property bool $proration Whether this is a proration.
+ * @property null|\Stripe\StripeObject $proration_details Additional details for proration line items
+ * @property null|int $quantity The quantity of the subscription, if the line item is a subscription or a proration.
+ * @property null|string $subscription The subscription that the invoice item pertains to, if any.
+ * @property string $subscription_item The subscription item that generated this invoice item. Left empty if the line item is not an explicit result of a subscription.
+ * @property \Stripe\StripeObject[] $tax_amounts The amount of tax calculated per tax rate for this line item
+ * @property \Stripe\TaxRate[] $tax_rates The tax rates which apply to the line item.
+ * @property string $type A string identifying the type of the source of this line item, either an invoiceitem or a subscription.
+ * @property null|string $unit_amount_excluding_tax The amount in %s representing the unit amount for this line item, excluding all tax and discounts.
*/
class InvoiceLineItem extends ApiResource
{
- const OBJECT_NAME = 'line_item';
+ public const OBJECT_NAME = 'line_item';
}
diff --git a/Stripe/Stripe/Issuing/Authorization.php b/Stripe/Stripe/Issuing/Authorization.php
index 1433edd..d7b9768 100755
--- a/Stripe/Stripe/Issuing/Authorization.php
+++ b/Stripe/Stripe/Issuing/Authorization.php
@@ -1,4 +1,4 @@
-Issued Card
* Authorizations.
*
- * @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 int $amount The total amount that was authorized or rejected. This amount is in the card's currency and in the smallest currency unit.
- * @property null|\Stripe\StripeObject $amount_details Detailed breakdown of amount components. These amounts are denominated in currency and in the smallest currency unit.
- * @property bool $approved Whether the authorization has been approved.
- * @property string $authorization_method How the card details were provided.
- * @property \Stripe\BalanceTransaction[] $balance_transactions List of balance transactions associated with this authorization.
- * @property \Stripe\Issuing\Card $card You can create physical or virtual cards that are issued to cardholders.
- * @property null|string|\Stripe\Issuing\Cardholder $cardholder The cardholder to whom this authorization belongs.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property int $merchant_amount The total amount that was authorized or rejected. This amount is in the merchant_currency and in the smallest currency unit.
- * @property string $merchant_currency The currency that was presented to the cardholder for the authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property \Stripe\StripeObject $merchant_data
- * @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|\Stripe\StripeObject $network_data Details about the authorization, such as identifiers, set by the card network.
- * @property null|\Stripe\StripeObject $pending_request The pending authorization request. This field will only be non-null during an issuing_authorization.request webhook.
- * @property \Stripe\StripeObject[] $request_history History of every time a pending_request authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined.
- * @property string $status The current status of the authorization in its lifecycle.
- * @property \Stripe\Issuing\Transaction[] $transactions List of transactions associated with this authorization.
- * @property null|\Stripe\StripeObject $treasury Treasury details related to this authorization if it was created on a FinancialAccount.
- * @property \Stripe\StripeObject $verification_data
- * @property null|string $wallet The digital wallet used for this transaction. One of apple_pay, google_pay, or samsung_pay. Will populate as null when no digital wallet was utilized.
+ * @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 int $amount The total amount that was authorized or rejected. This amount is in the card's currency and in the smallest currency unit.
+ * @property null|\Stripe\StripeObject $amount_details Detailed breakdown of amount components. These amounts are denominated in currency and in the smallest currency unit.
+ * @property bool $approved Whether the authorization has been approved.
+ * @property string $authorization_method How the card details were provided.
+ * @property \Stripe\BalanceTransaction[] $balance_transactions List of balance transactions associated with this authorization.
+ * @property \Stripe\Issuing\Card $card You can create physical or virtual cards that are issued to cardholders.
+ * @property null|string|\Stripe\Issuing\Cardholder $cardholder The cardholder to whom this authorization belongs.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property int $merchant_amount The total amount that was authorized or rejected. This amount is in the merchant_currency and in the smallest currency unit.
+ * @property string $merchant_currency The currency that was presented to the cardholder for the authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property \Stripe\StripeObject $merchant_data
+ * @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|\Stripe\StripeObject $network_data Details about the authorization, such as identifiers, set by the card network.
+ * @property null|\Stripe\StripeObject $pending_request The pending authorization request. This field will only be non-null during an issuing_authorization.request webhook.
+ * @property \Stripe\StripeObject[] $request_history History of every time a pending_request authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined.
+ * @property string $status The current status of the authorization in its lifecycle.
+ * @property \Stripe\Issuing\Transaction[] $transactions List of transactions associated with this authorization.
+ * @property null|\Stripe\StripeObject $treasury Treasury details related to this authorization if it was created on a FinancialAccount.
+ * @property \Stripe\StripeObject $verification_data
+ * @property null|string $wallet The digital wallet used for this transaction. One of apple_pay, google_pay, or samsung_pay. Will populate as null when no digital wallet was utilized.
*/
class Authorization extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'issuing.authorization';
+ public const OBJECT_NAME = 'issuing.authorization';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -57,7 +57,7 @@ class Authorization extends \Stripe\ApiResource
*/
public function approve($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/approve';
+ $url = $this->instanceUrl() . '/approve';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -65,7 +65,7 @@ class Authorization extends \Stripe\ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -74,7 +74,7 @@ class Authorization extends \Stripe\ApiResource
*/
public function decline($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/decline';
+ $url = $this->instanceUrl() . '/decline';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
diff --git a/Stripe/Stripe/Issuing/Card.php b/Stripe/Stripe/Issuing/Card.php
index 78f1e3f..1630e7a 100755
--- a/Stripe/Stripe/Issuing/Card.php
+++ b/Stripe/Stripe/Issuing/Card.php
@@ -1,4 +1,4 @@
-create physical or
* virtual cards that are issued to cardholders.
*
- * @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 $brand The brand of the card.
- * @property null|string $cancellation_reason The reason why the card was canceled.
- * @property \Stripe\Issuing\Cardholder $cardholder An Issuing Cardholder object represents an individual or business entity who is issued cards.
Related guide: How to create a Cardholder
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. - * @property string $currency Three-letter ISO currency code, in lowercase. Supported currencies areusd in the US, eur in the EU, and gbp in the UK.
- * @property string $cvc The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with the expand parameter. Additionally, it's only available via the "Retrieve a card" endpoint, not via "List all cards" or any other endpoint.
- * @property int $exp_month The expiration month of the card.
- * @property int $exp_year The expiration year of the card.
- * @property null|string $financial_account The financial account this card is attached to.
- * @property string $last4 The last 4 digits of the card number.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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 string $number The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with the expand parameter. Additionally, it's only available via the "Retrieve a card" endpoint, not via "List all cards" or any other endpoint.
- * @property null|string|\Stripe\Issuing\Card $replaced_by The latest card that replaces this card, if any.
- * @property null|string|\Stripe\Issuing\Card $replacement_for The card this card replaces, if any.
- * @property null|string $replacement_reason The reason why the previous card needed to be replaced.
- * @property null|\Stripe\StripeObject $shipping Where and how the card will be shipped.
- * @property \Stripe\StripeObject $spending_controls
- * @property string $status Whether authorizations can be approved on this card.
- * @property string $type The type of the card.
- * @property null|\Stripe\StripeObject $wallets Information relating to digital wallets (like Apple Pay and Google Pay).
+ * @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 $brand The brand of the card.
+ * @property null|string $cancellation_reason The reason why the card was canceled.
+ * @property \Stripe\Issuing\Cardholder $cardholder An Issuing Cardholder object represents an individual or business entity who is issued cards.
Related guide: How to create a Cardholder
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. + * @property string $currency Three-letter ISO currency code, in lowercase. Supported currencies areusd in the US, eur in the EU, and gbp in the UK.
+ * @property string $cvc The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with the expand parameter. Additionally, it's only available via the "Retrieve a card" endpoint, not via "List all cards" or any other endpoint.
+ * @property int $exp_month The expiration month of the card.
+ * @property int $exp_year The expiration year of the card.
+ * @property null|string $financial_account The financial account this card is attached to.
+ * @property string $last4 The last 4 digits of the card number.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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 string $number The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with the expand parameter. Additionally, it's only available via the "Retrieve a card" endpoint, not via "List all cards" or any other endpoint.
+ * @property null|string|\Stripe\Issuing\Card $replaced_by The latest card that replaces this card, if any.
+ * @property null|string|\Stripe\Issuing\Card $replacement_for The card this card replaces, if any.
+ * @property null|string $replacement_reason The reason why the previous card needed to be replaced.
+ * @property null|\Stripe\StripeObject $shipping Where and how the card will be shipped.
+ * @property \Stripe\StripeObject $spending_controls
+ * @property string $status Whether authorizations can be approved on this card.
+ * @property string $type The type of the card.
+ * @property null|\Stripe\StripeObject $wallets Information relating to digital wallets (like Apple Pay and Google Pay).
*/
class Card extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'issuing.card';
+ public const OBJECT_NAME = 'issuing.card';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
diff --git a/Stripe/Stripe/Issuing/CardDetails.php b/Stripe/Stripe/Issuing/CardDetails.php
index 98f4e0b..8c7becc 100755
--- a/Stripe/Stripe/Issuing/CardDetails.php
+++ b/Stripe/Stripe/Issuing/CardDetails.php
@@ -1,4 +1,4 @@
-How to create a
* Cardholder
*
- * @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 \Stripe\StripeObject $billing
- * @property null|\Stripe\StripeObject $company Additional information about a company cardholder.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property null|string $email The cardholder's email address.
- * @property null|\Stripe\StripeObject $individual Additional information about an individual cardholder.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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 string $name The cardholder's name. This will be printed on cards issued to them.
- * @property null|string $phone_number The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details.
- * @property \Stripe\StripeObject $requirements
+ * @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 \Stripe\StripeObject $billing
+ * @property null|\Stripe\StripeObject $company Additional information about a company cardholder.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|string $email The cardholder's email address.
+ * @property null|\Stripe\StripeObject $individual Additional information about an individual cardholder.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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 string $name The cardholder's name. This will be printed on cards issued to them.
+ * @property null|string $phone_number The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details.
+ * @property \Stripe\StripeObject $requirements
* @property null|\Stripe\StripeObject $spending_controls Rules that control spending across this cardholder's cards. Refer to our documentation for more details.
- * @property string $status Specifies whether to permit authorizations on this cardholder's cards.
- * @property string $type One of individual or company.
+ * @property string $status Specifies whether to permit authorizations on this cardholder's cards.
+ * @property string $type One of individual or company.
*/
class Cardholder extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'issuing.cardholder';
+ public const OBJECT_NAME = 'issuing.cardholder';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
diff --git a/Stripe/Stripe/Issuing/Dispute.php b/Stripe/Stripe/Issuing/Dispute.php
index 644831a..939c69e 100755
--- a/Stripe/Stripe/Issuing/Dispute.php
+++ b/Stripe/Stripe/Issuing/Dispute.php
@@ -1,4 +1,4 @@
-Disputing
* Transactions
*
- * @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 int $amount Disputed amount in the card's currency and in the smallest currency unit. Usually the amount of the transaction, but can differ (usually because of currency fluctuation).
- * @property null|\Stripe\BalanceTransaction[] $balance_transactions List of balance transactions associated with the dispute.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency The currency the transaction was made in.
- * @property \Stripe\StripeObject $evidence
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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 string $status Current status of the dispute.
- * @property string|\Stripe\Issuing\Transaction $transaction The transaction being disputed.
- * @property null|\Stripe\StripeObject $treasury Treasury details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts
+ * @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 int $amount Disputed amount in the card's currency and in the smallest currency unit. Usually the amount of the transaction, but can differ (usually because of currency fluctuation).
+ * @property null|\Stripe\BalanceTransaction[] $balance_transactions List of balance transactions associated with the dispute.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency The currency the transaction was made in.
+ * @property \Stripe\StripeObject $evidence
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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 string $status Current status of the dispute.
+ * @property string|\Stripe\Issuing\Transaction $transaction The transaction being disputed.
+ * @property null|\Stripe\StripeObject $treasury Treasury details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts
*/
class Dispute extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'issuing.dispute';
+ public const OBJECT_NAME = 'issuing.dispute';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
@@ -36,7 +36,7 @@ class Dispute extends \Stripe\ApiResource
use \Stripe\ApiOperations\Update;
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -45,7 +45,7 @@ class Dispute extends \Stripe\ApiResource
*/
public function submit($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/submit';
+ $url = $this->instanceUrl() . '/submit';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
diff --git a/Stripe/Stripe/Issuing/Transaction.php b/Stripe/Stripe/Issuing/Transaction.php
index 4586b2f..10dc1f9 100755
--- a/Stripe/Stripe/Issuing/Transaction.php
+++ b/Stripe/Stripe/Issuing/Transaction.php
@@ -1,4 +1,4 @@
-Issued Card
* Transactions.
*
- * @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 int $amount The transaction amount, which will be reflected in your balance. This amount is in your currency and in the smallest currency unit.
- * @property null|\Stripe\StripeObject $amount_details Detailed breakdown of amount components. These amounts are denominated in currency and in the smallest currency unit.
- * @property null|string|\Stripe\Issuing\Authorization $authorization The Authorization object that led to this transaction.
- * @property null|string|\Stripe\BalanceTransaction $balance_transaction ID of the balance transaction associated with this transaction.
- * @property string|\Stripe\Issuing\Card $card The card used to make this transaction.
- * @property null|string|\Stripe\Issuing\Cardholder $cardholder The cardholder to whom this transaction belongs.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property null|string|\Stripe\Issuing\Dispute $dispute If you've disputed the transaction, the ID of the dispute.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property int $merchant_amount The amount that the merchant will receive, denominated in merchant_currency and in the smallest currency unit. It will be different from amount if the merchant is taking payment in a different currency.
- * @property string $merchant_currency The currency with which the merchant is taking payment.
- * @property \Stripe\StripeObject $merchant_data
- * @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|\Stripe\StripeObject $purchase_details Additional purchase information that is optionally provided by the merchant.
- * @property null|\Stripe\StripeObject $treasury Treasury details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts
- * @property string $type The nature of the transaction.
- * @property null|string $wallet The digital wallet used for this transaction. One of apple_pay, google_pay, or samsung_pay.
+ * @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 int $amount The transaction amount, which will be reflected in your balance. This amount is in your currency and in the smallest currency unit.
+ * @property null|\Stripe\StripeObject $amount_details Detailed breakdown of amount components. These amounts are denominated in currency and in the smallest currency unit.
+ * @property null|string|\Stripe\Issuing\Authorization $authorization The Authorization object that led to this transaction.
+ * @property null|string|\Stripe\BalanceTransaction $balance_transaction ID of the balance transaction associated with this transaction.
+ * @property string|\Stripe\Issuing\Card $card The card used to make this transaction.
+ * @property null|string|\Stripe\Issuing\Cardholder $cardholder The cardholder to whom this transaction belongs.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property null|string|\Stripe\Issuing\Dispute $dispute If you've disputed the transaction, the ID of the dispute.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property int $merchant_amount The amount that the merchant will receive, denominated in merchant_currency and in the smallest currency unit. It will be different from amount if the merchant is taking payment in a different currency.
+ * @property string $merchant_currency The currency with which the merchant is taking payment.
+ * @property \Stripe\StripeObject $merchant_data
+ * @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|\Stripe\StripeObject $purchase_details Additional purchase information that is optionally provided by the merchant.
+ * @property null|\Stripe\StripeObject $treasury Treasury details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts
+ * @property string $type The nature of the transaction.
+ * @property null|string $wallet The digital wallet used for this transaction. One of apple_pay, google_pay, or samsung_pay.
*/
class Transaction extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'issuing.transaction';
+ public const OBJECT_NAME = 'issuing.transaction';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
diff --git a/Stripe/Stripe/LineItem.php b/Stripe/Stripe/LineItem.php
index 63c5ca2..4a86364 100755
--- a/Stripe/Stripe/LineItem.php
+++ b/Stripe/Stripe/LineItem.php
@@ -1,4 +1,4 @@
-ISO currency code, in lowercase. Must be a supported currency.
- * @property string $description An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.
- * @property \Stripe\StripeObject[] $discounts The discounts applied to the line item.
- * @property null|\Stripe\Price $price The price used to generate the line item.
- * @property null|int $quantity The quantity of products being purchased.
- * @property \Stripe\StripeObject[] $taxes The taxes applied to the line item.
+ * @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 int $amount_discount Total discount amount applied. If no discounts were applied, defaults to 0.
+ * @property int $amount_subtotal Total before any discounts or taxes are applied.
+ * @property int $amount_tax Total tax amount applied. If no tax was applied, defaults to 0.
+ * @property int $amount_total Total after discounts and taxes.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string $description An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.
+ * @property \Stripe\StripeObject[] $discounts The discounts applied to the line item.
+ * @property null|\Stripe\Price $price The price used to generate the line item.
+ * @property null|int $quantity The quantity of products being purchased.
+ * @property \Stripe\StripeObject[] $taxes The taxes applied to the line item.
*/
class LineItem extends ApiResource
{
- const OBJECT_NAME = 'item';
+ public const OBJECT_NAME = 'item';
}
diff --git a/Stripe/Stripe/LoginLink.php b/Stripe/Stripe/LoginLink.php
index 3351356..cda3513 100755
--- a/Stripe/Stripe/LoginLink.php
+++ b/Stripe/Stripe/LoginLink.php
@@ -1,15 +1,15 @@
-true if the object exists in live mode or the value false if the object exists in test mode.
- * @property \Stripe\StripeObject $multi_use
- * @property string|\Stripe\PaymentMethod $payment_method ID of the payment method associated with this mandate.
- * @property \Stripe\StripeObject $payment_method_details
- * @property \Stripe\StripeObject $single_use
- * @property string $status The status of the mandate, which indicates whether it can be used to initiate a payment.
- * @property string $type The type of the mandate.
+ * @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 \Stripe\StripeObject $customer_acceptance
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property \Stripe\StripeObject $multi_use
+ * @property string|\Stripe\PaymentMethod $payment_method ID of the payment method associated with this mandate.
+ * @property \Stripe\StripeObject $payment_method_details
+ * @property \Stripe\StripeObject $single_use
+ * @property string $status The status of the mandate, which indicates whether it can be used to initiate a payment.
+ * @property string $type The type of the mandate.
*/
class Mandate extends ApiResource
{
- const OBJECT_NAME = 'mandate';
+ public const OBJECT_NAME = 'mandate';
use ApiOperations\Retrieve;
}
diff --git a/Stripe/Stripe/OAuth.php b/Stripe/Stripe/OAuth.php
index 7b0886e..96b220a 100755
--- a/Stripe/Stripe/OAuth.php
+++ b/Stripe/Stripe/OAuth.php
@@ -1,4 +1,4 @@
-request(
'post',
'/oauth/token',
@@ -64,10 +64,10 @@ abstract class OAuth
*/
public static function deauthorize($params = null, $opts = null)
{
- $params = $params ?: [];
- $base = ($opts && \array_key_exists('connect_base', $opts)) ? $opts['connect_base'] : Stripe::$connectBase;
- $requestor = new ApiRequestor(null, $base);
- $params['client_id'] = self::_getClientId($params);
+ $params = $params ?: [];
+ $base = ($opts && \array_key_exists('connect_base', $opts)) ? $opts['connect_base'] : Stripe::$connectBase;
+ $requestor = new ApiRequestor(null, $base);
+ $params['client_id'] = self::_getClientId($params);
list($response, $apiKey) = $requestor->request(
'post',
'/oauth/deauthorize',
@@ -81,10 +81,10 @@ abstract class OAuth
private static function _getClientId($params = null)
{
$clientId = ($params && \array_key_exists('client_id', $params)) ? $params['client_id'] : null;
- if (null === $clientId) {
+ if ($clientId === null) {
$clientId = Stripe::getClientId();
}
- if (null === $clientId) {
+ if ($clientId === null) {
$msg = 'No client_id provided. (HINT: set your client_id using '
. '"Stripe::setClientId(status is canceled, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.
- * @property null|string $cancellation_reason Reason for cancellation of this PaymentIntent, either user-provided (duplicate, fraudulent, requested_by_customer, or abandoned) or generated by Stripe internally (failed_invoice, void_invoice, or automatic).
- * @property string $capture_method Controls when the funds will be captured from the customer's account.
- * @property null|string $client_secret The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.
The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
Refer to our docs to accept a payment and learn about how client_secret should be handled.
ID of the Customer this PaymentIntent belongs to, if one exists.
Payment methods attached to other Customers cannot be used with this PaymentIntent.
If present in combination with setup_future_usage, this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.
- * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. - * @property null|string|\Stripe\Invoice $invoice ID of the invoice that created this PaymentIntent, if it exists. - * @property null|\Stripe\StripeObject $last_payment_error The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason. - * @property null|string|\Stripe\Charge $latest_charge The latest charge created by this payment intent. - * @property bool $livemode Has the valuetrue if the object exists in live mode or the value false if the object exists in test mode.
- * @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. For more information, see the documentation.
- * @property null|\Stripe\StripeObject $next_action If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.
- * @property null|string|\Stripe\Account $on_behalf_of The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents use case for connected accounts for details.
- * @property null|string|\Stripe\PaymentMethod $payment_method ID of the payment method used in this PaymentIntent.
- * @property null|\Stripe\StripeObject $payment_method_options Payment-method-specific configuration for this PaymentIntent.
- * @property string[] $payment_method_types The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.
- * @property null|\Stripe\StripeObject $processing If present, this property tells you about the processing state of the payment.
- * @property null|string $receipt_email Email address that the receipt for the resulting payment will be sent to. If receipt_email is specified for a payment in live mode, a receipt will be sent regardless of your email settings.
- * @property null|string|\Stripe\Review $review ID of the review associated with this PaymentIntent, if any.
- * @property null|string $setup_future_usage Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded. Read more about each PaymentIntent status.
- * @property null|\Stripe\StripeObject $transfer_data The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents use case for connected accounts for details.
- * @property null|string $transfer_group A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.
+ * @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 int $amount Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
+ * @property int $amount_capturable Amount that can be captured from this PaymentIntent.
+ * @property \Stripe\StripeObject $amount_details
+ * @property int $amount_received Amount that was collected by this PaymentIntent.
+ * @property null|string|\Stripe\StripeObject $application ID of the Connect application that created the PaymentIntent.
+ * @property null|int $application_fee_amount The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents use case for connected accounts.
+ * @property null|\Stripe\StripeObject $automatic_payment_methods Settings to configure compatible payment methods from the Stripe Dashboard
+ * @property null|int $canceled_at Populated when status is canceled, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.
+ * @property null|string $cancellation_reason Reason for cancellation of this PaymentIntent, either user-provided (duplicate, fraudulent, requested_by_customer, or abandoned) or generated by Stripe internally (failed_invoice, void_invoice, or automatic).
+ * @property string $capture_method Controls when the funds will be captured from the customer's account.
+ * @property null|string $client_secret The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.
The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
Refer to our docs to accept a payment and learn about how client_secret should be handled.
ID of the Customer this PaymentIntent belongs to, if one exists.
Payment methods attached to other Customers cannot be used with this PaymentIntent.
If present in combination with setup_future_usage, this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.
+ * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. + * @property null|string|\Stripe\Invoice $invoice ID of the invoice that created this PaymentIntent, if it exists. + * @property null|\Stripe\StripeObject $last_payment_error The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason. + * @property null|string|\Stripe\Charge $latest_charge The latest charge created by this payment intent. + * @property bool $livemode Has the valuetrue if the object exists in live mode or the value false if the object exists in test mode.
+ * @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. For more information, see the documentation.
+ * @property null|\Stripe\StripeObject $next_action If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.
+ * @property null|string|\Stripe\Account $on_behalf_of The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents use case for connected accounts for details.
+ * @property null|string|\Stripe\PaymentMethod $payment_method ID of the payment method used in this PaymentIntent.
+ * @property null|\Stripe\StripeObject $payment_method_options Payment-method-specific configuration for this PaymentIntent.
+ * @property string[] $payment_method_types The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.
+ * @property null|\Stripe\StripeObject $processing If present, this property tells you about the processing state of the payment.
+ * @property null|string $receipt_email Email address that the receipt for the resulting payment will be sent to. If receipt_email is specified for a payment in live mode, a receipt will be sent regardless of your email settings.
+ * @property null|string|\Stripe\Review $review ID of the review associated with this PaymentIntent, if any.
+ * @property null|string $setup_future_usage Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded. Read more about each PaymentIntent status.
+ * @property null|\Stripe\StripeObject $transfer_data The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents use case for connected accounts for details.
+ * @property null|string $transfer_group A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.
*/
class PaymentIntent extends ApiResource
{
- const OBJECT_NAME = 'payment_intent';
+ public const OBJECT_NAME = 'payment_intent';
use ApiOperations\All;
use ApiOperations\Create;
@@ -68,16 +68,22 @@ class PaymentIntent extends ApiResource
use ApiOperations\Search;
use ApiOperations\Update;
- const STATUS_CANCELED = 'canceled';
- const STATUS_PROCESSING = 'processing';
- const STATUS_REQUIRES_ACTION = 'requires_action';
- const STATUS_REQUIRES_CAPTURE = 'requires_capture';
- const STATUS_REQUIRES_CONFIRMATION = 'requires_confirmation';
- const STATUS_REQUIRES_PAYMENT_METHOD = 'requires_payment_method';
- const STATUS_SUCCEEDED = 'succeeded';
+ public const STATUS_CANCELED = 'canceled';
+
+ public const STATUS_PROCESSING = 'processing';
+
+ public const STATUS_REQUIRES_ACTION = 'requires_action';
+
+ public const STATUS_REQUIRES_CAPTURE = 'requires_capture';
+
+ public const STATUS_REQUIRES_CONFIRMATION = 'requires_confirmation';
+
+ public const STATUS_REQUIRES_PAYMENT_METHOD = 'requires_payment_method';
+
+ public const STATUS_SUCCEEDED = 'succeeded';
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -86,7 +92,7 @@ class PaymentIntent extends ApiResource
*/
public function applyCustomerBalance($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/apply_customer_balance';
+ $url = $this->instanceUrl() . '/apply_customer_balance';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -94,7 +100,7 @@ class PaymentIntent extends ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -103,7 +109,7 @@ class PaymentIntent extends ApiResource
*/
public function cancel($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/cancel';
+ $url = $this->instanceUrl() . '/cancel';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -111,7 +117,7 @@ class PaymentIntent extends ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -120,7 +126,7 @@ class PaymentIntent extends ApiResource
*/
public function capture($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/capture';
+ $url = $this->instanceUrl() . '/capture';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -128,7 +134,7 @@ class PaymentIntent extends ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -137,7 +143,7 @@ class PaymentIntent extends ApiResource
*/
public function confirm($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/confirm';
+ $url = $this->instanceUrl() . '/confirm';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -145,7 +151,7 @@ class PaymentIntent extends ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -154,7 +160,7 @@ class PaymentIntent extends ApiResource
*/
public function incrementAuthorization($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/increment_authorization';
+ $url = $this->instanceUrl() . '/increment_authorization';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -162,7 +168,7 @@ class PaymentIntent extends ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -171,7 +177,7 @@ class PaymentIntent extends ApiResource
*/
public function verifyMicrodeposits($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/verify_microdeposits';
+ $url = $this->instanceUrl() . '/verify_microdeposits';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -179,7 +185,7 @@ class PaymentIntent extends ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/PaymentLink.php b/Stripe/Stripe/PaymentLink.php
index 5c3462e..eb90f51 100755
--- a/Stripe/Stripe/PaymentLink.php
+++ b/Stripe/Stripe/PaymentLink.php
@@ -1,4 +1,4 @@
-Payment Links API
*
- * @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 bool $active Whether the payment link's url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated.
- * @property \Stripe\StripeObject $after_completion
- * @property bool $allow_promotion_codes Whether user redeemable promotion codes are enabled.
- * @property null|int $application_fee_amount The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.
- * @property null|float $application_fee_percent This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account.
- * @property \Stripe\StripeObject $automatic_tax
- * @property string $billing_address_collection Configuration for collecting the customer's billing address.
- * @property null|\Stripe\StripeObject $consent_collection When set, provides configuration to gather active consent from customers.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property \Stripe\StripeObject $custom_text
- * @property string $customer_creation Configuration for Customer creation during checkout.
- * @property \Stripe\Collection<\Stripe\LineItem> $line_items The line items representing what is being sold.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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|\Stripe\Account $on_behalf_of The account on behalf of which to charge. See the Connect documentation for details.
- * @property null|\Stripe\StripeObject $payment_intent_data Indicates the parameters to be passed to PaymentIntent creation during checkout.
- * @property string $payment_method_collection Configuration for collecting a payment method during checkout.
- * @property null|string[] $payment_method_types The list of payment method types that customers can use. When null, Stripe will dynamically show relevant payment methods you've enabled in your payment method settings.
- * @property \Stripe\StripeObject $phone_number_collection
- * @property null|\Stripe\StripeObject $shipping_address_collection Configuration for collecting the customer's shipping address.
- * @property \Stripe\StripeObject[] $shipping_options The shipping rate options applied to the session.
- * @property string $submit_type Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
- * @property null|\Stripe\StripeObject $subscription_data When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use subscription_data.
- * @property \Stripe\StripeObject $tax_id_collection
- * @property null|\Stripe\StripeObject $transfer_data The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
- * @property string $url The public URL that can be shared with customers.
+ * @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 bool $active Whether the payment link's url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated.
+ * @property \Stripe\StripeObject $after_completion
+ * @property bool $allow_promotion_codes Whether user redeemable promotion codes are enabled.
+ * @property null|int $application_fee_amount The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.
+ * @property null|float $application_fee_percent This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account.
+ * @property \Stripe\StripeObject $automatic_tax
+ * @property string $billing_address_collection Configuration for collecting the customer's billing address.
+ * @property null|\Stripe\StripeObject $consent_collection When set, provides configuration to gather active consent from customers.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property \Stripe\StripeObject $custom_text
+ * @property string $customer_creation Configuration for Customer creation during checkout.
+ * @property \Stripe\Collection<\Stripe\LineItem> $line_items The line items representing what is being sold.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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|\Stripe\Account $on_behalf_of The account on behalf of which to charge. See the Connect documentation for details.
+ * @property null|\Stripe\StripeObject $payment_intent_data Indicates the parameters to be passed to PaymentIntent creation during checkout.
+ * @property string $payment_method_collection Configuration for collecting a payment method during checkout.
+ * @property null|string[] $payment_method_types The list of payment method types that customers can use. When null, Stripe will dynamically show relevant payment methods you've enabled in your payment method settings.
+ * @property \Stripe\StripeObject $phone_number_collection
+ * @property null|\Stripe\StripeObject $shipping_address_collection Configuration for collecting the customer's shipping address.
+ * @property \Stripe\StripeObject[] $shipping_options The shipping rate options applied to the session.
+ * @property string $submit_type Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
+ * @property null|\Stripe\StripeObject $subscription_data When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use subscription_data.
+ * @property \Stripe\StripeObject $tax_id_collection
+ * @property null|\Stripe\StripeObject $transfer_data The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
+ * @property string $url The public URL that can be shared with customers.
*/
class PaymentLink extends ApiResource
{
- const OBJECT_NAME = 'payment_link';
+ public const OBJECT_NAME = 'payment_link';
use ApiOperations\All;
use ApiOperations\Create;
use ApiOperations\Retrieve;
use ApiOperations\Update;
- const BILLING_ADDRESS_COLLECTION_AUTO = 'auto';
- const BILLING_ADDRESS_COLLECTION_REQUIRED = 'required';
+ public const BILLING_ADDRESS_COLLECTION_AUTO = 'auto';
- const CUSTOMER_CREATION_ALWAYS = 'always';
- const CUSTOMER_CREATION_IF_REQUIRED = 'if_required';
+ public const BILLING_ADDRESS_COLLECTION_REQUIRED = 'required';
- const PAYMENT_METHOD_COLLECTION_ALWAYS = 'always';
- const PAYMENT_METHOD_COLLECTION_IF_REQUIRED = 'if_required';
+ public const CUSTOMER_CREATION_ALWAYS = 'always';
- const SUBMIT_TYPE_AUTO = 'auto';
- const SUBMIT_TYPE_BOOK = 'book';
- const SUBMIT_TYPE_DONATE = 'donate';
- const SUBMIT_TYPE_PAY = 'pay';
+ public const CUSTOMER_CREATION_IF_REQUIRED = 'if_required';
+
+ public const PAYMENT_METHOD_COLLECTION_ALWAYS = 'always';
+
+ public const PAYMENT_METHOD_COLLECTION_IF_REQUIRED = 'if_required';
+
+ public const SUBMIT_TYPE_AUTO = 'auto';
+
+ public const SUBMIT_TYPE_BOOK = 'book';
+
+ public const SUBMIT_TYPE_DONATE = 'donate';
+
+ public const SUBMIT_TYPE_PAY = 'pay';
/**
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -80,9 +86,9 @@ class PaymentLink extends ApiResource
*/
public static function allLineItems($id, $params = null, $opts = null)
{
- $url = static::resourceUrl($id) . '/line_items';
+ $url = static::resourceUrl($id) . '/line_items';
list($response, $opts) = static::_staticRequest('get', $url, $params, $opts);
- $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
+ $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
diff --git a/Stripe/Stripe/PaymentMethod.php b/Stripe/Stripe/PaymentMethod.php
index 1ac4cee..701a9a8 100755
--- a/Stripe/Stripe/PaymentMethod.php
+++ b/Stripe/Stripe/PaymentMethod.php
@@ -1,4 +1,4 @@
-More Payment
* Scenarios.
*
- * @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 \Stripe\StripeObject $acss_debit
- * @property \Stripe\StripeObject $affirm
- * @property \Stripe\StripeObject $afterpay_clearpay
- * @property \Stripe\StripeObject $alipay
- * @property \Stripe\StripeObject $au_becs_debit
- * @property \Stripe\StripeObject $bacs_debit
- * @property \Stripe\StripeObject $bancontact
- * @property \Stripe\StripeObject $billing_details
- * @property \Stripe\StripeObject $blik
- * @property \Stripe\StripeObject $boleto
- * @property \Stripe\StripeObject $card
- * @property \Stripe\StripeObject $card_present
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property null|string|\Stripe\Customer $customer The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
- * @property \Stripe\StripeObject $customer_balance
- * @property \Stripe\StripeObject $eps
- * @property \Stripe\StripeObject $fpx
- * @property \Stripe\StripeObject $giropay
- * @property \Stripe\StripeObject $grabpay
- * @property \Stripe\StripeObject $ideal
- * @property \Stripe\StripeObject $interac_present
- * @property \Stripe\StripeObject $klarna
- * @property \Stripe\StripeObject $konbini
- * @property \Stripe\StripeObject $link
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|\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 \Stripe\StripeObject $oxxo
- * @property \Stripe\StripeObject $p24
- * @property \Stripe\StripeObject $paynow
- * @property \Stripe\StripeObject $pix
- * @property \Stripe\StripeObject $promptpay
- * @property \Stripe\StripeObject $radar_options Options to configure Radar. See Radar Session for more information.
- * @property \Stripe\StripeObject $sepa_debit
- * @property \Stripe\StripeObject $sofort
- * @property string $type The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
- * @property \Stripe\StripeObject $us_bank_account
- * @property \Stripe\StripeObject $wechat_pay
+ * @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 \Stripe\StripeObject $acss_debit
+ * @property \Stripe\StripeObject $affirm
+ * @property \Stripe\StripeObject $afterpay_clearpay
+ * @property \Stripe\StripeObject $alipay
+ * @property \Stripe\StripeObject $au_becs_debit
+ * @property \Stripe\StripeObject $bacs_debit
+ * @property \Stripe\StripeObject $bancontact
+ * @property \Stripe\StripeObject $billing_details
+ * @property \Stripe\StripeObject $blik
+ * @property \Stripe\StripeObject $boleto
+ * @property \Stripe\StripeObject $card
+ * @property \Stripe\StripeObject $card_present
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|string|\Stripe\Customer $customer The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
+ * @property \Stripe\StripeObject $customer_balance
+ * @property \Stripe\StripeObject $eps
+ * @property \Stripe\StripeObject $fpx
+ * @property \Stripe\StripeObject $giropay
+ * @property \Stripe\StripeObject $grabpay
+ * @property \Stripe\StripeObject $ideal
+ * @property \Stripe\StripeObject $interac_present
+ * @property \Stripe\StripeObject $klarna
+ * @property \Stripe\StripeObject $konbini
+ * @property \Stripe\StripeObject $link
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|\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 \Stripe\StripeObject $oxxo
+ * @property \Stripe\StripeObject $p24
+ * @property \Stripe\StripeObject $paynow
+ * @property \Stripe\StripeObject $pix
+ * @property \Stripe\StripeObject $promptpay
+ * @property \Stripe\StripeObject $radar_options Options to configure Radar. See Radar Session for more information.
+ * @property \Stripe\StripeObject $sepa_debit
+ * @property \Stripe\StripeObject $sofort
+ * @property string $type The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
+ * @property \Stripe\StripeObject $us_bank_account
+ * @property \Stripe\StripeObject $wechat_pay
*/
class PaymentMethod extends ApiResource
{
- const OBJECT_NAME = 'payment_method';
+ public const OBJECT_NAME = 'payment_method';
use ApiOperations\All;
use ApiOperations\Create;
@@ -66,7 +66,7 @@ class PaymentMethod extends ApiResource
use ApiOperations\Update;
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -75,7 +75,7 @@ class PaymentMethod extends ApiResource
*/
public function attach($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/attach';
+ $url = $this->instanceUrl() . '/attach';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -83,7 +83,7 @@ class PaymentMethod extends ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -92,7 +92,7 @@ class PaymentMethod extends ApiResource
*/
public function detach($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/detach';
+ $url = $this->instanceUrl() . '/detach';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
diff --git a/Stripe/Stripe/Payout.php b/Stripe/Stripe/Payout.php
index f3d20f7..7289759 100755
--- a/Stripe/Stripe/Payout.php
+++ b/Stripe/Stripe/Payout.php
@@ -1,4 +1,4 @@
-Receiving Payouts.
*
- * @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 int $amount Amount (in %s) to be transferred to your bank account or debit card.
- * @property int $arrival_date Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays.
- * @property bool $automatic Returns true if the payout was created by an automated payout schedule, and false if it was requested manually.
- * @property null|string|\Stripe\BalanceTransaction $balance_transaction ID of the balance transaction that describes the impact of this payout on your account balance.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
- * @property null|string|\Stripe\BankAccount|\Stripe\Card $destination ID of the bank account or card the payout was sent to.
- * @property null|string|\Stripe\BalanceTransaction $failure_balance_transaction If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance.
- * @property null|string $failure_code Error code explaining reason for payout failure if available. See Types of payout failures for a list of failure codes.
- * @property null|string $failure_message Message to user further explaining reason for payout failure if available.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|\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 string $method The method used to send this payout, which can be standard or instant. instant is only supported for payouts to debit cards. (See Instant payouts for marketplaces for more information.)
- * @property null|string|\Stripe\Payout $original_payout If the payout reverses another, this is the ID of the original payout.
- * @property null|string|\Stripe\Payout $reversed_by If the payout was reversed, this is the ID of the payout that reverses this payout.
- * @property string $source_type The source balance this payout came from. One of card, fpx, or bank_account.
- * @property null|string $statement_descriptor Extra information about a payout to be displayed on the user's bank statement.
- * @property string $status Current status of the payout: paid, pending, in_transit, canceled or failed. A payout is pending until it is submitted to the bank, when it becomes in_transit. The status then changes to paid if the transaction goes through, or to failed or canceled (within 5 business days). Some failed payouts may initially show as paid but then change to failed.
- * @property string $type Can be bank_account or card.
+ * @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 int $amount Amount (in %s) to be transferred to your bank account or debit card.
+ * @property int $arrival_date Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays.
+ * @property bool $automatic Returns true if the payout was created by an automated payout schedule, and false if it was requested manually.
+ * @property null|string|\Stripe\BalanceTransaction $balance_transaction ID of the balance transaction that describes the impact of this payout on your account balance.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
+ * @property null|string|\Stripe\BankAccount|\Stripe\Card $destination ID of the bank account or card the payout was sent to.
+ * @property null|string|\Stripe\BalanceTransaction $failure_balance_transaction If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance.
+ * @property null|string $failure_code Error code explaining reason for payout failure if available. See Types of payout failures for a list of failure codes.
+ * @property null|string $failure_message Message to user further explaining reason for payout failure if available.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|\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 string $method The method used to send this payout, which can be standard or instant. instant is only supported for payouts to debit cards. (See Instant payouts for marketplaces for more information.)
+ * @property null|string|\Stripe\Payout $original_payout If the payout reverses another, this is the ID of the original payout.
+ * @property null|string|\Stripe\Payout $reversed_by If the payout was reversed, this is the ID of the payout that reverses this payout.
+ * @property string $source_type The source balance this payout came from. One of card, fpx, or bank_account.
+ * @property null|string $statement_descriptor Extra information about a payout to be displayed on the user's bank statement.
+ * @property string $status Current status of the payout: paid, pending, in_transit, canceled or failed. A payout is pending until it is submitted to the bank, when it becomes in_transit. The status then changes to paid if the transaction goes through, or to failed or canceled (within 5 business days). Some failed payouts may initially show as paid but then change to failed.
+ * @property string $type Can be bank_account or card.
*/
class Payout extends ApiResource
{
- const OBJECT_NAME = 'payout';
+ public const OBJECT_NAME = 'payout';
use ApiOperations\All;
use ApiOperations\Create;
use ApiOperations\Retrieve;
use ApiOperations\Update;
- const FAILURE_ACCOUNT_CLOSED = 'account_closed';
- const FAILURE_ACCOUNT_FROZEN = 'account_frozen';
- const FAILURE_BANK_ACCOUNT_RESTRICTED = 'bank_account_restricted';
- const FAILURE_BANK_OWNERSHIP_CHANGED = 'bank_ownership_changed';
- const FAILURE_COULD_NOT_PROCESS = 'could_not_process';
- const FAILURE_DEBIT_NOT_AUTHORIZED = 'debit_not_authorized';
- const FAILURE_DECLINED = 'declined';
- const FAILURE_INCORRECT_ACCOUNT_HOLDER_ADDRESS = 'incorrect_account_holder_address';
- const FAILURE_INCORRECT_ACCOUNT_HOLDER_NAME = 'incorrect_account_holder_name';
- const FAILURE_INCORRECT_ACCOUNT_HOLDER_TAX_ID = 'incorrect_account_holder_tax_id';
- const FAILURE_INSUFFICIENT_FUNDS = 'insufficient_funds';
- const FAILURE_INVALID_ACCOUNT_NUMBER = 'invalid_account_number';
- const FAILURE_INVALID_CURRENCY = 'invalid_currency';
- const FAILURE_NO_ACCOUNT = 'no_account';
- const FAILURE_UNSUPPORTED_CARD = 'unsupported_card';
+ public const FAILURE_ACCOUNT_CLOSED = 'account_closed';
- const METHOD_INSTANT = 'instant';
- const METHOD_STANDARD = 'standard';
+ public const FAILURE_ACCOUNT_FROZEN = 'account_frozen';
- const STATUS_CANCELED = 'canceled';
- const STATUS_FAILED = 'failed';
- const STATUS_IN_TRANSIT = 'in_transit';
- const STATUS_PAID = 'paid';
- const STATUS_PENDING = 'pending';
+ public const FAILURE_BANK_ACCOUNT_RESTRICTED = 'bank_account_restricted';
- const TYPE_BANK_ACCOUNT = 'bank_account';
- const TYPE_CARD = 'card';
+ public const FAILURE_BANK_OWNERSHIP_CHANGED = 'bank_ownership_changed';
+
+ public const FAILURE_COULD_NOT_PROCESS = 'could_not_process';
+
+ public const FAILURE_DEBIT_NOT_AUTHORIZED = 'debit_not_authorized';
+
+ public const FAILURE_DECLINED = 'declined';
+
+ public const FAILURE_INCORRECT_ACCOUNT_HOLDER_ADDRESS = 'incorrect_account_holder_address';
+
+ public const FAILURE_INCORRECT_ACCOUNT_HOLDER_NAME = 'incorrect_account_holder_name';
+
+ public const FAILURE_INCORRECT_ACCOUNT_HOLDER_TAX_ID = 'incorrect_account_holder_tax_id';
+
+ public const FAILURE_INSUFFICIENT_FUNDS = 'insufficient_funds';
+
+ public const FAILURE_INVALID_ACCOUNT_NUMBER = 'invalid_account_number';
+
+ public const FAILURE_INVALID_CURRENCY = 'invalid_currency';
+
+ public const FAILURE_NO_ACCOUNT = 'no_account';
+
+ public const FAILURE_UNSUPPORTED_CARD = 'unsupported_card';
+
+ public const METHOD_INSTANT = 'instant';
+
+ public const METHOD_STANDARD = 'standard';
+
+ public const STATUS_CANCELED = 'canceled';
+
+ public const STATUS_FAILED = 'failed';
+
+ public const STATUS_IN_TRANSIT = 'in_transit';
+
+ public const STATUS_PAID = 'paid';
+
+ public const STATUS_PENDING = 'pending';
+
+ public const TYPE_BANK_ACCOUNT = 'bank_account';
+
+ public const TYPE_CARD = 'card';
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -84,7 +104,7 @@ class Payout extends ApiResource
*/
public function cancel($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/cancel';
+ $url = $this->instanceUrl() . '/cancel';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -92,7 +112,7 @@ class Payout extends ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -101,7 +121,7 @@ class Payout extends ApiResource
*/
public function reverse($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/reverse';
+ $url = $this->instanceUrl() . '/reverse';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
diff --git a/Stripe/Stripe/Person.php b/Stripe/Stripe/Person.php
index becd590..015c9c0 100755
--- a/Stripe/Stripe/Person.php
+++ b/Stripe/Stripe/Person.php
@@ -1,4 +1,4 @@
-Handling
* Identity Verification with the API.
*
- * @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 string[] $full_name_aliases A list of alternate names or aliases that the person is known by.
- * @property null|\Stripe\StripeObject $future_requirements Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.
- * @property null|string $gender The person's gender (International regulations require either "male" or "female").
- * @property bool $id_number_provided Whether the person's id_number was provided.
- * @property bool $id_number_secondary_provided Whether the person's id_number_secondary 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 $nationality The country where the person is a national.
- * @property null|string $phone The person's phone number.
- * @property 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.
- * @property \Stripe\StripeObject $registered_address
- * @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
+ * @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 string[] $full_name_aliases A list of alternate names or aliases that the person is known by.
+ * @property null|\Stripe\StripeObject $future_requirements Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.
+ * @property null|string $gender The person's gender (International regulations require either "male" or "female").
+ * @property bool $id_number_provided Whether the person's id_number was provided.
+ * @property bool $id_number_secondary_provided Whether the person's id_number_secondary 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 $nationality The country where the person is a national.
+ * @property null|string $phone The person's phone number.
+ * @property 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.
+ * @property \Stripe\StripeObject $registered_address
+ * @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';
+ public const OBJECT_NAME = 'person';
use ApiOperations\Delete;
use ApiOperations\Update;
- const GENDER_FEMALE = 'female';
- const GENDER_MALE = 'male';
+ public const GENDER_FEMALE = 'female';
- const POLITICAL_EXPOSURE_EXISTING = 'existing';
- const POLITICAL_EXPOSURE_NONE = 'none';
+ public const GENDER_MALE = 'male';
- const VERIFICATION_STATUS_PENDING = 'pending';
- const VERIFICATION_STATUS_UNVERIFIED = 'unverified';
- const VERIFICATION_STATUS_VERIFIED = 'verified';
+ public const POLITICAL_EXPOSURE_EXISTING = 'existing';
+
+ public const POLITICAL_EXPOSURE_NONE = 'none';
+
+ public const VERIFICATION_STATUS_PENDING = 'pending';
+
+ public const VERIFICATION_STATUS_UNVERIFIED = 'unverified';
+
+ public const VERIFICATION_STATUS_VERIFIED = 'verified';
/**
* @return string the API URL for this Stripe account reversal
*/
public function instanceUrl()
{
- $id = $this['id'];
+ $id = $this['id'];
$account = $this['account'];
if (!$id) {
throw new Exception\UnexpectedValueException(
@@ -81,23 +85,23 @@ class Person extends ApiResource
null
);
}
- $id = Util\Util::utf8($id);
+ $id = Util\Util::utf8($id);
$account = Util\Util::utf8($account);
- $base = Account::classUrl();
+ $base = Account::classUrl();
$accountExtn = \urlencode($account);
- $extn = \urlencode($id);
+ $extn = \urlencode($id);
return "{$base}/{$accountExtn}/persons/{$extn}";
}
/**
- * @param array|string $_id
+ * @param array|string $_id
* @param null|array|string $_opts
*
* @throws \Stripe\Exception\BadMethodCallException
*/
- public static function retrieve($_id, $_opts = null)
+ public static function retrieve($_id, $_opts = null) : void
{
$msg = 'Persons cannot be retrieved without an account ID. Retrieve ' .
"a person using `Account::retrievePerson('account_id', " .
@@ -107,13 +111,13 @@ class Person extends ApiResource
}
/**
- * @param string $_id
- * @param null|array $_params
+ * @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)
+ public static function update($_id, $_params = null, $_options = null) : void
{
$msg = 'Persons cannot be updated without an account ID. Update ' .
"a person using `Account::updatePerson('account_id', " .
diff --git a/Stripe/Stripe/Plan.php b/Stripe/Stripe/Plan.php
index c3621fa..03af499 100755
--- a/Stripe/Stripe/Plan.php
+++ b/Stripe/Stripe/Plan.php
@@ -1,4 +1,4 @@
- and more about products and prices.
*
- * @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 bool $active Whether the plan can be used for new purchases.
- * @property null|string $aggregate_usage Specifies a usage aggregation strategy for plans of usage_type=metered. Allowed values are sum for summing up all usage during a period, last_during_period for using the last usage record reported within a period, last_ever for using the last usage record ever (across period bounds) or max which uses the usage record with the maximum reported usage during a period. Defaults to sum.
- * @property null|int $amount The unit amount in %s to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
- * @property null|string $amount_decimal The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
- * @property string $billing_scheme Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in amount) will be charged per unit in quantity (for plans with usage_type=licensed), or per unit of total usage (for plans with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property string $interval The frequency at which a subscription is billed. One of day, week, month or year.
- * @property int $interval_count The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|\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 $nickname A brief description of the plan, hidden from customers.
- * @property null|string|\Stripe\Product $product The product whose pricing this plan determines.
- * @property \Stripe\StripeObject[] $tiers Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
- * @property null|string $tiers_mode Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.
- * @property null|\Stripe\StripeObject $transform_usage Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
- * @property null|int $trial_period_days Default number of trial days when subscribing a customer to this plan using trial_from_plan=true.
- * @property string $usage_type Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed.
+ * @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 bool $active Whether the plan can be used for new purchases.
+ * @property null|string $aggregate_usage Specifies a usage aggregation strategy for plans of usage_type=metered. Allowed values are sum for summing up all usage during a period, last_during_period for using the last usage record reported within a period, last_ever for using the last usage record ever (across period bounds) or max which uses the usage record with the maximum reported usage during a period. Defaults to sum.
+ * @property null|int $amount The unit amount in %s to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
+ * @property null|string $amount_decimal The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
+ * @property string $billing_scheme Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in amount) will be charged per unit in quantity (for plans with usage_type=licensed), or per unit of total usage (for plans with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string $interval The frequency at which a subscription is billed. One of day, week, month or year.
+ * @property int $interval_count The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|\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 $nickname A brief description of the plan, hidden from customers.
+ * @property null|string|\Stripe\Product $product The product whose pricing this plan determines.
+ * @property \Stripe\StripeObject[] $tiers Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
+ * @property null|string $tiers_mode Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.
+ * @property null|\Stripe\StripeObject $transform_usage Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
+ * @property null|int $trial_period_days Default number of trial days when subscribing a customer to this plan using trial_from_plan=true.
+ * @property string $usage_type Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed.
*/
class Plan extends ApiResource
{
- const OBJECT_NAME = 'plan';
+ public const OBJECT_NAME = 'plan';
use ApiOperations\All;
use ApiOperations\Create;
diff --git a/Stripe/Stripe/Price.php b/Stripe/Stripe/Price.php
index defb37d..bbba59c 100755
--- a/Stripe/Stripe/Price.php
+++ b/Stripe/Stripe/Price.php
@@ -1,4 +1,4 @@
-products and prices.
*
- * @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 bool $active Whether the price can be used for new purchases.
- * @property string $billing_scheme Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property \Stripe\StripeObject $currency_options Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
- * @property null|\Stripe\StripeObject $custom_unit_amount When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|string $lookup_key A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
- * @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 $nickname A brief description of the price, hidden from customers.
- * @property string|\Stripe\Product $product The ID of the product this price is associated with.
- * @property null|\Stripe\StripeObject $recurring The recurring components of a price such as interval and usage_type.
- * @property null|string $tax_behavior Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
- * @property \Stripe\StripeObject[] $tiers Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
- * @property null|string $tiers_mode Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.
- * @property null|\Stripe\StripeObject $transform_quantity Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
- * @property string $type One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
- * @property null|int $unit_amount The unit amount in %s to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
- * @property null|string $unit_amount_decimal The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
+ * @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 bool $active Whether the price can be used for new purchases.
+ * @property string $billing_scheme Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property \Stripe\StripeObject $currency_options Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
+ * @property null|\Stripe\StripeObject $custom_unit_amount When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|string $lookup_key A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
+ * @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 $nickname A brief description of the price, hidden from customers.
+ * @property string|\Stripe\Product $product The ID of the product this price is associated with.
+ * @property null|\Stripe\StripeObject $recurring The recurring components of a price such as interval and usage_type.
+ * @property null|string $tax_behavior Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
+ * @property \Stripe\StripeObject[] $tiers Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
+ * @property null|string $tiers_mode Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.
+ * @property null|\Stripe\StripeObject $transform_quantity Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
+ * @property string $type One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
+ * @property null|int $unit_amount The unit amount in %s to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
+ * @property null|string $unit_amount_decimal The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
*/
class Price extends ApiResource
{
- const OBJECT_NAME = 'price';
+ public const OBJECT_NAME = 'price';
use ApiOperations\All;
use ApiOperations\Create;
@@ -55,21 +55,26 @@ class Price extends ApiResource
use ApiOperations\Search;
use ApiOperations\Update;
- const BILLING_SCHEME_PER_UNIT = 'per_unit';
- const BILLING_SCHEME_TIERED = 'tiered';
+ public const BILLING_SCHEME_PER_UNIT = 'per_unit';
- const TAX_BEHAVIOR_EXCLUSIVE = 'exclusive';
- const TAX_BEHAVIOR_INCLUSIVE = 'inclusive';
- const TAX_BEHAVIOR_UNSPECIFIED = 'unspecified';
+ public const BILLING_SCHEME_TIERED = 'tiered';
- const TIERS_MODE_GRADUATED = 'graduated';
- const TIERS_MODE_VOLUME = 'volume';
+ public const TAX_BEHAVIOR_EXCLUSIVE = 'exclusive';
- const TYPE_ONE_TIME = 'one_time';
- const TYPE_RECURRING = 'recurring';
+ public const TAX_BEHAVIOR_INCLUSIVE = 'inclusive';
+
+ public const TAX_BEHAVIOR_UNSPECIFIED = 'unspecified';
+
+ public const TIERS_MODE_GRADUATED = 'graduated';
+
+ public const TIERS_MODE_VOLUME = 'volume';
+
+ public const TYPE_ONE_TIME = 'one_time';
+
+ public const TYPE_RECURRING = 'recurring';
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Product.php b/Stripe/Stripe/Product.php
index d3d2163..9058670 100755
--- a/Stripe/Stripe/Product.php
+++ b/Stripe/Stripe/Product.php
@@ -1,4 +1,4 @@
-, and more about Products and Prices
*
- * @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 bool $active Whether the product is currently available for purchase.
- * @property null|string[] $attributes A list of up to 5 attributes that each SKU can provide values for (e.g., ["color", "size"]).
- * @property null|string $caption A short one-line description of the product, meant to be displayable to the customer. Only applicable to products of type=good.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string[] $deactivate_on An array of connect application identifiers that cannot purchase this product. Only applicable to products of type=good.
- * @property null|string|\Stripe\Price $default_price The ID of the Price object that is the default price for this product.
- * @property null|string $description The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
- * @property string[] $images A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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 string $name The product's name, meant to be displayable to the customer.
- * @property null|\Stripe\StripeObject $package_dimensions The dimensions of this product for shipping purposes.
- * @property null|bool $shippable Whether this product is shipped (i.e., physical goods).
- * @property null|string $statement_descriptor Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used.
- * @property null|string|\Stripe\TaxCode $tax_code A tax code ID.
- * @property string $type The type of the product. The product is either of type good, which is eligible for use with Orders and SKUs, or service, which is eligible for use with Subscriptions and Plans.
- * @property null|string $unit_label A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions.
- * @property int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch.
- * @property null|string $url A URL of a publicly-accessible webpage for this product.
+ * @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 bool $active Whether the product is currently available for purchase.
+ * @property null|string[] $attributes A list of up to 5 attributes that each SKU can provide values for (e.g., ["color", "size"]).
+ * @property null|string $caption A short one-line description of the product, meant to be displayable to the customer. Only applicable to products of type=good.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string[] $deactivate_on An array of connect application identifiers that cannot purchase this product. Only applicable to products of type=good.
+ * @property null|string|\Stripe\Price $default_price The ID of the Price object that is the default price for this product.
+ * @property null|string $description The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
+ * @property string[] $images A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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 string $name The product's name, meant to be displayable to the customer.
+ * @property null|\Stripe\StripeObject $package_dimensions The dimensions of this product for shipping purposes.
+ * @property null|bool $shippable Whether this product is shipped (i.e., physical goods).
+ * @property null|string $statement_descriptor Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used.
+ * @property null|string|\Stripe\TaxCode $tax_code A tax code ID.
+ * @property string $type The type of the product. The product is either of type good, which is eligible for use with Orders and SKUs, or service, which is eligible for use with Subscriptions and Plans.
+ * @property null|string $unit_label A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions.
+ * @property int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch.
+ * @property null|string $url A URL of a publicly-accessible webpage for this product.
*/
class Product extends ApiResource
{
- const OBJECT_NAME = 'product';
+ public const OBJECT_NAME = 'product';
use ApiOperations\All;
use ApiOperations\Create;
@@ -53,11 +53,12 @@ class Product extends ApiResource
use ApiOperations\Search;
use ApiOperations\Update;
- const TYPE_GOOD = 'good';
- const TYPE_SERVICE = 'service';
+ public const TYPE_GOOD = 'good';
+
+ public const TYPE_SERVICE = 'service';
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/PromotionCode.php b/Stripe/Stripe/PromotionCode.php
index 7eb0c40..e193f0f 100755
--- a/Stripe/Stripe/PromotionCode.php
+++ b/Stripe/Stripe/PromotionCode.php
@@ -1,4 +1,4 @@
-coupon. It can be used to create
* multiple codes for a single coupon.
*
- * @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 bool $active Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
- * @property string $code The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer.
- * @property \Stripe\Coupon $coupon A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to subscriptions, invoices, checkout sessions, quotes, and more. Coupons do not work with conventional one-off charges or payment intents.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property null|string|\Stripe\Customer $customer The customer that this promotion code can be used by.
- * @property null|int $expires_at Date at which the promotion code can no longer be redeemed.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|int $max_redemptions Maximum number of times this promotion code can be redeemed.
- * @property null|\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 \Stripe\StripeObject $restrictions
- * @property int $times_redeemed Number of times this promotion code has been used.
+ * @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 bool $active Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
+ * @property string $code The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer.
+ * @property \Stripe\Coupon $coupon A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to subscriptions, invoices, checkout sessions, quotes, and more. Coupons do not work with conventional one-off charges or payment intents.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|string|\Stripe\Customer $customer The customer that this promotion code can be used by.
+ * @property null|int $expires_at Date at which the promotion code can no longer be redeemed.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|int $max_redemptions Maximum number of times this promotion code can be redeemed.
+ * @property null|\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 \Stripe\StripeObject $restrictions
+ * @property int $times_redeemed Number of times this promotion code has been used.
*/
class PromotionCode extends ApiResource
{
- const OBJECT_NAME = 'promotion_code';
+ public const OBJECT_NAME = 'promotion_code';
use ApiOperations\All;
use ApiOperations\Create;
diff --git a/Stripe/Stripe/Quote.php b/Stripe/Stripe/Quote.php
index 7e564e8..e51a3be 100755
--- a/Stripe/Stripe/Quote.php
+++ b/Stripe/Stripe/Quote.php
@@ -1,4 +1,4 @@
-charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active. Defaults to charge_automatically.
- * @property \Stripe\StripeObject $computed
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property null|string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property null|string|\Stripe\Customer $customer The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
- * @property (string|\Stripe\TaxRate)[] $default_tax_rates The tax rates applied to this quote.
- * @property null|string $description A description that will be displayed on the quote PDF.
- * @property (string|\Stripe\Discount)[] $discounts The discounts applied to this quote.
- * @property int $expires_at The date on which the quote will be canceled if in open or draft status. Measured in seconds since the Unix epoch.
- * @property null|string $footer A footer that will be displayed on the quote PDF.
- * @property null|\Stripe\StripeObject $from_quote Details of the quote that was cloned. See the cloning documentation for more details.
- * @property null|string $header A header that will be displayed on the quote PDF.
- * @property null|string|\Stripe\Invoice $invoice The invoice that was created from this quote.
- * @property null|\Stripe\StripeObject $invoice_settings All invoices will be billed using the specified settings.
- * @property \Stripe\Collection<\Stripe\LineItem> $line_items A list of items the customer is being quoted for.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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 $number A unique number that identifies this particular quote. This number is assigned once the quote is finalized.
- * @property null|string|\Stripe\Account $on_behalf_of The account on behalf of which to charge. See the Connect documentation for details.
- * @property string $status The status of the quote.
- * @property \Stripe\StripeObject $status_transitions
- * @property null|string|\Stripe\Subscription $subscription The subscription that was created or updated from this quote.
- * @property \Stripe\StripeObject $subscription_data
- * @property null|string|\Stripe\SubscriptionSchedule $subscription_schedule The subscription schedule that was created or updated from this quote.
- * @property null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this quote belongs to.
- * @property \Stripe\StripeObject $total_details
- * @property null|\Stripe\StripeObject $transfer_data The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices.
+ * @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 int $amount_subtotal Total before any discounts or taxes are applied.
+ * @property int $amount_total Total after discounts and taxes are applied.
+ * @property null|string|\Stripe\StripeObject $application ID of the Connect Application that created the quote.
+ * @property null|int $application_fee_amount The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote.
+ * @property null|float $application_fee_percent A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote.
+ * @property \Stripe\StripeObject $automatic_tax
+ * @property string $collection_method Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active. Defaults to charge_automatically.
+ * @property \Stripe\StripeObject $computed
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property null|string|\Stripe\Customer $customer The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
+ * @property (string|\Stripe\TaxRate)[] $default_tax_rates The tax rates applied to this quote.
+ * @property null|string $description A description that will be displayed on the quote PDF.
+ * @property (string|\Stripe\Discount)[] $discounts The discounts applied to this quote.
+ * @property int $expires_at The date on which the quote will be canceled if in open or draft status. Measured in seconds since the Unix epoch.
+ * @property null|string $footer A footer that will be displayed on the quote PDF.
+ * @property null|\Stripe\StripeObject $from_quote Details of the quote that was cloned. See the cloning documentation for more details.
+ * @property null|string $header A header that will be displayed on the quote PDF.
+ * @property null|string|\Stripe\Invoice $invoice The invoice that was created from this quote.
+ * @property null|\Stripe\StripeObject $invoice_settings All invoices will be billed using the specified settings.
+ * @property \Stripe\Collection<\Stripe\LineItem> $line_items A list of items the customer is being quoted for.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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 $number A unique number that identifies this particular quote. This number is assigned once the quote is finalized.
+ * @property null|string|\Stripe\Account $on_behalf_of The account on behalf of which to charge. See the Connect documentation for details.
+ * @property string $status The status of the quote.
+ * @property \Stripe\StripeObject $status_transitions
+ * @property null|string|\Stripe\Subscription $subscription The subscription that was created or updated from this quote.
+ * @property \Stripe\StripeObject $subscription_data
+ * @property null|string|\Stripe\SubscriptionSchedule $subscription_schedule The subscription schedule that was created or updated from this quote.
+ * @property null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this quote belongs to.
+ * @property \Stripe\StripeObject $total_details
+ * @property null|\Stripe\StripeObject $transfer_data The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices.
*/
class Quote extends ApiResource
{
- const OBJECT_NAME = 'quote';
+ public const OBJECT_NAME = 'quote';
use ApiOperations\All;
use ApiOperations\Create;
use ApiOperations\Retrieve;
use ApiOperations\Update;
- const COLLECTION_METHOD_CHARGE_AUTOMATICALLY = 'charge_automatically';
- const COLLECTION_METHOD_SEND_INVOICE = 'send_invoice';
+ public const COLLECTION_METHOD_CHARGE_AUTOMATICALLY = 'charge_automatically';
- const STATUS_ACCEPTED = 'accepted';
- const STATUS_CANCELED = 'canceled';
- const STATUS_DRAFT = 'draft';
- const STATUS_OPEN = 'open';
+ public const COLLECTION_METHOD_SEND_INVOICE = 'send_invoice';
+
+ public const STATUS_ACCEPTED = 'accepted';
+
+ public const STATUS_CANCELED = 'canceled';
+
+ public const STATUS_DRAFT = 'draft';
+
+ public const STATUS_OPEN = 'open';
/**
- * @param callable $readBodyChunkCallable
- * @param null|array $params
+ * @param callable $readBodyChunkCallable
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*/
- public function pdf($readBodyChunkCallable, $params = null, $opts = null)
+ public function pdf($readBodyChunkCallable, $params = null, $opts = null) : void
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
- if (null === $opts->apiBase) {
+ if ($opts->apiBase === null) {
$opts->apiBase = Stripe::$apiUploadBase;
}
@@ -81,7 +85,7 @@ class Quote extends ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -90,7 +94,7 @@ class Quote extends ApiResource
*/
public function accept($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/accept';
+ $url = $this->instanceUrl() . '/accept';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -98,7 +102,7 @@ class Quote extends ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -107,7 +111,7 @@ class Quote extends ApiResource
*/
public function cancel($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/cancel';
+ $url = $this->instanceUrl() . '/cancel';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -115,7 +119,7 @@ class Quote extends ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -124,7 +128,7 @@ class Quote extends ApiResource
*/
public function finalizeQuote($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/finalize';
+ $url = $this->instanceUrl() . '/finalize';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -132,8 +136,8 @@ class Quote extends ApiResource
}
/**
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -142,17 +146,17 @@ class Quote extends ApiResource
*/
public static function allComputedUpfrontLineItems($id, $params = null, $opts = null)
{
- $url = static::resourceUrl($id) . '/computed_upfront_line_items';
+ $url = static::resourceUrl($id) . '/computed_upfront_line_items';
list($response, $opts) = static::_staticRequest('get', $url, $params, $opts);
- $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
+ $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
}
/**
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -161,9 +165,9 @@ class Quote extends ApiResource
*/
public static function allLineItems($id, $params = null, $opts = null)
{
- $url = static::resourceUrl($id) . '/line_items';
+ $url = static::resourceUrl($id) . '/line_items';
list($response, $opts) = static::_staticRequest('get', $url, $params, $opts);
- $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
+ $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
diff --git a/Stripe/Stripe/Radar/EarlyFraudWarning.php b/Stripe/Stripe/Radar/EarlyFraudWarning.php
index 2dfd2ac..2011bfc 100755
--- a/Stripe/Stripe/Radar/EarlyFraudWarning.php
+++ b/Stripe/Stripe/Radar/EarlyFraudWarning.php
@@ -1,4 +1,4 @@
-Early
* Fraud Warnings.
*
- * @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 bool $actionable An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later.
- * @property string|\Stripe\Charge $charge ID of the charge this early fraud warning is for, optionally expanded.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $fraud_type The type of fraud labelled by the issuer. One of card_never_received, fraudulent_card_application, made_with_counterfeit_card, made_with_lost_card, made_with_stolen_card, misc, unauthorized_use_of_card.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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 bool $actionable An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later.
+ * @property string|\Stripe\Charge $charge ID of the charge this early fraud warning is for, optionally expanded.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $fraud_type The type of fraud labelled by the issuer. One of card_never_received, fraudulent_card_application, made_with_counterfeit_card, made_with_lost_card, made_with_stolen_card, misc, unauthorized_use_of_card.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
* @property string|\Stripe\PaymentIntent $payment_intent ID of the Payment Intent this early fraud warning is for, optionally expanded.
*/
class EarlyFraudWarning extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'radar.early_fraud_warning';
+ public const OBJECT_NAME = 'radar.early_fraud_warning';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
- const FRAUD_TYPE_CARD_NEVER_RECEIVED = 'card_never_received';
- const FRAUD_TYPE_FRAUDULENT_CARD_APPLICATION = 'fraudulent_card_application';
- const FRAUD_TYPE_MADE_WITH_COUNTERFEIT_CARD = 'made_with_counterfeit_card';
- const FRAUD_TYPE_MADE_WITH_LOST_CARD = 'made_with_lost_card';
- const FRAUD_TYPE_MADE_WITH_STOLEN_CARD = 'made_with_stolen_card';
- const FRAUD_TYPE_MISC = 'misc';
- const FRAUD_TYPE_UNAUTHORIZED_USE_OF_CARD = 'unauthorized_use_of_card';
+ public const FRAUD_TYPE_CARD_NEVER_RECEIVED = 'card_never_received';
+
+ public const FRAUD_TYPE_FRAUDULENT_CARD_APPLICATION = 'fraudulent_card_application';
+
+ public const FRAUD_TYPE_MADE_WITH_COUNTERFEIT_CARD = 'made_with_counterfeit_card';
+
+ public const FRAUD_TYPE_MADE_WITH_LOST_CARD = 'made_with_lost_card';
+
+ public const FRAUD_TYPE_MADE_WITH_STOLEN_CARD = 'made_with_stolen_card';
+
+ public const FRAUD_TYPE_MISC = 'misc';
+
+ public const FRAUD_TYPE_UNAUTHORIZED_USE_OF_CARD = 'unauthorized_use_of_card';
}
diff --git a/Stripe/Stripe/Radar/ValueList.php b/Stripe/Stripe/Radar/ValueList.php
index 8cd6223..cb007ac 100755
--- a/Stripe/Stripe/Radar/ValueList.php
+++ b/Stripe/Stripe/Radar/ValueList.php
@@ -1,4 +1,4 @@
-Default Stripe
* Lists.
*
- * @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 $alias The name of the value list for use in rules.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $created_by The name or email address of the user who created this value list.
- * @property string $item_type The type of items in the value list. One of card_fingerprint, card_bin, email, ip_address, country, string, case_sensitive_string, or customer_id.
+ * @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 $alias The name of the value list for use in rules.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $created_by The name or email address of the user who created this value list.
+ * @property string $item_type The type of items in the value list. One of card_fingerprint, card_bin, email, ip_address, country, string, case_sensitive_string, or customer_id.
* @property \Stripe\Collection<\Stripe\Radar\ValueListItem> $list_items List of items contained within this value list.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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 string $name The name of the value list.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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 string $name The name of the value list.
*/
class ValueList extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'radar.value_list';
+ public const OBJECT_NAME = 'radar.value_list';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
diff --git a/Stripe/Stripe/Radar/ValueListItem.php b/Stripe/Stripe/Radar/ValueListItem.php
index c4ab281..f77bc54 100755
--- a/Stripe/Stripe/Radar/ValueListItem.php
+++ b/Stripe/Stripe/Radar/ValueListItem.php
@@ -1,4 +1,4 @@
-Managing List
* Items.
*
- * @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 int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @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 int $created Time at which the object was created. Measured in seconds since the Unix epoch.
* @property string $created_by The name or email address of the user who added this item to the value list.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property string $value The value of the item.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string $value The value of the item.
* @property string $value_list The identifier of the value list this item belongs to.
*/
class ValueListItem extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'radar.value_list_item';
+ public const OBJECT_NAME = 'radar.value_list_item';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
diff --git a/Stripe/Stripe/RecipientTransfer.php b/Stripe/Stripe/RecipientTransfer.php
index 5e2d436..864c548 100755
--- a/Stripe/Stripe/RecipientTransfer.php
+++ b/Stripe/Stripe/RecipientTransfer.php
@@ -1,36 +1,36 @@
-Refunds.
*
- * @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 int $amount Amount, in %s.
- * @property null|string|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact on your account balance.
- * @property null|string|\Stripe\Charge $charge ID of the charge that was refunded.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property string $description An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only)
- * @property string|\Stripe\BalanceTransaction $failure_balance_transaction If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.
- * @property string $failure_reason If the refund failed, the reason for refund failure if known. Possible values are lost_or_stolen_card, expired_or_canceled_card, or unknown.
- * @property string $instructions_email Email to which refund instructions, if required, are sent to.
- * @property null|\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 \Stripe\StripeObject $next_action
- * @property null|string|\Stripe\PaymentIntent $payment_intent ID of the PaymentIntent that was refunded.
- * @property null|string $reason Reason for the refund, either user-provided (duplicate, fraudulent, or requested_by_customer) or generated by Stripe internally (expired_uncaptured_charge).
- * @property null|string $receipt_number This is the transaction number that appears on email receipts sent for this refund.
- * @property null|string|\Stripe\TransferReversal $source_transfer_reversal The transfer reversal that is associated with the refund. Only present if the charge came from another Stripe account. See the Connect documentation for details.
- * @property null|string $status Status of the refund. For credit card refunds, this can be pending, succeeded, or failed. For other types of refunds, it can be pending, requires_action, succeeded, failed, or canceled. Refer to our refunds documentation for more details.
- * @property null|string|\Stripe\TransferReversal $transfer_reversal If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter.
+ * @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 int $amount Amount, in %s.
+ * @property null|string|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact on your account balance.
+ * @property null|string|\Stripe\Charge $charge ID of the charge that was refunded.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string $description An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only)
+ * @property string|\Stripe\BalanceTransaction $failure_balance_transaction If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.
+ * @property string $failure_reason If the refund failed, the reason for refund failure if known. Possible values are lost_or_stolen_card, expired_or_canceled_card, or unknown.
+ * @property string $instructions_email Email to which refund instructions, if required, are sent to.
+ * @property null|\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 \Stripe\StripeObject $next_action
+ * @property null|string|\Stripe\PaymentIntent $payment_intent ID of the PaymentIntent that was refunded.
+ * @property null|string $reason Reason for the refund, either user-provided (duplicate, fraudulent, or requested_by_customer) or generated by Stripe internally (expired_uncaptured_charge).
+ * @property null|string $receipt_number This is the transaction number that appears on email receipts sent for this refund.
+ * @property null|string|\Stripe\TransferReversal $source_transfer_reversal The transfer reversal that is associated with the refund. Only present if the charge came from another Stripe account. See the Connect documentation for details.
+ * @property null|string $status Status of the refund. For credit card refunds, this can be pending, succeeded, or failed. For other types of refunds, it can be pending, requires_action, succeeded, failed, or canceled. Refer to our refunds documentation for more details.
+ * @property null|string|\Stripe\TransferReversal $transfer_reversal If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter.
*/
class Refund extends ApiResource
{
- const OBJECT_NAME = 'refund';
+ public const OBJECT_NAME = 'refund';
use ApiOperations\All;
use ApiOperations\Create;
use ApiOperations\Retrieve;
use ApiOperations\Update;
- const FAILURE_REASON_EXPIRED_OR_CANCELED_CARD = 'expired_or_canceled_card';
- const FAILURE_REASON_LOST_OR_STOLEN_CARD = 'lost_or_stolen_card';
- const FAILURE_REASON_UNKNOWN = 'unknown';
+ public const FAILURE_REASON_EXPIRED_OR_CANCELED_CARD = 'expired_or_canceled_card';
- const REASON_DUPLICATE = 'duplicate';
- const REASON_EXPIRED_UNCAPTURED_CHARGE = 'expired_uncaptured_charge';
- const REASON_FRAUDULENT = 'fraudulent';
- const REASON_REQUESTED_BY_CUSTOMER = 'requested_by_customer';
+ public const FAILURE_REASON_LOST_OR_STOLEN_CARD = 'lost_or_stolen_card';
- const STATUS_CANCELED = 'canceled';
- const STATUS_FAILED = 'failed';
- const STATUS_PENDING = 'pending';
- const STATUS_REQUIRES_ACTION = 'requires_action';
- const STATUS_SUCCEEDED = 'succeeded';
+ public const FAILURE_REASON_UNKNOWN = 'unknown';
+
+ public const REASON_DUPLICATE = 'duplicate';
+
+ public const REASON_EXPIRED_UNCAPTURED_CHARGE = 'expired_uncaptured_charge';
+
+ public const REASON_FRAUDULENT = 'fraudulent';
+
+ public const REASON_REQUESTED_BY_CUSTOMER = 'requested_by_customer';
+
+ public const STATUS_CANCELED = 'canceled';
+
+ public const STATUS_FAILED = 'failed';
+
+ public const STATUS_PENDING = 'pending';
+
+ public const STATUS_REQUIRES_ACTION = 'requires_action';
+
+ public const STATUS_SUCCEEDED = 'succeeded';
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -65,7 +74,7 @@ class Refund extends ApiResource
*/
public function cancel($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/cancel';
+ $url = $this->instanceUrl() . '/cancel';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
diff --git a/Stripe/Stripe/Reporting/ReportRun.php b/Stripe/Stripe/Reporting/ReportRun.php
index 7c3d2a9..dd7415a 100755
--- a/Stripe/Stripe/Reporting/ReportRun.php
+++ b/Stripe/Stripe/Reporting/ReportRun.php
@@ -1,4 +1,4 @@
-live-mode API key.
*
- * @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 int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property null|string $error If something should go wrong during the run, a message about the failure (populated when status=failed).
- * @property bool $livemode true if the report is run on live mode data and false if it is run on test mode data.
+ * @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 int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|string $error If something should go wrong during the run, a message about the failure (populated when status=failed).
+ * @property bool $livemode true if the report is run on live mode data and false if it is run on test mode data.
* @property \Stripe\StripeObject $parameters
- * @property string $report_type The ID of the report type to run, such as "balance.summary.1".
- * @property null|\Stripe\File $result The file object representing the result of the report run (populated when status=succeeded).
- * @property string $status Status of this report run. This will be pending when the run is initially created. When the run finishes, this will be set to succeeded and the result field will be populated. Rarely, we may encounter an error, at which point this will be set to failed and the error field will be populated.
- * @property null|int $succeeded_at Timestamp at which this run successfully finished (populated when status=succeeded). Measured in seconds since the Unix epoch.
+ * @property string $report_type The ID of the report type to run, such as "balance.summary.1".
+ * @property null|\Stripe\File $result The file object representing the result of the report run (populated when status=succeeded).
+ * @property string $status Status of this report run. This will be pending when the run is initially created. When the run finishes, this will be set to succeeded and the result field will be populated. Rarely, we may encounter an error, at which point this will be set to failed and the error field will be populated.
+ * @property null|int $succeeded_at Timestamp at which this run successfully finished (populated when status=succeeded). Measured in seconds since the Unix epoch.
*/
class ReportRun extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'reporting.report_run';
+ public const OBJECT_NAME = 'reporting.report_run';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
diff --git a/Stripe/Stripe/Reporting/ReportType.php b/Stripe/Stripe/Reporting/ReportType.php
index 4725656..f5663a3 100755
--- a/Stripe/Stripe/Reporting/ReportType.php
+++ b/Stripe/Stripe/Reporting/ReportType.php
@@ -1,4 +1,4 @@
-live-mode API key.
*
- * @property string $id The ID of the Report Type, such as balance.summary.1.
- * @property string $object String representing the object's type. Objects of the same type share the same value.
- * @property int $data_available_end Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.
- * @property int $data_available_start Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.
- * @property null|string[] $default_columns List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the columns parameter, this will be null.)
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property string $name Human-readable name of the Report Type
- * @property int $updated When this Report Type was latest updated. Measured in seconds since the Unix epoch.
- * @property int $version Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.
+ * @property string $id The ID of the Report Type, such as balance.summary.1.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $data_available_end Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.
+ * @property int $data_available_start Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.
+ * @property null|string[] $default_columns List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the columns parameter, this will be null.)
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string $name Human-readable name of the Report Type
+ * @property int $updated When this Report Type was latest updated. Measured in seconds since the Unix epoch.
+ * @property int $version Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.
*/
class ReportType extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'reporting.report_type';
+ public const OBJECT_NAME = 'reporting.report_type';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
diff --git a/Stripe/Stripe/RequestTelemetry.php b/Stripe/Stripe/RequestTelemetry.php
index bf9074a..cd57d90 100755
--- a/Stripe/Stripe/RequestTelemetry.php
+++ b/Stripe/Stripe/RequestTelemetry.php
@@ -1,4 +1,4 @@
-requestId = $requestId;
+ $this->requestId = $requestId;
$this->requestDuration = $requestDuration;
}
}
diff --git a/Stripe/Stripe/Review.php b/Stripe/Stripe/Review.php
index af8f398..3e8e447 100755
--- a/Stripe/Stripe/Review.php
+++ b/Stripe/Stripe/Review.php
@@ -1,4 +1,4 @@
-Radar and reviewing payments here.
*
- * @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 null|string $billing_zip The ZIP or postal code of the card used, if applicable.
- * @property null|string|\Stripe\Charge $charge The charge associated with this review.
- * @property null|string $closed_reason The reason the review was closed, or null if it has not yet been closed. One of approved, refunded, refunded_as_fraud, disputed, or redacted.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property null|string $ip_address The IP address where the payment originated.
- * @property null|\Stripe\StripeObject $ip_address_location Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property bool $open If true, the review needs action.
- * @property string $opened_reason The reason the review was opened. One of rule or manual.
- * @property string|\Stripe\PaymentIntent $payment_intent The PaymentIntent ID associated with this review, if one exists.
- * @property string $reason The reason the review is currently open or closed. One of rule, manual, approved, refunded, refunded_as_fraud, disputed, or redacted.
- * @property null|\Stripe\StripeObject $session Information related to the browsing session of the user who initiated the payment.
+ * @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 null|string $billing_zip The ZIP or postal code of the card used, if applicable.
+ * @property null|string|\Stripe\Charge $charge The charge associated with this review.
+ * @property null|string $closed_reason The reason the review was closed, or null if it has not yet been closed. One of approved, refunded, refunded_as_fraud, disputed, or redacted.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|string $ip_address The IP address where the payment originated.
+ * @property null|\Stripe\StripeObject $ip_address_location Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property bool $open If true, the review needs action.
+ * @property string $opened_reason The reason the review was opened. One of rule or manual.
+ * @property string|\Stripe\PaymentIntent $payment_intent The PaymentIntent ID associated with this review, if one exists.
+ * @property string $reason The reason the review is currently open or closed. One of rule, manual, approved, refunded, refunded_as_fraud, disputed, or redacted.
+ * @property null|\Stripe\StripeObject $session Information related to the browsing session of the user who initiated the payment.
*/
class Review extends ApiResource
{
- const OBJECT_NAME = 'review';
+ public const OBJECT_NAME = 'review';
use ApiOperations\All;
use ApiOperations\Retrieve;
@@ -40,15 +40,20 @@ class Review extends ApiResource
*
* @see https://stripe.com/docs/api/radar/reviews/object
*/
- const REASON_APPROVED = 'approved';
- const REASON_DISPUTED = 'disputed';
- const REASON_MANUAL = 'manual';
- const REASON_REFUNDED = 'refunded';
- const REASON_REFUNDED_AS_FRAUD = 'refunded_as_fraud';
- const REASON_RULE = 'rule';
+ public const REASON_APPROVED = 'approved';
+
+ public const REASON_DISPUTED = 'disputed';
+
+ public const REASON_MANUAL = 'manual';
+
+ public const REASON_REFUNDED = 'refunded';
+
+ public const REASON_REFUNDED_AS_FRAUD = 'refunded_as_fraud';
+
+ public const REASON_RULE = 'rule';
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -57,7 +62,7 @@ class Review extends ApiResource
*/
public function approve($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/approve';
+ $url = $this->instanceUrl() . '/approve';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
diff --git a/Stripe/Stripe/SearchResult.php b/Stripe/Stripe/SearchResult.php
index b600531..49d46b4 100755
--- a/Stripe/Stripe/SearchResult.php
+++ b/Stripe/Stripe/SearchResult.php
@@ -1,4 +1,4 @@
-
*
- * @property string $object
- * @property string $url
- * @property string $next_page
- * @property int $total_count
- * @property bool $has_more
+ * @property string $object
+ * @property string $url
+ * @property string $next_page
+ * @property int $total_count
+ * @property bool $has_more
* @property TStripeObject[] $data
*/
class SearchResult extends StripeObject implements \Countable, \IteratorAggregate
{
- const OBJECT_NAME = 'search_result';
+ public const OBJECT_NAME = 'search_result';
use ApiOperations\Request;
@@ -57,7 +57,7 @@ class SearchResult extends StripeObject implements \Countable, \IteratorAggregat
*
* @param array $filters the filters
*/
- public function setFilters($filters)
+ public function setFilters($filters) : void
{
$this->filters = $filters;
}
@@ -80,7 +80,7 @@ class SearchResult extends StripeObject implements \Countable, \IteratorAggregat
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws Exception\ApiErrorException
@@ -93,10 +93,10 @@ class SearchResult extends StripeObject implements \Countable, \IteratorAggregat
list($url, $params) = $this->extractPathAndUpdateParams($params);
list($response, $opts) = $this->_request('get', $url, $params, $opts);
- $obj = Util\Util::convertToStripeObject($response, $opts);
- if (!($obj instanceof \Stripe\SearchResult)) {
+ $obj = Util\Util::convertToStripeObject($response, $opts);
+ if (!($obj instanceof self)) {
throw new \Stripe\Exception\UnexpectedValueException(
- 'Expected type ' . \Stripe\SearchResult::class . ', got "' . \get_class($obj) . '" instead.'
+ 'Expected type ' . self::class . ', got "' . \get_class($obj) . '" instead.'
);
}
$obj->setFilters($params);
@@ -115,7 +115,7 @@ class SearchResult extends StripeObject implements \Countable, \IteratorAggregat
/**
* @return \ArrayIterator an iterator that can be used to iterate
- * across objects in the current page
+ * across objects in the current page
*/
#[\ReturnTypeWillChange]
public function getIterator()
@@ -125,9 +125,9 @@ class SearchResult extends StripeObject implements \Countable, \IteratorAggregat
/**
* @return \Generator|TStripeObject[] A generator that can be used to
- * iterate across all objects across all pages. As page boundaries are
- * encountered, the next page will be fetched automatically for
- * continued iteration.
+ * iterate across all objects across all pages. As page boundaries are
+ * encountered, the next page will be fetched automatically for
+ * continued iteration.
*/
public function autoPagingIterator()
{
@@ -157,7 +157,7 @@ class SearchResult extends StripeObject implements \Countable, \IteratorAggregat
*/
public static function emptySearchResult($opts = null)
{
- return SearchResult::constructFrom(['data' => []], $opts);
+ return self::constructFrom(['data' => []], $opts);
}
/**
@@ -176,7 +176,7 @@ class SearchResult extends StripeObject implements \Countable, \IteratorAggregat
* This method will try to respect the limit of the current page. If none
* was given, the default limit will be fetched again.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @return SearchResultexecutive parameter, you cannot delete the only verified
* executive on file.
*
- * @param string $parentId
- * @param string $id
- * @param null|array $params
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -214,8 +214,8 @@ class AccountService extends \Stripe\Service\AbstractService
* Test-mode Custom and Express accounts can be rejected at any time. Accounts
* created using live-mode keys may only be rejected once all balances are zero.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -230,9 +230,9 @@ class AccountService extends \Stripe\Service\AbstractService
/**
* Retrieves information about the specified Account Capability.
*
- * @param string $parentId
- * @param string $id
- * @param null|array $params
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -247,9 +247,9 @@ class AccountService extends \Stripe\Service\AbstractService
/**
* Retrieve a specified external account for a given account.
*
- * @param string $parentId
- * @param string $id
- * @param null|array $params
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -264,9 +264,9 @@ class AccountService extends \Stripe\Service\AbstractService
/**
* Retrieves an existing person.
*
- * @param string $parentId
- * @param string $id
- * @param null|array $params
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -290,8 +290,8 @@ class AccountService extends \Stripe\Service\AbstractService
* href="/docs/connect/updating-accounts">Connect documentation to learn more
* about updating accounts.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -306,9 +306,9 @@ class AccountService extends \Stripe\Service\AbstractService
/**
* Updates an existing Account Capability.
*
- * @param string $parentId
- * @param string $id
- * @param null|array $params
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -329,9 +329,9 @@ class AccountService extends \Stripe\Service\AbstractService
* You can re-enable a disabled bank account by performing an update call without
* providing any arguments or changes.
*
- * @param string $parentId
- * @param string $id
- * @param null|array $params
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -346,9 +346,9 @@ class AccountService extends \Stripe\Service\AbstractService
/**
* Updates an existing person.
*
- * @param string $parentId
- * @param string $id
- * @param null|array $params
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -363,8 +363,8 @@ class AccountService extends \Stripe\Service\AbstractService
/**
* Retrieves the details of an account.
*
- * @param null|string $id
- * @param null|array $params
+ * @param null|string $id
+ * @param null|array $params
* @param null|array|StripeUtilRequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -373,7 +373,7 @@ class AccountService extends \Stripe\Service\AbstractService
*/
public function retrieve($id = null, $params = null, $opts = null)
{
- if (null === $id) {
+ if ($id === null) {
return $this->request('get', '/v1/account', $params, $opts);
}
diff --git a/Stripe/Stripe/Service/ApplePayDomainService.php b/Stripe/Stripe/Service/ApplePayDomainService.php
index 3a076f4..7e2e2bd 100755
--- a/Stripe/Stripe/Service/ApplePayDomainService.php
+++ b/Stripe/Stripe/Service/ApplePayDomainService.php
@@ -1,4 +1,4 @@
-limit and starting_after parameters to
* page through additional refunds.
*
- * @param string $parentId
- * @param null|array $params
+ * @param string $parentId
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -54,8 +54,8 @@ class ApplicationFeeService extends \Stripe\Service\AbstractService
* will raise an error when called on an already-refunded application fee, or when
* trying to refund more money than is left on an application fee.
*
- * @param string $parentId
- * @param null|array $params
+ * @param string $parentId
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -71,8 +71,8 @@ class ApplicationFeeService extends \Stripe\Service\AbstractService
* Retrieves the details of an application fee that your account has collected. The
* same information is returned when refunding the application fee.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -89,9 +89,9 @@ class ApplicationFeeService extends \Stripe\Service\AbstractService
* application fee object, but you can also retrieve details about a specific
* refund stored on the application fee.
*
- * @param string $parentId
- * @param string $id
- * @param null|array $params
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -109,9 +109,9 @@ class ApplicationFeeService extends \Stripe\Service\AbstractService
*
* This request only accepts metadata as an argument.
*
- * @param string $parentId
- * @param string $id
- * @param null|array $params
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/Apps/AppsServiceFactory.php b/Stripe/Stripe/Service/Apps/AppsServiceFactory.php
index 39f3734..e3ca54c 100755
--- a/Stripe/Stripe/Service/Apps/AppsServiceFactory.php
+++ b/Stripe/Stripe/Service/Apps/AppsServiceFactory.php
@@ -1,4 +1,4 @@
-Accounting
* for negative balances.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/BalanceTransactionService.php b/Stripe/Stripe/Service/BalanceTransactionService.php
index 9e6d37c..5cb02c2 100755
--- a/Stripe/Stripe/Service/BalanceTransactionService.php
+++ b/Stripe/Stripe/Service/BalanceTransactionService.php
@@ -1,4 +1,4 @@
-/v1/balance/history.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -32,8 +32,8 @@ class BalanceTransactionService extends \Stripe\Service\AbstractService
* Note that this endpoint previously used the path
* /v1/balance/history/:id.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/BillingPortal/BillingPortalServiceFactory.php b/Stripe/Stripe/Service/BillingPortal/BillingPortalServiceFactory.php
index 23a4d30..95d9f64 100755
--- a/Stripe/Stripe/Service/BillingPortal/BillingPortalServiceFactory.php
+++ b/Stripe/Stripe/Service/BillingPortal/BillingPortalServiceFactory.php
@@ -1,4 +1,4 @@
- ConfigurationService::class,
- 'sessions' => SessionService::class,
+ 'sessions' => SessionService::class,
];
protected function getServiceClass($name)
diff --git a/Stripe/Stripe/Service/BillingPortal/ConfigurationService.php b/Stripe/Stripe/Service/BillingPortal/ConfigurationService.php
index 11d1a5a..3fec5fd 100755
--- a/Stripe/Stripe/Service/BillingPortal/ConfigurationService.php
+++ b/Stripe/Stripe/Service/BillingPortal/ConfigurationService.php
@@ -1,4 +1,4 @@
-
*/
private static $classMap = [
- 'accountLinks' => AccountLinkService::class,
- 'accounts' => AccountService::class,
- 'applePayDomains' => ApplePayDomainService::class,
- 'applicationFees' => ApplicationFeeService::class,
- 'apps' => Apps\AppsServiceFactory::class,
- 'balance' => BalanceService::class,
- 'balanceTransactions' => BalanceTransactionService::class,
- 'billingPortal' => BillingPortal\BillingPortalServiceFactory::class,
- 'charges' => ChargeService::class,
- 'checkout' => Checkout\CheckoutServiceFactory::class,
- 'countrySpecs' => CountrySpecService::class,
- 'coupons' => CouponService::class,
- 'creditNotes' => CreditNoteService::class,
- 'customers' => CustomerService::class,
- 'disputes' => DisputeService::class,
- 'ephemeralKeys' => EphemeralKeyService::class,
- 'events' => EventService::class,
- 'exchangeRates' => ExchangeRateService::class,
- 'fileLinks' => FileLinkService::class,
- 'files' => FileService::class,
- 'financialConnections' => FinancialConnections\FinancialConnectionsServiceFactory::class,
- 'identity' => Identity\IdentityServiceFactory::class,
- 'invoiceItems' => InvoiceItemService::class,
- 'invoices' => InvoiceService::class,
- 'issuing' => Issuing\IssuingServiceFactory::class,
- 'mandates' => MandateService::class,
- 'oauth' => OAuthService::class,
- 'paymentIntents' => PaymentIntentService::class,
- 'paymentLinks' => PaymentLinkService::class,
- 'paymentMethods' => PaymentMethodService::class,
- 'payouts' => PayoutService::class,
- 'plans' => PlanService::class,
- 'prices' => PriceService::class,
- 'products' => ProductService::class,
- 'promotionCodes' => PromotionCodeService::class,
- 'quotes' => QuoteService::class,
- 'radar' => Radar\RadarServiceFactory::class,
- 'refunds' => RefundService::class,
- 'reporting' => Reporting\ReportingServiceFactory::class,
- 'reviews' => ReviewService::class,
- 'setupAttempts' => SetupAttemptService::class,
- 'setupIntents' => SetupIntentService::class,
- 'shippingRates' => ShippingRateService::class,
- 'sigma' => Sigma\SigmaServiceFactory::class,
- 'sources' => SourceService::class,
- 'subscriptionItems' => SubscriptionItemService::class,
- 'subscriptions' => SubscriptionService::class,
+ 'accountLinks' => AccountLinkService::class,
+ 'accounts' => AccountService::class,
+ 'applePayDomains' => ApplePayDomainService::class,
+ 'applicationFees' => ApplicationFeeService::class,
+ 'apps' => Apps\AppsServiceFactory::class,
+ 'balance' => BalanceService::class,
+ 'balanceTransactions' => BalanceTransactionService::class,
+ 'billingPortal' => BillingPortal\BillingPortalServiceFactory::class,
+ 'charges' => ChargeService::class,
+ 'checkout' => Checkout\CheckoutServiceFactory::class,
+ 'countrySpecs' => CountrySpecService::class,
+ 'coupons' => CouponService::class,
+ 'creditNotes' => CreditNoteService::class,
+ 'customers' => CustomerService::class,
+ 'disputes' => DisputeService::class,
+ 'ephemeralKeys' => EphemeralKeyService::class,
+ 'events' => EventService::class,
+ 'exchangeRates' => ExchangeRateService::class,
+ 'fileLinks' => FileLinkService::class,
+ 'files' => FileService::class,
+ 'financialConnections' => FinancialConnections\FinancialConnectionsServiceFactory::class,
+ 'identity' => Identity\IdentityServiceFactory::class,
+ 'invoiceItems' => InvoiceItemService::class,
+ 'invoices' => InvoiceService::class,
+ 'issuing' => Issuing\IssuingServiceFactory::class,
+ 'mandates' => MandateService::class,
+ 'oauth' => OAuthService::class,
+ 'paymentIntents' => PaymentIntentService::class,
+ 'paymentLinks' => PaymentLinkService::class,
+ 'paymentMethods' => PaymentMethodService::class,
+ 'payouts' => PayoutService::class,
+ 'plans' => PlanService::class,
+ 'prices' => PriceService::class,
+ 'products' => ProductService::class,
+ 'promotionCodes' => PromotionCodeService::class,
+ 'quotes' => QuoteService::class,
+ 'radar' => Radar\RadarServiceFactory::class,
+ 'refunds' => RefundService::class,
+ 'reporting' => Reporting\ReportingServiceFactory::class,
+ 'reviews' => ReviewService::class,
+ 'setupAttempts' => SetupAttemptService::class,
+ 'setupIntents' => SetupIntentService::class,
+ 'shippingRates' => ShippingRateService::class,
+ 'sigma' => Sigma\SigmaServiceFactory::class,
+ 'sources' => SourceService::class,
+ 'subscriptionItems' => SubscriptionItemService::class,
+ 'subscriptions' => SubscriptionService::class,
'subscriptionSchedules' => SubscriptionScheduleService::class,
- 'taxCodes' => TaxCodeService::class,
- 'taxRates' => TaxRateService::class,
- 'terminal' => Terminal\TerminalServiceFactory::class,
- 'testHelpers' => TestHelpers\TestHelpersServiceFactory::class,
- 'tokens' => TokenService::class,
- 'topups' => TopupService::class,
- 'transfers' => TransferService::class,
- 'treasury' => Treasury\TreasuryServiceFactory::class,
- 'webhookEndpoints' => WebhookEndpointService::class,
+ 'taxCodes' => TaxCodeService::class,
+ 'taxRates' => TaxRateService::class,
+ 'terminal' => Terminal\TerminalServiceFactory::class,
+ 'testHelpers' => TestHelpers\TestHelpersServiceFactory::class,
+ 'tokens' => TokenService::class,
+ 'topups' => TopupService::class,
+ 'transfers' => TransferService::class,
+ 'treasury' => Treasury\TreasuryServiceFactory::class,
+ 'webhookEndpoints' => WebhookEndpointService::class,
];
protected function getServiceClass($name)
diff --git a/Stripe/Stripe/Service/CountrySpecService.php b/Stripe/Stripe/Service/CountrySpecService.php
index 8f3869f..f18e9db 100755
--- a/Stripe/Stripe/Service/CountrySpecService.php
+++ b/Stripe/Stripe/Service/CountrySpecService.php
@@ -1,4 +1,4 @@
-amount_off of status at the time of credit note creation.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -76,7 +76,7 @@ class CreditNoteService extends \Stripe\Service\AbstractService
/**
* Get a preview of a credit note without creating it.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -93,7 +93,7 @@ class CreditNoteService extends \Stripe\Service\AbstractService
* property containing the first handful of those items. This URL you can retrieve
* the full (paginated) list of line items.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -108,8 +108,8 @@ class CreditNoteService extends \Stripe\Service\AbstractService
/**
* Retrieves the credit note object with the given identifier.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -124,8 +124,8 @@ class CreditNoteService extends \Stripe\Service\AbstractService
/**
* Updates an existing credit note.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -141,8 +141,8 @@ class CreditNoteService extends \Stripe\Service\AbstractService
* Marks a credit note as void. Learn more about voiding credit notes.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/CustomerService.php b/Stripe/Stripe/Service/CustomerService.php
index 5cb7910..9de7828 100755
--- a/Stripe/Stripe/Service/CustomerService.php
+++ b/Stripe/Stripe/Service/CustomerService.php
@@ -1,4 +1,4 @@
-balances.
*
- * @param string $parentId
- * @param null|array $params
+ * @param string $parentId
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -43,8 +43,8 @@ class CustomerService extends \Stripe\Service\AbstractService
* Returns a list of transactions that modified the customer’s cash balance.
*
- * @param string $parentId
- * @param null|array $params
+ * @param string $parentId
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -59,8 +59,8 @@ class CustomerService extends \Stripe\Service\AbstractService
/**
* Returns a list of PaymentMethods for a given Customer.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -75,8 +75,8 @@ class CustomerService extends \Stripe\Service\AbstractService
/**
* List sources for a specified customer.
*
- * @param string $parentId
- * @param null|array $params
+ * @param string $parentId
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -91,8 +91,8 @@ class CustomerService extends \Stripe\Service\AbstractService
/**
* Returns a list of tax IDs for a customer.
*
- * @param string $parentId
- * @param null|array $params
+ * @param string $parentId
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -107,7 +107,7 @@ class CustomerService extends \Stripe\Service\AbstractService
/**
* Creates a new customer object.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -123,8 +123,8 @@ class CustomerService extends \Stripe\Service\AbstractService
* Creates an immutable transaction that updates the customer’s credit balance.
*
- * @param string $parentId
- * @param null|array $params
+ * @param string $parentId
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -143,8 +143,8 @@ class CustomerService extends \Stripe\Service\AbstractService
* the same funding instructions will be retrieved. In other words, we will return
* the same funding instructions each time.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -165,8 +165,8 @@ class CustomerService extends \Stripe\Service\AbstractService
* To change the default, you should update the
* customer to have a new default_source.
*
- * @param string $parentId
- * @param null|array $params
+ * @param string $parentId
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -181,8 +181,8 @@ class CustomerService extends \Stripe\Service\AbstractService
/**
* Creates a new TaxID object for a customer.
*
- * @param string $parentId
- * @param null|array $params
+ * @param string $parentId
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -198,8 +198,8 @@ class CustomerService extends \Stripe\Service\AbstractService
* Permanently deletes a customer. It cannot be undone. Also immediately cancels
* any active subscriptions on the customer.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -214,8 +214,8 @@ class CustomerService extends \Stripe\Service\AbstractService
/**
* Removes the currently applied discount on a customer.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -228,9 +228,9 @@ class CustomerService extends \Stripe\Service\AbstractService
}
/**
- * @param string $parentId
- * @param string $id
- * @param null|array $params
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -245,9 +245,9 @@ class CustomerService extends \Stripe\Service\AbstractService
/**
* Deletes an existing TaxID object.
*
- * @param string $parentId
- * @param string $id
- * @param null|array $params
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -262,8 +262,8 @@ class CustomerService extends \Stripe\Service\AbstractService
/**
* Retrieves a Customer object.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -279,9 +279,9 @@ class CustomerService extends \Stripe\Service\AbstractService
* Retrieves a specific customer balance transaction that updated the customer’s balances.
*
- * @param string $parentId
- * @param string $id
- * @param null|array $params
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -296,8 +296,8 @@ class CustomerService extends \Stripe\Service\AbstractService
/**
* Retrieves a customer’s cash balance.
*
- * @param string $parentId
- * @param null|array $params
+ * @param string $parentId
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -313,9 +313,9 @@ class CustomerService extends \Stripe\Service\AbstractService
* Retrieves a specific cash balance transaction, which updated the customer’s cash balance.
*
- * @param string $parentId
- * @param string $id
- * @param null|array $params
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -330,9 +330,9 @@ class CustomerService extends \Stripe\Service\AbstractService
/**
* Retrieves a PaymentMethod object for a given Customer.
*
- * @param string $parentId
- * @param string $id
- * @param null|array $params
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -347,9 +347,9 @@ class CustomerService extends \Stripe\Service\AbstractService
/**
* Retrieve a specified source for a given customer.
*
- * @param string $parentId
- * @param string $id
- * @param null|array $params
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -364,9 +364,9 @@ class CustomerService extends \Stripe\Service\AbstractService
/**
* Retrieves the TaxID object with the given identifier.
*
- * @param string $parentId
- * @param string $id
- * @param null|array $params
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -386,7 +386,7 @@ class CustomerService extends \Stripe\Service\AbstractService
* Occasionally, propagation of new or updated data can be up to an hour behind
* during outages. Search functionality is not available to merchants in India.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -413,8 +413,8 @@ class CustomerService extends \Stripe\Service\AbstractService
*
* This request accepts mostly the same arguments as the customer creation call.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -430,9 +430,9 @@ class CustomerService extends \Stripe\Service\AbstractService
* Most credit balance transaction fields are immutable, but you may update its
* description and metadata.
*
- * @param string $parentId
- * @param string $id
- * @param null|array $params
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -447,8 +447,8 @@ class CustomerService extends \Stripe\Service\AbstractService
/**
* Changes the settings on a customer’s cash balance.
*
- * @param string $parentId
- * @param null|array $params
+ * @param string $parentId
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -461,9 +461,9 @@ class CustomerService extends \Stripe\Service\AbstractService
}
/**
- * @param string $parentId
- * @param string $id
- * @param null|array $params
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -476,9 +476,9 @@ class CustomerService extends \Stripe\Service\AbstractService
}
/**
- * @param string $parentId
- * @param string $id
- * @param null|array $params
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/DisputeService.php b/Stripe/Stripe/Service/DisputeService.php
index 86d3584..62c0b84 100755
--- a/Stripe/Stripe/Service/DisputeService.php
+++ b/Stripe/Stripe/Service/DisputeService.php
@@ -1,4 +1,4 @@
-needs_response to
* lost. Closing a dispute is irreversible.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -44,8 +44,8 @@ class DisputeService extends \Stripe\Service\AbstractService
/**
* Retrieves the dispute with the given ID.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -68,8 +68,8 @@ class DisputeService extends \Stripe\Service\AbstractService
* chance of winning your dispute. To figure out which evidence fields to provide,
* see our guide to dispute types.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/EphemeralKeyService.php b/Stripe/Stripe/Service/EphemeralKeyService.php
index 3ca14c9..7019b65 100755
--- a/Stripe/Stripe/Service/EphemeralKeyService.php
+++ b/Stripe/Stripe/Service/EphemeralKeyService.php
@@ -1,4 +1,4 @@
-Stripe-Version header).
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -29,8 +29,8 @@ class EventService extends \Stripe\Service\AbstractService
* Retrieves the details of an event. Supply the unique identifier of the event,
* which you might have received in a webhook.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/ExchangeRateService.php b/Stripe/Stripe/Service/ExchangeRateService.php
index fe010b0..734e93c 100755
--- a/Stripe/Stripe/Service/ExchangeRateService.php
+++ b/Stripe/Stripe/Service/ExchangeRateService.php
@@ -1,4 +1,4 @@
-File Upload
* Guide.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -45,7 +45,7 @@ class FileService extends \Stripe\Service\AbstractService
/**
* Create a file.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @return \Stripe\File
diff --git a/Stripe/Stripe/Service/FinancialConnections/AccountService.php b/Stripe/Stripe/Service/FinancialConnections/AccountService.php
index 213d172..40d61ff 100755
--- a/Stripe/Stripe/Service/FinancialConnections/AccountService.php
+++ b/Stripe/Stripe/Service/FinancialConnections/AccountService.php
@@ -1,4 +1,4 @@
-Account objects.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -24,8 +24,8 @@ class AccountService extends \Stripe\Service\AbstractService
/**
* Lists all owners for a given Account.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -42,8 +42,8 @@ class AccountService extends \Stripe\Service\AbstractService
* no longer be able to access data associated with the account (e.g. balances,
* transactions).
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -58,8 +58,8 @@ class AccountService extends \Stripe\Service\AbstractService
/**
* Refreshes the data associated with a Financial Connections Account.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -74,8 +74,8 @@ class AccountService extends \Stripe\Service\AbstractService
/**
* Retrieves the details of an Financial Connections Account.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/FinancialConnections/FinancialConnectionsServiceFactory.php b/Stripe/Stripe/Service/FinancialConnections/FinancialConnectionsServiceFactory.php
index 7dd8263..2ff22c7 100755
--- a/Stripe/Stripe/Service/FinancialConnections/FinancialConnectionsServiceFactory.php
+++ b/Stripe/Stripe/Service/FinancialConnections/FinancialConnectionsServiceFactory.php
@@ -1,4 +1,4 @@
-Session. The session’s client_secret can be used to
* launch the flow using Stripe.js.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -26,8 +26,8 @@ class SessionService extends \Stripe\Service\AbstractService
/**
* Retrieves the details of a Financial Connections Session.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/Identity/IdentityServiceFactory.php b/Stripe/Stripe/Service/Identity/IdentityServiceFactory.php
index cf63146..4affc5c 100755
--- a/Stripe/Stripe/Service/Identity/IdentityServiceFactory.php
+++ b/Stripe/Stripe/Service/Identity/IdentityServiceFactory.php
@@ -1,4 +1,4 @@
-
*/
private static $classMap = [
- 'verificationReports' => VerificationReportService::class,
+ 'verificationReports' => VerificationReportService::class,
'verificationSessions' => VerificationSessionService::class,
];
diff --git a/Stripe/Stripe/Service/Identity/VerificationReportService.php b/Stripe/Stripe/Service/Identity/VerificationReportService.php
index 9289d9d..0ca774d 100755
--- a/Stripe/Stripe/Service/Identity/VerificationReportService.php
+++ b/Stripe/Stripe/Service/Identity/VerificationReportService.php
@@ -1,4 +1,4 @@
-Learn more.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -55,7 +55,7 @@ class VerificationSessionService extends \Stripe\Service\AbstractService
* Related guide: Verify your
* users’ identity documents.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -92,8 +92,8 @@ class VerificationSessionService extends \Stripe\Service\AbstractService
*
* Learn more.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -112,8 +112,8 @@ class VerificationSessionService extends \Stripe\Service\AbstractService
* to retrieve a valid client_secret or url to allow
* re-submission.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -131,8 +131,8 @@ class VerificationSessionService extends \Stripe\Service\AbstractService
* When the session status is requires_input, you can use this method
* to update the verification check and options.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/InvoiceItemService.php b/Stripe/Stripe/Service/InvoiceItemService.php
index 45e2072..5573099 100755
--- a/Stripe/Stripe/Service/InvoiceItemService.php
+++ b/Stripe/Stripe/Service/InvoiceItemService.php
@@ -1,4 +1,4 @@
-pay or send
* the invoice to your customers.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -66,8 +66,8 @@ class InvoiceService extends \Stripe\Service\AbstractService
* has been finalized or if an invoice is for a subscription, it must be voided.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -84,8 +84,8 @@ class InvoiceService extends \Stripe\Service\AbstractService
* invoices. However, if you’d like to finalize a draft invoice manually, you can
* do so using this method.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -101,8 +101,8 @@ class InvoiceService extends \Stripe\Service\AbstractService
* Marking an invoice as uncollectible is useful for keeping track of bad debts
* that can be written off for accounting purposes.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -121,8 +121,8 @@ class InvoiceService extends \Stripe\Service\AbstractService
* settings. However, if you’d like to attempt payment on an invoice out of the
* normal collection schedule or for some other reason, you can do so.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -137,8 +137,8 @@ class InvoiceService extends \Stripe\Service\AbstractService
/**
* Retrieves the invoice with the given ID.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -158,7 +158,7 @@ class InvoiceService extends \Stripe\Service\AbstractService
* Occasionally, propagation of new or updated data can be up to an hour behind
* during outages. Search functionality is not available to merchants in India.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -180,8 +180,8 @@ class InvoiceService extends \Stripe\Service\AbstractService
* Requests made in test-mode result in no emails being sent, despite sending an
* invoice.sent event.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -216,7 +216,7 @@ class InvoiceService extends \Stripe\Service\AbstractService
* consider only proration line items where period[start] is equal to
* the subscription_proration_date on the upcoming invoice resource.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -234,7 +234,7 @@ class InvoiceService extends \Stripe\Service\AbstractService
* items. There is also a URL where you can retrieve the full (paginated) list of
* line items.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -256,8 +256,8 @@ class InvoiceService extends \Stripe\Service\AbstractService
* href="/docs/billing/invoices/reconciliation">automatically reconciling
* invoices, pass auto_advance=false.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -275,8 +275,8 @@ class InvoiceService extends \Stripe\Service\AbstractService
* finalized invoices and maintains a papertrail where the invoice can still be
* found.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/Issuing/AuthorizationService.php b/Stripe/Stripe/Service/Issuing/AuthorizationService.php
index d36f48e..46aeebf 100755
--- a/Stripe/Stripe/Service/Issuing/AuthorizationService.php
+++ b/Stripe/Stripe/Service/Issuing/AuthorizationService.php
@@ -1,4 +1,4 @@
-here.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -52,8 +52,8 @@ class AuthorizationService extends \Stripe\Service\AbstractService
* decline an authorization (preferred). More details can be found here.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -68,8 +68,8 @@ class AuthorizationService extends \Stripe\Service\AbstractService
/**
* Retrieves an Issuing Authorization object.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -86,8 +86,8 @@ class AuthorizationService extends \Stripe\Service\AbstractService
* values of the parameters passed. Any parameters not provided will be left
* unchanged.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/Issuing/CardService.php b/Stripe/Stripe/Service/Issuing/CardService.php
index 22b7e54..7eaffa8 100755
--- a/Stripe/Stripe/Service/Issuing/CardService.php
+++ b/Stripe/Stripe/Service/Issuing/CardService.php
@@ -1,4 +1,4 @@
-Card object.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -41,8 +41,8 @@ class CardService extends \Stripe\Service\AbstractService
/**
* Retrieves an Issuing Card object.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -58,8 +58,8 @@ class CardService extends \Stripe\Service\AbstractService
* Updates the specified Issuing Card object by setting the values of
* the parameters passed. Any parameters not provided will be left unchanged.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/Issuing/CardholderService.php b/Stripe/Stripe/Service/Issuing/CardholderService.php
index 65e675b..a5c1df6 100755
--- a/Stripe/Stripe/Service/Issuing/CardholderService.php
+++ b/Stripe/Stripe/Service/Issuing/CardholderService.php
@@ -1,4 +1,4 @@
-Cardholder object that can be issued cards.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -41,8 +41,8 @@ class CardholderService extends \Stripe\Service\AbstractService
/**
* Retrieves an Issuing Cardholder object.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -59,8 +59,8 @@ class CardholderService extends \Stripe\Service\AbstractService
* values of the parameters passed. Any parameters not provided will be left
* unchanged.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/Issuing/DisputeService.php b/Stripe/Stripe/Service/Issuing/DisputeService.php
index 45c2528..38e4dc3 100755
--- a/Stripe/Stripe/Service/Issuing/DisputeService.php
+++ b/Stripe/Stripe/Service/Issuing/DisputeService.php
@@ -1,4 +1,4 @@
-Dispute
* reasons and evidence for more details about evidence requirements.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -45,8 +45,8 @@ class DisputeService extends \Stripe\Service\AbstractService
/**
* Retrieves an Issuing Dispute object.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -65,8 +65,8 @@ class DisputeService extends \Stripe\Service\AbstractService
* href="/docs/issuing/purchases/disputes#dispute-reasons-and-evidence">Dispute
* reasons and evidence.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -84,8 +84,8 @@ class DisputeService extends \Stripe\Service\AbstractService
* Properties on the evidence object can be unset by passing in an
* empty string.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/Issuing/IssuingServiceFactory.php b/Stripe/Stripe/Service/Issuing/IssuingServiceFactory.php
index a8d5d0f..8fa897e 100755
--- a/Stripe/Stripe/Service/Issuing/IssuingServiceFactory.php
+++ b/Stripe/Stripe/Service/Issuing/IssuingServiceFactory.php
@@ -1,4 +1,4 @@
- AuthorizationService::class,
- 'cardholders' => CardholderService::class,
- 'cards' => CardService::class,
- 'disputes' => DisputeService::class,
- 'transactions' => TransactionService::class,
+ 'cardholders' => CardholderService::class,
+ 'cards' => CardService::class,
+ 'disputes' => DisputeService::class,
+ 'transactions' => TransactionService::class,
];
protected function getServiceClass($name)
diff --git a/Stripe/Stripe/Service/Issuing/TransactionService.php b/Stripe/Stripe/Service/Issuing/TransactionService.php
index dd83b18..d003c43 100755
--- a/Stripe/Stripe/Service/Issuing/TransactionService.php
+++ b/Stripe/Stripe/Service/Issuing/TransactionService.php
@@ -1,4 +1,4 @@
-Transaction object.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -44,8 +44,8 @@ class TransactionService extends \Stripe\Service\AbstractService
* values of the parameters passed. Any parameters not provided will be left
* unchanged.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/MandateService.php b/Stripe/Stripe/Service/MandateService.php
index 156bff0..cc4821a 100755
--- a/Stripe/Stripe/Service/MandateService.php
+++ b/Stripe/Stripe/Service/MandateService.php
@@ -1,4 +1,4 @@
-_parseOpts($opts);
+ $opts = $this->_parseOpts($opts);
$opts->apiBase = $this->_getBase($opts);
return $this->request($method, $path, $params, $opts);
@@ -59,7 +59,7 @@ class OAuthService extends \Stripe\Service\AbstractService
*/
public function token($params = null, $opts = null)
{
- $params = $params ?: [];
+ $params = $params ?: [];
$params['client_secret'] = $this->_getClientSecret($params);
return $this->requestConnect('post', '/oauth/token', $params, $opts);
@@ -77,7 +77,7 @@ class OAuthService extends \Stripe\Service\AbstractService
*/
public function deauthorize($params = null, $opts = null)
{
- $params = $params ?: [];
+ $params = $params ?: [];
$params['client_id'] = $this->_getClientId($params);
return $this->requestConnect('post', '/oauth/deauthorize', $params, $opts);
@@ -87,10 +87,10 @@ class OAuthService extends \Stripe\Service\AbstractService
{
$clientId = ($params && \array_key_exists('client_id', $params)) ? $params['client_id'] : null;
- if (null === $clientId) {
+ if ($clientId === null) {
$clientId = $this->client->getClientId();
}
- if (null === $clientId) {
+ if ($clientId === null) {
$msg = 'No client_id provided. (HINT: set your client_id using '
. '`new \Stripe\StripeClient([clientId => confirm=true is supplied.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -179,8 +179,8 @@ class PaymentIntentService extends \Stripe\Service\AbstractService
* href="/docs/terminal/features/incremental-authorizations">incremental
* authorizations.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -202,8 +202,8 @@ class PaymentIntentService extends \Stripe\Service\AbstractService
* returned. Please refer to the payment
* intent object reference for more details.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -223,7 +223,7 @@ class PaymentIntentService extends \Stripe\Service\AbstractService
* Occasionally, propagation of new or updated data can be up to an hour behind
* during outages. Search functionality is not available to merchants in India.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -244,8 +244,8 @@ class PaymentIntentService extends \Stripe\Service\AbstractService
* and confirm at the same time, we recommend updating properties via the confirm API instead.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -260,8 +260,8 @@ class PaymentIntentService extends \Stripe\Service\AbstractService
/**
* Verifies microdeposits on a PaymentIntent object.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/PaymentLinkService.php b/Stripe/Stripe/Service/PaymentLinkService.php
index e5008d7..08e724f 100755
--- a/Stripe/Stripe/Service/PaymentLinkService.php
+++ b/Stripe/Stripe/Service/PaymentLinkService.php
@@ -1,4 +1,4 @@
-List a Customer’s
* PaymentMethods API instead.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -44,8 +44,8 @@ class PaymentMethodService extends \Stripe\Service\AbstractService
* href="/docs/api/customers/update#update_customer-invoice_settings-default_payment_method">invoice_settings.default_payment_method,
* on the Customer to the PaymentMethod’s ID.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -68,7 +68,7 @@ class PaymentMethodService extends \Stripe\Service\AbstractService
* href="/docs/payments/save-and-reuse">SetupIntent API to collect payment
* method details ahead of a future payment.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -84,8 +84,8 @@ class PaymentMethodService extends \Stripe\Service\AbstractService
* Detaches a PaymentMethod object from a Customer. After a PaymentMethod is
* detached, it can no longer be used for a payment or re-attached to a Customer.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -103,8 +103,8 @@ class PaymentMethodService extends \Stripe\Service\AbstractService
* href="/docs/api/payment_methods/customer">Retrieve a Customer’s
* PaymentMethods.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -120,8 +120,8 @@ class PaymentMethodService extends \Stripe\Service\AbstractService
* Updates a PaymentMethod object. A PaymentMethod must be attached a customer to
* be updated.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/PayoutService.php b/Stripe/Stripe/Service/PayoutService.php
index 4ca3561..a6f67a2 100755
--- a/Stripe/Stripe/Service/PayoutService.php
+++ b/Stripe/Stripe/Service/PayoutService.php
@@ -1,4 +1,4 @@
-balance object
* details available and pending amounts by source type.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -71,8 +71,8 @@ class PayoutService extends \Stripe\Service\AbstractService
* either a payout creation request or the payout list, and Stripe will return the
* corresponding payout information.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -94,8 +94,8 @@ class PayoutService extends \Stripe\Service\AbstractService
* that the authorized signatory of the selected bank account has authorized the
* debit on the bank account and that no other authorization is required.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -112,8 +112,8 @@ class PayoutService extends \Stripe\Service\AbstractService
* parameters not provided will be left unchanged. This request accepts only the
* metadata as arguments.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/PlanService.php b/Stripe/Stripe/Service/PlanService.php
index 6c0a8d4..089ad10 100755
--- a/Stripe/Stripe/Service/PlanService.php
+++ b/Stripe/Stripe/Service/PlanService.php
@@ -1,4 +1,4 @@
-. It replaces the Plans API and is backwards compatible to simplify your
* migration.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -42,8 +42,8 @@ class PlanService extends \Stripe\Service\AbstractService
* Deleting plans means new subscribers can’t be added. Existing subscribers aren’t
* affected.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -58,8 +58,8 @@ class PlanService extends \Stripe\Service\AbstractService
/**
* Retrieves the plan with the given ID.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -76,8 +76,8 @@ class PlanService extends \Stripe\Service\AbstractService
* parameters not provided are left unchanged. By design, you cannot change a
* plan’s ID, amount, currency, or billing cycle.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/PriceService.php b/Stripe/Stripe/Service/PriceService.php
index ef2b938..acb265b 100755
--- a/Stripe/Stripe/Service/PriceService.php
+++ b/Stripe/Stripe/Service/PriceService.php
@@ -1,4 +1,4 @@
-type=good
* is only possible if it has no SKUs associated with it.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -60,8 +60,8 @@ class ProductService extends \Stripe\Service\AbstractService
* either a product creation request or the product list, and Stripe will return
* the corresponding product information.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -81,7 +81,7 @@ class ProductService extends \Stripe\Service\AbstractService
* Occasionally, propagation of new or updated data can be up to an hour behind
* during outages. Search functionality is not available to merchants in India.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -97,8 +97,8 @@ class ProductService extends \Stripe\Service\AbstractService
* Updates the specific product by setting the values of the parameters passed. Any
* parameters not provided will be left unchanged.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/PromotionCodeService.php b/Stripe/Stripe/Service/PromotionCodeService.php
index 17461b4..3760aed 100755
--- a/Stripe/Stripe/Service/PromotionCodeService.php
+++ b/Stripe/Stripe/Service/PromotionCodeService.php
@@ -1,4 +1,4 @@
-list with the desired
* code.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -60,8 +60,8 @@ class PromotionCodeService extends \Stripe\Service\AbstractService
* Updates the specified promotion code by setting the values of the parameters
* passed. Most fields are, by design, not editable.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/QuoteService.php b/Stripe/Stripe/Service/QuoteService.php
index 05f0dfb..c69ddc6 100755
--- a/Stripe/Stripe/Service/QuoteService.php
+++ b/Stripe/Stripe/Service/QuoteService.php
@@ -1,4 +1,4 @@
-expires_at can be set in the dashboard via the quote template.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -111,8 +111,8 @@ class QuoteService extends \Stripe\Service\AbstractService
/**
* Finalizes the quote.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -127,8 +127,8 @@ class QuoteService extends \Stripe\Service\AbstractService
/**
* Retrieves the quote with the given ID.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -143,8 +143,8 @@ class QuoteService extends \Stripe\Service\AbstractService
/**
* A quote models prices and services for a customer.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -159,14 +159,14 @@ class QuoteService extends \Stripe\Service\AbstractService
/**
* Download the PDF for a finalized quote.
*
- * @param string $id
- * @param callable $readBodyChunkCallable
- * @param null|array $params
+ * @param string $id
+ * @param callable $readBodyChunkCallable
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*/
- public function pdf($id, $readBodyChunkCallable, $params = null, $opts = null)
+ public function pdf($id, $readBodyChunkCallable, $params = null, $opts = null) : void
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
if (!isset($opts->apiBase)) {
diff --git a/Stripe/Stripe/Service/Radar/EarlyFraudWarningService.php b/Stripe/Stripe/Service/Radar/EarlyFraudWarningService.php
index be119b4..32bd1d0 100755
--- a/Stripe/Stripe/Service/Radar/EarlyFraudWarningService.php
+++ b/Stripe/Stripe/Service/Radar/EarlyFraudWarningService.php
@@ -1,4 +1,4 @@
-early fraud
* warning object reference for more details.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/Radar/RadarServiceFactory.php b/Stripe/Stripe/Service/Radar/RadarServiceFactory.php
index b093c67..5d32f9d 100755
--- a/Stripe/Stripe/Service/Radar/RadarServiceFactory.php
+++ b/Stripe/Stripe/Service/Radar/RadarServiceFactory.php
@@ -1,4 +1,4 @@
- EarlyFraudWarningService::class,
- 'valueListItems' => ValueListItemService::class,
- 'valueLists' => ValueListService::class,
+ 'valueListItems' => ValueListItemService::class,
+ 'valueLists' => ValueListService::class,
];
protected function getServiceClass($name)
diff --git a/Stripe/Stripe/Service/Radar/ValueListItemService.php b/Stripe/Stripe/Service/Radar/ValueListItemService.php
index b9da3dd..10eec24 100755
--- a/Stripe/Stripe/Service/Radar/ValueListItemService.php
+++ b/Stripe/Stripe/Service/Radar/ValueListItemService.php
@@ -1,4 +1,4 @@
-ValueListItem object, which is added to the specified
* parent value list.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -43,8 +43,8 @@ class ValueListItemService extends \Stripe\Service\AbstractService
* Deletes a ValueListItem object, removing it from its parent value
* list.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -59,8 +59,8 @@ class ValueListItemService extends \Stripe\Service\AbstractService
/**
* Retrieves a ValueListItem object.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/Radar/ValueListService.php b/Stripe/Stripe/Service/Radar/ValueListService.php
index 70d9b48..30b93a9 100755
--- a/Stripe/Stripe/Service/Radar/ValueListService.php
+++ b/Stripe/Stripe/Service/Radar/ValueListService.php
@@ -1,4 +1,4 @@
-ValueList object, which can then be referenced in
* rules.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -44,8 +44,8 @@ class ValueListService extends \Stripe\Service\AbstractService
* within the value list. To be deleted, a value list must not be referenced in any
* rules.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -60,8 +60,8 @@ class ValueListService extends \Stripe\Service\AbstractService
/**
* Retrieves a ValueList object.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -78,8 +78,8 @@ class ValueListService extends \Stripe\Service\AbstractService
* passed. Any parameters not provided will be left unchanged. Note that
* item_type is immutable.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/RefundService.php b/Stripe/Stripe/Service/RefundService.php
index 772c0f6..1d72e74 100755
--- a/Stripe/Stripe/Service/RefundService.php
+++ b/Stripe/Stripe/Service/RefundService.php
@@ -1,4 +1,4 @@
-requires_action state.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -46,7 +46,7 @@ class RefundService extends \Stripe\Service\AbstractService
/**
* Create a refund.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -61,8 +61,8 @@ class RefundService extends \Stripe\Service\AbstractService
/**
* Retrieves the details of an existing refund.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -80,8 +80,8 @@ class RefundService extends \Stripe\Service\AbstractService
*
* This request only accepts metadata as an argument.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/Reporting/ReportRunService.php b/Stripe/Stripe/Service/Reporting/ReportRunService.php
index b62898f..2cb1721 100755
--- a/Stripe/Stripe/Service/Reporting/ReportRunService.php
+++ b/Stripe/Stripe/Service/Reporting/ReportRunService.php
@@ -1,4 +1,4 @@
-live-mode API key.).
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -40,8 +40,8 @@ class ReportRunService extends \Stripe\Service\AbstractService
/**
* Retrieves the details of an existing Report Run.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/Reporting/ReportTypeService.php b/Stripe/Stripe/Service/Reporting/ReportTypeService.php
index 7fa5038..5172ed4 100755
--- a/Stripe/Stripe/Service/Reporting/ReportTypeService.php
+++ b/Stripe/Stripe/Service/Reporting/ReportTypeService.php
@@ -1,4 +1,4 @@
-live-mode API key.).
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/Reporting/ReportingServiceFactory.php b/Stripe/Stripe/Service/Reporting/ReportingServiceFactory.php
index 7832e91..0da168a 100755
--- a/Stripe/Stripe/Service/Reporting/ReportingServiceFactory.php
+++ b/Stripe/Stripe/Service/Reporting/ReportingServiceFactory.php
@@ -1,4 +1,4 @@
-
*/
private static $classMap = [
- 'reportRuns' => ReportRunService::class,
+ 'reportRuns' => ReportRunService::class,
'reportTypes' => ReportTypeService::class,
];
diff --git a/Stripe/Stripe/Service/ReviewService.php b/Stripe/Stripe/Service/ReviewService.php
index 3bcd325..67cb7e8 100755
--- a/Stripe/Stripe/Service/ReviewService.php
+++ b/Stripe/Stripe/Service/ReviewService.php
@@ -1,4 +1,4 @@
-true. The objects are sorted in descending order by creation date,
* with the most recently created object appearing first.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -27,8 +27,8 @@ class ReviewService extends \Stripe\Service\AbstractService
* Approves a Review object, closing it and removing it from the list
* of reviews.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -43,8 +43,8 @@ class ReviewService extends \Stripe\Service\AbstractService
/**
* Retrieves a Review object.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/SetupAttemptService.php b/Stripe/Stripe/Service/SetupAttemptService.php
index 8657441..c5c91e9 100755
--- a/Stripe/Stripe/Service/SetupAttemptService.php
+++ b/Stripe/Stripe/Service/SetupAttemptService.php
@@ -1,4 +1,4 @@
-next_action. If setup fails, the
* SetupIntent will transition to the requires_payment_method status.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -74,7 +74,7 @@ class SetupIntentService extends \Stripe\Service\AbstractService
* href="/docs/api/setup_intents/confirm">confirm to collect any required
* permissions to charge the payment method later.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -96,8 +96,8 @@ class SetupIntentService extends \Stripe\Service\AbstractService
* returned. Please refer to the SetupIntent
* object reference for more details.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -112,8 +112,8 @@ class SetupIntentService extends \Stripe\Service\AbstractService
/**
* Updates a SetupIntent object.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -128,8 +128,8 @@ class SetupIntentService extends \Stripe\Service\AbstractService
/**
* Verifies microdeposits on a SetupIntent object.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/ShippingRateService.php b/Stripe/Stripe/Service/ShippingRateService.php
index d141e48..046533d 100755
--- a/Stripe/Stripe/Service/ShippingRateService.php
+++ b/Stripe/Stripe/Service/ShippingRateService.php
@@ -1,4 +1,4 @@
-payment method
* guides for more detail.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -97,8 +97,8 @@ class SourceService extends \Stripe\Service\AbstractService
/**
* Verify a given source.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/SubscriptionItemService.php b/Stripe/Stripe/Service/SubscriptionItemService.php
index e18c8de..b7bbfe7 100755
--- a/Stripe/Stripe/Service/SubscriptionItemService.php
+++ b/Stripe/Stripe/Service/SubscriptionItemService.php
@@ -1,4 +1,4 @@
-tiered pricing
* model.
*
- * @param string $parentId
- * @param null|array $params
+ * @param string $parentId
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -104,8 +104,8 @@ class SubscriptionItemService extends \Stripe\Service\AbstractService
* Deletes an item from the subscription. Removing a subscription item from a
* subscription will not cancel the subscription.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -120,8 +120,8 @@ class SubscriptionItemService extends \Stripe\Service\AbstractService
/**
* Retrieves the subscription item with the given ID.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -136,8 +136,8 @@ class SubscriptionItemService extends \Stripe\Service\AbstractService
/**
* Updates the plan or quantity of an item on a current subscription.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/SubscriptionScheduleService.php b/Stripe/Stripe/Service/SubscriptionScheduleService.php
index 42aaf6b..69527eb 100755
--- a/Stripe/Stripe/Service/SubscriptionScheduleService.php
+++ b/Stripe/Stripe/Service/SubscriptionScheduleService.php
@@ -1,4 +1,4 @@
-not_started or
* active.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -44,7 +44,7 @@ class SubscriptionScheduleService extends \Stripe\Service\AbstractService
* Creates a new subscription schedule object. Each customer can have up to 500
* active or scheduled subscriptions.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -64,8 +64,8 @@ class SubscriptionScheduleService extends \Stripe\Service\AbstractService
* it will remove its subscription property and set the subscription’s
* ID to the released_subscription property.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -82,8 +82,8 @@ class SubscriptionScheduleService extends \Stripe\Service\AbstractService
* supply the unique subscription schedule identifier that was returned upon
* subscription schedule creation.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -98,8 +98,8 @@ class SubscriptionScheduleService extends \Stripe\Service\AbstractService
/**
* Updates an existing subscription schedule.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/SubscriptionService.php b/Stripe/Stripe/Service/SubscriptionService.php
index f81310c..91adb67 100755
--- a/Stripe/Stripe/Service/SubscriptionService.php
+++ b/Stripe/Stripe/Service/SubscriptionService.php
@@ -1,4 +1,4 @@
-status=canceled.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -41,8 +41,8 @@ class SubscriptionService extends \Stripe\Service\AbstractService
* for unpaid invoices before allowing the customer to cancel the subscription at
* all.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -69,7 +69,7 @@ class SubscriptionService extends \Stripe\Service\AbstractService
* schedules instead. Schedules provide the flexibility to model more complex
* billing configurations that change over time.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -84,8 +84,8 @@ class SubscriptionService extends \Stripe\Service\AbstractService
/**
* Removes the currently applied discount on a subscription.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -100,8 +100,8 @@ class SubscriptionService extends \Stripe\Service\AbstractService
/**
* Retrieves the subscription with the given ID.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -121,7 +121,7 @@ class SubscriptionService extends \Stripe\Service\AbstractService
* Occasionally, propagation of new or updated data can be up to an hour behind
* during outages. Search functionality is not available to merchants in India.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -140,8 +140,8 @@ class SubscriptionService extends \Stripe\Service\AbstractService
* proration will be calculated, use the upcoming
* invoice endpoint.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/TaxCodeService.php b/Stripe/Stripe/Service/TaxCodeService.php
index fd167a1..79bb55a 100755
--- a/Stripe/Stripe/Service/TaxCodeService.php
+++ b/Stripe/Stripe/Service/TaxCodeService.php
@@ -1,4 +1,4 @@
-all tax codes
* available to add to Products in order to allow specific tax calculations.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -26,8 +26,8 @@ class TaxCodeService extends \Stripe\Service\AbstractService
* Retrieves the details of an existing tax code. Supply the unique tax code ID and
* Stripe will return the corresponding tax code information.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/TaxRateService.php b/Stripe/Stripe/Service/TaxRateService.php
index 0d67eec..be748be 100755
--- a/Stripe/Stripe/Service/TaxRateService.php
+++ b/Stripe/Stripe/Service/TaxRateService.php
@@ -1,4 +1,4 @@
-Configuration objects.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -24,7 +24,7 @@ class ConfigurationService extends \Stripe\Service\AbstractService
/**
* Creates a new Configuration object.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -39,8 +39,8 @@ class ConfigurationService extends \Stripe\Service\AbstractService
/**
* Deletes a Configuration object.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -55,8 +55,8 @@ class ConfigurationService extends \Stripe\Service\AbstractService
/**
* Retrieves a Configuration object.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -71,8 +71,8 @@ class ConfigurationService extends \Stripe\Service\AbstractService
/**
* Updates a new Configuration object.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/Terminal/ConnectionTokenService.php b/Stripe/Stripe/Service/Terminal/ConnectionTokenService.php
index 7b25b23..1b61100 100755
--- a/Stripe/Stripe/Service/Terminal/ConnectionTokenService.php
+++ b/Stripe/Stripe/Service/Terminal/ConnectionTokenService.php
@@ -1,4 +1,4 @@
-Location objects.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -26,7 +26,7 @@ class LocationService extends \Stripe\Service\AbstractService
* address fields are required in each country, see the Manage locations guide.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -41,8 +41,8 @@ class LocationService extends \Stripe\Service\AbstractService
/**
* Deletes a Location object.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -57,8 +57,8 @@ class LocationService extends \Stripe\Service\AbstractService
/**
* Retrieves a Location object.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -74,8 +74,8 @@ class LocationService extends \Stripe\Service\AbstractService
* Updates a Location object by setting the values of the parameters
* passed. Any parameters not provided will be left unchanged.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/Terminal/ReaderService.php b/Stripe/Stripe/Service/Terminal/ReaderService.php
index ae85559..bed143a 100755
--- a/Stripe/Stripe/Service/Terminal/ReaderService.php
+++ b/Stripe/Stripe/Service/Terminal/ReaderService.php
@@ -1,4 +1,4 @@
-Reader objects.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -24,8 +24,8 @@ class ReaderService extends \Stripe\Service\AbstractService
/**
* Cancels the current reader action.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -40,7 +40,7 @@ class ReaderService extends \Stripe\Service\AbstractService
/**
* Creates a new Reader object.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -55,8 +55,8 @@ class ReaderService extends \Stripe\Service\AbstractService
/**
* Deletes a Reader object.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -71,8 +71,8 @@ class ReaderService extends \Stripe\Service\AbstractService
/**
* Initiates a payment flow on a Reader.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -87,8 +87,8 @@ class ReaderService extends \Stripe\Service\AbstractService
/**
* Initiates a setup intent flow on a Reader.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -103,8 +103,8 @@ class ReaderService extends \Stripe\Service\AbstractService
/**
* Retrieves a Reader object.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -119,8 +119,8 @@ class ReaderService extends \Stripe\Service\AbstractService
/**
* Sets reader display to show cart details.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -136,8 +136,8 @@ class ReaderService extends \Stripe\Service\AbstractService
* Updates a Reader object by setting the values of the parameters
* passed. Any parameters not provided will be left unchanged.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/Terminal/TerminalServiceFactory.php b/Stripe/Stripe/Service/Terminal/TerminalServiceFactory.php
index f095124..819dd51 100755
--- a/Stripe/Stripe/Service/Terminal/TerminalServiceFactory.php
+++ b/Stripe/Stripe/Service/Terminal/TerminalServiceFactory.php
@@ -1,4 +1,4 @@
-
*/
private static $classMap = [
- 'configurations' => ConfigurationService::class,
+ 'configurations' => ConfigurationService::class,
'connectionTokens' => ConnectionTokenService::class,
- 'locations' => LocationService::class,
- 'readers' => ReaderService::class,
+ 'locations' => LocationService::class,
+ 'readers' => ReaderService::class,
];
protected function getServiceClass($name)
diff --git a/Stripe/Stripe/Service/TestHelpers/CustomerService.php b/Stripe/Stripe/Service/TestHelpers/CustomerService.php
index c46b579..31fbc04 100755
--- a/Stripe/Stripe/Service/TestHelpers/CustomerService.php
+++ b/Stripe/Stripe/Service/TestHelpers/CustomerService.php
@@ -1,4 +1,4 @@
-Card object to
* delivered.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -27,8 +27,8 @@ class CardService extends \Stripe\Service\AbstractService
* Updates the shipping status of the specified Issuing Card object to
* failure.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -44,8 +44,8 @@ class CardService extends \Stripe\Service\AbstractService
* Updates the shipping status of the specified Issuing Card object to
* returned.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -61,8 +61,8 @@ class CardService extends \Stripe\Service\AbstractService
* Updates the shipping status of the specified Issuing Card object to
* shipped.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/TestHelpers/Issuing/IssuingServiceFactory.php b/Stripe/Stripe/Service/TestHelpers/Issuing/IssuingServiceFactory.php
index a202ec3..c79fa3f 100755
--- a/Stripe/Stripe/Service/TestHelpers/Issuing/IssuingServiceFactory.php
+++ b/Stripe/Stripe/Service/TestHelpers/Issuing/IssuingServiceFactory.php
@@ -1,4 +1,4 @@
-requires_action.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/TestHelpers/Terminal/ReaderService.php b/Stripe/Stripe/Service/TestHelpers/Terminal/ReaderService.php
index 2eb4de4..39686ed 100755
--- a/Stripe/Stripe/Service/TestHelpers/Terminal/ReaderService.php
+++ b/Stripe/Stripe/Service/TestHelpers/Terminal/ReaderService.php
@@ -1,4 +1,4 @@
-Ready.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -26,7 +26,7 @@ class TestClockService extends \Stripe\Service\AbstractService
/**
* Returns a list of your test clocks.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -41,7 +41,7 @@ class TestClockService extends \Stripe\Service\AbstractService
/**
* Creates a new test clock that can be attached to new customers and quotes.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -56,8 +56,8 @@ class TestClockService extends \Stripe\Service\AbstractService
/**
* Deletes a test clock.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -72,8 +72,8 @@ class TestClockService extends \Stripe\Service\AbstractService
/**
* Retrieves a test clock.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/TestHelpers/TestHelpersServiceFactory.php b/Stripe/Stripe/Service/TestHelpers/TestHelpersServiceFactory.php
index cb0ee1a..4ca1c6d 100755
--- a/Stripe/Stripe/Service/TestHelpers/TestHelpersServiceFactory.php
+++ b/Stripe/Stripe/Service/TestHelpers/TestHelpersServiceFactory.php
@@ -1,4 +1,4 @@
-
*/
private static $classMap = [
- 'customers' => CustomerService::class,
- 'issuing' => Issuing\IssuingServiceFactory::class,
- 'refunds' => RefundService::class,
- 'terminal' => Terminal\TerminalServiceFactory::class,
+ 'customers' => CustomerService::class,
+ 'issuing' => Issuing\IssuingServiceFactory::class,
+ 'refunds' => RefundService::class,
+ 'terminal' => Terminal\TerminalServiceFactory::class,
'testClocks' => TestClockService::class,
- 'treasury' => Treasury\TreasuryServiceFactory::class,
+ 'treasury' => Treasury\TreasuryServiceFactory::class,
];
protected function getServiceClass($name)
diff --git a/Stripe/Stripe/Service/TestHelpers/Treasury/InboundTransferService.php b/Stripe/Stripe/Service/TestHelpers/Treasury/InboundTransferService.php
index 1c82476..5cac0ed 100755
--- a/Stripe/Stripe/Service/TestHelpers/Treasury/InboundTransferService.php
+++ b/Stripe/Stripe/Service/TestHelpers/Treasury/InboundTransferService.php
@@ -1,4 +1,4 @@
-processing
* state.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -29,8 +29,8 @@ class InboundTransferService extends \Stripe\Service\AbstractService
* InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the
* succeeded state.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -47,8 +47,8 @@ class InboundTransferService extends \Stripe\Service\AbstractService
* status. The InboundTransfer must already be in the processing
* state.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/TestHelpers/Treasury/OutboundPaymentService.php b/Stripe/Stripe/Service/TestHelpers/Treasury/OutboundPaymentService.php
index 4981e68..f3ae3b6 100755
--- a/Stripe/Stripe/Service/TestHelpers/Treasury/OutboundPaymentService.php
+++ b/Stripe/Stripe/Service/TestHelpers/Treasury/OutboundPaymentService.php
@@ -1,4 +1,4 @@
-processing
* state.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -29,8 +29,8 @@ class OutboundPaymentService extends \Stripe\Service\AbstractService
* status. The OutboundPayment must already be in the processing
* state.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -47,8 +47,8 @@ class OutboundPaymentService extends \Stripe\Service\AbstractService
* status. The OutboundPayment must already be in the processing
* state.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/TestHelpers/Treasury/OutboundTransferService.php b/Stripe/Stripe/Service/TestHelpers/Treasury/OutboundTransferService.php
index 4b26bed..cdc019d 100755
--- a/Stripe/Stripe/Service/TestHelpers/Treasury/OutboundTransferService.php
+++ b/Stripe/Stripe/Service/TestHelpers/Treasury/OutboundTransferService.php
@@ -1,4 +1,4 @@
-processing
* state.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -29,8 +29,8 @@ class OutboundTransferService extends \Stripe\Service\AbstractService
* status. The OutboundTransfer must already be in the processing
* state.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -47,8 +47,8 @@ class OutboundTransferService extends \Stripe\Service\AbstractService
* status. The OutboundTransfer must already be in the processing
* state.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/TestHelpers/Treasury/ReceivedCreditService.php b/Stripe/Stripe/Service/TestHelpers/Treasury/ReceivedCreditService.php
index a90031a..357cb32 100755
--- a/Stripe/Stripe/Service/TestHelpers/Treasury/ReceivedCreditService.php
+++ b/Stripe/Stripe/Service/TestHelpers/Treasury/ReceivedCreditService.php
@@ -1,4 +1,4 @@
-
*/
private static $classMap = [
- 'inboundTransfers' => InboundTransferService::class,
- 'outboundPayments' => OutboundPaymentService::class,
+ 'inboundTransfers' => InboundTransferService::class,
+ 'outboundPayments' => OutboundPaymentService::class,
'outboundTransfers' => OutboundTransferService::class,
- 'receivedCredits' => ReceivedCreditService::class,
- 'receivedDebits' => ReceivedDebitService::class,
+ 'receivedCredits' => ReceivedCreditService::class,
+ 'receivedDebits' => ReceivedDebitService::class,
];
protected function getServiceClass($name)
diff --git a/Stripe/Stripe/Service/TokenService.php b/Stripe/Stripe/Service/TokenService.php
index 1c72759..23b4190 100755
--- a/Stripe/Stripe/Service/TokenService.php
+++ b/Stripe/Stripe/Service/TokenService.php
@@ -1,4 +1,4 @@
-Custom
* account.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -27,8 +27,8 @@ class TokenService extends \Stripe\Service\AbstractService
/**
* Retrieves the token with the given ID.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/TopupService.php b/Stripe/Stripe/Service/TopupService.php
index bd486b9..291d6f5 100755
--- a/Stripe/Stripe/Service/TopupService.php
+++ b/Stripe/Stripe/Service/TopupService.php
@@ -1,4 +1,4 @@
-limit and starting_after parameters to page through
* additional reversals.
*
- * @param string $parentId
- * @param null|array $params
+ * @param string $parentId
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -48,7 +48,7 @@ class TransferService extends \Stripe\Service\AbstractService
* transfer object. Your Stripe balance must be able to
* cover the transfer amount, or you’ll receive an “Insufficient Funds” error.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -70,8 +70,8 @@ class TransferService extends \Stripe\Service\AbstractService
* return an error when called on an already-reversed transfer, or when trying to
* reverse more money than is left on a transfer.
*
- * @param string $parentId
- * @param null|array $params
+ * @param string $parentId
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -88,8 +88,8 @@ class TransferService extends \Stripe\Service\AbstractService
* from either a transfer creation request or the transfer list, and Stripe will
* return the corresponding transfer information.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -106,9 +106,9 @@ class TransferService extends \Stripe\Service\AbstractService
* transfer object, but you can also retrieve details about a specific reversal
* stored on the transfer.
*
- * @param string $parentId
- * @param string $id
- * @param null|array $params
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -126,8 +126,8 @@ class TransferService extends \Stripe\Service\AbstractService
*
* This request accepts only metadata as an argument.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -145,9 +145,9 @@ class TransferService extends \Stripe\Service\AbstractService
*
* This request only accepts metadata and description as arguments.
*
- * @param string $parentId
- * @param string $id
- * @param null|array $params
+ * @param string $parentId
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/Service/Treasury/CreditReversalService.php b/Stripe/Stripe/Service/Treasury/CreditReversalService.php
index 60bf900..2a14302 100755
--- a/Stripe/Stripe/Service/Treasury/CreditReversalService.php
+++ b/Stripe/Stripe/Service/Treasury/CreditReversalService.php
@@ -1,4 +1,4 @@
-
*/
private static $classMap = [
- 'creditReversals' => CreditReversalService::class,
- 'debitReversals' => DebitReversalService::class,
- 'financialAccounts' => FinancialAccountService::class,
- 'inboundTransfers' => InboundTransferService::class,
- 'outboundPayments' => OutboundPaymentService::class,
- 'outboundTransfers' => OutboundTransferService::class,
- 'receivedCredits' => ReceivedCreditService::class,
- 'receivedDebits' => ReceivedDebitService::class,
+ 'creditReversals' => CreditReversalService::class,
+ 'debitReversals' => DebitReversalService::class,
+ 'financialAccounts' => FinancialAccountService::class,
+ 'inboundTransfers' => InboundTransferService::class,
+ 'outboundPayments' => OutboundPaymentService::class,
+ 'outboundTransfers' => OutboundTransferService::class,
+ 'receivedCredits' => ReceivedCreditService::class,
+ 'receivedDebits' => ReceivedDebitService::class,
'transactionEntries' => TransactionEntryService::class,
- 'transactions' => TransactionService::class,
+ 'transactions' => TransactionService::class,
];
protected function getServiceClass($name)
diff --git a/Stripe/Stripe/Service/WebhookEndpointService.php b/Stripe/Stripe/Service/WebhookEndpointService.php
index baa15bd..f394b0a 100755
--- a/Stripe/Stripe/Service/WebhookEndpointService.php
+++ b/Stripe/Stripe/Service/WebhookEndpointService.php
@@ -1,4 +1,4 @@
-webhooks settings
* section of the Dashboard.
*
- * @param null|array $params
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -49,8 +49,8 @@ class WebhookEndpointService extends \Stripe\Service\AbstractService
* href="https://dashboard.stripe.com/account/webhooks">webhook endpoint
* management page of the Stripe dashboard.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -65,8 +65,8 @@ class WebhookEndpointService extends \Stripe\Service\AbstractService
/**
* Retrieves the webhook endpoint with the given ID.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -82,8 +82,8 @@ class WebhookEndpointService extends \Stripe\Service\AbstractService
* Updates the webhook endpoint. You may edit the url, the list of
* enabled_events, and the status of your endpoint.
*
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/SetupAttempt.php b/Stripe/Stripe/SetupAttempt.php
index b091cda..3216c15 100755
--- a/Stripe/Stripe/SetupAttempt.php
+++ b/Stripe/Stripe/SetupAttempt.php
@@ -1,4 +1,4 @@
-application on the SetupIntent at the time of this confirmation.
- * @property bool $attach_to_self If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. - * @property null|string|\Stripe\Customer $customer The value of customer on the SetupIntent at the time of this confirmation. - * @property null|string[] $flow_directionsIndicates the directions of money movement for which this payment method is intended to be used.
Include inbound if you intend to use the payment method as the origin to pull funds from. Include outbound if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.
true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|string|\Stripe\Account $on_behalf_of The value of on_behalf_of on the SetupIntent at the time of this confirmation.
- * @property string|\Stripe\PaymentMethod $payment_method ID of the payment method used with this SetupAttempt.
- * @property \Stripe\StripeObject $payment_method_details
- * @property null|\Stripe\StripeObject $setup_error The error encountered during this attempt to confirm the SetupIntent, if any.
- * @property string|\Stripe\SetupIntent $setup_intent ID of the SetupIntent that this attempt belongs to.
- * @property string $status Status of this SetupAttempt, one of requires_confirmation, requires_action, processing, succeeded, failed, or abandoned.
- * @property string $usage The value of usage on the SetupIntent at the time of this confirmation, one of off_session or on_session.
+ * @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 null|string|\Stripe\StripeObject $application The value of application on the SetupIntent at the time of this confirmation.
+ * @property bool $attach_to_self If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. + * @property null|string|\Stripe\Customer $customer The value of customer on the SetupIntent at the time of this confirmation. + * @property null|string[] $flow_directionsIndicates the directions of money movement for which this payment method is intended to be used.
Include inbound if you intend to use the payment method as the origin to pull funds from. Include outbound if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.
true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|string|\Stripe\Account $on_behalf_of The value of on_behalf_of on the SetupIntent at the time of this confirmation.
+ * @property string|\Stripe\PaymentMethod $payment_method ID of the payment method used with this SetupAttempt.
+ * @property \Stripe\StripeObject $payment_method_details
+ * @property null|\Stripe\StripeObject $setup_error The error encountered during this attempt to confirm the SetupIntent, if any.
+ * @property string|\Stripe\SetupIntent $setup_intent ID of the SetupIntent that this attempt belongs to.
+ * @property string $status Status of this SetupAttempt, one of requires_confirmation, requires_action, processing, succeeded, failed, or abandoned.
+ * @property string $usage The value of usage on the SetupIntent at the time of this confirmation, one of off_session or on_session.
*/
class SetupAttempt extends ApiResource
{
- const OBJECT_NAME = 'setup_attempt';
+ public const OBJECT_NAME = 'setup_attempt';
use ApiOperations\All;
}
diff --git a/Stripe/Stripe/SetupIntent.php b/Stripe/Stripe/SetupIntent.php
index ae6111c..26fe4a6 100755
--- a/Stripe/Stripe/SetupIntent.php
+++ b/Stripe/Stripe/SetupIntent.php
@@ -1,4 +1,4 @@
-Setup
* Intents API.
*
- * @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 null|string|\Stripe\StripeObject $application ID of the Connect application that created the SetupIntent.
- * @property bool $attach_to_self If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
- * @property null|string $cancellation_reason Reason for cancellation of this SetupIntent, one ofabandoned, requested_by_customer, or duplicate.
- * @property null|string $client_secret The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.
The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. - * @property null|string|\Stripe\Customer $customerID of the Customer this SetupIntent belongs to, if one exists.
If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.
- * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. - * @property null|string[] $flow_directionsIndicates the directions of money movement for which this payment method is intended to be used.
Include inbound if you intend to use the payment method as the origin to pull funds from. Include outbound if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.
true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|string|\Stripe\Mandate $mandate ID of the multi use Mandate generated by the SetupIntent.
- * @property null|\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|\Stripe\StripeObject $next_action If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
- * @property null|string|\Stripe\Account $on_behalf_of The account (if any) for which the setup is intended.
- * @property null|string|\Stripe\PaymentMethod $payment_method ID of the payment method used with this SetupIntent.
- * @property null|\Stripe\StripeObject $payment_method_options Payment-method-specific configuration for this SetupIntent.
- * @property string[] $payment_method_types The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.
- * @property null|string|\Stripe\Mandate $single_use_mandate ID of the single_use Mandate generated by the SetupIntent.
- * @property string $status Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.
- * @property string $usage Indicates how the payment method is intended to be used in the future.
Use on_session if you intend to only reuse the payment method when the customer is in your checkout flow. Use off_session if your customer may or may not be in your checkout flow. If not provided, this value defaults to off_session.
If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
+ * @property null|string $cancellation_reason Reason for cancellation of this SetupIntent, one ofabandoned, requested_by_customer, or duplicate.
+ * @property null|string $client_secret The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.
The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. + * @property null|string|\Stripe\Customer $customerID of the Customer this SetupIntent belongs to, if one exists.
If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.
+ * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. + * @property null|string[] $flow_directionsIndicates the directions of money movement for which this payment method is intended to be used.
Include inbound if you intend to use the payment method as the origin to pull funds from. Include outbound if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.
true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|string|\Stripe\Mandate $mandate ID of the multi use Mandate generated by the SetupIntent.
+ * @property null|\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|\Stripe\StripeObject $next_action If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
+ * @property null|string|\Stripe\Account $on_behalf_of The account (if any) for which the setup is intended.
+ * @property null|string|\Stripe\PaymentMethod $payment_method ID of the payment method used with this SetupIntent.
+ * @property null|\Stripe\StripeObject $payment_method_options Payment-method-specific configuration for this SetupIntent.
+ * @property string[] $payment_method_types The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.
+ * @property null|string|\Stripe\Mandate $single_use_mandate ID of the single_use Mandate generated by the SetupIntent.
+ * @property string $status Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.
+ * @property string $usage Indicates how the payment method is intended to be used in the future.
Use on_session if you intend to only reuse the payment method when the customer is in your checkout flow. Use off_session if your customer may or may not be in your checkout flow. If not provided, this value defaults to off_session.
true.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property null|\Stripe\StripeObject $delivery_estimate The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
- * @property null|string $display_name The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
- * @property \Stripe\StripeObject $fixed_amount
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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 $tax_behavior Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
- * @property null|string|\Stripe\TaxCode $tax_code A tax code ID. The Shipping tax code is txcd_92010001.
- * @property string $type The type of calculation to use on the shipping rate. Can only be fixed_amount for now.
+ * @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 bool $active Whether the shipping rate can be used for new purchases. Defaults to true.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|\Stripe\StripeObject $delivery_estimate The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
+ * @property null|string $display_name The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
+ * @property \Stripe\StripeObject $fixed_amount
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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 $tax_behavior Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
+ * @property null|string|\Stripe\TaxCode $tax_code A tax code ID. The Shipping tax code is txcd_92010001.
+ * @property string $type The type of calculation to use on the shipping rate. Can only be fixed_amount for now.
*/
class ShippingRate extends ApiResource
{
- const OBJECT_NAME = 'shipping_rate';
+ public const OBJECT_NAME = 'shipping_rate';
use ApiOperations\All;
use ApiOperations\Create;
use ApiOperations\Retrieve;
use ApiOperations\Update;
- const TAX_BEHAVIOR_EXCLUSIVE = 'exclusive';
- const TAX_BEHAVIOR_INCLUSIVE = 'inclusive';
- const TAX_BEHAVIOR_UNSPECIFIED = 'unspecified';
+ public const TAX_BEHAVIOR_EXCLUSIVE = 'exclusive';
- const TYPE_FIXED_AMOUNT = 'fixed_amount';
+ public const TAX_BEHAVIOR_INCLUSIVE = 'inclusive';
+
+ public const TAX_BEHAVIOR_UNSPECIFIED = 'unspecified';
+
+ public const TYPE_FIXED_AMOUNT = 'fixed_amount';
}
diff --git a/Stripe/Stripe/Sigma/ScheduledQueryRun.php b/Stripe/Stripe/Sigma/ScheduledQueryRun.php
index b109dde..038bd0a 100755
--- a/Stripe/Stripe/Sigma/ScheduledQueryRun.php
+++ b/Stripe/Stripe/Sigma/ScheduledQueryRun.php
@@ -1,4 +1,4 @@
-ScheduledQueryRun object, which you can use
* to retrieve the query results.
*
- * @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 int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property int $data_load_time When the query was run, Sigma contained a snapshot of your Stripe data at this time.
+ * @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 int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property int $data_load_time When the query was run, Sigma contained a snapshot of your Stripe data at this time.
* @property \Stripe\StripeObject $error
- * @property null|\Stripe\File $file The file object representing the results of the query.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property int $result_available_until Time at which the result expires and is no longer available for download.
- * @property string $sql SQL for the query.
- * @property string $status The query's execution status, which will be completed for successful runs, and canceled, failed, or timed_out otherwise.
- * @property string $title Title of the query.
+ * @property null|\Stripe\File $file The file object representing the results of the query.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property int $result_available_until Time at which the result expires and is no longer available for download.
+ * @property string $sql SQL for the query.
+ * @property string $status The query's execution status, which will be completed for successful runs, and canceled, failed, or timed_out otherwise.
+ * @property string $title Title of the query.
*/
class ScheduledQueryRun extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'scheduled_query_run';
+ public const OBJECT_NAME = 'scheduled_query_run';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
diff --git a/Stripe/Stripe/SingletonApiResource.php b/Stripe/Stripe/SingletonApiResource.php
index 34dfa43..c90af8b 100755
--- a/Stripe/Stripe/SingletonApiResource.php
+++ b/Stripe/Stripe/SingletonApiResource.php
@@ -1,4 +1,4 @@
-Sources API and Sources & Customers.
*
- * @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 \Stripe\StripeObject $ach_credit_transfer
- * @property \Stripe\StripeObject $ach_debit
- * @property \Stripe\StripeObject $acss_debit
- * @property \Stripe\StripeObject $alipay
- * @property null|int $amount A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.
- * @property \Stripe\StripeObject $au_becs_debit
- * @property \Stripe\StripeObject $bancontact
- * @property \Stripe\StripeObject $card
- * @property \Stripe\StripeObject $card_present
- * @property string $client_secret The client secret of the source. Used for client-side retrieval using a publishable key.
- * @property \Stripe\StripeObject $code_verification
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property null|string $currency Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.
- * @property string $customer The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
- * @property \Stripe\StripeObject $eps
- * @property string $flow The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.
- * @property \Stripe\StripeObject $giropay
- * @property \Stripe\StripeObject $ideal
- * @property \Stripe\StripeObject $klarna
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|\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 \Stripe\StripeObject $multibanco
- * @property null|\Stripe\StripeObject $owner Information about the owner of the payment instrument that may be used or required by particular source types.
- * @property \Stripe\StripeObject $p24
- * @property \Stripe\StripeObject $receiver
- * @property \Stripe\StripeObject $redirect
- * @property \Stripe\StripeObject $sepa_credit_transfer
- * @property \Stripe\StripeObject $sepa_debit
- * @property \Stripe\StripeObject $sofort
- * @property \Stripe\StripeObject $source_order
- * @property null|string $statement_descriptor Extra information about a source. This will appear on your customer's statement every time you charge the source.
- * @property string $status The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.
- * @property \Stripe\StripeObject $three_d_secure
- * @property string $type The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
- * @property null|string $usage Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
- * @property \Stripe\StripeObject $wechat
+ * @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 \Stripe\StripeObject $ach_credit_transfer
+ * @property \Stripe\StripeObject $ach_debit
+ * @property \Stripe\StripeObject $acss_debit
+ * @property \Stripe\StripeObject $alipay
+ * @property null|int $amount A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.
+ * @property \Stripe\StripeObject $au_becs_debit
+ * @property \Stripe\StripeObject $bancontact
+ * @property \Stripe\StripeObject $card
+ * @property \Stripe\StripeObject $card_present
+ * @property string $client_secret The client secret of the source. Used for client-side retrieval using a publishable key.
+ * @property \Stripe\StripeObject $code_verification
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|string $currency Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.
+ * @property string $customer The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
+ * @property \Stripe\StripeObject $eps
+ * @property string $flow The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.
+ * @property \Stripe\StripeObject $giropay
+ * @property \Stripe\StripeObject $ideal
+ * @property \Stripe\StripeObject $klarna
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|\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 \Stripe\StripeObject $multibanco
+ * @property null|\Stripe\StripeObject $owner Information about the owner of the payment instrument that may be used or required by particular source types.
+ * @property \Stripe\StripeObject $p24
+ * @property \Stripe\StripeObject $receiver
+ * @property \Stripe\StripeObject $redirect
+ * @property \Stripe\StripeObject $sepa_credit_transfer
+ * @property \Stripe\StripeObject $sepa_debit
+ * @property \Stripe\StripeObject $sofort
+ * @property \Stripe\StripeObject $source_order
+ * @property null|string $statement_descriptor Extra information about a source. This will appear on your customer's statement every time you charge the source.
+ * @property string $status The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.
+ * @property \Stripe\StripeObject $three_d_secure
+ * @property string $type The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
+ * @property null|string $usage Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
+ * @property \Stripe\StripeObject $wechat
*/
class Source extends ApiResource
{
- const OBJECT_NAME = 'source';
+ public const OBJECT_NAME = 'source';
use ApiOperations\Create;
use ApiOperations\Retrieve;
use ApiOperations\Update;
- const FLOW_CODE_VERIFICATION = 'code_verification';
- const FLOW_NONE = 'none';
- const FLOW_RECEIVER = 'receiver';
- const FLOW_REDIRECT = 'redirect';
+ public const FLOW_CODE_VERIFICATION = 'code_verification';
- const STATUS_CANCELED = 'canceled';
- const STATUS_CHARGEABLE = 'chargeable';
- const STATUS_CONSUMED = 'consumed';
- const STATUS_FAILED = 'failed';
- const STATUS_PENDING = 'pending';
+ public const FLOW_NONE = 'none';
- const USAGE_REUSABLE = 'reusable';
- const USAGE_SINGLE_USE = 'single_use';
+ public const FLOW_RECEIVER = 'receiver';
+
+ public const FLOW_REDIRECT = 'redirect';
+
+ public const STATUS_CANCELED = 'canceled';
+
+ public const STATUS_CHARGEABLE = 'chargeable';
+
+ public const STATUS_CONSUMED = 'consumed';
+
+ public const STATUS_FAILED = 'failed';
+
+ public const STATUS_PENDING = 'pending';
+
+ public const USAGE_REUSABLE = 'reusable';
+
+ public const USAGE_SINGLE_USE = 'single_use';
use ApiOperations\NestedResource;
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\UnexpectedValueException if the source is not attached to a customer
- * @throws \Stripe\Exception\ApiErrorException if the request fails
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\Source the detached source
*/
@@ -98,17 +106,17 @@ class Source extends ApiResource
$id = $this['id'];
if (!$id) {
$class = static::class;
- $msg = "Could not determine which URL to request: {$class} instance "
+ $msg = "Could not determine which URL to request: {$class} instance "
. "has invalid ID: {$id}";
throw new Exception\UnexpectedValueException($msg, null);
}
if ($this['customer']) {
- $base = Customer::classUrl();
+ $base = Customer::classUrl();
$parentExtn = \urlencode(Util\Util::utf8($this['customer']));
- $extn = \urlencode(Util\Util::utf8($id));
- $url = "{$base}/{$parentExtn}/sources/{$extn}";
+ $extn = \urlencode(Util\Util::utf8($id));
+ $url = "{$base}/{$parentExtn}/sources/{$extn}";
list($response, $opts) = $this->_request('delete', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -122,8 +130,8 @@ class Source extends ApiResource
}
/**
- * @param string $id
- * @param null|array $params
+ * @param string $id
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -132,16 +140,16 @@ class Source extends ApiResource
*/
public static function allSourceTransactions($id, $params = null, $opts = null)
{
- $url = static::resourceUrl($id) . '/source_transactions';
+ $url = static::resourceUrl($id) . '/source_transactions';
list($response, $opts) = static::_staticRequest('get', $url, $params, $opts);
- $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
+ $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -150,7 +158,7 @@ class Source extends ApiResource
*/
public function verify($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/verify';
+ $url = $this->instanceUrl() . '/verify';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
diff --git a/Stripe/Stripe/SourceTransaction.php b/Stripe/Stripe/SourceTransaction.php
index 281f2a7..556dcb5 100755
--- a/Stripe/Stripe/SourceTransaction.php
+++ b/Stripe/Stripe/SourceTransaction.php
@@ -1,20 +1,20 @@
-coreServiceFactory) {
+ if ($this->coreServiceFactory === null) {
$this->coreServiceFactory = new \Stripe\Service\CoreServiceFactory($this);
}
diff --git a/Stripe/Stripe/StripeClientInterface.php b/Stripe/Stripe/StripeClientInterface.php
index d5a8806..0e85f74 100755
--- a/Stripe/Stripe/StripeClientInterface.php
+++ b/Stripe/Stripe/StripeClientInterface.php
@@ -1,4 +1,4 @@
-_retrieveOptions) = Util\Util::normalizeId($id);
- $this->_opts = Util\RequestOptions::parse($opts);
- $this->_originalValues = [];
- $this->_values = [];
- $this->_unsavedValues = new Util\Set();
- $this->_transientValues = new Util\Set();
- if (null !== $id) {
+ $this->_opts = Util\RequestOptions::parse($opts);
+ $this->_originalValues = [];
+ $this->_values = [];
+ $this->_unsavedValues = new Util\Set();
+ $this->_transientValues = new Util\Set();
+ if ($id !== null) {
$this->_values['id'] = $id;
}
}
// Standard accessor magic methods
- public function __set($k, $v)
+ public function __set($k, $v) : void
{
if (static::getPermanentAttributes()->includes($k)) {
throw new Exception\InvalidArgumentException(
@@ -136,7 +136,7 @@ class StripeObject implements \ArrayAccess, \Countable, \JsonSerializable
);
}
- if ('' === $v) {
+ if ($v === '') {
throw new Exception\InvalidArgumentException(
'You cannot set \'' . $k . '\'to an empty string. '
. 'We interpret empty strings as NULL in requests. '
@@ -159,7 +159,7 @@ class StripeObject implements \ArrayAccess, \Countable, \JsonSerializable
return isset($this->_values[$k]);
}
- public function __unset($k)
+ public function __unset($k) : void
{
unset($this->_values[$k]);
$this->_transientValues->add($k);
@@ -174,8 +174,8 @@ class StripeObject implements \ArrayAccess, \Countable, \JsonSerializable
return $this->_values[$k];
}
if (!empty($this->_transientValues) && $this->_transientValues->includes($k)) {
- $class = static::class;
- $attrs = \implode(', ', \array_keys($this->_values));
+ $class = static::class;
+ $attrs = \implode(', ', \array_keys($this->_values));
$message = "Stripe Notice: Undefined property of {$class} instance: {$k}. "
. "HINT: The {$k} attribute was set in the past, however. "
. 'It was then wiped when refreshing the object '
@@ -208,7 +208,7 @@ class StripeObject implements \ArrayAccess, \Countable, \JsonSerializable
* @return void
*/
#[\ReturnTypeWillChange]
- public function offsetSet($k, $v)
+ public function offsetSet($k, $v) : void
{
$this->{$k} = $v;
}
@@ -226,7 +226,7 @@ class StripeObject implements \ArrayAccess, \Countable, \JsonSerializable
* @return void
*/
#[\ReturnTypeWillChange]
- public function offsetUnset($k)
+ public function offsetUnset($k) : void
{
unset($this->{$k});
}
@@ -262,7 +262,7 @@ class StripeObject implements \ArrayAccess, \Countable, \JsonSerializable
/**
* This unfortunately needs to be public to be used in Util\Util.
*
- * @param array $values
+ * @param array $values
* @param null|array|string|Util\RequestOptions $opts
*
* @return static the object constructed from the given values
@@ -278,17 +278,17 @@ class StripeObject implements \ArrayAccess, \Countable, \JsonSerializable
/**
* Refreshes this object using the provided values.
*
- * @param array $values
+ * @param array $values
* @param null|array|string|Util\RequestOptions $opts
- * @param bool $partial defaults to false
+ * @param bool $partial defaults to false
*/
- public function refreshFrom($values, $opts, $partial = false)
+ public function refreshFrom($values, $opts, $partial = false) : void
{
$this->_opts = Util\RequestOptions::parse($opts);
$this->_originalValues = self::deepCopy($values);
- if ($values instanceof StripeObject) {
+ if ($values instanceof self) {
$values = $values->toArray();
}
@@ -315,19 +315,19 @@ class StripeObject implements \ArrayAccess, \Countable, \JsonSerializable
/**
* Mass assigns attributes on the model.
*
- * @param array $values
+ * @param array $values
* @param null|array|string|Util\RequestOptions $opts
- * @param bool $dirty defaults to true
+ * @param bool $dirty defaults to true
*/
- public function updateAttributes($values, $opts = null, $dirty = true)
+ public function updateAttributes($values, $opts = null, $dirty = true) : void
{
foreach ($values as $k => $v) {
// Special-case metadata to always be cast as a StripeObject
// This is necessary in case metadata is empty, as PHP arrays do
// not differentiate between lists and hashes, and we consider
// empty arrays to be lists.
- if (('metadata' === $k) && (\is_array($v))) {
- $this->_values[$k] = StripeObject::constructFrom($v, $opts);
+ if (($k === 'metadata') && (\is_array($v))) {
+ $this->_values[$k] = self::constructFrom($v, $opts);
} else {
$this->_values[$k] = Util\Util::convertToStripeObject($v, $opts);
}
@@ -342,7 +342,7 @@ class StripeObject implements \ArrayAccess, \Countable, \JsonSerializable
* @param bool $force defaults to false
*
* @return array a recursive mapping of attributes to values for this object,
- * including the proper value for deleted attributes
+ * including the proper value for deleted attributes
*/
public function serializeParameters($force = false)
{
@@ -358,8 +358,8 @@ class StripeObject implements \ArrayAccess, \Countable, \JsonSerializable
// values within in that its parent StripeObject doesn't know about.
//
$original = \array_key_exists($k, $this->_originalValues) ? $this->_originalValues[$k] : null;
- $unsaved = $this->_unsavedValues->includes($k);
- if ($force || $unsaved || $v instanceof StripeObject) {
+ $unsaved = $this->_unsavedValues->includes($k);
+ if ($force || $unsaved || $v instanceof self) {
$updateParams[$k] = $this->serializeParamsValue(
$this->_values[$k],
$original,
@@ -375,7 +375,7 @@ class StripeObject implements \ArrayAccess, \Countable, \JsonSerializable
return \array_filter(
$updateParams,
function ($v) {
- return null !== $v;
+ return $v !== null;
}
);
}
@@ -404,7 +404,7 @@ class StripeObject implements \ArrayAccess, \Countable, \JsonSerializable
// We throw an error if a property was set explicitly but we can't do
// anything with it because the integration is probably not working as the
// user intended it to.
- if (null === $value) {
+ if ($value === null) {
return '';
}
if (($value instanceof ApiResource) && (!$value->saveWithParent)) {
@@ -436,7 +436,7 @@ class StripeObject implements \ArrayAccess, \Countable, \JsonSerializable
// Associative array, i.e. a map
return Util\Util::convertToStripeObject($value, $this->_opts)->serializeParameters();
}
- } elseif ($value instanceof StripeObject) {
+ } elseif ($value instanceof self) {
$update = $value->serializeParameters($force);
if ($original && $unsaved && $key && static::getAdditiveParams()->includes($key)) {
$update = \array_merge(self::emptyValues($original), $update);
@@ -466,7 +466,7 @@ class StripeObject implements \ArrayAccess, \Countable, \JsonSerializable
public function toArray()
{
$maybeToArray = function ($value) {
- if (null === $value) {
+ if ($value === null) {
return null;
}
@@ -474,7 +474,7 @@ class StripeObject implements \ArrayAccess, \Countable, \JsonSerializable
};
return \array_reduce(\array_keys($this->_values), function ($acc, $k) use ($maybeToArray) {
- if ('_' === \substr((string) $k, 0, 1)) {
+ if (\substr((string) $k, 0, 1) === '_') {
return $acc;
}
$v = $this->_values[$k];
@@ -511,7 +511,7 @@ class StripeObject implements \ArrayAccess, \Countable, \JsonSerializable
* method is also recursive, so any StripeObjects contained as values or
* which are values in a tenant array are also marked as dirty.
*/
- public function dirty()
+ public function dirty() : void
{
$this->_unsavedValues = new Util\Set(\array_keys($this->_values));
foreach ($this->_values as $k => $v) {
@@ -519,13 +519,13 @@ class StripeObject implements \ArrayAccess, \Countable, \JsonSerializable
}
}
- protected function dirtyValue($value)
+ protected function dirtyValue($value) : void
{
if (\is_array($value)) {
foreach ($value as $v) {
$this->dirtyValue($v);
}
- } elseif ($value instanceof StripeObject) {
+ } elseif ($value instanceof self) {
$value->dirty();
}
}
@@ -546,7 +546,7 @@ class StripeObject implements \ArrayAccess, \Countable, \JsonSerializable
return $copy;
}
- if ($obj instanceof StripeObject) {
+ if ($obj instanceof self) {
return $obj::constructFrom(
self::deepCopy($obj->_values),
clone $obj->_opts
@@ -566,7 +566,7 @@ class StripeObject implements \ArrayAccess, \Countable, \JsonSerializable
{
if (\is_array($obj)) {
$values = $obj;
- } elseif ($obj instanceof StripeObject) {
+ } elseif ($obj instanceof self) {
$values = $obj->_values;
} else {
throw new Exception\InvalidArgumentException(
@@ -590,7 +590,7 @@ class StripeObject implements \ArrayAccess, \Countable, \JsonSerializable
*
* @param ApiResponse $resp
*/
- public function setLastResponse($resp)
+ public function setLastResponse($resp) : void
{
$this->_lastResponse = $resp;
}
diff --git a/Stripe/Stripe/StripeStreamingClientInterface.php b/Stripe/Stripe/StripeStreamingClientInterface.php
index e5e34c1..9f21b43 100755
--- a/Stripe/Stripe/StripeStreamingClientInterface.php
+++ b/Stripe/Stripe/StripeStreamingClientInterface.php
@@ -1,4 +1,4 @@
-Creating
* Subscriptions.
*
- * @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 null|string|\Stripe\StripeObject $application ID of the Connect Application that created the subscription.
- * @property null|float $application_fee_percent A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account.
- * @property \Stripe\StripeObject $automatic_tax
- * @property int $billing_cycle_anchor Determines the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.
- * @property null|\Stripe\StripeObject $billing_thresholds Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
- * @property null|int $cancel_at A date in the future at which the subscription will automatically get canceled
- * @property bool $cancel_at_period_end If the subscription has been canceled with the at_period_end flag set to true, cancel_at_period_end on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.
- * @property null|int $canceled_at If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
- * @property string $collection_method Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property int $current_period_end End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.
- * @property int $current_period_start Start of the current period that the subscription has been invoiced for.
- * @property string|\Stripe\Customer $customer ID of the customer who owns the subscription.
- * @property null|int $days_until_due Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where collection_method=charge_automatically.
- * @property null|string|\Stripe\PaymentMethod $default_payment_method ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
- * @property null|string|\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source $default_source ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
- * @property null|\Stripe\TaxRate[] $default_tax_rates The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.
- * @property null|string $description The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces.
- * @property null|\Stripe\Discount $discount Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis.
- * @property null|int $ended_at If the subscription has ended, the date the subscription ended.
- * @property \Stripe\Collection<\Stripe\SubscriptionItem> $items List of subscription items, each with an attached price.
- * @property null|string|\Stripe\Invoice $latest_invoice The most recent invoice this subscription has generated.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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|int $next_pending_invoice_item_invoice Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.
- * @property null|string|\Stripe\Account $on_behalf_of The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.
- * @property null|\Stripe\StripeObject $pause_collection If specified, payment collection for this subscription will be paused.
- * @property null|\Stripe\StripeObject $payment_settings Payment settings passed on to invoices created by the subscription.
- * @property null|\Stripe\StripeObject $pending_invoice_item_interval Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
- * @property null|string|\Stripe\SetupIntent $pending_setup_intent You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the SCA Migration Guide.
- * @property null|\Stripe\StripeObject $pending_update If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.
- * @property null|string|\Stripe\SubscriptionSchedule $schedule The schedule attached to the subscription
- * @property int $start_date Date when the subscription was first created. The date might differ from the created date due to backdating.
- * @property string $status Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, or unpaid.
For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active state. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal state, the open invoice will be voided and no further invoices will be generated.
A subscription that is currently in a trial period is trialing and moves to active when the trial period is over.
If subscription collection_method=charge_automatically it becomes past_due when payment to renew it fails and canceled or unpaid (depending on your subscriptions settings) when Stripe has exhausted all payment retry attempts.
If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.
month or year intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.
+ * @property null|\Stripe\StripeObject $billing_thresholds Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
+ * @property null|int $cancel_at A date in the future at which the subscription will automatically get canceled
+ * @property bool $cancel_at_period_end If the subscription has been canceled with the at_period_end flag set to true, cancel_at_period_end on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.
+ * @property null|int $canceled_at If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
+ * @property string $collection_method Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property int $current_period_end End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.
+ * @property int $current_period_start Start of the current period that the subscription has been invoiced for.
+ * @property string|\Stripe\Customer $customer ID of the customer who owns the subscription.
+ * @property null|int $days_until_due Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where collection_method=charge_automatically.
+ * @property null|string|\Stripe\PaymentMethod $default_payment_method ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
+ * @property null|string|\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source $default_source ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
+ * @property null|\Stripe\TaxRate[] $default_tax_rates The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.
+ * @property null|string $description The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces.
+ * @property null|\Stripe\Discount $discount Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis.
+ * @property null|int $ended_at If the subscription has ended, the date the subscription ended.
+ * @property \Stripe\Collection<\Stripe\SubscriptionItem> $items List of subscription items, each with an attached price.
+ * @property null|string|\Stripe\Invoice $latest_invoice The most recent invoice this subscription has generated.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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|int $next_pending_invoice_item_invoice Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.
+ * @property null|string|\Stripe\Account $on_behalf_of The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.
+ * @property null|\Stripe\StripeObject $pause_collection If specified, payment collection for this subscription will be paused.
+ * @property null|\Stripe\StripeObject $payment_settings Payment settings passed on to invoices created by the subscription.
+ * @property null|\Stripe\StripeObject $pending_invoice_item_interval Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
+ * @property null|string|\Stripe\SetupIntent $pending_setup_intent You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the SCA Migration Guide.
+ * @property null|\Stripe\StripeObject $pending_update If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.
+ * @property null|string|\Stripe\SubscriptionSchedule $schedule The schedule attached to the subscription
+ * @property int $start_date Date when the subscription was first created. The date might differ from the created date due to backdating.
+ * @property string $status Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, or unpaid.
For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active state. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal state, the open invoice will be voided and no further invoices will be generated.
A subscription that is currently in a trial period is trialing and moves to active when the trial period is over.
If subscription collection_method=charge_automatically it becomes past_due when payment to renew it fails and canceled or unpaid (depending on your subscriptions settings) when Stripe has exhausted all payment retry attempts.
If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
Related guides: Set up a subscription and more about products and prices.
- * @property \Stripe\Price $pricePrices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. Products help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.
Related guides: Set up a subscription, create an invoice, and more about products and prices.
- * @property int $quantity The quantity of the plan to which the customer should be subscribed. - * @property string $subscription Thesubscription this subscription_item belongs to.
- * @property null|\Stripe\TaxRate[] $tax_rates The tax rates which apply to this subscription_item. When set, the default_tax_rates on the subscription do not apply to this subscription_item.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @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 \Stripe\Plan $plan You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
Related guides: Set up a subscription and more about products and prices.
+ * @property \Stripe\Price $pricePrices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. Products help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.
Related guides: Set up a subscription, create an invoice, and more about products and prices.
+ * @property int $quantity The quantity of the plan to which the customer should be subscribed. + * @property string $subscription Thesubscription this subscription_item belongs to.
+ * @property null|\Stripe\TaxRate[] $tax_rates The tax rates which apply to this subscription_item. When set, the default_tax_rates on the subscription do not apply to this subscription_item.
*/
class SubscriptionItem extends ApiResource
{
- const OBJECT_NAME = 'subscription_item';
+ public const OBJECT_NAME = 'subscription_item';
use ApiOperations\All;
use ApiOperations\Create;
@@ -30,11 +30,11 @@ class SubscriptionItem extends ApiResource
use ApiOperations\Retrieve;
use ApiOperations\Update;
- const PATH_USAGE_RECORDS = '/usage_records';
+ public const PATH_USAGE_RECORDS = '/usage_records';
/**
- * @param null|string $id the ID of the subscription item on which to create the usage record
- * @param null|array $params
+ * @param null|string $id the ID of the subscription item on which to create the usage record
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -46,11 +46,11 @@ class SubscriptionItem extends ApiResource
return self::_createNestedResource($id, static::PATH_USAGE_RECORDS, $params, $opts);
}
- const PATH_USAGE_RECORD_SUMMARIES = '/usage_record_summaries';
+ public const PATH_USAGE_RECORD_SUMMARIES = '/usage_record_summaries';
/**
- * @param string $id the ID of the subscription item on which to retrieve the usage record summaries
- * @param null|array $params
+ * @param string $id the ID of the subscription item on which to retrieve the usage record summaries
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/SubscriptionSchedule.php b/Stripe/Stripe/SubscriptionSchedule.php
index cc00117..e006613 100755
--- a/Stripe/Stripe/SubscriptionSchedule.php
+++ b/Stripe/Stripe/SubscriptionSchedule.php
@@ -1,4 +1,4 @@
-Subscription
* Schedules.
*
- * @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 null|string|\Stripe\StripeObject $application ID of the Connect Application that created the schedule.
- * @property null|int $canceled_at Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
- * @property null|int $completed_at Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property null|\Stripe\StripeObject $current_phase Object representing the start and end dates for the current phase of the subscription schedule, if it is active.
- * @property string|\Stripe\Customer $customer ID of the customer who owns the subscription schedule.
- * @property \Stripe\StripeObject $default_settings
- * @property string $end_behavior Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running.cancel will end the subscription schedule and cancel the underlying subscription.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|\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 \Stripe\StripeObject[] $phases Configuration for the subscription schedule's phases.
- * @property null|int $released_at Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
- * @property null|string $released_subscription ID of the subscription once managed by the subscription schedule (if it is released).
- * @property string $status The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.
- * @property null|string|\Stripe\Subscription $subscription ID of the subscription managed by the subscription schedule.
- * @property null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this subscription schedule belongs to.
+ * @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 null|string|\Stripe\StripeObject $application ID of the Connect Application that created the schedule.
+ * @property null|int $canceled_at Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
+ * @property null|int $completed_at Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|\Stripe\StripeObject $current_phase Object representing the start and end dates for the current phase of the subscription schedule, if it is active.
+ * @property string|\Stripe\Customer $customer ID of the customer who owns the subscription schedule.
+ * @property \Stripe\StripeObject $default_settings
+ * @property string $end_behavior Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running.cancel will end the subscription schedule and cancel the underlying subscription.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|\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 \Stripe\StripeObject[] $phases Configuration for the subscription schedule's phases.
+ * @property null|int $released_at Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
+ * @property null|string $released_subscription ID of the subscription once managed by the subscription schedule (if it is released).
+ * @property string $status The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.
+ * @property null|string|\Stripe\Subscription $subscription ID of the subscription managed by the subscription schedule.
+ * @property null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this subscription schedule belongs to.
*/
class SubscriptionSchedule extends ApiResource
{
- const OBJECT_NAME = 'subscription_schedule';
+ public const OBJECT_NAME = 'subscription_schedule';
use ApiOperations\All;
use ApiOperations\Create;
@@ -41,7 +41,7 @@ class SubscriptionSchedule extends ApiResource
use ApiOperations\Update;
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -50,7 +50,7 @@ class SubscriptionSchedule extends ApiResource
*/
public function cancel($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/cancel';
+ $url = $this->instanceUrl() . '/cancel';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -58,7 +58,7 @@ class SubscriptionSchedule extends ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -67,7 +67,7 @@ class SubscriptionSchedule extends ApiResource
*/
public function release($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/release';
+ $url = $this->instanceUrl() . '/release';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
diff --git a/Stripe/Stripe/TaxCode.php b/Stripe/Stripe/TaxCode.php
index 0dfc49e..db948da 100755
--- a/Stripe/Stripe/TaxCode.php
+++ b/Stripe/Stripe/TaxCode.php
@@ -1,4 +1,4 @@
-Tax codes classify
* goods and services for tax purposes.
*
- * @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 $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 $description A detailed description of which types of products the tax code represents.
- * @property string $name A short name for the tax code.
+ * @property string $name A short name for the tax code.
*/
class TaxCode extends ApiResource
{
- const OBJECT_NAME = 'tax_code';
+ public const OBJECT_NAME = 'tax_code';
use ApiOperations\All;
use ApiOperations\Retrieve;
diff --git a/Stripe/Stripe/TaxId.php b/Stripe/Stripe/TaxId.php
index 0e2dd4a..03a2a7d 100755
--- a/Stripe/Stripe/TaxId.php
+++ b/Stripe/Stripe/TaxId.php
@@ -1,4 +1,4 @@
-Customer
* Tax Identification Numbers.
*
- * @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 null|string $country Two-letter ISO code representing the country of the tax ID.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property null|string|\Stripe\Customer $customer ID of the customer.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property string $type Type of the tax ID, one of ae_trn, au_abn, au_arn, bg_uic, br_cnpj, br_cpf, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, ch_vat, cl_tin, eg_tin, es_cif, eu_oss_vat, eu_vat, gb_vat, ge_vat, hk_br, hu_tin, id_npwp, il_vat, in_gst, is_vat, jp_cn, jp_rn, jp_trn, ke_pin, kr_brn, li_uid, mx_rfc, my_frp, my_itn, my_sst, no_vat, nz_gst, ph_tin, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, th_vat, tr_tin, tw_vat, ua_vat, us_ein, or za_vat. Note that some legacy tax IDs have type unknown
- * @property string $value Value of the tax ID.
- * @property null|\Stripe\StripeObject $verification Tax ID verification information.
+ * @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 null|string $country Two-letter ISO code representing the country of the tax ID.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|string|\Stripe\Customer $customer ID of the customer.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string $type Type of the tax ID, one of ae_trn, au_abn, au_arn, bg_uic, br_cnpj, br_cpf, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, ch_vat, cl_tin, eg_tin, es_cif, eu_oss_vat, eu_vat, gb_vat, ge_vat, hk_br, hu_tin, id_npwp, il_vat, in_gst, is_vat, jp_cn, jp_rn, jp_trn, ke_pin, kr_brn, li_uid, mx_rfc, my_frp, my_itn, my_sst, no_vat, nz_gst, ph_tin, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, th_vat, tr_tin, tw_vat, ua_vat, us_ein, or za_vat. Note that some legacy tax IDs have type unknown
+ * @property string $value Value of the tax ID.
+ * @property null|\Stripe\StripeObject $verification Tax ID verification information.
*/
class TaxId extends ApiResource
{
- const OBJECT_NAME = 'tax_id';
+ public const OBJECT_NAME = 'tax_id';
use ApiOperations\Delete;
- const TYPE_AE_TRN = 'ae_trn';
- const TYPE_AU_ABN = 'au_abn';
- const TYPE_AU_ARN = 'au_arn';
- const TYPE_BG_UIC = 'bg_uic';
- const TYPE_BR_CNPJ = 'br_cnpj';
- const TYPE_BR_CPF = 'br_cpf';
- const TYPE_CA_BN = 'ca_bn';
- const TYPE_CA_GST_HST = 'ca_gst_hst';
- const TYPE_CA_PST_BC = 'ca_pst_bc';
- const TYPE_CA_PST_MB = 'ca_pst_mb';
- const TYPE_CA_PST_SK = 'ca_pst_sk';
- const TYPE_CA_QST = 'ca_qst';
- const TYPE_CH_VAT = 'ch_vat';
- const TYPE_CL_TIN = 'cl_tin';
- const TYPE_EG_TIN = 'eg_tin';
- const TYPE_ES_CIF = 'es_cif';
- const TYPE_EU_OSS_VAT = 'eu_oss_vat';
- const TYPE_EU_VAT = 'eu_vat';
- const TYPE_GB_VAT = 'gb_vat';
- const TYPE_GE_VAT = 'ge_vat';
- const TYPE_HK_BR = 'hk_br';
- const TYPE_HU_TIN = 'hu_tin';
- const TYPE_ID_NPWP = 'id_npwp';
- const TYPE_IL_VAT = 'il_vat';
- const TYPE_IN_GST = 'in_gst';
- const TYPE_IS_VAT = 'is_vat';
- const TYPE_JP_CN = 'jp_cn';
- const TYPE_JP_RN = 'jp_rn';
- const TYPE_JP_TRN = 'jp_trn';
- const TYPE_KE_PIN = 'ke_pin';
- const TYPE_KR_BRN = 'kr_brn';
- const TYPE_LI_UID = 'li_uid';
- const TYPE_MX_RFC = 'mx_rfc';
- const TYPE_MY_FRP = 'my_frp';
- const TYPE_MY_ITN = 'my_itn';
- const TYPE_MY_SST = 'my_sst';
- const TYPE_NO_VAT = 'no_vat';
- const TYPE_NZ_GST = 'nz_gst';
- const TYPE_PH_TIN = 'ph_tin';
- const TYPE_RU_INN = 'ru_inn';
- const TYPE_RU_KPP = 'ru_kpp';
- const TYPE_SA_VAT = 'sa_vat';
- const TYPE_SG_GST = 'sg_gst';
- const TYPE_SG_UEN = 'sg_uen';
- const TYPE_SI_TIN = 'si_tin';
- const TYPE_TH_VAT = 'th_vat';
- const TYPE_TR_TIN = 'tr_tin';
- const TYPE_TW_VAT = 'tw_vat';
- const TYPE_UA_VAT = 'ua_vat';
- const TYPE_UNKNOWN = 'unknown';
- const TYPE_US_EIN = 'us_ein';
- const TYPE_ZA_VAT = 'za_vat';
+ public const TYPE_AE_TRN = 'ae_trn';
- const VERIFICATION_STATUS_PENDING = 'pending';
- const VERIFICATION_STATUS_UNAVAILABLE = 'unavailable';
- const VERIFICATION_STATUS_UNVERIFIED = 'unverified';
- const VERIFICATION_STATUS_VERIFIED = 'verified';
+ public const TYPE_AU_ABN = 'au_abn';
+
+ public const TYPE_AU_ARN = 'au_arn';
+
+ public const TYPE_BG_UIC = 'bg_uic';
+
+ public const TYPE_BR_CNPJ = 'br_cnpj';
+
+ public const TYPE_BR_CPF = 'br_cpf';
+
+ public const TYPE_CA_BN = 'ca_bn';
+
+ public const TYPE_CA_GST_HST = 'ca_gst_hst';
+
+ public const TYPE_CA_PST_BC = 'ca_pst_bc';
+
+ public const TYPE_CA_PST_MB = 'ca_pst_mb';
+
+ public const TYPE_CA_PST_SK = 'ca_pst_sk';
+
+ public const TYPE_CA_QST = 'ca_qst';
+
+ public const TYPE_CH_VAT = 'ch_vat';
+
+ public const TYPE_CL_TIN = 'cl_tin';
+
+ public const TYPE_EG_TIN = 'eg_tin';
+
+ public const TYPE_ES_CIF = 'es_cif';
+
+ public const TYPE_EU_OSS_VAT = 'eu_oss_vat';
+
+ public const TYPE_EU_VAT = 'eu_vat';
+
+ public const TYPE_GB_VAT = 'gb_vat';
+
+ public const TYPE_GE_VAT = 'ge_vat';
+
+ public const TYPE_HK_BR = 'hk_br';
+
+ public const TYPE_HU_TIN = 'hu_tin';
+
+ public const TYPE_ID_NPWP = 'id_npwp';
+
+ public const TYPE_IL_VAT = 'il_vat';
+
+ public const TYPE_IN_GST = 'in_gst';
+
+ public const TYPE_IS_VAT = 'is_vat';
+
+ public const TYPE_JP_CN = 'jp_cn';
+
+ public const TYPE_JP_RN = 'jp_rn';
+
+ public const TYPE_JP_TRN = 'jp_trn';
+
+ public const TYPE_KE_PIN = 'ke_pin';
+
+ public const TYPE_KR_BRN = 'kr_brn';
+
+ public const TYPE_LI_UID = 'li_uid';
+
+ public const TYPE_MX_RFC = 'mx_rfc';
+
+ public const TYPE_MY_FRP = 'my_frp';
+
+ public const TYPE_MY_ITN = 'my_itn';
+
+ public const TYPE_MY_SST = 'my_sst';
+
+ public const TYPE_NO_VAT = 'no_vat';
+
+ public const TYPE_NZ_GST = 'nz_gst';
+
+ public const TYPE_PH_TIN = 'ph_tin';
+
+ public const TYPE_RU_INN = 'ru_inn';
+
+ public const TYPE_RU_KPP = 'ru_kpp';
+
+ public const TYPE_SA_VAT = 'sa_vat';
+
+ public const TYPE_SG_GST = 'sg_gst';
+
+ public const TYPE_SG_UEN = 'sg_uen';
+
+ public const TYPE_SI_TIN = 'si_tin';
+
+ public const TYPE_TH_VAT = 'th_vat';
+
+ public const TYPE_TR_TIN = 'tr_tin';
+
+ public const TYPE_TW_VAT = 'tw_vat';
+
+ public const TYPE_UA_VAT = 'ua_vat';
+
+ public const TYPE_UNKNOWN = 'unknown';
+
+ public const TYPE_US_EIN = 'us_ein';
+
+ public const TYPE_ZA_VAT = 'za_vat';
+
+ public const VERIFICATION_STATUS_PENDING = 'pending';
+
+ public const VERIFICATION_STATUS_UNAVAILABLE = 'unavailable';
+
+ public const VERIFICATION_STATUS_UNVERIFIED = 'unverified';
+
+ public const VERIFICATION_STATUS_VERIFIED = 'verified';
/**
* @return string the API URL for this tax id
*/
public function instanceUrl()
{
- $id = $this['id'];
+ $id = $this['id'];
$customer = $this['customer'];
if (!$id) {
throw new Exception\UnexpectedValueException(
"Could not determine which URL to request: class instance has invalid ID: {$id}"
);
}
- $id = Util\Util::utf8($id);
+ $id = Util\Util::utf8($id);
$customer = Util\Util::utf8($customer);
- $base = Customer::classUrl();
+ $base = Customer::classUrl();
$customerExtn = \urlencode($customer);
- $extn = \urlencode($id);
+ $extn = \urlencode($id);
return "{$base}/{$customerExtn}/tax_ids/{$extn}";
}
/**
- * @param array|string $_id
+ * @param array|string $_id
* @param null|array|string $_opts
*
* @throws \Stripe\Exception\BadMethodCallException
*/
- public static function retrieve($_id, $_opts = null)
+ public static function retrieve($_id, $_opts = null) : void
{
$msg = 'Tax IDs cannot be retrieved without a customer ID. Retrieve ' .
"a tax ID using `Customer::retrieveTaxId('customer_id', " .
diff --git a/Stripe/Stripe/TaxRate.php b/Stripe/Stripe/TaxRate.php
index 5a45637..0ceda1e 100755
--- a/Stripe/Stripe/TaxRate.php
+++ b/Stripe/Stripe/TaxRate.php
@@ -1,4 +1,4 @@
-Tax
* Rates.
*
- * @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 bool $active Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.
- * @property null|string $country Two-letter country code (ISO 3166-1 alpha-2).
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property null|string $description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
- * @property string $display_name The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
- * @property bool $inclusive This specifies if the tax rate is inclusive or exclusive.
- * @property null|string $jurisdiction The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|\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 float $percentage This represents the tax rate percent out of 100.
- * @property null|string $state ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
- * @property null|string $tax_type The high-level tax type, such as vat or sales_tax.
+ * @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 bool $active Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.
+ * @property null|string $country Two-letter country code (ISO 3166-1 alpha-2).
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|string $description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
+ * @property string $display_name The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
+ * @property bool $inclusive This specifies if the tax rate is inclusive or exclusive.
+ * @property null|string $jurisdiction The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|\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 float $percentage This represents the tax rate percent out of 100.
+ * @property null|string $state ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
+ * @property null|string $tax_type The high-level tax type, such as vat or sales_tax.
*/
class TaxRate extends ApiResource
{
- const OBJECT_NAME = 'tax_rate';
+ public const OBJECT_NAME = 'tax_rate';
use ApiOperations\All;
use ApiOperations\Create;
use ApiOperations\Retrieve;
use ApiOperations\Update;
- const TAX_TYPE_GST = 'gst';
- const TAX_TYPE_HST = 'hst';
- const TAX_TYPE_JCT = 'jct';
- const TAX_TYPE_PST = 'pst';
- const TAX_TYPE_QST = 'qst';
- const TAX_TYPE_RST = 'rst';
- const TAX_TYPE_SALES_TAX = 'sales_tax';
- const TAX_TYPE_VAT = 'vat';
+ public const TAX_TYPE_GST = 'gst';
+
+ public const TAX_TYPE_HST = 'hst';
+
+ public const TAX_TYPE_JCT = 'jct';
+
+ public const TAX_TYPE_PST = 'pst';
+
+ public const TAX_TYPE_QST = 'qst';
+
+ public const TAX_TYPE_RST = 'rst';
+
+ public const TAX_TYPE_SALES_TAX = 'sales_tax';
+
+ public const TAX_TYPE_VAT = 'vat';
}
diff --git a/Stripe/Stripe/Terminal/Configuration.php b/Stripe/Stripe/Terminal/Configuration.php
index f34831f..d90ef1c 100755
--- a/Stripe/Stripe/Terminal/Configuration.php
+++ b/Stripe/Stripe/Terminal/Configuration.php
@@ -1,4 +1,4 @@
-true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|bool $is_account_default Whether this Configuration is the default for your account
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
* @property \Stripe\StripeObject $tipping
* @property \Stripe\StripeObject $verifone_p400
*/
class Configuration extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'terminal.configuration';
+ public const OBJECT_NAME = 'terminal.configuration';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
diff --git a/Stripe/Stripe/Terminal/ConnectionToken.php b/Stripe/Stripe/Terminal/ConnectionToken.php
index e49a0b0..bcb0264 100755
--- a/Stripe/Stripe/Terminal/ConnectionToken.php
+++ b/Stripe/Stripe/Terminal/ConnectionToken.php
@@ -1,4 +1,4 @@
-Fleet
* Management.
*
- * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
* @property string $location The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see the docs on scoping connection tokens.
- * @property string $secret Your application should pass this token to the Stripe Terminal SDK.
+ * @property string $secret Your application should pass this token to the Stripe Terminal SDK.
*/
class ConnectionToken extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'terminal.connection_token';
+ public const OBJECT_NAME = 'terminal.connection_token';
use \Stripe\ApiOperations\Create;
}
diff --git a/Stripe/Stripe/Terminal/Location.php b/Stripe/Stripe/Terminal/Location.php
index 11c625d..38ede54 100755
--- a/Stripe/Stripe/Terminal/Location.php
+++ b/Stripe/Stripe/Terminal/Location.php
@@ -1,4 +1,4 @@
-Fleet
* Management.
*
- * @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 $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 \Stripe\StripeObject $address
- * @property string $configuration_overrides The ID of a configuration that will be used to customize all readers in this location.
- * @property string $display_name The display name of the location.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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 string $configuration_overrides The ID of a configuration that will be used to customize all readers in this location.
+ * @property string $display_name The display name of the location.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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.
*/
class Location extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'terminal.location';
+ public const OBJECT_NAME = 'terminal.location';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
diff --git a/Stripe/Stripe/Terminal/Reader.php b/Stripe/Stripe/Terminal/Reader.php
index 16d610a..5f0a830 100755
--- a/Stripe/Stripe/Terminal/Reader.php
+++ b/Stripe/Stripe/Terminal/Reader.php
@@ -1,4 +1,4 @@
-Connecting to a
* Reader.
*
- * @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 null|\Stripe\StripeObject $action The most recent action performed by the reader.
- * @property null|string $device_sw_version The current software version of the reader.
- * @property string $device_type Type of reader, one of bbpos_wisepad3, stripe_m2, bbpos_chipper2x, bbpos_wisepos_e, verifone_P400, or simulated_wisepos_e.
- * @property null|string $ip_address The local IP address of the reader.
- * @property string $label Custom label given to the reader for easier identification.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|string|\Stripe\Terminal\Location $location The location identifier of the reader.
- * @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 string $serial_number Serial number of the reader.
- * @property null|string $status The networking status of the reader.
+ * @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 null|\Stripe\StripeObject $action The most recent action performed by the reader.
+ * @property null|string $device_sw_version The current software version of the reader.
+ * @property string $device_type Type of reader, one of bbpos_wisepad3, stripe_m2, bbpos_chipper2x, bbpos_wisepos_e, verifone_P400, or simulated_wisepos_e.
+ * @property null|string $ip_address The local IP address of the reader.
+ * @property string $label Custom label given to the reader for easier identification.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|string|\Stripe\Terminal\Location $location The location identifier of the reader.
+ * @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 string $serial_number Serial number of the reader.
+ * @property null|string $status The networking status of the reader.
*/
class Reader extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'terminal.reader';
+ public const OBJECT_NAME = 'terminal.reader';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
@@ -35,7 +35,7 @@ class Reader extends \Stripe\ApiResource
use \Stripe\ApiOperations\Update;
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -44,7 +44,7 @@ class Reader extends \Stripe\ApiResource
*/
public function cancelAction($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/cancel_action';
+ $url = $this->instanceUrl() . '/cancel_action';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -52,7 +52,7 @@ class Reader extends \Stripe\ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -61,7 +61,7 @@ class Reader extends \Stripe\ApiResource
*/
public function processPaymentIntent($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/process_payment_intent';
+ $url = $this->instanceUrl() . '/process_payment_intent';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -69,7 +69,7 @@ class Reader extends \Stripe\ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -78,7 +78,7 @@ class Reader extends \Stripe\ApiResource
*/
public function processSetupIntent($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/process_setup_intent';
+ $url = $this->instanceUrl() . '/process_setup_intent';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
@@ -86,7 +86,7 @@ class Reader extends \Stripe\ApiResource
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -95,7 +95,7 @@ class Reader extends \Stripe\ApiResource
*/
public function setReaderDisplay($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/set_reader_display';
+ $url = $this->instanceUrl() . '/set_reader_display';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
diff --git a/Stripe/Stripe/TestHelpers/TestClock.php b/Stripe/Stripe/TestHelpers/TestClock.php
index 01d36ea..391056e 100755
--- a/Stripe/Stripe/TestHelpers/TestClock.php
+++ b/Stripe/Stripe/TestHelpers/TestClock.php
@@ -1,4 +1,4 @@
-true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|string $name The custom name supplied at creation.
- * @property string $status The status of the Test Clock.
+ * @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 int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property int $deletes_after Time at which this clock is scheduled to auto delete.
+ * @property int $frozen_time Time at which all objects belonging to this clock are frozen.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|string $name The custom name supplied at creation.
+ * @property string $status The status of the Test Clock.
*/
class TestClock extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'test_helpers.test_clock';
+ public const OBJECT_NAME = 'test_helpers.test_clock';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Delete;
use \Stripe\ApiOperations\Retrieve;
- const STATUS_ADVANCING = 'advancing';
- const STATUS_INTERNAL_FAILURE = 'internal_failure';
- const STATUS_READY = 'ready';
+ public const STATUS_ADVANCING = 'advancing';
+
+ public const STATUS_INTERNAL_FAILURE = 'internal_failure';
+
+ public const STATUS_READY = 'ready';
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -44,7 +46,7 @@ class TestClock extends \Stripe\ApiResource
*/
public function advance($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/advance';
+ $url = $this->instanceUrl() . '/advance';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
diff --git a/Stripe/Stripe/Token.php b/Stripe/Stripe/Token.php
index 18b33e8..7f80dad 100755
--- a/Stripe/Stripe/Token.php
+++ b/Stripe/Stripe/Token.php
@@ -1,4 +1,4 @@
-Accept
* a payment
*
- * @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 $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 \Stripe\BankAccount $bank_account These bank accounts are payment methods on Customer objects.
On the other hand External Accounts are transfer destinations on Account objects for Custom accounts. They can be bank accounts or debit cards as well, and are documented in the links above.
Related guide: Bank Debits and Transfers.
- * @property \Stripe\Card $cardYou can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later.
Related guide: Card Payments with Sources.
- * @property null|string $client_ip IP address of the client that generated the token. - * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. - * @property bool $livemode Has the valuetrue if the object exists in live mode or the value false if the object exists in test mode.
- * @property string $type Type of the token: account, bank_account, card, or pii.
- * @property bool $used Whether this token has already been used (tokens can be used only once).
+ * @property \Stripe\Card $card You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later.
Related guide: Card Payments with Sources.
+ * @property null|string $client_ip IP address of the client that generated the token. + * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. + * @property bool $livemode Has the valuetrue if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string $type Type of the token: account, bank_account, card, or pii.
+ * @property bool $used Whether this token has already been used (tokens can be used only once).
*/
class Token extends ApiResource
{
- const OBJECT_NAME = 'token';
+ public const OBJECT_NAME = 'token';
use ApiOperations\Create;
use ApiOperations\Retrieve;
- const TYPE_ACCOUNT = 'account';
- const TYPE_BANK_ACCOUNT = 'bank_account';
- const TYPE_CARD = 'card';
- const TYPE_PII = 'pii';
+ public const TYPE_ACCOUNT = 'account';
+
+ public const TYPE_BANK_ACCOUNT = 'bank_account';
+
+ public const TYPE_CARD = 'card';
+
+ public const TYPE_PII = 'pii';
}
diff --git a/Stripe/Stripe/Topup.php b/Stripe/Stripe/Topup.php
index a0ea053..f59e670 100755
--- a/Stripe/Stripe/Topup.php
+++ b/Stripe/Stripe/Topup.php
@@ -1,4 +1,4 @@
-Topping Up your
* Platform Account.
*
- * @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 int $amount Amount transferred.
- * @property null|string|\Stripe\BalanceTransaction $balance_transaction ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
- * @property null|int $expected_availability_date Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.
- * @property null|string $failure_code Error code explaining reason for top-up failure if available (see the errors section for a list of codes).
- * @property null|string $failure_message Message to user further explaining reason for top-up failure if available.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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|\Stripe\Source $source For most Stripe users, the source of every top-up is a bank account. This hash is then the source object describing that bank account.
- * @property null|string $statement_descriptor Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.
- * @property string $status The status of the top-up is either canceled, failed, pending, reversed, or succeeded.
- * @property null|string $transfer_group A string that identifies this top-up as part of a group.
+ * @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 int $amount Amount transferred.
+ * @property null|string|\Stripe\BalanceTransaction $balance_transaction ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
+ * @property null|int $expected_availability_date Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.
+ * @property null|string $failure_code Error code explaining reason for top-up failure if available (see the errors section for a list of codes).
+ * @property null|string $failure_message Message to user further explaining reason for top-up failure if available.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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|\Stripe\Source $source For most Stripe users, the source of every top-up is a bank account. This hash is then the source object describing that bank account.
+ * @property null|string $statement_descriptor Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.
+ * @property string $status The status of the top-up is either canceled, failed, pending, reversed, or succeeded.
+ * @property null|string $transfer_group A string that identifies this top-up as part of a group.
*/
class Topup extends ApiResource
{
- const OBJECT_NAME = 'topup';
+ public const OBJECT_NAME = 'topup';
use ApiOperations\All;
use ApiOperations\Create;
use ApiOperations\Retrieve;
use ApiOperations\Update;
- const STATUS_CANCELED = 'canceled';
- const STATUS_FAILED = 'failed';
- const STATUS_PENDING = 'pending';
- const STATUS_REVERSED = 'reversed';
- const STATUS_SUCCEEDED = 'succeeded';
+ public const STATUS_CANCELED = 'canceled';
+
+ public const STATUS_FAILED = 'failed';
+
+ public const STATUS_PENDING = 'pending';
+
+ public const STATUS_REVERSED = 'reversed';
+
+ public const STATUS_SUCCEEDED = 'succeeded';
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -54,7 +58,7 @@ class Topup extends ApiResource
*/
public function cancel($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/cancel';
+ $url = $this->instanceUrl() . '/cancel';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
diff --git a/Stripe/Stripe/Transfer.php b/Stripe/Stripe/Transfer.php
index f93e3bd..32f6092 100755
--- a/Stripe/Stripe/Transfer.php
+++ b/Stripe/Stripe/Transfer.php
@@ -1,4 +1,4 @@
-Creating Separate
* Charges and Transfers.
*
- * @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 int $amount Amount in %s to be transferred.
- * @property int $amount_reversed Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).
- * @property null|string|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact of this transfer on your account balance.
- * @property int $created Time that this record of the transfer was first created.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
- * @property null|string|\Stripe\Account $destination ID of the Stripe account the transfer was sent to.
- * @property string|\Stripe\Charge $destination_payment If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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 \Stripe\Collection<\Stripe\TransferReversal> $reversals A list of reversals that have been applied to the transfer.
- * @property bool $reversed Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.
- * @property null|string|\Stripe\Charge $source_transaction ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance.
- * @property string $source_type The source balance this transfer came from. One of card, fpx, or bank_account.
- * @property null|string $transfer_group A string that identifies this transaction as part of a group. See the Connect documentation for details.
+ * @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 int $amount Amount in %s to be transferred.
+ * @property int $amount_reversed Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).
+ * @property null|string|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact of this transfer on your account balance.
+ * @property int $created Time that this record of the transfer was first created.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
+ * @property null|string|\Stripe\Account $destination ID of the Stripe account the transfer was sent to.
+ * @property string|\Stripe\Charge $destination_payment If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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 \Stripe\Collection<\Stripe\TransferReversal> $reversals A list of reversals that have been applied to the transfer.
+ * @property bool $reversed Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.
+ * @property null|string|\Stripe\Charge $source_transaction ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance.
+ * @property string $source_type The source balance this transfer came from. One of card, fpx, or bank_account.
+ * @property null|string $transfer_group A string that identifies this transaction as part of a group. See the Connect documentation for details.
*/
class Transfer extends ApiResource
{
- const OBJECT_NAME = 'transfer';
+ public const OBJECT_NAME = 'transfer';
use ApiOperations\All;
use ApiOperations\Create;
@@ -46,15 +46,17 @@ class Transfer extends ApiResource
use ApiOperations\Retrieve;
use ApiOperations\Update;
- const SOURCE_TYPE_BANK_ACCOUNT = 'bank_account';
- const SOURCE_TYPE_CARD = 'card';
- const SOURCE_TYPE_FPX = 'fpx';
+ public const SOURCE_TYPE_BANK_ACCOUNT = 'bank_account';
- const PATH_REVERSALS = '/reversals';
+ public const SOURCE_TYPE_CARD = 'card';
+
+ public const SOURCE_TYPE_FPX = 'fpx';
+
+ public const PATH_REVERSALS = '/reversals';
/**
- * @param string $id the ID of the transfer on which to retrieve the transfer reversals
- * @param null|array $params
+ * @param string $id the ID of the transfer on which to retrieve the transfer reversals
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -67,8 +69,8 @@ class Transfer extends ApiResource
}
/**
- * @param string $id the ID of the transfer on which to create the transfer reversal
- * @param null|array $params
+ * @param string $id the ID of the transfer on which to create the transfer reversal
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -81,9 +83,9 @@ class Transfer extends ApiResource
}
/**
- * @param string $id the ID of the transfer to which the transfer reversal belongs
- * @param string $reversalId the ID of the transfer reversal to retrieve
- * @param null|array $params
+ * @param string $id the ID of the transfer to which the transfer reversal belongs
+ * @param string $reversalId the ID of the transfer reversal to retrieve
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -96,9 +98,9 @@ class Transfer extends ApiResource
}
/**
- * @param string $id the ID of the transfer to which the transfer reversal belongs
- * @param string $reversalId the ID of the transfer reversal to update
- * @param null|array $params
+ * @param string $id the ID of the transfer to which the transfer reversal belongs
+ * @param string $reversalId the ID of the transfer reversal to update
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
diff --git a/Stripe/Stripe/TransferReversal.php b/Stripe/Stripe/TransferReversal.php
index b6167db..b52ed3d 100755
--- a/Stripe/Stripe/TransferReversal.php
+++ b/Stripe/Stripe/TransferReversal.php
@@ -1,4 +1,4 @@
-Reversing
* Transfers.
*
- * @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 int $amount Amount, in %s.
- * @property null|string|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact on your account balance.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property null|string|\Stripe\Refund $destination_payment_refund Linked payment refund for the transfer reversal.
- * @property null|\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|\Stripe\Refund $source_refund ID of the refund responsible for the transfer reversal.
- * @property string|\Stripe\Transfer $transfer ID of the transfer that was reversed.
+ * @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 int $amount Amount, in %s.
+ * @property null|string|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact on your account balance.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property null|string|\Stripe\Refund $destination_payment_refund Linked payment refund for the transfer reversal.
+ * @property null|\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|\Stripe\Refund $source_refund ID of the refund responsible for the transfer reversal.
+ * @property string|\Stripe\Transfer $transfer ID of the transfer that was reversed.
*/
class TransferReversal extends ApiResource
{
- const OBJECT_NAME = 'transfer_reversal';
+ public const OBJECT_NAME = 'transfer_reversal';
use ApiOperations\Update {
save as protected _save;
@@ -46,7 +46,7 @@ class TransferReversal extends ApiResource
*/
public function instanceUrl()
{
- $id = $this['id'];
+ $id = $this['id'];
$transfer = $this['transfer'];
if (!$id) {
throw new Exception\UnexpectedValueException(
@@ -55,12 +55,12 @@ class TransferReversal extends ApiResource
null
);
}
- $id = Util\Util::utf8($id);
+ $id = Util\Util::utf8($id);
$transfer = Util\Util::utf8($transfer);
- $base = Transfer::classUrl();
+ $base = Transfer::classUrl();
$transferExtn = \urlencode($transfer);
- $extn = \urlencode($id);
+ $extn = \urlencode($id);
return "{$base}/{$transferExtn}/reversals/{$extn}";
}
diff --git a/Stripe/Stripe/Treasury/CreditReversal.php b/Stripe/Stripe/Treasury/CreditReversal.php
index e142d81..2d67946 100755
--- a/Stripe/Stripe/Treasury/CreditReversal.php
+++ b/Stripe/Stripe/Treasury/CreditReversal.php
@@ -1,4 +1,4 @@
-ISO currency code, in lowercase. Must be a supported currency.
- * @property string $financial_account The FinancialAccount to reverse funds from.
- * @property null|string $hosted_regulatory_receipt_url A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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 string $network The rails used to reverse the funds.
- * @property string $received_credit The ReceivedCredit being reversed.
- * @property string $status Status of the CreditReversal
- * @property \Stripe\StripeObject $status_transitions
- * @property null|string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object.
+ * @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 int $amount Amount (in cents) transferred.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string $financial_account The FinancialAccount to reverse funds from.
+ * @property null|string $hosted_regulatory_receipt_url A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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 string $network The rails used to reverse the funds.
+ * @property string $received_credit The ReceivedCredit being reversed.
+ * @property string $status Status of the CreditReversal
+ * @property \Stripe\StripeObject $status_transitions
+ * @property null|string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object.
*/
class CreditReversal extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'treasury.credit_reversal';
+ public const OBJECT_NAME = 'treasury.credit_reversal';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
- const NETWORK_ACH = 'ach';
- const NETWORK_STRIPE = 'stripe';
+ public const NETWORK_ACH = 'ach';
- const STATUS_CANCELED = 'canceled';
- const STATUS_POSTED = 'posted';
- const STATUS_PROCESSING = 'processing';
+ public const NETWORK_STRIPE = 'stripe';
+
+ public const STATUS_CANCELED = 'canceled';
+
+ public const STATUS_POSTED = 'posted';
+
+ public const STATUS_PROCESSING = 'processing';
}
diff --git a/Stripe/Stripe/Treasury/DebitReversal.php b/Stripe/Stripe/Treasury/DebitReversal.php
index fa55033..1f44313 100755
--- a/Stripe/Stripe/Treasury/DebitReversal.php
+++ b/Stripe/Stripe/Treasury/DebitReversal.php
@@ -1,4 +1,4 @@
-ISO currency code, in lowercase. Must be a supported currency.
- * @property null|string $financial_account The FinancialAccount to reverse funds from.
- * @property null|string $hosted_regulatory_receipt_url A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
- * @property null|\Stripe\StripeObject $linked_flows Other flows linked to a DebitReversal.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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 string $network The rails used to reverse the funds.
- * @property string $received_debit The ReceivedDebit being reversed.
- * @property string $status Status of the DebitReversal
- * @property \Stripe\StripeObject $status_transitions
- * @property null|string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object.
+ * @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 int $amount Amount (in cents) transferred.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property null|string $financial_account The FinancialAccount to reverse funds from.
+ * @property null|string $hosted_regulatory_receipt_url A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+ * @property null|\Stripe\StripeObject $linked_flows Other flows linked to a DebitReversal.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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 string $network The rails used to reverse the funds.
+ * @property string $received_debit The ReceivedDebit being reversed.
+ * @property string $status Status of the DebitReversal
+ * @property \Stripe\StripeObject $status_transitions
+ * @property null|string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object.
*/
class DebitReversal extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'treasury.debit_reversal';
+ public const OBJECT_NAME = 'treasury.debit_reversal';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
- const NETWORK_ACH = 'ach';
- const NETWORK_CARD = 'card';
+ public const NETWORK_ACH = 'ach';
- const STATUS_FAILED = 'failed';
- const STATUS_PROCESSING = 'processing';
- const STATUS_SUCCEEDED = 'succeeded';
+ public const NETWORK_CARD = 'card';
+
+ public const STATUS_FAILED = 'failed';
+
+ public const STATUS_PROCESSING = 'processing';
+
+ public const STATUS_SUCCEEDED = 'succeeded';
}
diff --git a/Stripe/Stripe/Treasury/FinancialAccount.php b/Stripe/Stripe/Treasury/FinancialAccount.php
index a5c63c8..b3988bb 100755
--- a/Stripe/Stripe/Treasury/FinancialAccount.php
+++ b/Stripe/Stripe/Treasury/FinancialAccount.php
@@ -1,4 +1,4 @@
-ISO 3166-1 alpha-2).
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property \Stripe\Treasury\FinancialAccountFeatures $features Encodes whether a FinancialAccount has access to a particular Feature, with a status enum and associated status_details. Stripe or the platform can control Features via the requested field.
- * @property \Stripe\StripeObject[] $financial_addresses The set of credentials that resolve to a FinancialAccount.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property null|\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 string[] $pending_features The array of paths to pending Features in the Features hash.
- * @property null|\Stripe\StripeObject $platform_restrictions The set of functionalities that the platform can restrict on the FinancialAccount.
- * @property string[] $restricted_features The array of paths to restricted Features in the Features hash.
- * @property string $status The enum specifying what state the account is in.
- * @property \Stripe\StripeObject $status_details
- * @property string[] $supported_currencies The currencies the FinancialAccount can hold a balance in. Three-letter ISO currency code, in lowercase.
+ * @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[] $active_features The array of paths to active Features in the Features hash.
+ * @property \Stripe\StripeObject $balance Balance information for the FinancialAccount
+ * @property string $country Two-letter country code (ISO 3166-1 alpha-2).
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property \Stripe\Treasury\FinancialAccountFeatures $features Encodes whether a FinancialAccount has access to a particular Feature, with a status enum and associated status_details. Stripe or the platform can control Features via the requested field.
+ * @property \Stripe\StripeObject[] $financial_addresses The set of credentials that resolve to a FinancialAccount.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property null|\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 string[] $pending_features The array of paths to pending Features in the Features hash.
+ * @property null|\Stripe\StripeObject $platform_restrictions The set of functionalities that the platform can restrict on the FinancialAccount.
+ * @property string[] $restricted_features The array of paths to restricted Features in the Features hash.
+ * @property string $status The enum specifying what state the account is in.
+ * @property \Stripe\StripeObject $status_details
+ * @property string[] $supported_currencies The currencies the FinancialAccount can hold a balance in. Three-letter ISO currency code, in lowercase.
*/
class FinancialAccount extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'treasury.financial_account';
+ public const OBJECT_NAME = 'treasury.financial_account';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
- const STATUS_CLOSED = 'closed';
- const STATUS_OPEN = 'open';
+ public const STATUS_CLOSED = 'closed';
+
+ public const STATUS_OPEN = 'open';
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -48,16 +49,16 @@ class FinancialAccount extends \Stripe\ApiResource
*/
public function retrieveFeatures($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/features';
+ $url = $this->instanceUrl() . '/features';
list($response, $opts) = $this->_request('get', $url, $params, $opts);
- $obj = \Stripe\Util\Util::convertToStripeObject($response, $opts);
+ $obj = \Stripe\Util\Util::convertToStripeObject($response, $opts);
$obj->setLastResponse($response);
return $obj;
}
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -66,7 +67,7 @@ class FinancialAccount extends \Stripe\ApiResource
*/
public function updateFeatures($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/features';
+ $url = $this->instanceUrl() . '/features';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
diff --git a/Stripe/Stripe/Treasury/FinancialAccountFeatures.php b/Stripe/Stripe/Treasury/FinancialAccountFeatures.php
index ef343a7..27b159d 100755
--- a/Stripe/Stripe/Treasury/FinancialAccountFeatures.php
+++ b/Stripe/Stripe/Treasury/FinancialAccountFeatures.php
@@ -1,4 +1,4 @@
-status enum and associated status_details. Stripe or
* the platform can control Features via the requested field.
*
- * @property string $object String representing the object's type. Objects of the same type share the same value.
- * @property \Stripe\StripeObject $card_issuing Toggle settings for enabling/disabling a feature
- * @property \Stripe\StripeObject $deposit_insurance Toggle settings for enabling/disabling a feature
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property \Stripe\StripeObject $card_issuing Toggle settings for enabling/disabling a feature
+ * @property \Stripe\StripeObject $deposit_insurance Toggle settings for enabling/disabling a feature
* @property \Stripe\StripeObject $financial_addresses Settings related to Financial Addresses features on a Financial Account
- * @property \Stripe\StripeObject $inbound_transfers InboundTransfers contains inbound transfers features for a FinancialAccount.
- * @property \Stripe\StripeObject $intra_stripe_flows Toggle settings for enabling/disabling a feature
- * @property \Stripe\StripeObject $outbound_payments Settings related to Outbound Payments features on a Financial Account
- * @property \Stripe\StripeObject $outbound_transfers OutboundTransfers contains outbound transfers features for a FinancialAccount.
+ * @property \Stripe\StripeObject $inbound_transfers InboundTransfers contains inbound transfers features for a FinancialAccount.
+ * @property \Stripe\StripeObject $intra_stripe_flows Toggle settings for enabling/disabling a feature
+ * @property \Stripe\StripeObject $outbound_payments Settings related to Outbound Payments features on a Financial Account
+ * @property \Stripe\StripeObject $outbound_transfers OutboundTransfers contains outbound transfers features for a FinancialAccount.
*/
class FinancialAccountFeatures extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'treasury.financial_account_features';
+ public const OBJECT_NAME = 'treasury.financial_account_features';
}
diff --git a/Stripe/Stripe/Treasury/InboundTransfer.php b/Stripe/Stripe/Treasury/InboundTransfer.php
index bc841aa..6652337 100755
--- a/Stripe/Stripe/Treasury/InboundTransfer.php
+++ b/Stripe/Stripe/Treasury/InboundTransfer.php
@@ -1,4 +1,4 @@
-true if the InboundTransfer is able to be canceled.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
- * @property null|\Stripe\StripeObject $failure_details Details about this InboundTransfer's failure. Only set when status is failed.
- * @property string $financial_account The FinancialAccount that received the funds.
- * @property null|string $hosted_regulatory_receipt_url A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
- * @property \Stripe\StripeObject $linked_flows
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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 string $origin_payment_method The origin payment method to be debited for an InboundTransfer.
- * @property null|\Stripe\StripeObject $origin_payment_method_details Details about the PaymentMethod for an InboundTransfer.
- * @property null|bool $returned Returns true if the funds for an InboundTransfer were returned after the InboundTransfer went to the succeeded state.
- * @property string $statement_descriptor Statement descriptor shown when funds are debited from the source. Not all payment networks support statement_descriptor.
- * @property string $status Status of the InboundTransfer: processing, succeeded, failed, and canceled. An InboundTransfer is processing if it is created and pending. The status changes to succeeded once the funds have been "confirmed" and a transaction is created and posted. The status changes to failed if the transfer fails.
- * @property \Stripe\StripeObject $status_transitions
- * @property null|string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object.
+ * @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 int $amount Amount (in cents) transferred.
+ * @property bool $cancelable Returns true if the InboundTransfer is able to be canceled.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
+ * @property null|\Stripe\StripeObject $failure_details Details about this InboundTransfer's failure. Only set when status is failed.
+ * @property string $financial_account The FinancialAccount that received the funds.
+ * @property null|string $hosted_regulatory_receipt_url A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+ * @property \Stripe\StripeObject $linked_flows
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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 string $origin_payment_method The origin payment method to be debited for an InboundTransfer.
+ * @property null|\Stripe\StripeObject $origin_payment_method_details Details about the PaymentMethod for an InboundTransfer.
+ * @property null|bool $returned Returns true if the funds for an InboundTransfer were returned after the InboundTransfer went to the succeeded state.
+ * @property string $statement_descriptor Statement descriptor shown when funds are debited from the source. Not all payment networks support statement_descriptor.
+ * @property string $status Status of the InboundTransfer: processing, succeeded, failed, and canceled. An InboundTransfer is processing if it is created and pending. The status changes to succeeded once the funds have been "confirmed" and a transaction is created and posted. The status changes to failed if the transfer fails.
+ * @property \Stripe\StripeObject $status_transitions
+ * @property null|string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object.
*/
class InboundTransfer extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'treasury.inbound_transfer';
+ public const OBJECT_NAME = 'treasury.inbound_transfer';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
- const STATUS_CANCELED = 'canceled';
- const STATUS_FAILED = 'failed';
- const STATUS_PROCESSING = 'processing';
- const STATUS_SUCCEEDED = 'succeeded';
+ public const STATUS_CANCELED = 'canceled';
+
+ public const STATUS_FAILED = 'failed';
+
+ public const STATUS_PROCESSING = 'processing';
+
+ public const STATUS_SUCCEEDED = 'succeeded';
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -56,7 +59,7 @@ class InboundTransfer extends \Stripe\ApiResource
*/
public function cancel($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/cancel';
+ $url = $this->instanceUrl() . '/cancel';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
diff --git a/Stripe/Stripe/Treasury/OutboundPayment.php b/Stripe/Stripe/Treasury/OutboundPayment.php
index 3997bd3..810fdc1 100755
--- a/Stripe/Stripe/Treasury/OutboundPayment.php
+++ b/Stripe/Stripe/Treasury/OutboundPayment.php
@@ -1,4 +1,4 @@
-/v1/test_helpers/treasury/outbound_payments endpoints. These
* methods can only be called on test mode objects.
*
- * @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 int $amount Amount (in cents) transferred.
- * @property bool $cancelable Returns true if the object can be canceled, and false otherwise.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property null|string $customer ID of the customer to whom an OutboundPayment is sent.
- * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
- * @property null|string $destination_payment_method The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using destination_payment_method_data.
- * @property null|\Stripe\StripeObject $destination_payment_method_details Details about the PaymentMethod for an OutboundPayment.
- * @property null|\Stripe\StripeObject $end_user_details Details about the end user.
- * @property int $expected_arrival_date The date when funds are expected to arrive in the destination account.
- * @property string $financial_account The FinancialAccount that funds were pulled from.
- * @property null|string $hosted_regulatory_receipt_url A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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|\Stripe\StripeObject $returned_details Details about a returned OutboundPayment. Only set when the status is returned.
- * @property string $statement_descriptor The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).
- * @property string $status Current status of the OutboundPayment: processing, failed, posted, returned, canceled. An OutboundPayment is processing if it has been created and is pending. The status changes to posted once the OutboundPayment has been "confirmed" and funds have left the account, or to failed or canceled. If an OutboundPayment fails to arrive at its destination, its status will change to returned.
- * @property \Stripe\StripeObject $status_transitions
- * @property string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object.
+ * @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 int $amount Amount (in cents) transferred.
+ * @property bool $cancelable Returns true if the object can be canceled, and false otherwise.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property null|string $customer ID of the customer to whom an OutboundPayment is sent.
+ * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
+ * @property null|string $destination_payment_method The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using destination_payment_method_data.
+ * @property null|\Stripe\StripeObject $destination_payment_method_details Details about the PaymentMethod for an OutboundPayment.
+ * @property null|\Stripe\StripeObject $end_user_details Details about the end user.
+ * @property int $expected_arrival_date The date when funds are expected to arrive in the destination account.
+ * @property string $financial_account The FinancialAccount that funds were pulled from.
+ * @property null|string $hosted_regulatory_receipt_url A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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|\Stripe\StripeObject $returned_details Details about a returned OutboundPayment. Only set when the status is returned.
+ * @property string $statement_descriptor The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).
+ * @property string $status Current status of the OutboundPayment: processing, failed, posted, returned, canceled. An OutboundPayment is processing if it has been created and is pending. The status changes to posted once the OutboundPayment has been "confirmed" and funds have left the account, or to failed or canceled. If an OutboundPayment fails to arrive at its destination, its status will change to returned.
+ * @property \Stripe\StripeObject $status_transitions
+ * @property string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object.
*/
class OutboundPayment extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'treasury.outbound_payment';
+ public const OBJECT_NAME = 'treasury.outbound_payment';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
- const STATUS_CANCELED = 'canceled';
- const STATUS_FAILED = 'failed';
- const STATUS_POSTED = 'posted';
- const STATUS_PROCESSING = 'processing';
- const STATUS_RETURNED = 'returned';
+ public const STATUS_CANCELED = 'canceled';
+
+ public const STATUS_FAILED = 'failed';
+
+ public const STATUS_POSTED = 'posted';
+
+ public const STATUS_PROCESSING = 'processing';
+
+ public const STATUS_RETURNED = 'returned';
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -60,7 +64,7 @@ class OutboundPayment extends \Stripe\ApiResource
*/
public function cancel($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/cancel';
+ $url = $this->instanceUrl() . '/cancel';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
diff --git a/Stripe/Stripe/Treasury/OutboundTransfer.php b/Stripe/Stripe/Treasury/OutboundTransfer.php
index a21680b..4269684 100755
--- a/Stripe/Stripe/Treasury/OutboundTransfer.php
+++ b/Stripe/Stripe/Treasury/OutboundTransfer.php
@@ -1,4 +1,4 @@
-/v1/test_helpers/treasury/outbound_transfers endpoints. These
* methods can only be called on test mode objects.
*
- * @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 int $amount Amount (in cents) transferred.
- * @property bool $cancelable Returns true if the object can be canceled, and false otherwise.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
- * @property null|string $destination_payment_method The PaymentMethod used as the payment instrument for an OutboundTransfer.
- * @property \Stripe\StripeObject $destination_payment_method_details
- * @property int $expected_arrival_date The date when funds are expected to arrive in the destination account.
- * @property string $financial_account The FinancialAccount that funds were pulled from.
- * @property null|string $hosted_regulatory_receipt_url A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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|\Stripe\StripeObject $returned_details Details about a returned OutboundTransfer. Only set when the status is returned.
- * @property string $statement_descriptor Information about the OutboundTransfer to be sent to the recipient account.
- * @property string $status Current status of the OutboundTransfer: processing, failed, canceled, posted, returned. An OutboundTransfer is processing if it has been created and is pending. The status changes to posted once the OutboundTransfer has been "confirmed" and funds have left the account, or to failed or canceled. If an OutboundTransfer fails to arrive at its destination, its status will change to returned.
- * @property \Stripe\StripeObject $status_transitions
- * @property string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object.
+ * @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 int $amount Amount (in cents) transferred.
+ * @property bool $cancelable Returns true if the object can be canceled, and false otherwise.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
+ * @property null|string $destination_payment_method The PaymentMethod used as the payment instrument for an OutboundTransfer.
+ * @property \Stripe\StripeObject $destination_payment_method_details
+ * @property int $expected_arrival_date The date when funds are expected to arrive in the destination account.
+ * @property string $financial_account The FinancialAccount that funds were pulled from.
+ * @property null|string $hosted_regulatory_receipt_url A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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|\Stripe\StripeObject $returned_details Details about a returned OutboundTransfer. Only set when the status is returned.
+ * @property string $statement_descriptor Information about the OutboundTransfer to be sent to the recipient account.
+ * @property string $status Current status of the OutboundTransfer: processing, failed, canceled, posted, returned. An OutboundTransfer is processing if it has been created and is pending. The status changes to posted once the OutboundTransfer has been "confirmed" and funds have left the account, or to failed or canceled. If an OutboundTransfer fails to arrive at its destination, its status will change to returned.
+ * @property \Stripe\StripeObject $status_transitions
+ * @property string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object.
*/
class OutboundTransfer extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'treasury.outbound_transfer';
+ public const OBJECT_NAME = 'treasury.outbound_transfer';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
- const STATUS_CANCELED = 'canceled';
- const STATUS_FAILED = 'failed';
- const STATUS_POSTED = 'posted';
- const STATUS_PROCESSING = 'processing';
- const STATUS_RETURNED = 'returned';
+ public const STATUS_CANCELED = 'canceled';
+
+ public const STATUS_FAILED = 'failed';
+
+ public const STATUS_POSTED = 'posted';
+
+ public const STATUS_PROCESSING = 'processing';
+
+ public const STATUS_RETURNED = 'returned';
/**
- * @param null|array $params
+ * @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
@@ -60,7 +64,7 @@ class OutboundTransfer extends \Stripe\ApiResource
*/
public function cancel($params = null, $opts = null)
{
- $url = $this->instanceUrl() . '/cancel';
+ $url = $this->instanceUrl() . '/cancel';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
diff --git a/Stripe/Stripe/Treasury/ReceivedCredit.php b/Stripe/Stripe/Treasury/ReceivedCredit.php
index 9a72ff0..d08c4b4 100755
--- a/Stripe/Stripe/Treasury/ReceivedCredit.php
+++ b/Stripe/Stripe/Treasury/ReceivedCredit.php
@@ -1,4 +1,4 @@
-ISO currency code, in lowercase. Must be a supported currency.
- * @property string $description An arbitrary string attached to the object. Often useful for displaying to users.
- * @property null|string $failure_code Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.
- * @property null|string $financial_account The FinancialAccount that received the funds.
- * @property null|string $hosted_regulatory_receipt_url A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
- * @property \Stripe\StripeObject $initiating_payment_method_details
- * @property \Stripe\StripeObject $linked_flows
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property string $network The rails used to send the funds.
- * @property null|\Stripe\StripeObject $reversal_details Details describing when a ReceivedCredit may be reversed.
- * @property string $status Status of the ReceivedCredit. ReceivedCredits are created either succeeded (approved) or failed (declined). If a ReceivedCredit is declined, the failure reason can be found in the failure_code field.
- * @property null|string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object.
+ * @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 int $amount Amount (in cents) transferred.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string $description An arbitrary string attached to the object. Often useful for displaying to users.
+ * @property null|string $failure_code Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.
+ * @property null|string $financial_account The FinancialAccount that received the funds.
+ * @property null|string $hosted_regulatory_receipt_url A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+ * @property \Stripe\StripeObject $initiating_payment_method_details
+ * @property \Stripe\StripeObject $linked_flows
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string $network The rails used to send the funds.
+ * @property null|\Stripe\StripeObject $reversal_details Details describing when a ReceivedCredit may be reversed.
+ * @property string $status Status of the ReceivedCredit. ReceivedCredits are created either succeeded (approved) or failed (declined). If a ReceivedCredit is declined, the failure reason can be found in the failure_code field.
+ * @property null|string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object.
*/
class ReceivedCredit extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'treasury.received_credit';
+ public const OBJECT_NAME = 'treasury.received_credit';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
- const FAILURE_CODE_ACCOUNT_CLOSED = 'account_closed';
- const FAILURE_CODE_ACCOUNT_FROZEN = 'account_frozen';
- const FAILURE_CODE_OTHER = 'other';
+ public const FAILURE_CODE_ACCOUNT_CLOSED = 'account_closed';
- const NETWORK_ACH = 'ach';
- const NETWORK_CARD = 'card';
- const NETWORK_STRIPE = 'stripe';
- const NETWORK_US_DOMESTIC_WIRE = 'us_domestic_wire';
+ public const FAILURE_CODE_ACCOUNT_FROZEN = 'account_frozen';
- const STATUS_FAILED = 'failed';
- const STATUS_SUCCEEDED = 'succeeded';
+ public const FAILURE_CODE_OTHER = 'other';
+
+ public const NETWORK_ACH = 'ach';
+
+ public const NETWORK_CARD = 'card';
+
+ public const NETWORK_STRIPE = 'stripe';
+
+ public const NETWORK_US_DOMESTIC_WIRE = 'us_domestic_wire';
+
+ public const STATUS_FAILED = 'failed';
+
+ public const STATUS_SUCCEEDED = 'succeeded';
}
diff --git a/Stripe/Stripe/Treasury/ReceivedDebit.php b/Stripe/Stripe/Treasury/ReceivedDebit.php
index c252df4..d806244 100755
--- a/Stripe/Stripe/Treasury/ReceivedDebit.php
+++ b/Stripe/Stripe/Treasury/ReceivedDebit.php
@@ -1,4 +1,4 @@
-FinancialAccount.
* These are not initiated from the FinancialAccount.
*
- * @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 int $amount Amount (in cents) transferred.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property string $description An arbitrary string attached to the object. Often useful for displaying to users.
- * @property null|string $failure_code Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen.
- * @property null|string $financial_account The FinancialAccount that funds were pulled from.
- * @property null|string $hosted_regulatory_receipt_url A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
- * @property \Stripe\StripeObject $initiating_payment_method_details
- * @property \Stripe\StripeObject $linked_flows
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property string $network The network used for the ReceivedDebit.
- * @property null|\Stripe\StripeObject $reversal_details Details describing when a ReceivedDebit might be reversed.
- * @property string $status Status of the ReceivedDebit. ReceivedDebits are created with a status of either succeeded (approved) or failed (declined). The failure reason can be found under the failure_code.
- * @property null|string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object.
+ * @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 int $amount Amount (in cents) transferred.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string $description An arbitrary string attached to the object. Often useful for displaying to users.
+ * @property null|string $failure_code Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen.
+ * @property null|string $financial_account The FinancialAccount that funds were pulled from.
+ * @property null|string $hosted_regulatory_receipt_url A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+ * @property \Stripe\StripeObject $initiating_payment_method_details
+ * @property \Stripe\StripeObject $linked_flows
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string $network The network used for the ReceivedDebit.
+ * @property null|\Stripe\StripeObject $reversal_details Details describing when a ReceivedDebit might be reversed.
+ * @property string $status Status of the ReceivedDebit. ReceivedDebits are created with a status of either succeeded (approved) or failed (declined). The failure reason can be found under the failure_code.
+ * @property null|string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object.
*/
class ReceivedDebit extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'treasury.received_debit';
+ public const OBJECT_NAME = 'treasury.received_debit';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
- const FAILURE_CODE_ACCOUNT_CLOSED = 'account_closed';
- const FAILURE_CODE_ACCOUNT_FROZEN = 'account_frozen';
- const FAILURE_CODE_INSUFFICIENT_FUNDS = 'insufficient_funds';
- const FAILURE_CODE_OTHER = 'other';
+ public const FAILURE_CODE_ACCOUNT_CLOSED = 'account_closed';
- const NETWORK_ACH = 'ach';
- const NETWORK_CARD = 'card';
- const NETWORK_STRIPE = 'stripe';
+ public const FAILURE_CODE_ACCOUNT_FROZEN = 'account_frozen';
- const STATUS_FAILED = 'failed';
- const STATUS_SUCCEEDED = 'succeeded';
+ public const FAILURE_CODE_INSUFFICIENT_FUNDS = 'insufficient_funds';
+
+ public const FAILURE_CODE_OTHER = 'other';
+
+ public const NETWORK_ACH = 'ach';
+
+ public const NETWORK_CARD = 'card';
+
+ public const NETWORK_STRIPE = 'stripe';
+
+ public const STATUS_FAILED = 'failed';
+
+ public const STATUS_SUCCEEDED = 'succeeded';
}
diff --git a/Stripe/Stripe/Treasury/Transaction.php b/Stripe/Stripe/Treasury/Transaction.php
index 3216898..7515162 100755
--- a/Stripe/Stripe/Treasury/Transaction.php
+++ b/Stripe/Stripe/Treasury/Transaction.php
@@ -1,4 +1,4 @@
-FinancialAccount's
* balance.
*
- * @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 int $amount Amount (in cents) transferred.
- * @property \Stripe\StripeObject $balance_impact Change to a FinancialAccount's balance
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property string $description An arbitrary string attached to the object. Often useful for displaying to users.
- * @property null|\Stripe\Collection<\Stripe\Treasury\TransactionEntry> $entries A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.
- * @property string $financial_account The FinancialAccount associated with this object.
- * @property null|string $flow ID of the flow that created the Transaction.
- * @property null|\Stripe\StripeObject $flow_details Details of the flow that created the Transaction.
- * @property string $flow_type Type of the flow that created the Transaction.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property string $status Status of the Transaction.
- * @property \Stripe\StripeObject $status_transitions
+ * @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 int $amount Amount (in cents) transferred.
+ * @property \Stripe\StripeObject $balance_impact Change to a FinancialAccount's balance
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property string $description An arbitrary string attached to the object. Often useful for displaying to users.
+ * @property null|\Stripe\Collection<\Stripe\Treasury\TransactionEntry> $entries A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.
+ * @property string $financial_account The FinancialAccount associated with this object.
+ * @property null|string $flow ID of the flow that created the Transaction.
+ * @property null|\Stripe\StripeObject $flow_details Details of the flow that created the Transaction.
+ * @property string $flow_type Type of the flow that created the Transaction.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string $status Status of the Transaction.
+ * @property \Stripe\StripeObject $status_transitions
*/
class Transaction extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'treasury.transaction';
+ public const OBJECT_NAME = 'treasury.transaction';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
- const FLOW_TYPE_CREDIT_REVERSAL = 'credit_reversal';
- const FLOW_TYPE_DEBIT_REVERSAL = 'debit_reversal';
- const FLOW_TYPE_INBOUND_TRANSFER = 'inbound_transfer';
- const FLOW_TYPE_ISSUING_AUTHORIZATION = 'issuing_authorization';
- const FLOW_TYPE_OTHER = 'other';
- const FLOW_TYPE_OUTBOUND_PAYMENT = 'outbound_payment';
- const FLOW_TYPE_OUTBOUND_TRANSFER = 'outbound_transfer';
- const FLOW_TYPE_RECEIVED_CREDIT = 'received_credit';
- const FLOW_TYPE_RECEIVED_DEBIT = 'received_debit';
+ public const FLOW_TYPE_CREDIT_REVERSAL = 'credit_reversal';
- const STATUS_OPEN = 'open';
- const STATUS_POSTED = 'posted';
- const STATUS_VOID = 'void';
+ public const FLOW_TYPE_DEBIT_REVERSAL = 'debit_reversal';
+
+ public const FLOW_TYPE_INBOUND_TRANSFER = 'inbound_transfer';
+
+ public const FLOW_TYPE_ISSUING_AUTHORIZATION = 'issuing_authorization';
+
+ public const FLOW_TYPE_OTHER = 'other';
+
+ public const FLOW_TYPE_OUTBOUND_PAYMENT = 'outbound_payment';
+
+ public const FLOW_TYPE_OUTBOUND_TRANSFER = 'outbound_transfer';
+
+ public const FLOW_TYPE_RECEIVED_CREDIT = 'received_credit';
+
+ public const FLOW_TYPE_RECEIVED_DEBIT = 'received_debit';
+
+ public const STATUS_OPEN = 'open';
+
+ public const STATUS_POSTED = 'posted';
+
+ public const STATUS_VOID = 'void';
}
diff --git a/Stripe/Stripe/Treasury/TransactionEntry.php b/Stripe/Stripe/Treasury/TransactionEntry.php
index e50dbad..04f8d5d 100755
--- a/Stripe/Stripe/Treasury/TransactionEntry.php
+++ b/Stripe/Stripe/Treasury/TransactionEntry.php
@@ -1,4 +1,4 @@
-Transaction.
*
- * @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 \Stripe\StripeObject $balance_impact Change to a FinancialAccount's balance
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
- * @property int $effective_at When the TransactionEntry will impact the FinancialAccount's balance.
- * @property string $financial_account The FinancialAccount associated with this object.
- * @property null|string $flow Token of the flow associated with the TransactionEntry.
- * @property null|\Stripe\StripeObject $flow_details Details of the flow associated with the TransactionEntry.
- * @property string $flow_type Type of the flow associated with the TransactionEntry.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object.
- * @property string $type The specific money movement that generated the TransactionEntry.
+ * @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 \Stripe\StripeObject $balance_impact Change to a FinancialAccount's balance
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
+ * @property int $effective_at When the TransactionEntry will impact the FinancialAccount's balance.
+ * @property string $financial_account The FinancialAccount associated with this object.
+ * @property null|string $flow Token of the flow associated with the TransactionEntry.
+ * @property null|\Stripe\StripeObject $flow_details Details of the flow associated with the TransactionEntry.
+ * @property string $flow_type Type of the flow associated with the TransactionEntry.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object.
+ * @property string $type The specific money movement that generated the TransactionEntry.
*/
class TransactionEntry extends \Stripe\ApiResource
{
- const OBJECT_NAME = 'treasury.transaction_entry';
+ public const OBJECT_NAME = 'treasury.transaction_entry';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
- const FLOW_TYPE_CREDIT_REVERSAL = 'credit_reversal';
- const FLOW_TYPE_DEBIT_REVERSAL = 'debit_reversal';
- const FLOW_TYPE_INBOUND_TRANSFER = 'inbound_transfer';
- const FLOW_TYPE_ISSUING_AUTHORIZATION = 'issuing_authorization';
- const FLOW_TYPE_OTHER = 'other';
- const FLOW_TYPE_OUTBOUND_PAYMENT = 'outbound_payment';
- const FLOW_TYPE_OUTBOUND_TRANSFER = 'outbound_transfer';
- const FLOW_TYPE_RECEIVED_CREDIT = 'received_credit';
- const FLOW_TYPE_RECEIVED_DEBIT = 'received_debit';
+ public const FLOW_TYPE_CREDIT_REVERSAL = 'credit_reversal';
- const TYPE_CREDIT_REVERSAL = 'credit_reversal';
- const TYPE_CREDIT_REVERSAL_POSTING = 'credit_reversal_posting';
- const TYPE_DEBIT_REVERSAL = 'debit_reversal';
- const TYPE_INBOUND_TRANSFER = 'inbound_transfer';
- const TYPE_INBOUND_TRANSFER_RETURN = 'inbound_transfer_return';
- const TYPE_ISSUING_AUTHORIZATION_HOLD = 'issuing_authorization_hold';
- const TYPE_ISSUING_AUTHORIZATION_RELEASE = 'issuing_authorization_release';
- const TYPE_OTHER = 'other';
- const TYPE_OUTBOUND_PAYMENT = 'outbound_payment';
- const TYPE_OUTBOUND_PAYMENT_CANCELLATION = 'outbound_payment_cancellation';
- const TYPE_OUTBOUND_PAYMENT_FAILURE = 'outbound_payment_failure';
- const TYPE_OUTBOUND_PAYMENT_POSTING = 'outbound_payment_posting';
- const TYPE_OUTBOUND_PAYMENT_RETURN = 'outbound_payment_return';
- const TYPE_OUTBOUND_TRANSFER = 'outbound_transfer';
- const TYPE_OUTBOUND_TRANSFER_CANCELLATION = 'outbound_transfer_cancellation';
- const TYPE_OUTBOUND_TRANSFER_FAILURE = 'outbound_transfer_failure';
- const TYPE_OUTBOUND_TRANSFER_POSTING = 'outbound_transfer_posting';
- const TYPE_OUTBOUND_TRANSFER_RETURN = 'outbound_transfer_return';
- const TYPE_RECEIVED_CREDIT = 'received_credit';
- const TYPE_RECEIVED_DEBIT = 'received_debit';
+ public const FLOW_TYPE_DEBIT_REVERSAL = 'debit_reversal';
+
+ public const FLOW_TYPE_INBOUND_TRANSFER = 'inbound_transfer';
+
+ public const FLOW_TYPE_ISSUING_AUTHORIZATION = 'issuing_authorization';
+
+ public const FLOW_TYPE_OTHER = 'other';
+
+ public const FLOW_TYPE_OUTBOUND_PAYMENT = 'outbound_payment';
+
+ public const FLOW_TYPE_OUTBOUND_TRANSFER = 'outbound_transfer';
+
+ public const FLOW_TYPE_RECEIVED_CREDIT = 'received_credit';
+
+ public const FLOW_TYPE_RECEIVED_DEBIT = 'received_debit';
+
+ public const TYPE_CREDIT_REVERSAL = 'credit_reversal';
+
+ public const TYPE_CREDIT_REVERSAL_POSTING = 'credit_reversal_posting';
+
+ public const TYPE_DEBIT_REVERSAL = 'debit_reversal';
+
+ public const TYPE_INBOUND_TRANSFER = 'inbound_transfer';
+
+ public const TYPE_INBOUND_TRANSFER_RETURN = 'inbound_transfer_return';
+
+ public const TYPE_ISSUING_AUTHORIZATION_HOLD = 'issuing_authorization_hold';
+
+ public const TYPE_ISSUING_AUTHORIZATION_RELEASE = 'issuing_authorization_release';
+
+ public const TYPE_OTHER = 'other';
+
+ public const TYPE_OUTBOUND_PAYMENT = 'outbound_payment';
+
+ public const TYPE_OUTBOUND_PAYMENT_CANCELLATION = 'outbound_payment_cancellation';
+
+ public const TYPE_OUTBOUND_PAYMENT_FAILURE = 'outbound_payment_failure';
+
+ public const TYPE_OUTBOUND_PAYMENT_POSTING = 'outbound_payment_posting';
+
+ public const TYPE_OUTBOUND_PAYMENT_RETURN = 'outbound_payment_return';
+
+ public const TYPE_OUTBOUND_TRANSFER = 'outbound_transfer';
+
+ public const TYPE_OUTBOUND_TRANSFER_CANCELLATION = 'outbound_transfer_cancellation';
+
+ public const TYPE_OUTBOUND_TRANSFER_FAILURE = 'outbound_transfer_failure';
+
+ public const TYPE_OUTBOUND_TRANSFER_POSTING = 'outbound_transfer_posting';
+
+ public const TYPE_OUTBOUND_TRANSFER_RETURN = 'outbound_transfer_return';
+
+ public const TYPE_RECEIVED_CREDIT = 'received_credit';
+
+ public const TYPE_RECEIVED_DEBIT = 'received_debit';
}
diff --git a/Stripe/Stripe/UsageRecord.php b/Stripe/Stripe/UsageRecord.php
index 5522982..7e13f70 100755
--- a/Stripe/Stripe/UsageRecord.php
+++ b/Stripe/Stripe/UsageRecord.php
@@ -1,4 +1,4 @@
-Metered
* Billing.
*
- * @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 bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @property int $quantity The usage quantity for the specified date.
+ * @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 bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @property int $quantity The usage quantity for the specified date.
* @property string $subscription_item The ID of the subscription item this usage record contains data for.
- * @property int $timestamp The timestamp when this usage occurred.
+ * @property int $timestamp The timestamp when this usage occurred.
*/
class UsageRecord extends ApiResource
{
- const OBJECT_NAME = 'usage_record';
+ public const OBJECT_NAME = 'usage_record';
}
diff --git a/Stripe/Stripe/UsageRecordSummary.php b/Stripe/Stripe/UsageRecordSummary.php
index 174e14e..4b0d0fb 100755
--- a/Stripe/Stripe/UsageRecordSummary.php
+++ b/Stripe/Stripe/UsageRecordSummary.php
@@ -1,19 +1,19 @@
-true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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 null|string $invoice The invoice in which this usage period has been billed for.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
* @property \Stripe\StripeObject $period
- * @property string $subscription_item The ID of the subscription item this summary is describing.
- * @property int $total_usage The total usage within this usage period.
+ * @property string $subscription_item The ID of the subscription item this summary is describing.
+ * @property int $total_usage The total usage within this usage period.
*/
class UsageRecordSummary extends ApiResource
{
- const OBJECT_NAME = 'usage_record_summary';
+ public const OBJECT_NAME = 'usage_record_summary';
}
diff --git a/Stripe/Stripe/Util/ApiVersion.php b/Stripe/Stripe/Util/ApiVersion.php
index 9efa9d7..0d061bf 100755
--- a/Stripe/Stripe/Util/ApiVersion.php
+++ b/Stripe/Stripe/Util/ApiVersion.php
@@ -1,4 +1,4 @@
-container[] = $value;
} else {
$this->container[$offset] = $value;
@@ -68,7 +68,7 @@ class CaseInsensitiveArray implements \ArrayAccess, \Countable, \IteratorAggrega
* @return void
*/
#[\ReturnTypeWillChange]
- public function offsetUnset($offset)
+ public function offsetUnset($offset) : void
{
$offset = static::maybeLowercase($offset);
unset($this->container[$offset]);
diff --git a/Stripe/Stripe/Util/DefaultLogger.php b/Stripe/Stripe/Util/DefaultLogger.php
index 016cbe8..6839a9f 100755
--- a/Stripe/Stripe/Util/DefaultLogger.php
+++ b/Stripe/Stripe/Util/DefaultLogger.php
@@ -1,4 +1,4 @@
- 0) {
throw new \Stripe\Exception\BadMethodCallException('DefaultLogger does not currently implement context. Please implement if you need it.');
}
- if (null === $this->destination) {
+ if ($this->destination === null) {
\error_log($message, $this->messageType);
} else {
\error_log($message, $this->messageType, $this->destination);
diff --git a/Stripe/Stripe/Util/LoggerInterface.php b/Stripe/Stripe/Util/LoggerInterface.php
index 5603c81..e3f2709 100755
--- a/Stripe/Stripe/Util/LoggerInterface.php
+++ b/Stripe/Stripe/Util/LoggerInterface.php
@@ -1,4 +1,4 @@
- \Stripe\Account::class,
- \Stripe\AccountLink::OBJECT_NAME => \Stripe\AccountLink::class,
- \Stripe\ApplePayDomain::OBJECT_NAME => \Stripe\ApplePayDomain::class,
- \Stripe\ApplicationFee::OBJECT_NAME => \Stripe\ApplicationFee::class,
- \Stripe\ApplicationFeeRefund::OBJECT_NAME => \Stripe\ApplicationFeeRefund::class,
- \Stripe\Apps\Secret::OBJECT_NAME => \Stripe\Apps\Secret::class,
- \Stripe\Balance::OBJECT_NAME => \Stripe\Balance::class,
- \Stripe\BalanceTransaction::OBJECT_NAME => \Stripe\BalanceTransaction::class,
- \Stripe\BankAccount::OBJECT_NAME => \Stripe\BankAccount::class,
- \Stripe\BillingPortal\Configuration::OBJECT_NAME => \Stripe\BillingPortal\Configuration::class,
- \Stripe\BillingPortal\Session::OBJECT_NAME => \Stripe\BillingPortal\Session::class,
- \Stripe\Capability::OBJECT_NAME => \Stripe\Capability::class,
- \Stripe\Card::OBJECT_NAME => \Stripe\Card::class,
- \Stripe\CashBalance::OBJECT_NAME => \Stripe\CashBalance::class,
- \Stripe\Charge::OBJECT_NAME => \Stripe\Charge::class,
- \Stripe\Checkout\Session::OBJECT_NAME => \Stripe\Checkout\Session::class,
- \Stripe\Collection::OBJECT_NAME => \Stripe\Collection::class,
- \Stripe\CountrySpec::OBJECT_NAME => \Stripe\CountrySpec::class,
- \Stripe\Coupon::OBJECT_NAME => \Stripe\Coupon::class,
- \Stripe\CreditNote::OBJECT_NAME => \Stripe\CreditNote::class,
- \Stripe\CreditNoteLineItem::OBJECT_NAME => \Stripe\CreditNoteLineItem::class,
- \Stripe\Customer::OBJECT_NAME => \Stripe\Customer::class,
- \Stripe\CustomerBalanceTransaction::OBJECT_NAME => \Stripe\CustomerBalanceTransaction::class,
- \Stripe\CustomerCashBalanceTransaction::OBJECT_NAME => \Stripe\CustomerCashBalanceTransaction::class,
- \Stripe\Discount::OBJECT_NAME => \Stripe\Discount::class,
- \Stripe\Dispute::OBJECT_NAME => \Stripe\Dispute::class,
- \Stripe\EphemeralKey::OBJECT_NAME => \Stripe\EphemeralKey::class,
- \Stripe\Event::OBJECT_NAME => \Stripe\Event::class,
- \Stripe\ExchangeRate::OBJECT_NAME => \Stripe\ExchangeRate::class,
- \Stripe\File::OBJECT_NAME => \Stripe\File::class,
- \Stripe\File::OBJECT_NAME_ALT => \Stripe\File::class,
- \Stripe\FileLink::OBJECT_NAME => \Stripe\FileLink::class,
- \Stripe\FinancialConnections\Account::OBJECT_NAME => \Stripe\FinancialConnections\Account::class,
- \Stripe\FinancialConnections\AccountOwner::OBJECT_NAME => \Stripe\FinancialConnections\AccountOwner::class,
+ public const mapping = [
+ \Stripe\Account::OBJECT_NAME => \Stripe\Account::class,
+ \Stripe\AccountLink::OBJECT_NAME => \Stripe\AccountLink::class,
+ \Stripe\ApplePayDomain::OBJECT_NAME => \Stripe\ApplePayDomain::class,
+ \Stripe\ApplicationFee::OBJECT_NAME => \Stripe\ApplicationFee::class,
+ \Stripe\ApplicationFeeRefund::OBJECT_NAME => \Stripe\ApplicationFeeRefund::class,
+ \Stripe\Apps\Secret::OBJECT_NAME => \Stripe\Apps\Secret::class,
+ \Stripe\Balance::OBJECT_NAME => \Stripe\Balance::class,
+ \Stripe\BalanceTransaction::OBJECT_NAME => \Stripe\BalanceTransaction::class,
+ \Stripe\BankAccount::OBJECT_NAME => \Stripe\BankAccount::class,
+ \Stripe\BillingPortal\Configuration::OBJECT_NAME => \Stripe\BillingPortal\Configuration::class,
+ \Stripe\BillingPortal\Session::OBJECT_NAME => \Stripe\BillingPortal\Session::class,
+ \Stripe\Capability::OBJECT_NAME => \Stripe\Capability::class,
+ \Stripe\Card::OBJECT_NAME => \Stripe\Card::class,
+ \Stripe\CashBalance::OBJECT_NAME => \Stripe\CashBalance::class,
+ \Stripe\Charge::OBJECT_NAME => \Stripe\Charge::class,
+ \Stripe\Checkout\Session::OBJECT_NAME => \Stripe\Checkout\Session::class,
+ \Stripe\Collection::OBJECT_NAME => \Stripe\Collection::class,
+ \Stripe\CountrySpec::OBJECT_NAME => \Stripe\CountrySpec::class,
+ \Stripe\Coupon::OBJECT_NAME => \Stripe\Coupon::class,
+ \Stripe\CreditNote::OBJECT_NAME => \Stripe\CreditNote::class,
+ \Stripe\CreditNoteLineItem::OBJECT_NAME => \Stripe\CreditNoteLineItem::class,
+ \Stripe\Customer::OBJECT_NAME => \Stripe\Customer::class,
+ \Stripe\CustomerBalanceTransaction::OBJECT_NAME => \Stripe\CustomerBalanceTransaction::class,
+ \Stripe\CustomerCashBalanceTransaction::OBJECT_NAME => \Stripe\CustomerCashBalanceTransaction::class,
+ \Stripe\Discount::OBJECT_NAME => \Stripe\Discount::class,
+ \Stripe\Dispute::OBJECT_NAME => \Stripe\Dispute::class,
+ \Stripe\EphemeralKey::OBJECT_NAME => \Stripe\EphemeralKey::class,
+ \Stripe\Event::OBJECT_NAME => \Stripe\Event::class,
+ \Stripe\ExchangeRate::OBJECT_NAME => \Stripe\ExchangeRate::class,
+ \Stripe\File::OBJECT_NAME => \Stripe\File::class,
+ \Stripe\File::OBJECT_NAME_ALT => \Stripe\File::class,
+ \Stripe\FileLink::OBJECT_NAME => \Stripe\FileLink::class,
+ \Stripe\FinancialConnections\Account::OBJECT_NAME => \Stripe\FinancialConnections\Account::class,
+ \Stripe\FinancialConnections\AccountOwner::OBJECT_NAME => \Stripe\FinancialConnections\AccountOwner::class,
\Stripe\FinancialConnections\AccountOwnership::OBJECT_NAME => \Stripe\FinancialConnections\AccountOwnership::class,
- \Stripe\FinancialConnections\Session::OBJECT_NAME => \Stripe\FinancialConnections\Session::class,
- \Stripe\FundingInstructions::OBJECT_NAME => \Stripe\FundingInstructions::class,
- \Stripe\Identity\VerificationReport::OBJECT_NAME => \Stripe\Identity\VerificationReport::class,
- \Stripe\Identity\VerificationSession::OBJECT_NAME => \Stripe\Identity\VerificationSession::class,
- \Stripe\Invoice::OBJECT_NAME => \Stripe\Invoice::class,
- \Stripe\InvoiceItem::OBJECT_NAME => \Stripe\InvoiceItem::class,
- \Stripe\InvoiceLineItem::OBJECT_NAME => \Stripe\InvoiceLineItem::class,
- \Stripe\Issuing\Authorization::OBJECT_NAME => \Stripe\Issuing\Authorization::class,
- \Stripe\Issuing\Card::OBJECT_NAME => \Stripe\Issuing\Card::class,
- \Stripe\Issuing\CardDetails::OBJECT_NAME => \Stripe\Issuing\CardDetails::class,
- \Stripe\Issuing\Cardholder::OBJECT_NAME => \Stripe\Issuing\Cardholder::class,
- \Stripe\Issuing\Dispute::OBJECT_NAME => \Stripe\Issuing\Dispute::class,
- \Stripe\Issuing\Transaction::OBJECT_NAME => \Stripe\Issuing\Transaction::class,
- \Stripe\LineItem::OBJECT_NAME => \Stripe\LineItem::class,
- \Stripe\LoginLink::OBJECT_NAME => \Stripe\LoginLink::class,
- \Stripe\Mandate::OBJECT_NAME => \Stripe\Mandate::class,
- \Stripe\PaymentIntent::OBJECT_NAME => \Stripe\PaymentIntent::class,
- \Stripe\PaymentLink::OBJECT_NAME => \Stripe\PaymentLink::class,
- \Stripe\PaymentMethod::OBJECT_NAME => \Stripe\PaymentMethod::class,
- \Stripe\Payout::OBJECT_NAME => \Stripe\Payout::class,
- \Stripe\Person::OBJECT_NAME => \Stripe\Person::class,
- \Stripe\Plan::OBJECT_NAME => \Stripe\Plan::class,
- \Stripe\Price::OBJECT_NAME => \Stripe\Price::class,
- \Stripe\Product::OBJECT_NAME => \Stripe\Product::class,
- \Stripe\PromotionCode::OBJECT_NAME => \Stripe\PromotionCode::class,
- \Stripe\Quote::OBJECT_NAME => \Stripe\Quote::class,
- \Stripe\Radar\EarlyFraudWarning::OBJECT_NAME => \Stripe\Radar\EarlyFraudWarning::class,
- \Stripe\Radar\ValueList::OBJECT_NAME => \Stripe\Radar\ValueList::class,
- \Stripe\Radar\ValueListItem::OBJECT_NAME => \Stripe\Radar\ValueListItem::class,
- \Stripe\Refund::OBJECT_NAME => \Stripe\Refund::class,
- \Stripe\Reporting\ReportRun::OBJECT_NAME => \Stripe\Reporting\ReportRun::class,
- \Stripe\Reporting\ReportType::OBJECT_NAME => \Stripe\Reporting\ReportType::class,
- \Stripe\Review::OBJECT_NAME => \Stripe\Review::class,
- \Stripe\SearchResult::OBJECT_NAME => \Stripe\SearchResult::class,
- \Stripe\SetupAttempt::OBJECT_NAME => \Stripe\SetupAttempt::class,
- \Stripe\SetupIntent::OBJECT_NAME => \Stripe\SetupIntent::class,
- \Stripe\ShippingRate::OBJECT_NAME => \Stripe\ShippingRate::class,
- \Stripe\Sigma\ScheduledQueryRun::OBJECT_NAME => \Stripe\Sigma\ScheduledQueryRun::class,
- \Stripe\Source::OBJECT_NAME => \Stripe\Source::class,
- \Stripe\SourceTransaction::OBJECT_NAME => \Stripe\SourceTransaction::class,
- \Stripe\Subscription::OBJECT_NAME => \Stripe\Subscription::class,
- \Stripe\SubscriptionItem::OBJECT_NAME => \Stripe\SubscriptionItem::class,
- \Stripe\SubscriptionSchedule::OBJECT_NAME => \Stripe\SubscriptionSchedule::class,
- \Stripe\TaxCode::OBJECT_NAME => \Stripe\TaxCode::class,
- \Stripe\TaxId::OBJECT_NAME => \Stripe\TaxId::class,
- \Stripe\TaxRate::OBJECT_NAME => \Stripe\TaxRate::class,
- \Stripe\Terminal\Configuration::OBJECT_NAME => \Stripe\Terminal\Configuration::class,
- \Stripe\Terminal\ConnectionToken::OBJECT_NAME => \Stripe\Terminal\ConnectionToken::class,
- \Stripe\Terminal\Location::OBJECT_NAME => \Stripe\Terminal\Location::class,
- \Stripe\Terminal\Reader::OBJECT_NAME => \Stripe\Terminal\Reader::class,
- \Stripe\TestHelpers\TestClock::OBJECT_NAME => \Stripe\TestHelpers\TestClock::class,
- \Stripe\Token::OBJECT_NAME => \Stripe\Token::class,
- \Stripe\Topup::OBJECT_NAME => \Stripe\Topup::class,
- \Stripe\Transfer::OBJECT_NAME => \Stripe\Transfer::class,
- \Stripe\TransferReversal::OBJECT_NAME => \Stripe\TransferReversal::class,
- \Stripe\Treasury\CreditReversal::OBJECT_NAME => \Stripe\Treasury\CreditReversal::class,
- \Stripe\Treasury\DebitReversal::OBJECT_NAME => \Stripe\Treasury\DebitReversal::class,
- \Stripe\Treasury\FinancialAccount::OBJECT_NAME => \Stripe\Treasury\FinancialAccount::class,
- \Stripe\Treasury\FinancialAccountFeatures::OBJECT_NAME => \Stripe\Treasury\FinancialAccountFeatures::class,
- \Stripe\Treasury\InboundTransfer::OBJECT_NAME => \Stripe\Treasury\InboundTransfer::class,
- \Stripe\Treasury\OutboundPayment::OBJECT_NAME => \Stripe\Treasury\OutboundPayment::class,
- \Stripe\Treasury\OutboundTransfer::OBJECT_NAME => \Stripe\Treasury\OutboundTransfer::class,
- \Stripe\Treasury\ReceivedCredit::OBJECT_NAME => \Stripe\Treasury\ReceivedCredit::class,
- \Stripe\Treasury\ReceivedDebit::OBJECT_NAME => \Stripe\Treasury\ReceivedDebit::class,
- \Stripe\Treasury\Transaction::OBJECT_NAME => \Stripe\Treasury\Transaction::class,
- \Stripe\Treasury\TransactionEntry::OBJECT_NAME => \Stripe\Treasury\TransactionEntry::class,
- \Stripe\UsageRecord::OBJECT_NAME => \Stripe\UsageRecord::class,
- \Stripe\UsageRecordSummary::OBJECT_NAME => \Stripe\UsageRecordSummary::class,
- \Stripe\WebhookEndpoint::OBJECT_NAME => \Stripe\WebhookEndpoint::class,
+ \Stripe\FinancialConnections\Session::OBJECT_NAME => \Stripe\FinancialConnections\Session::class,
+ \Stripe\FundingInstructions::OBJECT_NAME => \Stripe\FundingInstructions::class,
+ \Stripe\Identity\VerificationReport::OBJECT_NAME => \Stripe\Identity\VerificationReport::class,
+ \Stripe\Identity\VerificationSession::OBJECT_NAME => \Stripe\Identity\VerificationSession::class,
+ \Stripe\Invoice::OBJECT_NAME => \Stripe\Invoice::class,
+ \Stripe\InvoiceItem::OBJECT_NAME => \Stripe\InvoiceItem::class,
+ \Stripe\InvoiceLineItem::OBJECT_NAME => \Stripe\InvoiceLineItem::class,
+ \Stripe\Issuing\Authorization::OBJECT_NAME => \Stripe\Issuing\Authorization::class,
+ \Stripe\Issuing\Card::OBJECT_NAME => \Stripe\Issuing\Card::class,
+ \Stripe\Issuing\CardDetails::OBJECT_NAME => \Stripe\Issuing\CardDetails::class,
+ \Stripe\Issuing\Cardholder::OBJECT_NAME => \Stripe\Issuing\Cardholder::class,
+ \Stripe\Issuing\Dispute::OBJECT_NAME => \Stripe\Issuing\Dispute::class,
+ \Stripe\Issuing\Transaction::OBJECT_NAME => \Stripe\Issuing\Transaction::class,
+ \Stripe\LineItem::OBJECT_NAME => \Stripe\LineItem::class,
+ \Stripe\LoginLink::OBJECT_NAME => \Stripe\LoginLink::class,
+ \Stripe\Mandate::OBJECT_NAME => \Stripe\Mandate::class,
+ \Stripe\PaymentIntent::OBJECT_NAME => \Stripe\PaymentIntent::class,
+ \Stripe\PaymentLink::OBJECT_NAME => \Stripe\PaymentLink::class,
+ \Stripe\PaymentMethod::OBJECT_NAME => \Stripe\PaymentMethod::class,
+ \Stripe\Payout::OBJECT_NAME => \Stripe\Payout::class,
+ \Stripe\Person::OBJECT_NAME => \Stripe\Person::class,
+ \Stripe\Plan::OBJECT_NAME => \Stripe\Plan::class,
+ \Stripe\Price::OBJECT_NAME => \Stripe\Price::class,
+ \Stripe\Product::OBJECT_NAME => \Stripe\Product::class,
+ \Stripe\PromotionCode::OBJECT_NAME => \Stripe\PromotionCode::class,
+ \Stripe\Quote::OBJECT_NAME => \Stripe\Quote::class,
+ \Stripe\Radar\EarlyFraudWarning::OBJECT_NAME => \Stripe\Radar\EarlyFraudWarning::class,
+ \Stripe\Radar\ValueList::OBJECT_NAME => \Stripe\Radar\ValueList::class,
+ \Stripe\Radar\ValueListItem::OBJECT_NAME => \Stripe\Radar\ValueListItem::class,
+ \Stripe\Refund::OBJECT_NAME => \Stripe\Refund::class,
+ \Stripe\Reporting\ReportRun::OBJECT_NAME => \Stripe\Reporting\ReportRun::class,
+ \Stripe\Reporting\ReportType::OBJECT_NAME => \Stripe\Reporting\ReportType::class,
+ \Stripe\Review::OBJECT_NAME => \Stripe\Review::class,
+ \Stripe\SearchResult::OBJECT_NAME => \Stripe\SearchResult::class,
+ \Stripe\SetupAttempt::OBJECT_NAME => \Stripe\SetupAttempt::class,
+ \Stripe\SetupIntent::OBJECT_NAME => \Stripe\SetupIntent::class,
+ \Stripe\ShippingRate::OBJECT_NAME => \Stripe\ShippingRate::class,
+ \Stripe\Sigma\ScheduledQueryRun::OBJECT_NAME => \Stripe\Sigma\ScheduledQueryRun::class,
+ \Stripe\Source::OBJECT_NAME => \Stripe\Source::class,
+ \Stripe\SourceTransaction::OBJECT_NAME => \Stripe\SourceTransaction::class,
+ \Stripe\Subscription::OBJECT_NAME => \Stripe\Subscription::class,
+ \Stripe\SubscriptionItem::OBJECT_NAME => \Stripe\SubscriptionItem::class,
+ \Stripe\SubscriptionSchedule::OBJECT_NAME => \Stripe\SubscriptionSchedule::class,
+ \Stripe\TaxCode::OBJECT_NAME => \Stripe\TaxCode::class,
+ \Stripe\TaxId::OBJECT_NAME => \Stripe\TaxId::class,
+ \Stripe\TaxRate::OBJECT_NAME => \Stripe\TaxRate::class,
+ \Stripe\Terminal\Configuration::OBJECT_NAME => \Stripe\Terminal\Configuration::class,
+ \Stripe\Terminal\ConnectionToken::OBJECT_NAME => \Stripe\Terminal\ConnectionToken::class,
+ \Stripe\Terminal\Location::OBJECT_NAME => \Stripe\Terminal\Location::class,
+ \Stripe\Terminal\Reader::OBJECT_NAME => \Stripe\Terminal\Reader::class,
+ \Stripe\TestHelpers\TestClock::OBJECT_NAME => \Stripe\TestHelpers\TestClock::class,
+ \Stripe\Token::OBJECT_NAME => \Stripe\Token::class,
+ \Stripe\Topup::OBJECT_NAME => \Stripe\Topup::class,
+ \Stripe\Transfer::OBJECT_NAME => \Stripe\Transfer::class,
+ \Stripe\TransferReversal::OBJECT_NAME => \Stripe\TransferReversal::class,
+ \Stripe\Treasury\CreditReversal::OBJECT_NAME => \Stripe\Treasury\CreditReversal::class,
+ \Stripe\Treasury\DebitReversal::OBJECT_NAME => \Stripe\Treasury\DebitReversal::class,
+ \Stripe\Treasury\FinancialAccount::OBJECT_NAME => \Stripe\Treasury\FinancialAccount::class,
+ \Stripe\Treasury\FinancialAccountFeatures::OBJECT_NAME => \Stripe\Treasury\FinancialAccountFeatures::class,
+ \Stripe\Treasury\InboundTransfer::OBJECT_NAME => \Stripe\Treasury\InboundTransfer::class,
+ \Stripe\Treasury\OutboundPayment::OBJECT_NAME => \Stripe\Treasury\OutboundPayment::class,
+ \Stripe\Treasury\OutboundTransfer::OBJECT_NAME => \Stripe\Treasury\OutboundTransfer::class,
+ \Stripe\Treasury\ReceivedCredit::OBJECT_NAME => \Stripe\Treasury\ReceivedCredit::class,
+ \Stripe\Treasury\ReceivedDebit::OBJECT_NAME => \Stripe\Treasury\ReceivedDebit::class,
+ \Stripe\Treasury\Transaction::OBJECT_NAME => \Stripe\Treasury\Transaction::class,
+ \Stripe\Treasury\TransactionEntry::OBJECT_NAME => \Stripe\Treasury\TransactionEntry::class,
+ \Stripe\UsageRecord::OBJECT_NAME => \Stripe\UsageRecord::class,
+ \Stripe\UsageRecordSummary::OBJECT_NAME => \Stripe\UsageRecordSummary::class,
+ \Stripe\WebhookEndpoint::OBJECT_NAME => \Stripe\WebhookEndpoint::class,
];
}
diff --git a/Stripe/Stripe/Util/RandomGenerator.php b/Stripe/Stripe/Util/RandomGenerator.php
index ccf023a..b03b23b 100755
--- a/Stripe/Stripe/Util/RandomGenerator.php
+++ b/Stripe/Stripe/Util/RandomGenerator.php
@@ -1,4 +1,4 @@
- $headers
- * @param null|string $base
+ * @param null|string $base
*/
public function __construct($key = null, $headers = [], $base = null)
{
- $this->apiKey = $key;
+ $this->apiKey = $key;
$this->headers = $headers;
$this->apiBase = $base;
}
@@ -39,7 +39,7 @@ class RequestOptions
public function __debugInfo()
{
return [
- 'apiKey' => $this->redactedApiKey(),
+ 'apiKey' => $this->redactedApiKey(),
'headers' => $this->headers,
'apiBase' => $this->apiBase,
];
@@ -50,17 +50,17 @@ class RequestOptions
* object.
*
* @param null|array|RequestOptions|string $options a key => value array
- * @param bool $strict when true, forbid string form and arbitrary keys in array form
+ * @param bool $strict when true, forbid string form and arbitrary keys in array form
*
* @return RequestOptions
*/
public function merge($options, $strict = false)
{
$other_options = self::parse($options, $strict);
- if (null === $other_options->apiKey) {
+ if ($other_options->apiKey === null) {
$other_options->apiKey = $this->apiKey;
}
- if (null === $other_options->apiBase) {
+ if ($other_options->apiBase === null) {
$other_options->apiBase = $this->apiBase;
}
$other_options->headers = \array_merge($this->headers, $other_options->headers);
@@ -71,7 +71,7 @@ class RequestOptions
/**
* Discards all headers that we don't want to persist across requests.
*/
- public function discardNonPersistentHeaders()
+ public function discardNonPersistentHeaders() : void
{
foreach ($this->headers as $k => $v) {
if (!\in_array($k, self::$HEADERS_TO_PERSIST, true)) {
@@ -84,7 +84,7 @@ class RequestOptions
* Unpacks an options array into an RequestOptions object.
*
* @param null|array|RequestOptions|string $options a key => value array
- * @param bool $strict when true, forbid string form and arbitrary keys in array form
+ * @param bool $strict when true, forbid string form and arbitrary keys in array form
*
* @throws \Stripe\Exception\InvalidArgumentException
*
@@ -96,8 +96,8 @@ class RequestOptions
return clone $options;
}
- if (null === $options) {
- return new RequestOptions(null, [], null);
+ if ($options === null) {
+ return new self(null, [], null);
}
if (\is_string($options)) {
@@ -108,13 +108,13 @@ class RequestOptions
throw new \Stripe\Exception\InvalidArgumentException($message);
}
- return new RequestOptions($options, [], null);
+ return new self($options, [], null);
}
if (\is_array($options)) {
$headers = [];
- $key = null;
- $base = null;
+ $key = null;
+ $base = null;
if (\array_key_exists('api_key', $options)) {
$key = $options['api_key'];
@@ -143,7 +143,7 @@ class RequestOptions
throw new \Stripe\Exception\InvalidArgumentException($message);
}
- return new RequestOptions($key, $headers, $base);
+ return new self($key, $headers, $base);
}
$message = 'The second argument to Stripe API method calls is an '
@@ -157,12 +157,12 @@ class RequestOptions
/** @return string */
private function redactedApiKey()
{
- if (null === $this->apiKey) {
+ if ($this->apiKey === null) {
return '';
}
- $pieces = \explode('_', $this->apiKey, 3);
- $last = \array_pop($pieces);
+ $pieces = \explode('_', $this->apiKey, 3);
+ $last = \array_pop($pieces);
$redactedLast = \strlen($last) > 4
? (\str_repeat('*', \strlen($last) - 4) . \substr($last, -4))
: $last;
diff --git a/Stripe/Stripe/Util/Set.php b/Stripe/Stripe/Util/Set.php
index aaa811d..0e26bb1 100755
--- a/Stripe/Stripe/Util/Set.php
+++ b/Stripe/Stripe/Util/Set.php
@@ -1,11 +1,8 @@
-_elts[$elt]);
}
- public function add($elt)
+ public function add($elt) : void
{
$this->_elts[$elt] = true;
}
- public function discard($elt)
+ public function discard($elt) : void
{
unset($this->_elts[$elt]);
}
@@ -38,11 +35,11 @@ class Set implements IteratorAggregate
}
/**
- * @return ArrayIterator
+ * @return \ArrayIterator
*/
#[\ReturnTypeWillChange]
public function getIterator()
{
- return new ArrayIterator($this->toArray());
+ return new \ArrayIterator($this->toArray());
}
}
diff --git a/Stripe/Stripe/Util/Util.php b/Stripe/Stripe/Util/Util.php
index 4f39050..035083b 100755
--- a/Stripe/Stripe/Util/Util.php
+++ b/Stripe/Stripe/Util/Util.php
@@ -1,4 +1,4 @@
- $v) {
- if (null === $v) {
+ if ($v === null) {
continue;
}
$results[$k] = static::objectsToIds($v);
@@ -166,17 +167,17 @@ abstract class Util
public static function encodeParameters($params)
{
$flattenedParams = self::flattenParams($params);
- $pieces = [];
+ $pieces = [];
foreach ($flattenedParams as $param) {
list($k, $v) = $param;
- $pieces[] = self::urlEncode($k) . '=' . self::urlEncode($v);
+ $pieces[] = self::urlEncode($k) . '=' . self::urlEncode($v);
}
return \implode('&', $pieces);
}
/**
- * @param array $params
+ * @param array $params
* @param null|string $parentKey
*
* @return array
@@ -201,7 +202,7 @@ abstract class Util
}
/**
- * @param array $value
+ * @param array $value
* @param string $calculatedKey
*
* @return array
@@ -244,7 +245,7 @@ abstract class Util
{
if (\is_array($id)) {
$params = $id;
- $id = $params['id'];
+ $id = $params['id'];
unset($params['id']);
} else {
$params = [];
diff --git a/Stripe/Stripe/Webhook.php b/Stripe/Stripe/Webhook.php
index b9db2d6..89e6484 100755
--- a/Stripe/Stripe/Webhook.php
+++ b/Stripe/Stripe/Webhook.php
@@ -1,10 +1,10 @@
-Setting up
* Webhooks.
*
- * @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 null|string $api_version The API version events are rendered as for this webhook endpoint.
- * @property null|string $application The ID of the associated Connect application.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property null|string $description An optional description of what the webhook is used for.
- * @property string[] $enabled_events The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.
- * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- * @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 string $secret The endpoint's secret, used to generate webhook signatures. Only returned at creation.
- * @property string $status The status of the webhook. It can be enabled or disabled.
- * @property string $url The URL of the webhook endpoint.
+ * @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 null|string $api_version The API version events are rendered as for this webhook endpoint.
+ * @property null|string $application The ID of the associated Connect application.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|string $description An optional description of what the webhook is used for.
+ * @property string[] $enabled_events The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.
+ * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+ * @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 string $secret The endpoint's secret, used to generate webhook signatures. Only returned at creation.
+ * @property string $status The status of the webhook. It can be enabled or disabled.
+ * @property string $url The URL of the webhook endpoint.
*/
class WebhookEndpoint extends ApiResource
{
- const OBJECT_NAME = 'webhook_endpoint';
+ public const OBJECT_NAME = 'webhook_endpoint';
use ApiOperations\All;
use ApiOperations\Create;
diff --git a/Stripe/Stripe/WebhookSignature.php b/Stripe/Stripe/WebhookSignature.php
index 46cbb28..61adae5 100755
--- a/Stripe/Stripe/WebhookSignature.php
+++ b/Stripe/Stripe/WebhookSignature.php
@@ -1,22 +1,22 @@
- $fp,
+ \CURLOPT_FILE => $fp,
\CURLOPT_TIMEOUT => 3600,
- \CURLOPT_URL => 'https://curl.se/ca/cacert.pem',
+ \CURLOPT_URL => 'https://curl.se/ca/cacert.pem',
];
$ch = \curl_init();
diff --git a/tcpdf/TCPDF.php b/tcpdf/TCPDF.php
index 598456c..6fbfc71 100644
--- a/tcpdf/TCPDF.php
+++ b/tcpdf/TCPDF.php
@@ -701,7 +701,7 @@ class TCPDF {
* @since 5.9.174 (2012-07-25)
* @protected
*/
- protected $txtshadow = ['enabled'=>false, 'depth_w'=>0, 'depth_h'=>0, 'color'=>false, 'opacity'=>1, 'blend_mode'=>'Normal'];
+ protected $txtshadow = ['enabled' => false, 'depth_w' => 0, 'depth_h' => 0, 'color' => false, 'opacity' => 1, 'blend_mode' => 'Normal'];
/**
* Default number of columns for html table.
@@ -1346,7 +1346,7 @@ class TCPDF {
* @protected
* @since 4.8.000 (2009-09-07)
*/
- protected $default_form_prop = ['lineWidth'=>1, 'borderStyle'=>'solid', 'fillColor'=>[255, 255, 255], 'strokeColor'=>[128, 128, 128]];
+ protected $default_form_prop = ['lineWidth' => 1, 'borderStyle' => 'solid', 'fillColor' => [255, 255, 255], 'strokeColor' => [128, 128, 128]];
/**
* Javascript objects array.
@@ -1876,7 +1876,7 @@ class TCPDF {
* @public
* @see getPageSizeFromFormat(), setPageFormat()
*/
- public function __construct($orientation='P', $unit='mm', $format='A4', $unicode=true, $encoding='UTF-8', $diskcache=false, $pdfa=false) {
+ public function __construct($orientation = 'P', $unit = 'mm', $format = 'A4', $unicode = true, $encoding = 'UTF-8', $diskcache = false, $pdfa = false) {
// set file ID for trailer
$serformat = (\is_array($format) ? \json_encode($format) : $format);
$this->file_id = \md5(TCPDF_STATIC::getRandomSeed('TCPDF'.$orientation.$unit.$serformat.$encoding));
@@ -1930,20 +1930,20 @@ class TCPDF {
$this->last_enc_key = '';
// standard Unicode fonts
$this->CoreFonts = [
- 'courier' => 'Courier',
- 'courierB' => 'Courier-Bold',
- 'courierI' => 'Courier-Oblique',
- 'courierBI' => 'Courier-BoldOblique',
- 'helvetica' => 'Helvetica',
- 'helveticaB' => 'Helvetica-Bold',
- 'helveticaI' => 'Helvetica-Oblique',
- 'helveticaBI' => 'Helvetica-BoldOblique',
- 'times' => 'Times-Roman',
- 'timesB' => 'Times-Bold',
- 'timesI' => 'Times-Italic',
- 'timesBI' => 'Times-BoldItalic',
- 'symbol' => 'Symbol',
- 'zapfdingbats'=> 'ZapfDingbats',
+ 'courier' => 'Courier',
+ 'courierB' => 'Courier-Bold',
+ 'courierI' => 'Courier-Oblique',
+ 'courierBI' => 'Courier-BoldOblique',
+ 'helvetica' => 'Helvetica',
+ 'helveticaB' => 'Helvetica-Bold',
+ 'helveticaI' => 'Helvetica-Oblique',
+ 'helveticaBI' => 'Helvetica-BoldOblique',
+ 'times' => 'Times-Roman',
+ 'timesB' => 'Times-Bold',
+ 'timesI' => 'Times-Italic',
+ 'timesBI' => 'Times-BoldItalic',
+ 'symbol' => 'Symbol',
+ 'zapfdingbats' => 'ZapfDingbats',
];
// set scale factor
$this->setPageUnit($unit);
@@ -2017,7 +2017,7 @@ class TCPDF {
// PCRE unicode support is turned OFF
$this->setSpacesRE('/[^\S\xa0]/');
}
- $this->default_form_prop = ['lineWidth'=>1, 'borderStyle'=>'solid', 'fillColor'=>[255, 255, 255], 'strokeColor'=>[128, 128, 128]];
+ $this->default_form_prop = ['lineWidth' => 1, 'borderStyle' => 'solid', 'fillColor' => [255, 255, 255], 'strokeColor' => [128, 128, 128]];
// set document creation and modification timestamp
$this->doc_creation_timestamp = \time();
$this->doc_modification_timestamp = $this->doc_creation_timestamp;
@@ -2139,7 +2139,7 @@ class TCPDF {
* @since 3.0.015 (2008-06-06)
* @see getPageSizeFromFormat()
*/
- protected function setPageFormat($format, $orientation='P') : void {
+ protected function setPageFormat($format, $orientation = 'P') : void {
if (!empty($format) && isset($this->pagedim[$this->page])) {
// remove inherited values
unset($this->pagedim[$this->page]);
@@ -2253,7 +2253,7 @@ class TCPDF {
* @public
* @since 3.0.015 (2008-06-06)
*/
- public function setPageOrientation($orientation, $autopagebreak=null, $bottommargin=null) : void {
+ public function setPageOrientation($orientation, $autopagebreak = null, $bottommargin = null) : void {
if (!isset($this->pagedim[$this->page]['MediaBox'])) {
// the boundaries of the physical medium on which the page shall be displayed or printed
$this->pagedim = TCPDF_STATIC::setPageBoxes($this->page, 'MediaBox', 0, 0, $this->fwPt, $this->fhPt, true, $this->k, $this->pagedim);
@@ -2359,7 +2359,7 @@ class TCPDF {
* @public
* @since 4.6.016 (2009-06-15)
*/
- public function setSpacesRE($re='/[^\S\xa0]/') : void {
+ public function setSpacesRE($re = '/[^\S\xa0]/') : void {
$this->re_spaces = $re;
$re_parts = \explode('/', $re);
// get pattern parts
@@ -2384,7 +2384,7 @@ class TCPDF {
* @public
* @since 2.0.000 (2008-01-03)
*/
- public function setRTL($enable, $resetx=true) : void {
+ public function setRTL($enable, $resetx = true) : void {
$enable = $enable ? true : false;
$resetx = ($resetx && ($enable != $this->rtl));
$this->rtl = $enable;
@@ -2464,7 +2464,7 @@ class TCPDF {
* @public
* @return float
*/
- public function getCellHeight($fontsize, $padding=true) {
+ public function getCellHeight($fontsize, $padding = true) {
$height = ($fontsize * $this->cell_height_ratio);
if ($padding) {
$height += ($this->cell_padding['T'] + $this->cell_padding['B']);
@@ -2522,7 +2522,7 @@ class TCPDF {
* @public
* @since 4.5.027 (2009-03-16)
*/
- public function getPageDimensions($pagenum=null) {
+ public function getPageDimensions($pagenum = null) {
if (empty($pagenum)) {
$pagenum = $this->page;
}
@@ -2538,7 +2538,7 @@ class TCPDF {
* @since 1.5.2
* @see getPageDimensions()
*/
- public function getPageWidth($pagenum=null) {
+ public function getPageWidth($pagenum = null) {
if (empty($pagenum)) {
return $this->w;
}
@@ -2554,7 +2554,7 @@ class TCPDF {
* @since 1.5.2
* @see getPageDimensions()
*/
- public function getPageHeight($pagenum=null) {
+ public function getPageHeight($pagenum = null) {
if (empty($pagenum)) {
return $this->h;
}
@@ -2570,7 +2570,7 @@ class TCPDF {
* @since 1.5.2
* @see getPageDimensions()
*/
- public function getBreakMargin($pagenum=null) {
+ public function getBreakMargin($pagenum = null) {
if (empty($pagenum)) {
return $this->bMargin;
}
@@ -2598,7 +2598,7 @@ class TCPDF {
* @since 1.0
* @see SetLeftMargin(), SetTopMargin(), SetRightMargin(), SetAutoPageBreak()
*/
- public function setMargins($left, $top, $right=null, $keepmargins=false) : void {
+ public function setMargins($left, $top, $right = null, $keepmargins = false) : void {
//Set left, top and right margins
$this->lMargin = $left;
$this->tMargin = $top;
@@ -2683,7 +2683,7 @@ class TCPDF {
* @since 5.9.000 (2010-10-03)
* @see getCellPaddings(), SetCellPadding()
*/
- public function setCellPaddings($left=null, $top=null, $right=null, $bottom=null) : void {
+ public function setCellPaddings($left = null, $top = null, $right = null, $bottom = null) : void {
if (!TCPDF_STATIC::empty_string($left) && ($left >= 0)) {
$this->cell_padding['L'] = $left;
}
@@ -2719,7 +2719,7 @@ class TCPDF {
* @since 5.9.000 (2010-10-03)
* @see getCellMargins()
*/
- public function setCellMargins($left=-1.0, $top=-1.0, $right=-1.0, $bottom=-1.0) : void {
+ public function setCellMargins($left = -1.0, $top = -1.0, $right = -1.0, $bottom = -1.0) : void {
if ($left >= 0) {
$this->cell_margin['L'] = $left;
}
@@ -2752,7 +2752,7 @@ class TCPDF {
* @public
* @since 5.9.000 (2010-10-03)
*/
- protected function adjustCellPadding($brd=0) {
+ protected function adjustCellPadding($brd = 0) {
if (empty($brd)) {
return;
}
@@ -2853,7 +2853,7 @@ class TCPDF {
* @since 1.0
* @see Cell(), MultiCell(), AcceptPageBreak()
*/
- public function setAutoPageBreak($auto, $margin=0) : void {
+ public function setAutoPageBreak($auto, $margin = 0) : void {
$this->AutoPageBreak = $auto ? true : false;
$this->bMargin = $margin;
$this->PageBreakTrigger = $this->h - $margin;
@@ -2877,7 +2877,7 @@ class TCPDF {
* @public
* @since 1.2
*/
- public function setDisplayMode($zoom, $layout='SinglePage', $mode='UseNone') : void {
+ public function setDisplayMode($zoom, $layout = 'SinglePage', $mode = 'UseNone') : void {
if (($zoom === 'fullpage') || ($zoom === 'fullwidth') || ($zoom === 'real') || ($zoom === 'default') || (!\is_string($zoom))) {
$this->ZoomMode = $zoom;
} else {
@@ -2894,7 +2894,7 @@ class TCPDF {
* @public
* @since 1.4
*/
- public function setCompression($compress=true) : void {
+ public function setCompression($compress = true) : void {
$this->compress = false;
if (\function_exists('gzcompress')) {
if ($compress) {
@@ -2911,7 +2911,7 @@ class TCPDF {
* @public
* @since 5.9.121 (2011-09-28)
*/
- public function setSRGBmode($mode=false) : void {
+ public function setSRGBmode($mode = false) : void {
$this->force_srgb = $mode ? true : false;
}
@@ -2922,7 +2922,7 @@ class TCPDF {
* @since 5.9.027 (2010-12-01)
* @public
*/
- public function setDocInfoUnicode($unicode=true) : void {
+ public function setDocInfoUnicode($unicode = true) : void {
$this->docinfounicode = $unicode ? true : false;
}
@@ -3072,7 +3072,7 @@ class TCPDF {
* @since 2.1.000 (2008-01-07)
* @see getPage(), lastpage(), getNumPages()
*/
- public function setPage($pnum, $resetmargins=false) : void {
+ public function setPage($pnum, $resetmargins = false) : void {
if (($pnum == $this->page) && ($this->state == 2)) {
return;
}
@@ -3119,7 +3119,7 @@ class TCPDF {
* @since 2.0.000 (2008-01-04)
* @see setPage(), getPage(), getNumPages()
*/
- public function lastPage($resetmargins=false) : void {
+ public function lastPage($resetmargins = false) : void {
$this->setPage($this->getNumPages(), $resetmargins);
}
@@ -3154,7 +3154,7 @@ class TCPDF {
* @since 5.0.001 (2010-05-06)
* @see AddPage(), startPage(), endPage(), endTOCPage()
*/
- public function addTOCPage($orientation='', $format='', $keepmargins=false) : void {
+ public function addTOCPage($orientation = '', $format = '', $keepmargins = false) : void {
$this->AddPage($orientation, $format, $keepmargins, true);
}
@@ -3179,7 +3179,7 @@ class TCPDF {
* @since 1.0
* @see startPage(), endPage(), addTOCPage(), endTOCPage(), getPageSizeFromFormat(), setPageFormat()
*/
- public function AddPage($orientation='', $format='', $keepmargins=false, $tocpage=false) : void {
+ public function AddPage($orientation = '', $format = '', $keepmargins = false, $tocpage = false) : void {
if ($this->inxobj) {
// we are inside an XObject template
return;
@@ -3203,7 +3203,7 @@ class TCPDF {
* @since 4.2.010 (2008-11-14)
* @see AddPage(), startPage(), addTOCPage(), endTOCPage()
*/
- public function endPage($tocpage=false) : void {
+ public function endPage($tocpage = false) : void {
// check if page is already closed
if (($this->page == 0) || ($this->numpages > $this->page) || (!$this->pageopen[$this->page])) {
return;
@@ -3229,7 +3229,7 @@ class TCPDF {
* @see AddPage(), endPage(), addTOCPage(), endTOCPage(), getPageSizeFromFormat(), setPageFormat()
* @public
*/
- public function startPage($orientation='', $format='', $tocpage=false) : void {
+ public function startPage($orientation = '', $format = '', $tocpage = false) : void {
if ($tocpage) {
$this->tocpage = true;
}
@@ -3289,7 +3289,7 @@ class TCPDF {
// print table header (if any)
$this->setTableHeader();
// set mark for empty page check
- $this->emptypagemrk[$this->page]= $this->pagelen[$this->page];
+ $this->emptypagemrk[$this->page] = $this->pagelen[$this->page];
}
/**
@@ -3313,7 +3313,7 @@ class TCPDF {
* @protected
* @since 4.6.021 (2009-07-20)
*/
- protected function setContentMark($page=0) : void {
+ protected function setContentMark($page = 0) : void {
if ($page <= 0) {
$page = $this->page;
}
@@ -3334,7 +3334,7 @@ class TCPDF {
* @param int[] $lc RGB array color for line
* @public
*/
- public function setHeaderData($ln='', $lw=0, $ht='', $hs='', $tc=[0,0,0], $lc=[0,0,0]) : void {
+ public function setHeaderData($ln = '', $lw = 0, $ht = '', $hs = '', $tc = [0,0,0], $lc = [0,0,0]) : void {
$this->header_logo = $ln;
$this->header_logo_width = $lw;
$this->header_title = $ht;
@@ -3349,7 +3349,7 @@ class TCPDF {
* @param int[] $lc RGB array color for line
* @public
*/
- public function setFooterData($tc=[0,0,0], $lc=[0,0,0]) : void {
+ public function setFooterData($tc = [0,0,0], $lc = [0,0,0]) : void {
$this->footer_text_color = $tc;
$this->footer_line_color = $lc;
}
@@ -3378,7 +3378,7 @@ class TCPDF {
* @param int $hm distance in user units
* @public
*/
- public function setHeaderMargin($hm=10) : void {
+ public function setHeaderMargin($hm = 10) : void {
$this->header_margin = $hm;
}
@@ -3398,7 +3398,7 @@ class TCPDF {
* @param int $fm distance in user units
* @public
*/
- public function setFooterMargin($fm=10) : void {
+ public function setFooterMargin($fm = 10) : void {
$this->footer_margin = $fm;
}
@@ -3417,7 +3417,7 @@ class TCPDF {
* @param bool $val set to true to print the page header (default), false otherwise
* @public
*/
- public function setPrintHeader($val=true) : void {
+ public function setPrintHeader($val = true) : void {
$this->print_header = $val ? true : false;
}
@@ -3426,7 +3426,7 @@ class TCPDF {
* @param bool $val set to true to print the page footer (default), false otherwise
* @public
*/
- public function setPrintFooter($val=true) : void {
+ public function setPrintFooter($val = true) : void {
$this->print_footer = $val ? true : false;
}
@@ -3461,7 +3461,7 @@ class TCPDF {
* @param bool $val set to true to reset Header xobject template at each page, false otherwise
* @public
*/
- public function setHeaderTemplateAutoreset($val=true) : void {
+ public function setHeaderTemplateAutoreset($val = true) : void {
$this->header_xobj_autoreset = $val ? true : false;
}
@@ -3558,7 +3558,7 @@ class TCPDF {
if (!empty($barcode)) {
$this->Ln($line_width);
$barcode_width = \round(($this->w - $this->original_lMargin - $this->original_rMargin) / 3);
- $style =[
+ $style = [
'position' => $this->rtl?'R':'L',
'align' => $this->rtl?'R':'L',
'stretch' => false,
@@ -3810,7 +3810,7 @@ class TCPDF {
* @public
* @since 5.9.125 (2011-10-03)
*/
- public function setSpotColor($type, $name, $tint=100) {
+ public function setSpotColor($type, $name, $tint = 100) {
$spotcolor = TCPDF_COLORS::getSpotColor($name, $this->spot_colors);
if ($spotcolor === false) {
$this->Error('Undefined spot color: '.$name.', you must add it using the AddSpotColor() method.');
@@ -3856,7 +3856,7 @@ class TCPDF {
* @since 4.0.024 (2008-09-12)
* @see AddSpotColor(), SetFillSpotColor(), SetTextSpotColor()
*/
- public function setDrawSpotColor($name, $tint=100) : void {
+ public function setDrawSpotColor($name, $tint = 100) : void {
$this->setSpotColor('draw', $name, $tint);
}
@@ -3868,7 +3868,7 @@ class TCPDF {
* @since 4.0.024 (2008-09-12)
* @see AddSpotColor(), SetDrawSpotColor(), SetTextSpotColor()
*/
- public function setFillSpotColor($name, $tint=100) : void {
+ public function setFillSpotColor($name, $tint = 100) : void {
$this->setSpotColor('fill', $name, $tint);
}
@@ -3880,7 +3880,7 @@ class TCPDF {
* @since 4.0.024 (2008-09-12)
* @see AddSpotColor(), SetDrawSpotColor(), SetFillSpotColor()
*/
- public function setTextSpotColor($name, $tint=100) : void {
+ public function setTextSpotColor($name, $tint = 100) : void {
$this->setSpotColor('text', $name, $tint);
}
@@ -3895,7 +3895,7 @@ class TCPDF {
* @public
* @since 3.1.000 (2008-06-11)
*/
- public function setColorArray($type, $color, $ret=false) {
+ public function setColorArray($type, $color, $ret = false) {
if (\is_array($color)) {
$color = \array_values($color);
// component: grey, RGB red or CMYK cyan
@@ -3926,7 +3926,7 @@ class TCPDF {
* @since 3.1.000 (2008-06-11)
* @see SetDrawColor()
*/
- public function setDrawColorArray($color, $ret=false) {
+ public function setDrawColorArray($color, $ret = false) {
return $this->setColorArray('draw', $color, $ret);
}
@@ -3940,7 +3940,7 @@ class TCPDF {
* @since 3.1.000 (2008-6-11)
* @see SetFillColor()
*/
- public function setFillColorArray($color, $ret=false) {
+ public function setFillColorArray($color, $ret = false) {
return $this->setColorArray('fill', $color, $ret);
}
@@ -3953,7 +3953,7 @@ class TCPDF {
* @since 3.1.000 (2008-6-11)
* @see SetFillColor()
*/
- public function setTextColorArray($color, $ret=false) {
+ public function setTextColorArray($color, $ret = false) {
return $this->setColorArray('text', $color, $ret);
}
@@ -3970,7 +3970,7 @@ class TCPDF {
* @public
* @since 5.9.125 (2011-10-03)
*/
- public function setColor($type, $col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='') {
+ public function setColor($type, $col1 = 0, $col2 = -1, $col3 = -1, $col4 = -1, $ret = false, $name = '') {
// set default values
if (!\is_numeric($col1)) {
$col1 = 0;
@@ -4060,7 +4060,7 @@ class TCPDF {
* @since 1.3
* @see SetDrawColor[], SetFillColor(), SetTextColor(), Line(), Rect(), Cell(), MultiCell()
*/
- public function setDrawColor($col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='') {
+ public function setDrawColor($col1 = 0, $col2 = -1, $col3 = -1, $col4 = -1, $ret = false, $name = '') {
return $this->setColor('draw', $col1, $col2, $col3, $col4, $ret, $name);
}
@@ -4077,7 +4077,7 @@ class TCPDF {
* @since 1.3
* @see SetFillColor[], SetDrawColor(), SetTextColor(), Rect(), Cell(), MultiCell()
*/
- public function setFillColor($col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='') {
+ public function setFillColor($col1 = 0, $col2 = -1, $col3 = -1, $col4 = -1, $ret = false, $name = '') {
return $this->setColor('fill', $col1, $col2, $col3, $col4, $ret, $name);
}
@@ -4094,7 +4094,7 @@ class TCPDF {
* @since 1.3
* @see SetTextColor[], SetDrawColor(), SetFillColor(), Text(), Cell(), MultiCell()
*/
- public function setTextColor($col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='') {
+ public function setTextColor($col1 = 0, $col2 = -1, $col3 = -1, $col4 = -1, $ret = false, $name = '') {
return $this->setColor('text', $col1, $col2, $col3, $col4, $ret, $name);
}
@@ -4110,7 +4110,7 @@ class TCPDF {
* @public
* @since 1.2
*/
- public function GetStringWidth($s, $fontname='', $fontstyle='', $fontsize=0, $getarray=false) {
+ public function GetStringWidth($s, $fontname = '', $fontstyle = '', $fontsize = 0, $getarray = false) {
return $this->GetArrStringWidth(TCPDF_FONTS::utf8Bidi(TCPDF_FONTS::UTF8StringToArray($s, $this->isunicode, $this->CurrentFont), $s, $this->tmprtl, $this->isunicode, $this->CurrentFont), $fontname, $fontstyle, $fontsize, $getarray);
}
@@ -4126,7 +4126,7 @@ class TCPDF {
* @public
* @since 2.4.000 (2008-03-06)
*/
- public function GetArrStringWidth($sa, $fontname='', $fontstyle='', $fontsize=0, $getarray=false) {
+ public function GetArrStringWidth($sa, $fontname = '', $fontstyle = '', $fontsize = 0, $getarray = false) {
// store current values
if ($fontname !== '') {
$prev_FontFamily = $this->FontFamily;
@@ -4181,7 +4181,7 @@ class TCPDF {
* @public
* @since 2.4.000 (2008-03-06)
*/
- public function GetCharWidth($char, $notlast=true) {
+ public function GetCharWidth($char, $notlast = true) {
// get raw width
$chw = $this->cachedRawFontWidths[$char] ?? ($this->cachedRawFontWidths[$char] = $this->getRawCharWidth($char));
if (($this->font_spacing < 0) || (($this->font_spacing > 0) && $notlast)) {
@@ -4268,7 +4268,7 @@ class TCPDF {
* @since 1.5
* @see SetFont(), setFontSubsetting()
*/
- public function AddFont($family, $style='', $fontfile='', $subset='default') {
+ public function AddFont($family, $style = '', $fontfile = '', $subset = 'default') {
if ($subset === 'default') {
$subset = $this->font_subsetting;
}
@@ -4386,7 +4386,7 @@ class TCPDF {
$enc = '';
}
if (!isset($cidinfo) || TCPDF_STATIC::empty_string($cidinfo)) {
- $cidinfo = ['Registry'=>'Adobe', 'Ordering'=>'Identity', 'Supplement'=>0];
+ $cidinfo = ['Registry' => 'Adobe', 'Ordering' => 'Identity', 'Supplement' => 0];
$cidinfo['uni2cid'] = [];
}
if (!isset($ctg) || TCPDF_STATIC::empty_string($ctg)) {
@@ -4477,7 +4477,7 @@ class TCPDF {
//Search existing encodings
$d = 0;
$nb = \count($this->diffs);
- for ($i=1; $i <= $nb; ++$i) {
+ for ($i = 1; $i <= $nb; ++$i) {
if ($this->diffs[$i] == $diff) {
$d = $i;
break;
@@ -4524,7 +4524,7 @@ class TCPDF {
* @since 1.0
* @see AddFont(), SetFontSize()
*/
- public function setFont($family, $style='', $size=null, $fontfile='', $subset='default', $out=true) : void {
+ public function setFont($family, $style = '', $size = null, $fontfile = '', $subset = 'default', $out = true) : void {
//Select a font; size given in points
if ($size === null) {
$size = $this->FontSizePt;
@@ -4539,7 +4539,7 @@ class TCPDF {
$fontdata = $this->AddFont($family, $style, $fontfile, $subset);
$this->FontFamily = $fontdata['family'];
$this->FontStyle = $fontdata['style'];
- if (isset($this->CurrentFont['fontkey']) && isset($this->CurrentFont['subsetchars'])) {
+ if (isset($this->CurrentFont['fontkey'], $this->CurrentFont['subsetchars'])) {
// save subset chars of the previous font
$this->setFontSubBuffer($this->CurrentFont['fontkey'], 'subsetchars', $this->CurrentFont['subsetchars']);
}
@@ -4555,12 +4555,12 @@ class TCPDF {
* @since 1.0
* @see SetFont()
*/
- public function setFontSize($size, $out=true) : void {
+ public function setFontSize($size, $out = true) : void {
$size = (float) $size;
// font size in points
$this->FontSizePt = $size;
// font size in user units
- $this->FontSize = $size / $this->k;
+ $this->FontSize = $size / $this->k;
$this->cachedRawFontWidths = [];
// calculate some font metrics
if (isset($this->CurrentFont['desc']['FontBBox'])) {
@@ -4669,7 +4669,7 @@ class TCPDF {
* @author Nicola Asuni
* @since 4.9.003 (2010-03-30)
*/
- public function getFontDescent($font, $style='', $size=0) {
+ public function getFontDescent($font, $style = '', $size = 0) {
$fontdata = $this->AddFont($font, $style);
$fontinfo = $this->getFontBuffer($fontdata['fontkey']);
if (isset($fontinfo['desc']['Descent']) && ($fontinfo['desc']['Descent'] <= 0)) {
@@ -4690,7 +4690,7 @@ class TCPDF {
* @author Nicola Asuni
* @since 4.9.003 (2010-03-30)
*/
- public function getFontAscent($font, $style='', $size=0) {
+ public function getFontAscent($font, $style = '', $size = 0) {
$fontdata = $this->AddFont($font, $style);
$fontinfo = $this->getFontBuffer($fontdata['fontkey']);
if (isset($fontinfo['desc']['Ascent']) && ($fontinfo['desc']['Ascent'] > 0)) {
@@ -4710,7 +4710,7 @@ class TCPDF {
* @public
* @since 5.9.153 (2012-03-28)
*/
- public function isCharDefined($char, $font='', $style='') {
+ public function isCharDefined($char, $font = '', $style = '') {
if (\is_string($char)) {
// get character code
$char = TCPDF_FONTS::UTF8StringToArray($char, $this->isunicode, $this->CurrentFont);
@@ -4737,7 +4737,7 @@ class TCPDF {
* @public
* @since 5.9.153 (2012-03-28)
*/
- public function replaceMissingChars($text, $font='', $style='', $subs=[]) {
+ public function replaceMissingChars($text, $font = '', $style = '', $subs = []) {
if (empty($subs)) {
return $text;
}
@@ -4801,7 +4801,7 @@ class TCPDF {
* @since 1.5
* @see AddLink()
*/
- public function setLink($link, $y=0, $page=-1) : void {
+ public function setLink($link, $y = 0, $page = -1) : void {
$fixed = false;
if (!empty($page) && (\substr($page, 0, 1) === '*')) {
$page = (int) \substr($page, 1);
@@ -4830,8 +4830,8 @@ class TCPDF {
* @since 1.5
* @see AddLink(), Annotation(), Cell(), Write(), Image()
*/
- public function Link($x, $y, $w, $h, $link, $spaces=0) : void {
- $this->Annotation($x, $y, $w, $h, $link, ['Subtype'=>'Link'], $spaces);
+ public function Link($x, $y, $w, $h, $link, $spaces = 0) : void {
+ $this->Annotation($x, $y, $w, $h, $link, ['Subtype' => 'Link'], $spaces);
}
/**
@@ -4847,7 +4847,7 @@ class TCPDF {
* @public
* @since 4.0.018 (2008-08-06)
*/
- public function Annotation($x, $y, $w, $h, $text, $opt=['Subtype'=>'Text'], $spaces=0) : void {
+ public function Annotation($x, $y, $w, $h, $text, $opt = ['Subtype' => 'Text'], $spaces = 0) : void {
if ($this->inxobj) {
// store parameters for later use on template
$this->xobjects[$this->xobjid]['annotations'][] = ['x' => $x, 'y' => $y, 'w' => $w, 'h' => $h, 'text' => $text, 'opt' => $opt, 'spaces' => $spaces];
@@ -4863,9 +4863,9 @@ class TCPDF {
list($x, $y) = $this->checkPageRegions($h, $x, $y);
// recalculate coordinates to account for graphic transformations
if (isset($this->transfmatrix) && !empty($this->transfmatrix)) {
- for ($i=$this->transfmatrix_key; $i > 0; --$i) {
+ for ($i = $this->transfmatrix_key; $i > 0; --$i) {
$maxid = \count($this->transfmatrix[$i]) - 1;
- for ($j=$maxid; $j >= 0; --$j) {
+ for ($j = $maxid; $j >= 0; --$j) {
$ctm = $this->transfmatrix[$i][$j];
if (isset($ctm['a'])) {
$x = $x * $this->k;
@@ -5003,7 +5003,7 @@ class TCPDF {
* @since 1.0
* @see Cell(), Write(), MultiCell(), WriteHTML(), WriteHTMLCell()
*/
- public function Text($x, $y, $txt, $fstroke=0, $fclip=false, $ffill=true, $border=0, $ln=0, $align='', $fill=false, $link='', $stretch=0, $ignore_min_height=false, $calign='T', $valign='M', $rtloff=false) : void {
+ public function Text($x, $y, $txt, $fstroke = 0, $fclip = false, $ffill = true, $border = 0, $ln = 0, $align = '', $fill = false, $link = '', $stretch = 0, $ignore_min_height = false, $calign = 'T', $valign = 'M', $rtloff = false) : void {
$textrendermode = $this->textrendermode;
$textstrokewidth = $this->textstrokewidth;
$this->setTextRenderingMode($fstroke, $ffill, $fclip);
@@ -5050,7 +5050,7 @@ class TCPDF {
* @since 3.2.000 (2008-07-01)
* @protected
*/
- protected function checkPageBreak($h=0, $y=null, $addpage=true) {
+ protected function checkPageBreak($h = 0, $y = null, $addpage = true) {
if (TCPDF_STATIC::empty_string($y)) {
$y = $this->y;
}
@@ -5104,7 +5104,7 @@ class TCPDF {
* @since 1.0
* @see SetFont(), SetDrawColor(), SetFillColor(), SetTextColor(), SetLineWidth(), AddLink(), Ln(), MultiCell(), Write(), SetAutoPageBreak()
*/
- public function Cell($w, $h=0, $txt='', $border=0, $ln=0, $align='', $fill=false, $link='', $stretch=0, $ignore_min_height=false, $calign='T', $valign='M') : void {
+ public function Cell($w, $h = 0, $txt = '', $border = 0, $ln = 0, $align = '', $fill = false, $link = '', $stretch = 0, $ignore_min_height = false, $calign = 'T', $valign = 'M') : void {
$prev_cell_margin = $this->cell_margin;
$prev_cell_padding = $this->cell_padding;
$this->adjustCellPadding($border);
@@ -5173,7 +5173,7 @@ class TCPDF {
* @since 1.0
* @see Cell()
*/
- protected function getCellCode($w, $h=0, $txt='', $border=0, $ln=0, $align='', $fill=false, $link='', $stretch=0, $ignore_min_height=false, $calign='T', $valign='M') {
+ protected function getCellCode($w, $h = 0, $txt = '', $border = 0, $ln = 0, $align = '', $fill = false, $link = '', $stretch = 0, $ignore_min_height = false, $calign = 'T', $valign = 'M') {
// replace 'NO-BREAK SPACE' (U+00A0) character with a simple space
$txt = \str_replace(TCPDF_FONTS::$cache_unichr[160] ?? (TCPDF_FONTS::$cache_unichr[160] = TCPDF_FONTS::unichr(160, $this->isunicode)), ' ', $txt);
$prev_cell_margin = $this->cell_margin;
@@ -5866,7 +5866,7 @@ class TCPDF {
* @since 1.3
* @see SetFont(), SetDrawColor(), SetFillColor(), SetTextColor(), SetLineWidth(), Cell(), Write(), SetAutoPageBreak()
*/
- public function MultiCell($w, $h, $txt, $border=0, $align='J', $fill=false, $ln=1, $x=null, $y=null, $reseth=true, $stretch=0, $ishtml=false, $autopadding=true, $maxh=0, $valign='T', $fitcell=false) {
+ public function MultiCell($w, $h, $txt, $border = 0, $align = 'J', $fill = false, $ln = 1, $x = null, $y = null, $reseth = true, $stretch = 0, $ishtml = false, $autopadding = true, $maxh = 0, $valign = 'T', $fitcell = false) {
$prev_cell_margin = $this->cell_margin;
$prev_cell_padding = $this->cell_padding;
// adjust internal padding
@@ -6032,9 +6032,9 @@ class TCPDF {
$check_page_regions = $this->check_page_regions;
$this->check_page_regions = false;
// get border modes
- $border_start = TCPDF_STATIC::getBorderMode($border, $position='start', $this->opencell);
- $border_end = TCPDF_STATIC::getBorderMode($border, $position='end', $this->opencell);
- $border_middle = TCPDF_STATIC::getBorderMode($border, $position='middle', $this->opencell);
+ $border_start = TCPDF_STATIC::getBorderMode($border, $position = 'start', $this->opencell);
+ $border_end = TCPDF_STATIC::getBorderMode($border, $position = 'end', $this->opencell);
+ $border_middle = TCPDF_STATIC::getBorderMode($border, $position = 'middle', $this->opencell);
// design borders around HTML cells.
for ($page = $startpage; $page <= $endpage; ++$page) { // for each page
$ccode = '';
@@ -6234,7 +6234,7 @@ class TCPDF {
* @public
* @since 4.5.011
*/
- public function getNumLines($txt, $w=0, $reseth=false, $autopadding=true, $cellpadding=null, $border=0) {
+ public function getNumLines($txt, $w = 0, $reseth = false, $autopadding = true, $cellpadding = null, $border = 0) {
if ($txt === null) {
return 0;
}
@@ -6353,7 +6353,7 @@ class TCPDF {
* @author Nicola Asuni, Alexander Escalona Fern\E1ndez
* @public
*/
- public function getStringHeight($w, $txt, $reseth=false, $autopadding=true, $cellpadding=null, $border=0) {
+ public function getStringHeight($w, $txt, $reseth = false, $autopadding = true, $cellpadding = null, $border = 0) {
// adjust internal padding
$prev_cell_padding = $this->cell_padding;
$prev_lasth = $this->lasth;
@@ -6386,7 +6386,7 @@ class TCPDF {
* @public
* @since 1.5
*/
- public function Write($h, $txt, $link='', $fill=false, $align='', $ln=false, $stretch=0, $firstline=false, $firstblock=false, $maxh=0, $wadj=0, $margin=null) {
+ public function Write($h, $txt, $link = '', $fill = false, $align = '', $ln = false, $stretch = 0, $firstline = false, $firstblock = false, $maxh = 0, $wadj = 0, $margin = null) {
// check page for no-write regions and adapt page margins if necessary
list($this->x, $this->y) = $this->checkPageRegions($h, $this->x, $this->y);
if (\strlen($txt) == 0) {
@@ -6836,7 +6836,7 @@ class TCPDF {
* @protected
* @since 5.5.009 (2010-07-05)
*/
- protected function fitBlock($w, $h, $x, $y, $fitonpage=false) {
+ protected function fitBlock($w, $h, $x, $y, $fitonpage = false) {
if ($w <= 0) {
// set maximum width
$w = ($this->w - $this->lMargin - $this->rMargin);
@@ -6931,7 +6931,7 @@ class TCPDF {
* @public
* @since 1.1
*/
- public function Image($file, $x=null, $y=null, $w=0, $h=0, $type='', $link='', $align='', $resize=false, $dpi=300, $palign='', $ismask=false, $imgmask=false, $border=0, $fitbox=false, $hidden=false, $fitonpage=false, $alt=false, $altimgs=[]) {
+ public function Image($file, $x = null, $y = null, $w = 0, $h = 0, $type = '', $link = '', $align = '', $resize = false, $dpi = 300, $palign = '', $ismask = false, $imgmask = false, $border = 0, $fitbox = false, $hidden = false, $fitonpage = false, $alt = false, $altimgs = []) {
if ($this->state != 2) {
return false;
}
@@ -7346,7 +7346,7 @@ class TCPDF {
* @since 4.3.007 (2008-12-04)
* @see Image()
*/
- protected function ImagePngAlpha($file, $x, $y, $wpx, $hpx, $w, $h, $type, $link, $align, $resize, $dpi, $palign, $filehash='') : void {
+ protected function ImagePngAlpha($file, $x, $y, $wpx, $hpx, $w, $h, $type, $link, $align, $resize, $dpi, $palign, $filehash = '') : void {
// create temp images
if (empty($filehash)) {
$filehash = \md5($file);
@@ -7473,7 +7473,7 @@ class TCPDF {
* @since 1.0
* @see Cell()
*/
- public function Ln($h=null, $cell=false) : void {
+ public function Ln($h = null, $cell = false) : void {
if (($this->num_columns > 1) && ($this->y == $this->columns[$this->current_column]['y']) && isset($this->columns[$this->current_column]['x']) && ($this->x == $this->columns[$this->current_column]['x'])) {
// revove vertical space from the top of the column
return;
@@ -7547,7 +7547,7 @@ class TCPDF {
* @since 1.2
* @see GetX(), GetY(), SetY(), SetXY()
*/
- public function setX($x, $rtloff=false) : void {
+ public function setX($x, $rtloff = false) : void {
$x = (float) $x;
if (!$rtloff && $this->rtl) {
if ($x >= 0) {
@@ -7580,7 +7580,7 @@ class TCPDF {
* @since 1.0
* @see GetX(), GetY(), SetY(), SetXY()
*/
- public function setY($y, $resetx=true, $rtloff=false) : void {
+ public function setY($y, $resetx = true, $rtloff = false) : void {
$y = (float) $y;
if ($resetx) {
//reset x
@@ -7613,7 +7613,7 @@ class TCPDF {
* @since 1.2
* @see SetX(), SetY()
*/
- public function setXY($x, $y, $rtloff=false) : void {
+ public function setXY($x, $y, $rtloff = false) : void {
$this->setY($y, false, $rtloff);
$this->setX($x, $rtloff);
}
@@ -7664,7 +7664,7 @@ class TCPDF {
* @since 1.0
* @see Close()
*/
- public function Output($name='doc.pdf', $dest='I') {
+ public function Output($name = 'doc.pdf', $dest = 'I') {
//Output PDF to some destination
//Finish document if necessary
if ($this->state < 3) {
@@ -7738,7 +7738,7 @@ class TCPDF {
if (\ob_get_contents()) {
$this->Error('Some data has already been output, can\'t send PDF file');
}
- if (PHP_SAPI != 'cli') {
+ if (\PHP_SAPI != 'cli') {
// send output to a browser
\header('Content-Type: application/pdf');
if (\headers_sent()) {
@@ -7771,7 +7771,7 @@ class TCPDF {
\header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past
\header('Last-Modified: '.\gmdate('D, d M Y H:i:s').' GMT');
// force download dialog
- if (\strpos(PHP_SAPI, 'cgi') === false) {
+ if (\strpos(\PHP_SAPI, 'cgi') === false) {
\header('Content-Type: application/force-download');
\header('Content-Type: application/octet-stream', false);
\header('Content-Type: application/download', false);
@@ -7819,7 +7819,7 @@ class TCPDF {
\header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past
\header('Last-Modified: '.\gmdate('D, d M Y H:i:s').' GMT');
// force download dialog
- if (\strpos(PHP_SAPI, 'cgi') === false) {
+ if (\strpos(\PHP_SAPI, 'cgi') === false) {
\header('Content-Type: application/force-download');
\header('Content-Type: application/octet-stream', false);
\header('Content-Type: application/download', false);
@@ -7864,7 +7864,7 @@ class TCPDF {
* @public
* @since 4.5.016 (2009-02-24)
*/
- public function _destroy($destroyall=false, $preserve_objcopy=false) : void {
+ public function _destroy($destroyall = false, $preserve_objcopy = false) : void {
if (isset(self::$cleaned_ids[$this->file_id])) {
$destroyall = false;
}
@@ -7887,7 +7887,7 @@ class TCPDF {
}
}
}
- $preserve =[
+ $preserve = [
'file_id',
'state',
'bufferlen',
@@ -7931,7 +7931,7 @@ class TCPDF {
* @return array of page number aliases
* @protected
*/
- protected function getInternalPageNumberAliases($a= '') {
+ protected function getInternalPageNumberAliases($a = '') {
$alias = [];
// build array of Unicode + ASCII variants (the order is important)
$alias = ['u' => [], 'a' => []];
@@ -8226,7 +8226,7 @@ class TCPDF {
*/
protected function _putannotsobjs() : void {
// reset object counter
- for ($n=1; $n <= $this->numpages; ++$n) {
+ for ($n = 1; $n <= $this->numpages; ++$n) {
if (isset($this->PageAnnots[$n])) {
// set page annotations
foreach ($this->PageAnnots[$n] as $key => $pl) {
@@ -8874,7 +8874,7 @@ class TCPDF {
* @protected
* @since 4.8.001 (2009-09-09)
*/
- protected function _putAPXObject($w=0, $h=0, $stream='') {
+ protected function _putAPXObject($w = 0, $h = 0, $stream = '') {
$stream = \trim($stream);
$out = $this->_getobj()."\n";
$this->xobjects['AX'.$this->n] = ['n' => $this->n];
@@ -9306,7 +9306,7 @@ class TCPDF {
$trns = '';
$count_info = \count($info['trns']);
if ($info['cs'] === 'Indexed') {
- $maxval =(\pow(2, $info['bpc']) - 1);
+ $maxval = (\pow(2, $info['bpc']) - 1);
for ($i = 0; $i < $count_info; ++$i) {
if (($info['trns'][$i] != 0) && ($info['trns'][$i] != $maxval)) {
// this is not a binary type mask @todo create a SMask
@@ -10071,7 +10071,7 @@ class TCPDF {
* @protected
*/
protected function _enddoc() : void {
- if (isset($this->CurrentFont['fontkey']) && isset($this->CurrentFont['subsetchars'])) {
+ if (isset($this->CurrentFont['fontkey'], $this->CurrentFont['subsetchars'])) {
// save subset chars of the previous font
$this->setFontSubBuffer($this->CurrentFont['fontkey'], 'subsetchars', $this->CurrentFont['subsetchars']);
}
@@ -10128,7 +10128,7 @@ class TCPDF {
$this->_out('0 '.($this->n + 1));
$this->_out('0000000000 65535 f ');
$freegen = ($this->n + 2);
- for ($i=1; $i <= $this->n; ++$i) {
+ for ($i = 1; $i <= $this->n; ++$i) {
if (!isset($this->offsets[$i]) && ($i > 1)) {
$this->_out(\sprintf('0000000000 %05d f ', $freegen));
++$freegen;
@@ -10161,7 +10161,7 @@ class TCPDF {
* @protected
* @see getPageSizeFromFormat(), setPageFormat()
*/
- protected function _beginpage($orientation='', $format='') : void {
+ protected function _beginpage($orientation = '', $format = '') : void {
++$this->page;
$this->pageobjects[$this->page] = [];
$this->setPageBuffer($this->page, '');
@@ -10226,7 +10226,7 @@ class TCPDF {
* @protected
* @since 5.8.009 (2010-08-20)
*/
- protected function _getobj($objid=null) {
+ protected function _getobj($objid = null) {
if (TCPDF_STATIC::empty_string($objid)) {
++$this->n;
$objid = $this->n;
@@ -10319,7 +10319,7 @@ class TCPDF {
* @return string escaped string
* @protected
*/
- protected function _datastring($s, $n=0) {
+ protected function _datastring($s, $n = 0) {
if ($n == 0) {
$n = $this->n;
}
@@ -10381,7 +10381,7 @@ class TCPDF {
* @protected
* @since 4.6.028 (2009-08-25)
*/
- protected function _datestring($n=0, $timestamp=0) {
+ protected function _datestring($n = 0, $timestamp = 0) {
if ((empty($timestamp)) || ($timestamp < 0)) {
$timestamp = $this->doc_creation_timestamp;
}
@@ -10395,7 +10395,7 @@ class TCPDF {
* @return string escaped string
* @protected
*/
- protected function _textstring($s, $n=0) {
+ protected function _textstring($s, $n = 0) {
if ($this->isunicode) {
//Convert string to UTF-16BE
$s = TCPDF_FONTS::UTF8ToUTF16BE($s, true, $this->isunicode, $this->CurrentFont);
@@ -10411,7 +10411,7 @@ class TCPDF {
* @author Nicola Asuni
* @since 5.5.000 (2010-06-22)
*/
- protected function _getrawstream($s, $n=0) {
+ protected function _getrawstream($s, $n = 0) {
if ($n <= 0) {
// default to current object
$n = $this->n;
@@ -10529,7 +10529,7 @@ class TCPDF {
* @return int the number of cells used or the remaining text if $firstline = true;
* @public
*/
- public function addHtmlLink($url, $name, $fill=false, $firstline=false, $color=null, $style=-1, $firstblock=false) {
+ public function addHtmlLink($url, $name, $fill = false, $firstline = false, $color = null, $style = -1, $firstblock = false) {
if (isset($url[1]) && ($url[0] === '#') && \is_numeric($url[1])) {
// convert url to internal link
$lnkdata = \explode(',', $url);
@@ -10994,7 +10994,7 @@ class TCPDF {
* @since 2.0.000 (2008-01-02)
* @author Nicola Asuni
*/
- public function setProtection($permissions=['print', 'modify', 'copy', 'annot-forms', 'fill-forms', 'extract', 'assemble', 'print-high'], $user_pass='', $owner_pass=null, $mode=0, $pubkeys=null) : void {
+ public function setProtection($permissions = ['print', 'modify', 'copy', 'annot-forms', 'fill-forms', 'extract', 'assemble', 'print-high'], $user_pass = '', $owner_pass = null, $mode = 0, $pubkeys = null) : void {
if ($this->pdfa_mode) {
// encryption is not allowed in PDF/A mode
return;
@@ -11149,7 +11149,7 @@ class TCPDF {
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
- public function ScaleX($s_x, $x='', $y='') : void {
+ public function ScaleX($s_x, $x = '', $y = '') : void {
$this->Scale($s_x, 100, $x, $y);
}
@@ -11162,7 +11162,7 @@ class TCPDF {
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
- public function ScaleY($s_y, $x='', $y='') : void {
+ public function ScaleY($s_y, $x = '', $y = '') : void {
$this->Scale(100, $s_y, $x, $y);
}
@@ -11175,7 +11175,7 @@ class TCPDF {
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
- public function ScaleXY($s, $x='', $y='') : void {
+ public function ScaleXY($s, $x = '', $y = '') : void {
$this->Scale($s, $s, $x, $y);
}
@@ -11189,7 +11189,7 @@ class TCPDF {
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
- public function Scale($s_x, $s_y, $x=null, $y=null) : void {
+ public function Scale($s_x, $s_y, $x = null, $y = null) : void {
if (TCPDF_STATIC::empty_string($x)) {
$x = $this->x;
}
@@ -11222,7 +11222,7 @@ class TCPDF {
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
- public function MirrorH($x=null) : void {
+ public function MirrorH($x = null) : void {
$this->Scale(-100, 100, $x);
}
@@ -11233,7 +11233,7 @@ class TCPDF {
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
- public function MirrorV($y=null) : void {
+ public function MirrorV($y = null) : void {
$this->Scale(100, -100, null, $y);
}
@@ -11245,7 +11245,7 @@ class TCPDF {
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
- public function MirrorP($x=null,$y=null) : void {
+ public function MirrorP($x = null,$y = null) : void {
$this->Scale(-100, -100, $x, $y);
}
@@ -11258,7 +11258,7 @@ class TCPDF {
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
- public function MirrorL($angle=0, $x=null,$y=null) : void {
+ public function MirrorL($angle = 0, $x = null,$y = null) : void {
$this->Scale(-100, 100, $x, $y);
$this->Rotate(-2 * ($angle - 90), $x, $y);
}
@@ -11315,7 +11315,7 @@ class TCPDF {
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
- public function Rotate($angle, $x=null, $y=null) : void {
+ public function Rotate($angle, $x = null, $y = null) : void {
if (TCPDF_STATIC::empty_string($x)) {
$x = $this->x;
}
@@ -11345,7 +11345,7 @@ class TCPDF {
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
- public function SkewX($angle_x, $x=null, $y=null) : void {
+ public function SkewX($angle_x, $x = null, $y = null) : void {
$this->Skew($angle_x, 0, $x, $y);
}
@@ -11358,7 +11358,7 @@ class TCPDF {
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
- public function SkewY($angle_y, $x=null, $y=null) : void {
+ public function SkewY($angle_y, $x = null, $y = null) : void {
$this->Skew(0, $angle_y, $x, $y);
}
@@ -11372,7 +11372,7 @@ class TCPDF {
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
- public function Skew($angle_x, $angle_y, $x=null, $y=null) : void {
+ public function Skew($angle_x, $angle_y, $x = null, $y = null) : void {
if (TCPDF_STATIC::empty_string($x)) {
$x = $this->x;
}
@@ -11478,7 +11478,7 @@ class TCPDF {
* @public
* @since 2.1.000 (2008-01-08)
*/
- public function setLineStyle($style, $ret=false) {
+ public function setLineStyle($style, $ret = false) {
$s = ''; // string to be returned
if (!\is_array($style)) {
return $s;
@@ -11489,7 +11489,7 @@ class TCPDF {
$s .= $this->linestyleWidth.' ';
}
if (isset($style['cap'])) {
- $ca = ['butt' => 0, 'round'=> 1, 'square' => 2];
+ $ca = ['butt' => 0, 'round' => 1, 'square' => 2];
if (isset($ca[$style['cap']])) {
$this->linestyleCap = $ca[$style['cap']].' J';
$s .= $this->linestyleCap.' ';
@@ -11637,7 +11637,7 @@ class TCPDF {
* @since 1.0
* @see SetLineWidth(), SetDrawColor(), SetLineStyle()
*/
- public function Line($x1, $y1, $x2, $y2, $style=[]) : void {
+ public function Line($x1, $y1, $x2, $y2, $style = []) : void {
if ($this->state != 2) {
return;
}
@@ -11667,7 +11667,7 @@ class TCPDF {
* @since 1.0
* @see SetLineStyle()
*/
- public function Rect($x, $y, $w, $h, $style='', $border_style=[], $fill_color=[]) : void {
+ public function Rect($x, $y, $w, $h, $style = '', $border_style = [], $fill_color = []) : void {
if ($this->state != 2) {
return;
}
@@ -11738,7 +11738,7 @@ class TCPDF {
* @see SetLineStyle()
* @since 2.1.000 (2008-01-08)
*/
- public function Curve($x0, $y0, $x1, $y1, $x2, $y2, $x3, $y3, $style='', $line_style=[], $fill_color=[]) : void {
+ public function Curve($x0, $y0, $x1, $y1, $x2, $y2, $x3, $y3, $style = '', $line_style = [], $fill_color = []) : void {
if ($this->state != 2) {
return;
}
@@ -11768,7 +11768,7 @@ class TCPDF {
* @see SetLineStyle()
* @since 3.0008 (2008-05-12)
*/
- public function Polycurve($x0, $y0, $segments, $style='', $line_style=[], $fill_color=[]) : void {
+ public function Polycurve($x0, $y0, $segments, $style = '', $line_style = [], $fill_color = []) : void {
if ($this->state != 2) {
return;
}
@@ -11808,7 +11808,7 @@ class TCPDF {
* @public
* @since 2.1.000 (2008-01-08)
*/
- public function Ellipse($x0, $y0, $rx, $ry=0, $angle=0, $astart=0, $afinish=360, $style='', $line_style=[], $fill_color=[], $nc=2) : void {
+ public function Ellipse($x0, $y0, $rx, $ry = 0, $angle = 0, $astart = 0, $afinish = 360, $style = '', $line_style = [], $fill_color = [], $nc = 2) : void {
if ($this->state != 2) {
return;
}
@@ -11849,7 +11849,7 @@ class TCPDF {
* @protected
* @since 4.9.019 (2010-04-26)
*/
- protected function _outellipticalarc($xc, $yc, $rx, $ry, $xang=0, $angs=0, $angf=360, $pie=false, $nc=2, $startpoint=true, $ccw=true, $svg=false) {
+ protected function _outellipticalarc($xc, $yc, $rx, $ry, $xang = 0, $angs = 0, $angf = 360, $pie = false, $nc = 2, $startpoint = true, $ccw = true, $svg = false) {
if (($rx <= 0) || ($ry < 0)) {
return;
}
@@ -11980,7 +11980,7 @@ class TCPDF {
* @public
* @since 2.1.000 (2008-01-08)
*/
- public function Circle($x0, $y0, $r, $angstr=0, $angend=360, $style='', $line_style=[], $fill_color=[], $nc=2) : void {
+ public function Circle($x0, $y0, $r, $angstr = 0, $angend = 360, $style = '', $line_style = [], $fill_color = [], $nc = 2) : void {
$this->Ellipse($x0, $y0, $r, $r, 0, $angstr, $angend, $style, $line_style, $fill_color, $nc);
}
@@ -11998,7 +11998,7 @@ class TCPDF {
* @since 4.8.003 (2009-09-15)
* @public
*/
- public function PolyLine($p, $style='', $line_style=[], $fill_color=[]) : void {
+ public function PolyLine($p, $style = '', $line_style = [], $fill_color = []) : void {
$this->Polygon($p, $style, $line_style, $fill_color, false);
}
@@ -12017,7 +12017,7 @@ class TCPDF {
* @public
* @since 2.1.000 (2008-01-08)
*/
- public function Polygon($p, $style='', $line_style=[], $fill_color=[], $closed=true) : void {
+ public function Polygon($p, $style = '', $line_style = [], $fill_color = [], $closed = true) : void {
if ($this->state != 2) {
return;
}
@@ -12118,7 +12118,7 @@ class TCPDF {
* @public
* @since 2.1.000 (2008-01-08)
*/
- public function RegularPolygon($x0, $y0, $r, $ns, $angle=0, $draw_circle=false, $style='', $line_style=[], $fill_color=[], $circle_style='', $circle_outLine_style=[], $circle_fill_color=[]) : void {
+ public function RegularPolygon($x0, $y0, $r, $ns, $angle = 0, $draw_circle = false, $style = '', $line_style = [], $fill_color = [], $circle_style = '', $circle_outLine_style = [], $circle_fill_color = []) : void {
if ($ns < 3) {
$ns = 3;
}
@@ -12166,7 +12166,7 @@ class TCPDF {
* @public
* @since 2.1.000 (2008-01-08)
*/
- public function StarPolygon($x0, $y0, $r, $nv, $ng, $angle=0, $draw_circle=false, $style='', $line_style=[], $fill_color=[], $circle_style='', $circle_outLine_style=[], $circle_fill_color=[]) : void {
+ public function StarPolygon($x0, $y0, $r, $nv, $ng, $angle = 0, $draw_circle = false, $style = '', $line_style = [], $fill_color = [], $circle_style = '', $circle_outLine_style = [], $circle_fill_color = []) : void {
if ($nv < 2) {
$nv = 2;
}
@@ -12208,7 +12208,7 @@ class TCPDF {
* @public
* @since 2.1.000 (2008-01-08)
*/
- public function RoundedRect($x, $y, $w, $h, $r, $round_corner='1111', $style='', $border_style=[], $fill_color=[]) : void {
+ public function RoundedRect($x, $y, $w, $h, $r, $round_corner = '1111', $style = '', $border_style = [], $fill_color = []) : void {
$this->RoundedRectXY($x, $y, $w, $h, $r, $r, $round_corner, $style, $border_style, $fill_color);
}
@@ -12227,7 +12227,7 @@ class TCPDF {
* @public
* @since 4.9.019 (2010-04-22)
*/
- public function RoundedRectXY($x, $y, $w, $h, $rx, $ry, $round_corner='1111', $style='', $border_style=[], $fill_color=[]) : void {
+ public function RoundedRectXY($x, $y, $w, $h, $rx, $ry, $round_corner = '1111', $style = '', $border_style = [], $fill_color = []) : void {
if ($this->state != 2) {
return;
}
@@ -12297,7 +12297,7 @@ class TCPDF {
* @author Piotr Galecki, Nicola Asuni, Andy Meier
* @since 4.6.018 (2009-07-10)
*/
- public function Arrow($x0, $y0, $x1, $y1, $head_style=0, $arm_size=5, $arm_angle=15) : void {
+ public function Arrow($x0, $y0, $x1, $y1, $head_style = 0, $arm_size = 5, $arm_angle = 15) : void {
// getting arrow direction angle
// 0 deg angle is when both arms go along X axis. angle grows clockwise.
$dir_angle = \atan2(($y0 - $y1), ($x0 - $x1));
@@ -12362,7 +12362,7 @@ class TCPDF {
* @author Christian Deligant, Nicola Asuni
* @since 5.9.097 (2011-06-23)
*/
- public function setDestination($name, $y=-1, $page='', $x=-1) {
+ public function setDestination($name, $y = -1, $page = '', $x = -1) {
// remove unsupported characters
$name = TCPDF_STATIC::encodeNameObject($name);
if (TCPDF_STATIC::empty_string($name)) {
@@ -12441,7 +12441,7 @@ class TCPDF {
* @param mixed $link URL, or numerical link ID, or named destination (# character followed by the destination name), or embedded file (* character followed by the file name)
* @public
*/
- public function setBookmark($txt, $level=0, $y=-1, $page='', $style='', $color=[0,0,0], $x=-1, $link='') : void {
+ public function setBookmark($txt, $level = 0, $y = -1, $page = '', $style = '', $color = [0,0,0], $x = -1, $link = '') : void {
$this->Bookmark($txt, $level, $y, $page, $style, $color, $x, $link);
}
@@ -12458,7 +12458,7 @@ class TCPDF {
* @public
* @since 2.1.002 (2008-02-12)
*/
- public function Bookmark($txt, $level=0, $y=-1, $page='', $style='', $color=[0,0,0], $x=-1, $link='') : void {
+ public function Bookmark($txt, $level = 0, $y = -1, $page = '', $style = '', $color = [0,0,0], $x = -1, $link = '') : void {
if ($level < 0) {
$level = 0;
}
@@ -12663,7 +12663,7 @@ class TCPDF {
* @author Nicola Asuni
* @since 4.8.000 (2009-09-07)
*/
- public function addJavascriptObject($script, $onload=false) {
+ public function addJavascriptObject($script, $onload = false) {
if ($this->pdfa_mode) {
// javascript is not allowed in PDF/A mode
return false;
@@ -12771,7 +12771,7 @@ class TCPDF {
* @author Nicola Asuni
* @since 4.8.000 (2009-09-06)
*/
- public function setFormDefaultProp($prop=[]) : void {
+ public function setFormDefaultProp($prop = []) : void {
$this->default_form_prop = $prop;
}
@@ -12800,7 +12800,7 @@ class TCPDF {
* @author Nicola Asuni
* @since 4.8.000 (2009-09-07)
*/
- public function TextField($name, $w, $h, $prop=[], $opt=[], $x=null, $y=null, $js=false) : void {
+ public function TextField($name, $w, $h, $prop = [], $opt = [], $x = null, $y = null, $js = false) : void {
if (TCPDF_STATIC::empty_string($x)) {
$x = $this->x;
}
@@ -12921,7 +12921,7 @@ class TCPDF {
* @author Nicola Asuni
* @since 4.8.000 (2009-09-07)
*/
- public function RadioButton($name, $w, $prop=[], $opt=[], $onvalue='On', $checked=false, $x=null, $y=null, $js=false) : void {
+ public function RadioButton($name, $w, $prop = [], $opt = [], $onvalue = 'On', $checked = false, $x = null, $y = null, $js = false) : void {
if (TCPDF_STATIC::empty_string($x)) {
$x = $this->x;
}
@@ -13024,7 +13024,7 @@ class TCPDF {
* @author Nicola Asuni
* @since 4.8.000 (2009-09-07)
*/
- public function ListBox($name, $w, $h, $values, $prop=[], $opt=[], $x=null, $y=null, $js=false) : void {
+ public function ListBox($name, $w, $h, $values, $prop = [], $opt = [], $x = null, $y = null, $js = false) : void {
if (TCPDF_STATIC::empty_string($x)) {
$x = $this->x;
}
@@ -13110,7 +13110,7 @@ class TCPDF {
* @author Nicola Asuni
* @since 4.8.000 (2009-09-07)
*/
- public function ComboBox($name, $w, $h, $values, $prop=[], $opt=[], $x=null, $y=null, $js=false) : void {
+ public function ComboBox($name, $w, $h, $values, $prop = [], $opt = [], $x = null, $y = null, $js = false) : void {
if (TCPDF_STATIC::empty_string($x)) {
$x = $this->x;
}
@@ -13197,7 +13197,7 @@ class TCPDF {
* @author Nicola Asuni
* @since 4.8.000 (2009-09-07)
*/
- public function CheckBox($name, $w, $checked=false, $prop=[], $opt=[], $onvalue='Yes', $x=null, $y=null, $js=false) : void {
+ public function CheckBox($name, $w, $checked = false, $prop = [], $opt = [], $onvalue = 'Yes', $x = null, $y = null, $js = false) : void {
if (TCPDF_STATIC::empty_string($x)) {
$x = $this->x;
}
@@ -13277,7 +13277,7 @@ class TCPDF {
* @author Nicola Asuni
* @since 4.8.000 (2009-09-07)
*/
- public function Button($name, $w, $h, $caption, $action, $prop=[], $opt=[], $x=null, $y=null, $js=false) : void {
+ public function Button($name, $w, $h, $caption, $action, $prop = [], $opt = [], $x = null, $y = null, $js = false) : void {
if (TCPDF_STATIC::empty_string($x)) {
$x = $this->x;
}
@@ -13534,13 +13534,13 @@ class TCPDF {
* @since 2.9.000 (2008-03-26)
*/
public function setUserRights(
- $enable=true,
- $document='/FullSave',
- $annots='/Create/Delete/Modify/Copy/Import/Export',
- $form='/Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate',
- $signature='/Modify',
- $ef='/Create/Delete/Modify/Import',
- $formex='') : void {
+ $enable = true,
+ $document = '/FullSave',
+ $annots = '/Create/Delete/Modify/Copy/Import/Export',
+ $form = '/Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate',
+ $signature = '/Modify',
+ $ef = '/Create/Delete/Modify/Import',
+ $formex = '') : void {
$this->ur['enabled'] = $enable;
$this->ur['document'] = $document;
$this->ur['annots'] = $annots;
@@ -13570,7 +13570,7 @@ class TCPDF {
* @author Nicola Asuni
* @since 4.6.005 (2009-04-24)
*/
- public function setSignature($signing_cert='', $private_key='', $private_key_password='', $extracerts='', $cert_type=2, $info=[], $approval='') : void {
+ public function setSignature($signing_cert = '', $private_key = '', $private_key_password = '', $extracerts = '', $cert_type = 2, $info = [], $approval = '') : void {
// to create self-signed signature: openssl req -x509 -nodes -days 365000 -newkey rsa:1024 -keyout tcpdf.crt -out tcpdf.crt
// to export crt to p12: openssl pkcs12 -export -in tcpdf.crt -out tcpdf.p12
// to convert pfx certificate to pem: openssl
@@ -13607,7 +13607,7 @@ class TCPDF {
* @author Nicola Asuni
* @since 5.3.011 (2010-06-17)
*/
- public function setSignatureAppearance($x=0, $y=0, $w=0, $h=0, $page=-1, $name='') : void {
+ public function setSignatureAppearance($x = 0, $y = 0, $w = 0, $h = 0, $page = -1, $name = '') : void {
$this->signature_appearance = $this->getSignatureAppearanceArray($x, $y, $w, $h, $page, $name);
}
@@ -13623,7 +13623,7 @@ class TCPDF {
* @author Nicola Asuni
* @since 5.9.101 (2011-07-06)
*/
- public function addEmptySignatureAppearance($x=0, $y=0, $w=0, $h=0, $page=-1, $name='') : void {
+ public function addEmptySignatureAppearance($x = 0, $y = 0, $w = 0, $h = 0, $page = -1, $name = '') : void {
++$this->n;
$this->empty_signature_appearance[] = ['objid' => $this->n] + $this->getSignatureAppearanceArray($x, $y, $w, $h, $page, $name);
}
@@ -13641,7 +13641,7 @@ class TCPDF {
* @author Nicola Asuni
* @since 5.9.101 (2011-07-06)
*/
- protected function getSignatureAppearanceArray($x=0, $y=0, $w=0, $h=0, $page=-1, $name='') {
+ protected function getSignatureAppearanceArray($x = 0, $y = 0, $w = 0, $h = 0, $page = -1, $name = '') {
$sigapp = [];
if (($page < 1) || ($page > $this->numpages)) {
$sigapp['page'] = $this->page;
@@ -13673,7 +13673,7 @@ class TCPDF {
* @author Richard Stockinger
* @since 6.0.090 (2014-06-16)
*/
- public function setTimeStamp($tsa_host='', $tsa_username='', $tsa_password='', $tsa_cert='') : void {
+ public function setTimeStamp($tsa_host = '', $tsa_username = '', $tsa_password = '', $tsa_cert = '') : void {
$this->tsa_data = [];
if (!\function_exists('curl_init')) {
$this->Error('Please enable cURL PHP extension!');
@@ -13716,7 +13716,7 @@ class TCPDF {
* @public
* @since 3.0.000 (2008-03-27)
*/
- public function startPageGroup($page=null) : void {
+ public function startPageGroup($page = null) : void {
if (empty($page)) {
$page = $this->page + 1;
}
@@ -13729,7 +13729,7 @@ class TCPDF {
* @since 5.9.093 (2011-06-16)
* @public
*/
- public function setStartingPageNumber($num=1) : void {
+ public function setStartingPageNumber($num = 1) : void {
$this->starting_page_number = \max(0, (int) $num);
}
@@ -13881,7 +13881,7 @@ class TCPDF {
* @public
* @since 5.9.102 (2011-07-13)
*/
- public function startLayer($name='', $print=true, $view=true, $lock=true) : void {
+ public function startLayer($name = '', $print = true, $view = true, $lock = true) : void {
if ($this->state != 2) {
return;
}
@@ -14026,7 +14026,7 @@ class TCPDF {
* @public
* @since 5.9.152 (2012-03-23)
*/
- public function setOverprint($stroking=true, $nonstroking=null, $mode=0) : void {
+ public function setOverprint($stroking = true, $nonstroking = null, $mode = 0) : void {
if ($this->state != 2) {
return;
}
@@ -14065,7 +14065,7 @@ class TCPDF {
* @public
* @since 3.0.000 (2008-03-27)
*/
- public function setAlpha($stroking=1, $bm='Normal', $nonstroking=null, $ais=false) : void {
+ public function setAlpha($stroking = 1, $bm = 'Normal', $nonstroking = null, $ais = false) : void {
if ($this->pdfa_mode && $this->pdfa_version < 2) {
// transparency is not allowed in PDF/A-1 mode
return;
@@ -14120,7 +14120,7 @@ class TCPDF {
* @public
* @since 3.0.014 (2008-06-04)
*/
- public function setDefaultTableColumns($cols=4) : void {
+ public function setDefaultTableColumns($cols = 4) : void {
$this->default_table_columns = (int) $cols;
}
@@ -14150,7 +14150,7 @@ class TCPDF {
* @public
* @since 3.1.000 (2008-06-09)
*/
- public function setPDFVersion($version='1.7') : void {
+ public function setPDFVersion($version = '1.7') : void {
if ($this->pdfa_mode && $this->pdfa_version == 1) {
// PDF/A-1 mode
$this->PDFVersion = '1.4';
@@ -14188,7 +14188,7 @@ class TCPDF {
* @since 4.9.000 (2010-03-26)
* @public
*/
- public function colorRegistrationBar($x, $y, $w, $h, $transition=true, $vertical=false, $colors='A,R,G,B,C,M,Y,K') : void {
+ public function colorRegistrationBar($x, $y, $w, $h, $transition = true, $vertical = false, $colors = 'A,R,G,B,C,M,Y,K') : void {
if (\strpos($colors, 'ALLSPOT') !== false) {
// expand spot colors
$spot_colors = '';
@@ -14328,7 +14328,7 @@ class TCPDF {
* @since 4.9.000 (2010-03-26)
* @public
*/
- public function cropMark($x, $y, $w, $h, $type='T,R,B,L', $color=[100,100,100,100,'All']) : void {
+ public function cropMark($x, $y, $w, $h, $type = 'T,R,B,L', $color = [100,100,100,100,'All']) : void {
$this->setLineStyle(['width' => (0.5 / $this->k), 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => $color]);
$type = \strtoupper($type);
$type = \preg_replace('/[^A-Z\-\,]*/', '', $type);
@@ -14399,7 +14399,7 @@ class TCPDF {
* @since 4.9.000 (2010-03-26)
* @public
*/
- public function registrationMark($x, $y, $r, $double=false, $cola=[100,100,100,100,'All'], $colb=[0,0,0,0,'None']) : void {
+ public function registrationMark($x, $y, $r, $double = false, $cola = [100,100,100,100,'All'], $colb = [0,0,0,0,'None']) : void {
$line_style = ['width' => \max((0.5 / $this->k),($r / 30)), 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => $cola];
$this->setFillColorArray($cola);
$this->PieSector($x, $y, $r, 90, 180, 'F');
@@ -14470,7 +14470,7 @@ class TCPDF {
* @since 3.1.000 (2008-06-09)
* @public
*/
- public function LinearGradient($x, $y, $w, $h, $col1=[], $col2=[], $coords=[0,0,1,0]) : void {
+ public function LinearGradient($x, $y, $w, $h, $col1 = [], $col2 = [], $coords = [0,0,1,0]) : void {
$this->Clip($x, $y, $w, $h);
$this->Gradient(2, $coords, [['color' => $col1, 'offset' => 0, 'exponent' => 1], ['color' => $col2, 'offset' => 1, 'exponent' => 1]], [], false);
}
@@ -14488,7 +14488,7 @@ class TCPDF {
* @since 3.1.000 (2008-06-09)
* @public
*/
- public function RadialGradient($x, $y, $w, $h, $col1=[], $col2=[], $coords=[0.5,0.5,0.5,0.5,1]) : void {
+ public function RadialGradient($x, $y, $w, $h, $col1 = [], $col2 = [], $coords = [0.5,0.5,0.5,0.5,1]) : void {
$this->Clip($x, $y, $w, $h);
$this->Gradient(3, $coords, [['color' => $col1, 'offset' => 0, 'exponent' => 1], ['color' => $col2, 'offset' => 1, 'exponent' => 1]], [], false);
}
@@ -14511,7 +14511,7 @@ class TCPDF {
* @since 3.1.000 (2008-06-09)
* @public
*/
- public function CoonsPatchMesh($x, $y, $w, $h, $col1=[], $col2=[], $col3=[], $col4=[], $coords=[0.00,0.0,0.33,0.00,0.67,0.00,1.00,0.00,1.00,0.33,1.00,0.67,1.00,1.00,0.67,1.00,0.33,1.00,0.00,1.00,0.00,0.67,0.00,0.33], $coords_min=0, $coords_max=1, $antialias=false) : void {
+ public function CoonsPatchMesh($x, $y, $w, $h, $col1 = [], $col2 = [], $col3 = [], $col4 = [], $coords = [0.00,0.0,0.33,0.00,0.67,0.00,1.00,0.00,1.00,0.33,1.00,0.67,1.00,1.00,0.67,1.00,0.33,1.00,0.00,1.00,0.00,0.67,0.00,0.33], $coords_min = 0, $coords_max = 1, $antialias = false) : void {
if (($this->pdfa_mode && $this->pdfa_version < 2) || ($this->state != 2)) {
return;
}
@@ -14560,10 +14560,10 @@ class TCPDF {
//build the data stream
$this->gradients[$n]['stream'] = '';
$count_patch = \count($patch_array);
- for ($i=0; $i < $count_patch; ++$i) {
+ for ($i = 0; $i < $count_patch; ++$i) {
$this->gradients[$n]['stream'] .= \chr($patch_array[$i]['f']); //start with the edge flag as 8 bit
$count_points = \count($patch_array[$i]['points']);
- for ($j=0; $j < $count_points; ++$j) {
+ for ($j = 0; $j < $count_points; ++$j) {
//each point as 16 bit
$patch_array[$i]['points'][$j] = (($patch_array[$i]['points'][$j] - $coords_min) / ($coords_max - $coords_min)) * $bpcd;
if ($patch_array[$i]['points'][$j] < 0) {
@@ -14576,7 +14576,7 @@ class TCPDF {
$this->gradients[$n]['stream'] .= \chr((int) \floor((int) ($patch_array[$i]['points'][$j]) % 256));
}
$count_cols = \count($patch_array[$i]['colors']);
- for ($j=0; $j < $count_cols; ++$j) {
+ for ($j = 0; $j < $count_cols; ++$j) {
//each color component as 8 bit
$this->gradients[$n]['stream'] .= \chr($patch_array[$i]['colors'][$j]['r']);
$this->gradients[$n]['stream'] .= \chr($patch_array[$i]['colors'][$j]['g']);
@@ -14630,7 +14630,7 @@ class TCPDF {
* @since 3.1.000 (2008-06-09)
* @public
*/
- public function Gradient($type, $coords, $stops, $background=[], $antialias=false) : void {
+ public function Gradient($type, $coords, $stops, $background = [], $antialias = false) : void {
if (($this->pdfa_mode && $this->pdfa_version < 2) || ($this->state != 2)) {
return;
}
@@ -14929,7 +14929,7 @@ class TCPDF {
* @since 3.1.000 (2008-06-09)
* @public
*/
- public function PieSector($xc, $yc, $r, $a, $b, $style='FD', $cw=true, $o=90) : void {
+ public function PieSector($xc, $yc, $r, $a, $b, $style = 'FD', $cw = true, $o = 90) : void {
$this->PieSectorXY($xc, $yc, $r, $r, $a, $b, $style, $cw, $o);
}
@@ -14950,7 +14950,7 @@ class TCPDF {
* @since 3.1.000 (2008-06-09)
* @public
*/
- public function PieSectorXY($xc, $yc, $rx, $ry, $a, $b, $style='FD', $cw=false, $o=0, $nc=2) : void {
+ public function PieSectorXY($xc, $yc, $rx, $ry, $a, $b, $style = 'FD', $cw = false, $o = 0, $nc = 2) : void {
if ($this->state != 2) {
return;
}
@@ -14994,7 +14994,7 @@ class TCPDF {
* @since 3.1.000 (2008-06-09)
* @public
*/
- public function ImageEps($file, $x=null, $y=null, $w=0, $h=0, $link='', $useBoundingBox=true, $align='', $palign='', $border=0, $fitonpage=false, $fixoutvals=false) {
+ public function ImageEps($file, $x = null, $y = null, $w = 0, $h = 0, $link = '', $useBoundingBox = true, $align = '', $palign = '', $border = 0, $fitonpage = false, $fixoutvals = false) {
if ($this->state != 2) {
return;
}
@@ -15120,9 +15120,9 @@ class TCPDF {
}
// handle pc/unix/mac line endings
$lines = \preg_split('/[\r\n]+/si', $data, -1, \PREG_SPLIT_NO_EMPTY);
- $u =0;
+ $u = 0;
$cnt = \count($lines);
- for ($i=0; $i < $cnt; ++$i) {
+ for ($i = 0; $i < $cnt; ++$i) {
$line = $lines[$i];
if (($line === '') || ($line[0] === '%')) {
continue;
@@ -15313,7 +15313,7 @@ class TCPDF {
* @param string $bc barcode
* @public
*/
- public function setBarcode($bc='') : void {
+ public function setBarcode($bc = '') : void {
$this->barcode = $bc;
}
@@ -15357,7 +15357,7 @@ class TCPDF {
* @since 3.1.000 (2008-06-09)
* @public
*/
- public function write1DBarcode($code, $type, $x=null, $y=null, $w=null, $h=null, $xres=null, $style=[], $align='') : void {
+ public function write1DBarcode($code, $type, $x = null, $y = null, $w = null, $h = null, $xres = null, $style = [], $align = '') : void {
if (TCPDF_STATIC::empty_string(\trim($code))) {
return;
}
@@ -15675,7 +15675,7 @@ class TCPDF {
* @since 4.5.037 (2009-04-07)
* @public
*/
- public function write2DBarcode($code, $type, $x=null, $y=null, $w=null, $h=null, $style=[], $align='', $distort=false) : void {
+ public function write2DBarcode($code, $type, $x = null, $y = null, $w = null, $h = null, $style = [], $align = '', $distort = false) : void {
if (TCPDF_STATIC::empty_string(\trim($code))) {
return;
}
@@ -15980,7 +15980,7 @@ class TCPDF {
* @since 5.9.017 (2010-11-16)
* @see setHtmlVSpace()
*/
- public function fixHTMLCode($html, $default_css='', $tagvs=null, $tidy_options=null) {
+ public function fixHTMLCode($html, $default_css = '', $tagvs = null, $tidy_options = null) {
return TCPDF_STATIC::fixHTMLCode($html, $default_css, $tagvs, $tidy_options, $this->tagvspaces);
}
@@ -16098,7 +16098,7 @@ class TCPDF {
* @public
* @since 5.9.000 (2010-10-04)
*/
- public function getCSSPadding($csspadding, $width=0) {
+ public function getCSSPadding($csspadding, $width = 0) {
$padding = \preg_split('/[\s]+/', \trim($csspadding));
$cell_padding = []; // value to be returned
switch (\count($padding)) {
@@ -16152,7 +16152,7 @@ class TCPDF {
* @public
* @since 5.9.000 (2010-10-04)
*/
- public function getCSSMargin($cssmargin, $width=0) {
+ public function getCSSMargin($cssmargin, $width = 0) {
$margin = \preg_split('/[\s]+/', \trim($cssmargin));
$cell_margin = []; // value to be returned
switch (\count($margin)) {
@@ -16206,7 +16206,7 @@ class TCPDF {
* @public
* @since 5.9.010 (2010-10-27)
*/
- public function getCSSBorderMargin($cssbspace, $width=0) {
+ public function getCSSBorderMargin($cssbspace, $width = 0) {
$space = \preg_split('/[\s]+/', \trim($cssbspace));
$border_spacing = []; // value to be returned
switch (\count($space)) {
@@ -16240,7 +16240,7 @@ class TCPDF {
* @protected
* @since 5.9.000 (2010-10-02)
*/
- protected function getCSSFontSpacing($spacing, $parent=0) {
+ protected function getCSSFontSpacing($spacing, $parent = 0) {
$val = 0; // value to be returned
$spacing = \trim($spacing);
switch ($spacing) {
@@ -16271,7 +16271,7 @@ class TCPDF {
* @protected
* @since 5.9.000 (2010-10-02)
*/
- protected function getCSSFontStretching($stretch, $parent=100) {
+ protected function getCSSFontStretching($stretch, $parent = 100) {
$val = 100; // value to be returned
$stretch = \trim($stretch);
switch ($stretch) {
@@ -16343,7 +16343,7 @@ class TCPDF {
* @return float value in points
* @public
*/
- public function getHTMLFontUnits($val, $refsize=12, $parent_size=12, $defaultunit='pt') {
+ public function getHTMLFontUnits($val, $refsize = 12, $parent_size = 12, $defaultunit = 'pt') {
$refsize = TCPDF_FONTS::getFontRefSize($refsize);
$parent_size = TCPDF_FONTS::getFontRefSize($parent_size, $refsize);
switch ($val) {
@@ -17266,7 +17266,7 @@ Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value:
* @see Multicell(), writeHTML()
* @public
*/
- public function writeHTMLCell($w, $h, $x, $y, $html='', $border=0, $ln=0, $fill=false, $reseth=true, $align='', $autopadding=true) {
+ public function writeHTMLCell($w, $h, $x, $y, $html = '', $border = 0, $ln = 0, $fill = false, $reseth = true, $align = '', $autopadding = true) {
return $this->MultiCell($w, $h, $html, $border, $align, $fill, $ln, $x, $y, $reseth, 0, true, $autopadding, 0, 'T', false);
}
@@ -17283,7 +17283,7 @@ Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value:
* @param string $align Allows to center or align the text. Possible values are: