code
stringlengths
15
9.96M
docstring
stringlengths
1
10.1k
func_name
stringlengths
1
124
language
stringclasses
1 value
repo
stringlengths
7
63
path
stringlengths
6
186
url
stringlengths
50
236
license
stringclasses
4 values
public function __construct($key = null, $headers = [], $base = null, $maxNetworkRetries = null) { $this->apiKey = $key; $this->headers = $headers; $this->apiBase = $base; $this->maxNetworkRetries = $maxNetworkRetries; }
@param null|string $key @param array<string, string> $headers @param null|string $base @param null|int $maxNetworkRetries
__construct
php
stripe/stripe-php
lib/Util/RequestOptions.php
https://github.com/stripe/stripe-php/blob/master/lib/Util/RequestOptions.php
MIT
public function __debugInfo() { return [ 'apiKey' => $this->redactedApiKey(), 'headers' => $this->headers, 'apiBase' => $this->apiBase, 'maxNetworkRetries' => $this->maxNetworkRetries, ]; }
@return array<string, string>
__debugInfo
php
stripe/stripe-php
lib/Util/RequestOptions.php
https://github.com/stripe/stripe-php/blob/master/lib/Util/RequestOptions.php
MIT
public function merge($options, $strict = false) { $other_options = self::parse($options, $strict); if (null === $other_options->apiKey) { $other_options->apiKey = $this->apiKey; } if (null === $other_options->apiBase) { $other_options->apiBase = $this->apiBase; } if (null === $other_options->maxNetworkRetries) { $other_options->maxNetworkRetries = $this->maxNetworkRetries; } $other_options->headers = \array_merge($this->headers, $other_options->headers); return $other_options; }
Unpacks an options array and merges it into the existing 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 @return RequestOptions
merge
php
stripe/stripe-php
lib/Util/RequestOptions.php
https://github.com/stripe/stripe-php/blob/master/lib/Util/RequestOptions.php
MIT
public function discardNonPersistentHeaders() { foreach ($this->headers as $k => $v) { if (!\in_array($k, self::$HEADERS_TO_PERSIST, true)) { unset($this->headers[$k]); } } }
Discards all headers that we don't want to persist across requests.
discardNonPersistentHeaders
php
stripe/stripe-php
lib/Util/RequestOptions.php
https://github.com/stripe/stripe-php/blob/master/lib/Util/RequestOptions.php
MIT
public static function parse($options, $strict = false) { if ($options instanceof self) { return clone $options; } if (null === $options) { return new RequestOptions(null, [], null); } if (\is_string($options)) { if ($strict) { $message = 'Do not pass a string for request options. If you want to set the ' . 'API key, pass an array like ["api_key" => <apiKey>] instead.'; throw new \Stripe\Exception\InvalidArgumentException($message); } return new RequestOptions($options, [], null); } if (\is_array($options)) { $headers = []; $key = null; $base = null; $maxNetworkRetries = null; if (\array_key_exists('api_key', $options)) { $key = $options['api_key']; unset($options['api_key']); } if (\array_key_exists('idempotency_key', $options)) { $headers['Idempotency-Key'] = $options['idempotency_key']; unset($options['idempotency_key']); } if (\array_key_exists('stripe_account', $options)) { if (null !== $options['stripe_account']) { $headers['Stripe-Account'] = $options['stripe_account']; } unset($options['stripe_account']); } if (\array_key_exists('stripe_context', $options)) { if (null !== $options['stripe_context']) { $headers['Stripe-Context'] = $options['stripe_context']; } unset($options['stripe_context']); } if (\array_key_exists('stripe_version', $options)) { if (null !== $options['stripe_version']) { $headers['Stripe-Version'] = $options['stripe_version']; } unset($options['stripe_version']); } if (\array_key_exists('max_network_retries', $options)) { if (null !== $options['max_network_retries']) { $maxNetworkRetries = $options['max_network_retries']; } unset($options['max_network_retries']); } if (\array_key_exists('api_base', $options)) { $base = $options['api_base']; unset($options['api_base']); } if ($strict && !empty($options)) { $message = 'Got unexpected keys in options array: ' . \implode(', ', \array_keys($options)); throw new \Stripe\Exception\InvalidArgumentException($message); } return new RequestOptions($key, $headers, $base, $maxNetworkRetries); } $message = 'The second argument to Stripe API method calls is an ' . 'optional per-request apiKey, which must be a string, or ' . 'per-request options, which must be an array. (HINT: you can set ' . 'a global apiKey by "Stripe::setApiKey(<apiKey>)")'; throw new \Stripe\Exception\InvalidArgumentException($message); }
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 @return RequestOptions @throws \Stripe\Exception\InvalidArgumentException
parse
php
stripe/stripe-php
lib/Util/RequestOptions.php
https://github.com/stripe/stripe-php/blob/master/lib/Util/RequestOptions.php
MIT
public static function isList($array) { if (!\is_array($array)) { return false; } if ([] === $array) { return true; } if (\array_keys($array) !== \range(0, \count($array) - 1)) { return false; } return true; }
Whether the provided array (or other) is a list rather than a dictionary. A list is defined as an array for which all the keys are consecutive integers starting at 0. Empty arrays are considered to be lists. @param array|mixed $array @return bool true if the given object is a list
isList
php
stripe/stripe-php
lib/Util/Util.php
https://github.com/stripe/stripe-php/blob/master/lib/Util/Util.php
MIT
public static function utf8($value) { if (null === self::$isMbstringAvailable) { self::$isMbstringAvailable = \function_exists('mb_detect_encoding') && \function_exists('mb_convert_encoding'); if (!self::$isMbstringAvailable) { \trigger_error( 'It looks like the mbstring extension is not enabled. ' . 'UTF-8 strings will not properly be encoded. Ask your system ' . 'administrator to enable the mbstring extension, or write to ' . '[email protected] if you have any questions.', \E_USER_WARNING ); } } if (\is_string($value) && self::$isMbstringAvailable && 'UTF-8' !== \mb_detect_encoding($value, 'UTF-8', true) ) { return mb_convert_encoding($value, 'UTF-8', 'ISO-8859-1'); } return $value; }
@param mixed|string $value a string to UTF8-encode @return mixed|string the UTF8-encoded string, or the object passed in if it wasn't a string
utf8
php
stripe/stripe-php
lib/Util/Util.php
https://github.com/stripe/stripe-php/blob/master/lib/Util/Util.php
MIT
public static function secureCompare($a, $b) { if (null === self::$isHashEqualsAvailable) { self::$isHashEqualsAvailable = \function_exists('hash_equals'); } if (self::$isHashEqualsAvailable) { return \hash_equals($a, $b); } if (\strlen($a) !== \strlen($b)) { return false; } $result = 0; for ($i = 0; $i < \strlen($a); ++$i) { $result |= \ord($a[$i]) ^ \ord($b[$i]); } return 0 === $result; }
Compares two strings for equality. The time taken is independent of the number of characters that match. @param string $a one of the strings to compare @param string $b the other string to compare @return bool true if the strings are equal, false otherwise
secureCompare
php
stripe/stripe-php
lib/Util/Util.php
https://github.com/stripe/stripe-php/blob/master/lib/Util/Util.php
MIT
public static function urlEncode($key) { $s = \urlencode((string) $key); // Don't use strict form encoding by changing the square bracket control // characters back to their literals. This is fine by the server, and // makes these parameter strings easier to read. $s = \str_replace('%5B', '[', $s); return \str_replace('%5D', ']', $s); }
@param string $key a string to URL-encode @return string the URL-encoded string
urlEncode
php
stripe/stripe-php
lib/Util/Util.php
https://github.com/stripe/stripe-php/blob/master/lib/Util/Util.php
MIT
public static function currentTimeMillis() { return (int) \round(\microtime(true) * 1000); }
Returns UNIX timestamp in milliseconds. @return int current time in millis
currentTimeMillis
php
stripe/stripe-php
lib/Util/Util.php
https://github.com/stripe/stripe-php/blob/master/lib/Util/Util.php
MIT
public function randFloat($max = 1.0) { return \mt_rand() / \mt_getrandmax() * $max; }
Returns a random value between 0 and $max. @param float $max (optional) @return float
randFloat
php
stripe/stripe-php
lib/Util/RandomGenerator.php
https://github.com/stripe/stripe-php/blob/master/lib/Util/RandomGenerator.php
MIT
public function uuid() { $arr = \array_values(\unpack('N1a/n4b/N1c', \openssl_random_pseudo_bytes(16))); $arr[2] = ($arr[2] & 0x0FFF) | 0x4000; $arr[3] = ($arr[3] & 0x3FFF) | 0x8000; return \vsprintf('%08x-%04x-%04x-%04x-%04x%08x', $arr); }
Returns a v4 UUID. @return string
uuid
php
stripe/stripe-php
lib/Util/RandomGenerator.php
https://github.com/stripe/stripe-php/blob/master/lib/Util/RandomGenerator.php
MIT
public function count() { return \count($this->container); }
[\ReturnTypeWillChange]
count
php
stripe/stripe-php
lib/Util/CaseInsensitiveArray.php
https://github.com/stripe/stripe-php/blob/master/lib/Util/CaseInsensitiveArray.php
MIT
public function getIterator() { return new \ArrayIterator($this->container); }
[\ReturnTypeWillChange]
getIterator
php
stripe/stripe-php
lib/Util/CaseInsensitiveArray.php
https://github.com/stripe/stripe-php/blob/master/lib/Util/CaseInsensitiveArray.php
MIT
public function offsetSet($offset, $value) { $offset = self::maybeLowercase($offset); if (null === $offset) { $this->container[] = $value; } else { $this->container[$offset] = $value; } }
[\ReturnTypeWillChange]
offsetSet
php
stripe/stripe-php
lib/Util/CaseInsensitiveArray.php
https://github.com/stripe/stripe-php/blob/master/lib/Util/CaseInsensitiveArray.php
MIT
public function offsetExists($offset) { $offset = self::maybeLowercase($offset); return isset($this->container[$offset]); }
[\ReturnTypeWillChange]
offsetExists
php
stripe/stripe-php
lib/Util/CaseInsensitiveArray.php
https://github.com/stripe/stripe-php/blob/master/lib/Util/CaseInsensitiveArray.php
MIT
public function offsetUnset($offset) { $offset = self::maybeLowercase($offset); unset($this->container[$offset]); }
[\ReturnTypeWillChange]
offsetUnset
php
stripe/stripe-php
lib/Util/CaseInsensitiveArray.php
https://github.com/stripe/stripe-php/blob/master/lib/Util/CaseInsensitiveArray.php
MIT
public function offsetGet($offset) { $offset = self::maybeLowercase($offset); return isset($this->container[$offset]) ? $this->container[$offset] : null; }
[\ReturnTypeWillChange]
offsetGet
php
stripe/stripe-php
lib/Util/CaseInsensitiveArray.php
https://github.com/stripe/stripe-php/blob/master/lib/Util/CaseInsensitiveArray.php
MIT
public function getIterator() { return new \ArrayIterator($this->toArray()); }
[\ReturnTypeWillChange]
getIterator
php
stripe/stripe-php
lib/Util/Set.php
https://github.com/stripe/stripe-php/blob/master/lib/Util/Set.php
MIT
public static function create($params = null, $options = null) { self::_validateParams($params); $url = static::classUrl(); list($response, $opts) = static::_staticRequest('post', $url, $params, $options); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; }
Creates a feature. @param null|array{expand?: string[], lookup_key: string, metadata?: \Stripe\StripeObject, name: string} $params @param null|array|string $options @return Feature the created resource @throws \Stripe\Exception\ApiErrorException if the request fails
create
php
stripe/stripe-php
lib/Entitlements/Feature.php
https://github.com/stripe/stripe-php/blob/master/lib/Entitlements/Feature.php
MIT
public static function all($params = null, $opts = null) { $url = static::classUrl(); return static::_requestPage($url, \Stripe\Collection::class, $params, $opts); }
Retrieve a list of features. @param null|array{archived?: bool, ending_before?: string, expand?: string[], limit?: int, lookup_key?: string, starting_after?: string} $params @param null|array|string $opts @return \Stripe\Collection<Feature> of ApiResources @throws \Stripe\Exception\ApiErrorException if the request fails
all
php
stripe/stripe-php
lib/Entitlements/Feature.php
https://github.com/stripe/stripe-php/blob/master/lib/Entitlements/Feature.php
MIT
public static function retrieve($id, $opts = null) { $opts = \Stripe\Util\RequestOptions::parse($opts); $instance = new static($id, $opts); $instance->refresh(); return $instance; }
Retrieves a feature. @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key @param null|array|string $opts @return Feature @throws \Stripe\Exception\ApiErrorException if the request fails
retrieve
php
stripe/stripe-php
lib/Entitlements/Feature.php
https://github.com/stripe/stripe-php/blob/master/lib/Entitlements/Feature.php
MIT
public static function update($id, $params = null, $opts = null) { self::_validateParams($params); $url = static::resourceUrl($id); list($response, $opts) = static::_staticRequest('post', $url, $params, $opts); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; }
Update a feature’s metadata or permanently deactivate it. @param string $id the ID of the resource to update @param null|array{active?: bool, expand?: string[], metadata?: null|\Stripe\StripeObject, name?: string} $params @param null|array|string $opts @return Feature the updated resource @throws \Stripe\Exception\ApiErrorException if the request fails
update
php
stripe/stripe-php
lib/Entitlements/Feature.php
https://github.com/stripe/stripe-php/blob/master/lib/Entitlements/Feature.php
MIT
public static function all($params = null, $opts = null) { $url = static::classUrl(); return static::_requestPage($url, \Stripe\Collection::class, $params, $opts); }
Retrieve a list of active entitlements for a customer. @param null|array{customer: string, ending_before?: string, expand?: string[], limit?: int, starting_after?: string} $params @param null|array|string $opts @return \Stripe\Collection<ActiveEntitlement> of ApiResources @throws \Stripe\Exception\ApiErrorException if the request fails
all
php
stripe/stripe-php
lib/Entitlements/ActiveEntitlement.php
https://github.com/stripe/stripe-php/blob/master/lib/Entitlements/ActiveEntitlement.php
MIT
public static function retrieve($id, $opts = null) { $opts = \Stripe\Util\RequestOptions::parse($opts); $instance = new static($id, $opts); $instance->refresh(); return $instance; }
Retrieve an active entitlement. @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key @param null|array|string $opts @return ActiveEntitlement @throws \Stripe\Exception\ApiErrorException if the request fails
retrieve
php
stripe/stripe-php
lib/Entitlements/ActiveEntitlement.php
https://github.com/stripe/stripe-php/blob/master/lib/Entitlements/ActiveEntitlement.php
MIT
public function fetchRelatedObject() { $apiMode = \Stripe\Util\Util::getApiMode($this->related_object->url); list($object, $options) = $this->_request( 'get', $this->related_object->url, [], ['stripe_account' => $this->context], [], $apiMode ); return \Stripe\Util\Util::convertToStripeObject($object, $options, $apiMode); }
Retrieves the related object from the API. Make an API request on every call. @return \Stripe\V2\EventDestination @throws \Stripe\Exception\ApiErrorException if the request fails
fetchRelatedObject
php
stripe/stripe-php
lib/Events/V2CoreEventDestinationPingEvent.php
https://github.com/stripe/stripe-php/blob/master/lib/Events/V2CoreEventDestinationPingEvent.php
MIT
public function fetchRelatedObject() { $apiMode = \Stripe\Util\Util::getApiMode($this->related_object->url); list($object, $options) = $this->_request( 'get', $this->related_object->url, [], ['stripe_account' => $this->context], [], $apiMode ); return \Stripe\Util\Util::convertToStripeObject($object, $options, $apiMode); }
Retrieves the related object from the API. Make an API request on every call. @return \Stripe\Billing\Meter @throws \Stripe\Exception\ApiErrorException if the request fails
fetchRelatedObject
php
stripe/stripe-php
lib/Events/V1BillingMeterErrorReportTriggeredEvent.php
https://github.com/stripe/stripe-php/blob/master/lib/Events/V1BillingMeterErrorReportTriggeredEvent.php
MIT
public static function retrieve($opts = null) { $opts = \Stripe\Util\RequestOptions::parse($opts); $instance = new static(null, $opts); $instance->refresh(); return $instance; }
@param null|array|string $opts the ID of the API resource to retrieve, or an options array containing an `id` key @return static @throws \Stripe\Exception\ApiErrorException if the request fails
retrieve
php
stripe/stripe-php
lib/ApiOperations/SingletonRetrieve.php
https://github.com/stripe/stripe-php/blob/master/lib/ApiOperations/SingletonRetrieve.php
MIT
protected static function _nestedResourceOperation($method, $url, $params = null, $options = null) { self::_validateParams($params); list($response, $opts) = static::_staticRequest($method, $url, $params, $options); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; }
@param 'delete'|'get'|'post' $method @param string $url @param null|array $params @param null|array|string $options @return \Stripe\StripeObject
_nestedResourceOperation
php
stripe/stripe-php
lib/ApiOperations/NestedResource.php
https://github.com/stripe/stripe-php/blob/master/lib/ApiOperations/NestedResource.php
MIT
protected static function _nestedResourceUrl($id, $nestedPath, $nestedId = null) { $url = static::resourceUrl($id) . $nestedPath; if (null !== $nestedId) { $url .= "/{$nestedId}"; } return $url; }
@param string $id @param string $nestedPath @param null|string $nestedId @return string
_nestedResourceUrl
php
stripe/stripe-php
lib/ApiOperations/NestedResource.php
https://github.com/stripe/stripe-php/blob/master/lib/ApiOperations/NestedResource.php
MIT
protected static function _createNestedResource($id, $nestedPath, $params = null, $options = null) { $url = static::_nestedResourceUrl($id, $nestedPath); return self::_nestedResourceOperation('post', $url, $params, $options); }
@param string $id @param string $nestedPath @param null|array $params @param null|array|string $options @return \Stripe\StripeObject @throws \Stripe\Exception\ApiErrorException if the request fails
_createNestedResource
php
stripe/stripe-php
lib/ApiOperations/NestedResource.php
https://github.com/stripe/stripe-php/blob/master/lib/ApiOperations/NestedResource.php
MIT
protected static function _retrieveNestedResource($id, $nestedPath, $nestedId, $params = null, $options = null) { $url = static::_nestedResourceUrl($id, $nestedPath, $nestedId); return self::_nestedResourceOperation('get', $url, $params, $options); }
@param string $id @param string $nestedPath @param null|string $nestedId @param null|array $params @param null|array|string $options @return \Stripe\StripeObject @throws \Stripe\Exception\ApiErrorException if the request fails
_retrieveNestedResource
php
stripe/stripe-php
lib/ApiOperations/NestedResource.php
https://github.com/stripe/stripe-php/blob/master/lib/ApiOperations/NestedResource.php
MIT
protected static function _updateNestedResource($id, $nestedPath, $nestedId, $params = null, $options = null) { $url = static::_nestedResourceUrl($id, $nestedPath, $nestedId); return self::_nestedResourceOperation('post', $url, $params, $options); }
@param string $id @param string $nestedPath @param null|string $nestedId @param null|array $params @param null|array|string $options @return \Stripe\StripeObject @throws \Stripe\Exception\ApiErrorException if the request fails
_updateNestedResource
php
stripe/stripe-php
lib/ApiOperations/NestedResource.php
https://github.com/stripe/stripe-php/blob/master/lib/ApiOperations/NestedResource.php
MIT
protected static function _deleteNestedResource($id, $nestedPath, $nestedId, $params = null, $options = null) { $url = static::_nestedResourceUrl($id, $nestedPath, $nestedId); return self::_nestedResourceOperation('delete', $url, $params, $options); }
@param string $id @param string $nestedPath @param null|string $nestedId @param null|array $params @param null|array|string $options @return \Stripe\StripeObject @throws \Stripe\Exception\ApiErrorException if the request fails
_deleteNestedResource
php
stripe/stripe-php
lib/ApiOperations/NestedResource.php
https://github.com/stripe/stripe-php/blob/master/lib/ApiOperations/NestedResource.php
MIT
protected static function _allNestedResources($id, $nestedPath, $params = null, $options = null) { $url = static::_nestedResourceUrl($id, $nestedPath); return self::_nestedResourceOperation('get', $url, $params, $options); }
@param string $id @param string $nestedPath @param null|array $params @param null|array|string $options @return \Stripe\StripeObject @throws \Stripe\Exception\ApiErrorException if the request fails
_allNestedResources
php
stripe/stripe-php
lib/ApiOperations/NestedResource.php
https://github.com/stripe/stripe-php/blob/master/lib/ApiOperations/NestedResource.php
MIT
public static function all($params = null, $opts = null) { $url = static::classUrl(); return static::_requestPage($url, \Stripe\Collection::class, $params, $opts); }
@param null|array $params @param null|array|string $opts @return \Stripe\Collection of ApiResources @throws \Stripe\Exception\ApiErrorException if the request fails
all
php
stripe/stripe-php
lib/ApiOperations/All.php
https://github.com/stripe/stripe-php/blob/master/lib/ApiOperations/All.php
MIT
public static function retrieve($id, $opts = null) { $opts = \Stripe\Util\RequestOptions::parse($opts); $instance = new static($id, $opts); $instance->refresh(); return $instance; }
@param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key @param null|array|string $opts @return static @throws \Stripe\Exception\ApiErrorException if the request fails
retrieve
php
stripe/stripe-php
lib/ApiOperations/Retrieve.php
https://github.com/stripe/stripe-php/blob/master/lib/ApiOperations/Retrieve.php
MIT
protected static function _validateParams($params = null) { if ($params && !\is_array($params)) { $message = 'You must pass an array as the first argument to Stripe API ' . 'method calls. (HINT: an example call to create a charge ' . "would be: \"Stripe\\Charge::create(['amount' => 100, " . "'currency' => 'usd', 'source' => 'tok_1234'])\")"; throw new \Stripe\Exception\InvalidArgumentException($message); } }
@param null|array|mixed $params The list of parameters to validate @throws \Stripe\Exception\InvalidArgumentException if $params exists and is not an array
_validateParams
php
stripe/stripe-php
lib/ApiOperations/Request.php
https://github.com/stripe/stripe-php/blob/master/lib/ApiOperations/Request.php
MIT
protected function _request($method, $url, $params = [], $options = null, $usage = [], $apiMode = 'v1') { $opts = $this->_opts->merge($options); list($resp, $options) = static::_staticRequest($method, $url, $params, $opts, $usage, $apiMode); $this->setLastResponse($resp); return [$resp->json, $options]; }
@param 'delete'|'get'|'post' $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 @param string[] $usage names of tracked behaviors associated with this request @param 'v1'|'v2' $apiMode @return array tuple containing (the JSON response, $options) @throws \Stripe\Exception\ApiErrorException if the request fails
_request
php
stripe/stripe-php
lib/ApiOperations/Request.php
https://github.com/stripe/stripe-php/blob/master/lib/ApiOperations/Request.php
MIT
protected static function _requestPage($url, $resultClass, $params = null, $options = null, $usage = []) { self::_validateParams($params); list($response, $opts) = static::_staticRequest('get', $url, $params, $options, $usage); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); if (!$obj instanceof $resultClass) { throw new \Stripe\Exception\UnexpectedValueException( 'Expected type ' . $resultClass . ', got "' . \get_class($obj) . '" instead.' ); } $obj->setLastResponse($response); $obj->setFilters($params); return $obj; }
@param string $url URL for the request @param class-string< \Stripe\Collection|\Stripe\SearchResult > $resultClass indicating what type of paginated result is returned @param null|array $params list of parameters for the request @param null|array|string $options @param string[] $usage names of tracked behaviors associated with this request @return \Stripe\Collection|\Stripe\SearchResult @throws \Stripe\Exception\ApiErrorException if the request fails
_requestPage
php
stripe/stripe-php
lib/ApiOperations/Request.php
https://github.com/stripe/stripe-php/blob/master/lib/ApiOperations/Request.php
MIT
protected function _requestStream($method, $url, $readBodyChunk, $params = [], $options = null, $usage = []) { $opts = $this->_opts->merge($options); static::_staticStreamingRequest($method, $url, $readBodyChunk, $params, $opts, $usage); }
@param 'delete'|'get'|'post' $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 @param string[] $usage names of tracked behaviors associated with this request @throws \Stripe\Exception\ApiErrorException if the request fails
_requestStream
php
stripe/stripe-php
lib/ApiOperations/Request.php
https://github.com/stripe/stripe-php/blob/master/lib/ApiOperations/Request.php
MIT
protected static function _staticRequest($method, $url, $params, $options, $usage = [], $apiMode = 'v1') { $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, $apiMode, $usage); $opts->discardNonPersistentHeaders(); return [$response, $opts]; }
@param 'delete'|'get'|'post' $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 @param string[] $usage names of tracked behaviors associated with this request @param 'v1'|'v2' $apiMode @return array tuple containing (the JSON response, $options) @throws \Stripe\Exception\ApiErrorException if the request fails
_staticRequest
php
stripe/stripe-php
lib/ApiOperations/Request.php
https://github.com/stripe/stripe-php/blob/master/lib/ApiOperations/Request.php
MIT
protected static function _staticStreamingRequest($method, $url, $readBodyChunk, $params, $options, $usage = []) { $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); }
@param 'delete'|'get'|'post' $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 @param string[] $usage names of tracked behaviors associated with this request @throws \Stripe\Exception\ApiErrorException if the request fails
_staticStreamingRequest
php
stripe/stripe-php
lib/ApiOperations/Request.php
https://github.com/stripe/stripe-php/blob/master/lib/ApiOperations/Request.php
MIT
public function delete($params = null, $opts = null) { self::_validateParams($params); $url = $this->instanceUrl(); list($response, $opts) = $this->_request('delete', $url, $params, $opts); $this->refreshFrom($response, $opts); return $this; }
@param null|array $params @param null|array|string $opts @return static the deleted resource @throws \Stripe\Exception\ApiErrorException if the request fails
delete
php
stripe/stripe-php
lib/ApiOperations/Delete.php
https://github.com/stripe/stripe-php/blob/master/lib/ApiOperations/Delete.php
MIT
public static function create($params = null, $options = null) { self::_validateParams($params); $url = static::classUrl(); list($response, $opts) = static::_staticRequest('post', $url, $params, $options); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; }
@param null|array $params @param null|array|string $options @return static the created resource @throws \Stripe\Exception\ApiErrorException if the request fails
create
php
stripe/stripe-php
lib/ApiOperations/Create.php
https://github.com/stripe/stripe-php/blob/master/lib/ApiOperations/Create.php
MIT
public static function update($id, $params = null, $opts = null) { self::_validateParams($params); $url = static::resourceUrl($id); list($response, $opts) = static::_staticRequest('post', $url, $params, $opts); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; }
@param string $id the ID of the resource to update @param null|array $params @param null|array|string $opts @return static the updated resource @throws \Stripe\Exception\ApiErrorException if the request fails
update
php
stripe/stripe-php
lib/ApiOperations/Update.php
https://github.com/stripe/stripe-php/blob/master/lib/ApiOperations/Update.php
MIT
public function save($opts = null) { $params = $this->serializeParameters(); if (\count($params) > 0) { $url = $this->instanceUrl(); list($response, $opts) = $this->_request('post', $url, $params, $opts, ['save']); $this->refreshFrom($response, $opts); } return $this; }
@param null|array|string $opts @return static the saved resource @throws \Stripe\Exception\ApiErrorException if the request fails @deprecated The `save` method is deprecated and will be removed in a future major version of the library. Use the static method `update` on the resource instead.
save
php
stripe/stripe-php
lib/ApiOperations/Update.php
https://github.com/stripe/stripe-php/blob/master/lib/ApiOperations/Update.php
MIT
public static function create($params = null, $options = null) { self::_validateParams($params); $url = static::classUrl(); list($response, $opts) = static::_staticRequest('post', $url, $params, $options); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; }
Creates a personalization design object. @param null|array{card_logo?: string, carrier_text?: array{footer_body?: null|string, footer_title?: null|string, header_body?: null|string, header_title?: null|string}, expand?: string[], lookup_key?: string, metadata?: \Stripe\StripeObject, name?: string, physical_bundle: string, preferences?: array{is_default: bool}, transfer_lookup_key?: bool} $params @param null|array|string $options @return PersonalizationDesign the created resource @throws \Stripe\Exception\ApiErrorException if the request fails
create
php
stripe/stripe-php
lib/Issuing/PersonalizationDesign.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/PersonalizationDesign.php
MIT
public static function all($params = null, $opts = null) { $url = static::classUrl(); return static::_requestPage($url, \Stripe\Collection::class, $params, $opts); }
Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first. @param null|array{ending_before?: string, expand?: string[], limit?: int, lookup_keys?: string[], preferences?: array{is_default?: bool, is_platform_default?: bool}, starting_after?: string, status?: string} $params @param null|array|string $opts @return \Stripe\Collection<PersonalizationDesign> of ApiResources @throws \Stripe\Exception\ApiErrorException if the request fails
all
php
stripe/stripe-php
lib/Issuing/PersonalizationDesign.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/PersonalizationDesign.php
MIT
public static function retrieve($id, $opts = null) { $opts = \Stripe\Util\RequestOptions::parse($opts); $instance = new static($id, $opts); $instance->refresh(); return $instance; }
Retrieves a personalization design object. @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key @param null|array|string $opts @return PersonalizationDesign @throws \Stripe\Exception\ApiErrorException if the request fails
retrieve
php
stripe/stripe-php
lib/Issuing/PersonalizationDesign.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/PersonalizationDesign.php
MIT
public static function update($id, $params = null, $opts = null) { self::_validateParams($params); $url = static::resourceUrl($id); list($response, $opts) = static::_staticRequest('post', $url, $params, $opts); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; }
Updates a card personalization object. @param string $id the ID of the resource to update @param null|array{card_logo?: null|string, carrier_text?: null|array{footer_body?: null|string, footer_title?: null|string, header_body?: null|string, header_title?: null|string}, expand?: string[], lookup_key?: null|string, metadata?: \Stripe\StripeObject, name?: null|string, physical_bundle?: string, preferences?: array{is_default: bool}, transfer_lookup_key?: bool} $params @param null|array|string $opts @return PersonalizationDesign the updated resource @throws \Stripe\Exception\ApiErrorException if the request fails
update
php
stripe/stripe-php
lib/Issuing/PersonalizationDesign.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/PersonalizationDesign.php
MIT
public static function all($params = null, $opts = null) { $url = static::classUrl(); return static::_requestPage($url, \Stripe\Collection::class, $params, $opts); }
Lists all Issuing <code>Token</code> objects for a given card. @param null|array{card: string, created?: array|int, ending_before?: string, expand?: string[], limit?: int, starting_after?: string, status?: string} $params @param null|array|string $opts @return \Stripe\Collection<Token> of ApiResources @throws \Stripe\Exception\ApiErrorException if the request fails
all
php
stripe/stripe-php
lib/Issuing/Token.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Token.php
MIT
public static function retrieve($id, $opts = null) { $opts = \Stripe\Util\RequestOptions::parse($opts); $instance = new static($id, $opts); $instance->refresh(); return $instance; }
Retrieves an Issuing <code>Token</code> object. @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key @param null|array|string $opts @return Token @throws \Stripe\Exception\ApiErrorException if the request fails
retrieve
php
stripe/stripe-php
lib/Issuing/Token.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Token.php
MIT
public static function update($id, $params = null, $opts = null) { self::_validateParams($params); $url = static::resourceUrl($id); list($response, $opts) = static::_staticRequest('post', $url, $params, $opts); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; }
Attempts to update the specified Issuing <code>Token</code> object to the status specified. @param string $id the ID of the resource to update @param null|array{expand?: string[], status: string} $params @param null|array|string $opts @return Token the updated resource @throws \Stripe\Exception\ApiErrorException if the request fails
update
php
stripe/stripe-php
lib/Issuing/Token.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Token.php
MIT
public static function create($params = null, $options = null) { self::_validateParams($params); $url = static::classUrl(); list($response, $opts) = static::_staticRequest('post', $url, $params, $options); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; }
Creates a new Issuing <code>Cardholder</code> object that can be issued cards. @param null|array{billing: array{address: array{city: string, country: string, line1: string, line2?: string, postal_code: string, state?: string}}, company?: array{tax_id?: string}, email?: string, expand?: string[], individual?: array{card_issuing?: array{user_terms_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}, dob?: array{day: int, month: int, year: int}, first_name?: string, last_name?: string, verification?: array{document?: array{back?: string, front?: string}}}, metadata?: \Stripe\StripeObject, name: string, phone_number?: string, preferred_locales?: string[], spending_controls?: array{allowed_categories?: string[], allowed_merchant_countries?: string[], blocked_categories?: string[], blocked_merchant_countries?: string[], spending_limits?: array{amount: int, categories?: string[], interval: string}[], spending_limits_currency?: string}, status?: string, type?: string} $params @param null|array|string $options @return Cardholder the created resource @throws \Stripe\Exception\ApiErrorException if the request fails
create
php
stripe/stripe-php
lib/Issuing/Cardholder.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Cardholder.php
MIT
public static function all($params = null, $opts = null) { $url = static::classUrl(); return static::_requestPage($url, \Stripe\Collection::class, $params, $opts); }
Returns a list of Issuing <code>Cardholder</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first. @param null|array{created?: array|int, email?: string, ending_before?: string, expand?: string[], limit?: int, phone_number?: string, starting_after?: string, status?: string, type?: string} $params @param null|array|string $opts @return \Stripe\Collection<Cardholder> of ApiResources @throws \Stripe\Exception\ApiErrorException if the request fails
all
php
stripe/stripe-php
lib/Issuing/Cardholder.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Cardholder.php
MIT
public static function retrieve($id, $opts = null) { $opts = \Stripe\Util\RequestOptions::parse($opts); $instance = new static($id, $opts); $instance->refresh(); return $instance; }
Retrieves an Issuing <code>Cardholder</code> object. @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key @param null|array|string $opts @return Cardholder @throws \Stripe\Exception\ApiErrorException if the request fails
retrieve
php
stripe/stripe-php
lib/Issuing/Cardholder.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Cardholder.php
MIT
public static function update($id, $params = null, $opts = null) { self::_validateParams($params); $url = static::resourceUrl($id); list($response, $opts) = static::_staticRequest('post', $url, $params, $opts); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; }
Updates the specified Issuing <code>Cardholder</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. @param string $id the ID of the resource to update @param null|array{billing?: array{address: array{city: string, country: string, line1: string, line2?: string, postal_code: string, state?: string}}, company?: array{tax_id?: string}, email?: string, expand?: string[], individual?: array{card_issuing?: array{user_terms_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}, dob?: array{day: int, month: int, year: int}, first_name?: string, last_name?: string, verification?: array{document?: array{back?: string, front?: string}}}, metadata?: \Stripe\StripeObject, phone_number?: string, preferred_locales?: string[], spending_controls?: array{allowed_categories?: string[], allowed_merchant_countries?: string[], blocked_categories?: string[], blocked_merchant_countries?: string[], spending_limits?: array{amount: int, categories?: string[], interval: string}[], spending_limits_currency?: string}, status?: string} $params @param null|array|string $opts @return Cardholder the updated resource @throws \Stripe\Exception\ApiErrorException if the request fails
update
php
stripe/stripe-php
lib/Issuing/Cardholder.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Cardholder.php
MIT
public static function create($params = null, $options = null) { self::_validateParams($params); $url = static::classUrl(); list($response, $opts) = static::_staticRequest('post', $url, $params, $options); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; }
Creates an Issuing <code>Dispute</code> object. Individual pieces of evidence within the <code>evidence</code> object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to <a href="/docs/issuing/purchases/disputes#dispute-reasons-and-evidence">Dispute reasons and evidence</a> for more details about evidence requirements. @param null|array{amount?: int, evidence?: array{canceled?: null|array{additional_documentation?: null|string, canceled_at?: null|int, cancellation_policy_provided?: null|bool, cancellation_reason?: null|string, expected_at?: null|int, explanation?: null|string, product_description?: null|string, product_type?: null|string, return_status?: null|string, returned_at?: null|int}, duplicate?: null|array{additional_documentation?: null|string, card_statement?: null|string, cash_receipt?: null|string, check_image?: null|string, explanation?: null|string, original_transaction?: string}, fraudulent?: null|array{additional_documentation?: null|string, explanation?: null|string}, merchandise_not_as_described?: null|array{additional_documentation?: null|string, explanation?: null|string, received_at?: null|int, return_description?: null|string, return_status?: null|string, returned_at?: null|int}, no_valid_authorization?: null|array{additional_documentation?: null|string, explanation?: null|string}, not_received?: null|array{additional_documentation?: null|string, expected_at?: null|int, explanation?: null|string, product_description?: null|string, product_type?: null|string}, other?: null|array{additional_documentation?: null|string, explanation?: null|string, product_description?: null|string, product_type?: null|string}, reason?: string, service_not_as_described?: null|array{additional_documentation?: null|string, canceled_at?: null|int, cancellation_reason?: null|string, explanation?: null|string, received_at?: null|int}}, expand?: string[], metadata?: \Stripe\StripeObject, transaction?: string, treasury?: array{received_debit: string}} $params @param null|array|string $options @return Dispute the created resource @throws \Stripe\Exception\ApiErrorException if the request fails
create
php
stripe/stripe-php
lib/Issuing/Dispute.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Dispute.php
MIT
public static function all($params = null, $opts = null) { $url = static::classUrl(); return static::_requestPage($url, \Stripe\Collection::class, $params, $opts); }
Returns a list of Issuing <code>Dispute</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first. @param null|array{created?: array|int, ending_before?: string, expand?: string[], limit?: int, starting_after?: string, status?: string, transaction?: string} $params @param null|array|string $opts @return \Stripe\Collection<Dispute> of ApiResources @throws \Stripe\Exception\ApiErrorException if the request fails
all
php
stripe/stripe-php
lib/Issuing/Dispute.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Dispute.php
MIT
public static function retrieve($id, $opts = null) { $opts = \Stripe\Util\RequestOptions::parse($opts); $instance = new static($id, $opts); $instance->refresh(); return $instance; }
Retrieves an Issuing <code>Dispute</code> object. @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key @param null|array|string $opts @return Dispute @throws \Stripe\Exception\ApiErrorException if the request fails
retrieve
php
stripe/stripe-php
lib/Issuing/Dispute.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Dispute.php
MIT
public static function update($id, $params = null, $opts = null) { self::_validateParams($params); $url = static::resourceUrl($id); list($response, $opts) = static::_staticRequest('post', $url, $params, $opts); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; }
Updates the specified Issuing <code>Dispute</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the <code>evidence</code> object can be unset by passing in an empty string. @param string $id the ID of the resource to update @param null|array{amount?: int, evidence?: array{canceled?: null|array{additional_documentation?: null|string, canceled_at?: null|int, cancellation_policy_provided?: null|bool, cancellation_reason?: null|string, expected_at?: null|int, explanation?: null|string, product_description?: null|string, product_type?: null|string, return_status?: null|string, returned_at?: null|int}, duplicate?: null|array{additional_documentation?: null|string, card_statement?: null|string, cash_receipt?: null|string, check_image?: null|string, explanation?: null|string, original_transaction?: string}, fraudulent?: null|array{additional_documentation?: null|string, explanation?: null|string}, merchandise_not_as_described?: null|array{additional_documentation?: null|string, explanation?: null|string, received_at?: null|int, return_description?: null|string, return_status?: null|string, returned_at?: null|int}, no_valid_authorization?: null|array{additional_documentation?: null|string, explanation?: null|string}, not_received?: null|array{additional_documentation?: null|string, expected_at?: null|int, explanation?: null|string, product_description?: null|string, product_type?: null|string}, other?: null|array{additional_documentation?: null|string, explanation?: null|string, product_description?: null|string, product_type?: null|string}, reason?: string, service_not_as_described?: null|array{additional_documentation?: null|string, canceled_at?: null|int, cancellation_reason?: null|string, explanation?: null|string, received_at?: null|int}}, expand?: string[], metadata?: null|\Stripe\StripeObject} $params @param null|array|string $opts @return Dispute the updated resource @throws \Stripe\Exception\ApiErrorException if the request fails
update
php
stripe/stripe-php
lib/Issuing/Dispute.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Dispute.php
MIT
public function submit($params = null, $opts = null) { $url = $this->instanceUrl() . '/submit'; list($response, $opts) = $this->_request('post', $url, $params, $opts); $this->refreshFrom($response, $opts); return $this; }
@param null|array $params @param null|array|string $opts @return Dispute the submited dispute @throws \Stripe\Exception\ApiErrorException if the request fails
submit
php
stripe/stripe-php
lib/Issuing/Dispute.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Dispute.php
MIT
public static function all($params = null, $opts = null) { $url = static::classUrl(); return static::_requestPage($url, \Stripe\Collection::class, $params, $opts); }
Returns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first. @param null|array{ending_before?: string, expand?: string[], limit?: int, starting_after?: string, status?: string, type?: string} $params @param null|array|string $opts @return \Stripe\Collection<PhysicalBundle> of ApiResources @throws \Stripe\Exception\ApiErrorException if the request fails
all
php
stripe/stripe-php
lib/Issuing/PhysicalBundle.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/PhysicalBundle.php
MIT
public static function retrieve($id, $opts = null) { $opts = \Stripe\Util\RequestOptions::parse($opts); $instance = new static($id, $opts); $instance->refresh(); return $instance; }
Retrieves a physical bundle object. @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key @param null|array|string $opts @return PhysicalBundle @throws \Stripe\Exception\ApiErrorException if the request fails
retrieve
php
stripe/stripe-php
lib/Issuing/PhysicalBundle.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/PhysicalBundle.php
MIT
public static function all($params = null, $opts = null) { $url = static::classUrl(); return static::_requestPage($url, \Stripe\Collection::class, $params, $opts); }
Returns a list of Issuing <code>Transaction</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first. @param null|array{card?: string, cardholder?: string, created?: array|int, ending_before?: string, expand?: string[], limit?: int, starting_after?: string, type?: string} $params @param null|array|string $opts @return \Stripe\Collection<Transaction> of ApiResources @throws \Stripe\Exception\ApiErrorException if the request fails
all
php
stripe/stripe-php
lib/Issuing/Transaction.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Transaction.php
MIT
public static function retrieve($id, $opts = null) { $opts = \Stripe\Util\RequestOptions::parse($opts); $instance = new static($id, $opts); $instance->refresh(); return $instance; }
Retrieves an Issuing <code>Transaction</code> object. @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key @param null|array|string $opts @return Transaction @throws \Stripe\Exception\ApiErrorException if the request fails
retrieve
php
stripe/stripe-php
lib/Issuing/Transaction.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Transaction.php
MIT
public static function update($id, $params = null, $opts = null) { self::_validateParams($params); $url = static::resourceUrl($id); list($response, $opts) = static::_staticRequest('post', $url, $params, $opts); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; }
Updates the specified Issuing <code>Transaction</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. @param string $id the ID of the resource to update @param null|array{expand?: string[], metadata?: null|\Stripe\StripeObject} $params @param null|array|string $opts @return Transaction the updated resource @throws \Stripe\Exception\ApiErrorException if the request fails
update
php
stripe/stripe-php
lib/Issuing/Transaction.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Transaction.php
MIT
public static function create($params = null, $options = null) { self::_validateParams($params); $url = static::classUrl(); list($response, $opts) = static::_staticRequest('post', $url, $params, $options); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; }
Creates an Issuing <code>Card</code> object. @param null|array{cardholder?: string, currency: string, expand?: string[], financial_account?: string, metadata?: \Stripe\StripeObject, personalization_design?: string, pin?: array{encrypted_number?: string}, replacement_for?: string, replacement_reason?: string, second_line?: null|string, shipping?: array{address: array{city: string, country: string, line1: string, line2?: string, postal_code: string, state?: string}, address_validation?: array{mode: string}, customs?: array{eori_number?: string}, name: string, phone_number?: string, require_signature?: bool, service?: string, type?: string}, spending_controls?: array{allowed_categories?: string[], allowed_merchant_countries?: string[], blocked_categories?: string[], blocked_merchant_countries?: string[], spending_limits?: array{amount: int, categories?: string[], interval: string}[]}, status?: string, type: string} $params @param null|array|string $options @return Card the created resource @throws \Stripe\Exception\ApiErrorException if the request fails
create
php
stripe/stripe-php
lib/Issuing/Card.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Card.php
MIT
public static function all($params = null, $opts = null) { $url = static::classUrl(); return static::_requestPage($url, \Stripe\Collection::class, $params, $opts); }
Returns a list of Issuing <code>Card</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first. @param null|array{cardholder?: string, created?: array|int, ending_before?: string, exp_month?: int, exp_year?: int, expand?: string[], last4?: string, limit?: int, personalization_design?: string, starting_after?: string, status?: string, type?: string} $params @param null|array|string $opts @return \Stripe\Collection<Card> of ApiResources @throws \Stripe\Exception\ApiErrorException if the request fails
all
php
stripe/stripe-php
lib/Issuing/Card.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Card.php
MIT
public static function retrieve($id, $opts = null) { $opts = \Stripe\Util\RequestOptions::parse($opts); $instance = new static($id, $opts); $instance->refresh(); return $instance; }
Retrieves an Issuing <code>Card</code> object. @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key @param null|array|string $opts @return Card @throws \Stripe\Exception\ApiErrorException if the request fails
retrieve
php
stripe/stripe-php
lib/Issuing/Card.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Card.php
MIT
public static function update($id, $params = null, $opts = null) { self::_validateParams($params); $url = static::resourceUrl($id); list($response, $opts) = static::_staticRequest('post', $url, $params, $opts); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; }
Updates the specified Issuing <code>Card</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. @param string $id the ID of the resource to update @param null|array{cancellation_reason?: string, expand?: string[], metadata?: null|\Stripe\StripeObject, personalization_design?: string, pin?: array{encrypted_number?: string}, shipping?: array{address: array{city: string, country: string, line1: string, line2?: string, postal_code: string, state?: string}, address_validation?: array{mode: string}, customs?: array{eori_number?: string}, name: string, phone_number?: string, require_signature?: bool, service?: string, type?: string}, spending_controls?: array{allowed_categories?: string[], allowed_merchant_countries?: string[], blocked_categories?: string[], blocked_merchant_countries?: string[], spending_limits?: array{amount: int, categories?: string[], interval: string}[]}, status?: string} $params @param null|array|string $opts @return Card the updated resource @throws \Stripe\Exception\ApiErrorException if the request fails
update
php
stripe/stripe-php
lib/Issuing/Card.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Card.php
MIT
public static function all($params = null, $opts = null) { $url = static::classUrl(); return static::_requestPage($url, \Stripe\Collection::class, $params, $opts); }
Returns a list of Issuing <code>Authorization</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first. @param null|array{card?: string, cardholder?: string, created?: array|int, ending_before?: string, expand?: string[], limit?: int, starting_after?: string, status?: string} $params @param null|array|string $opts @return \Stripe\Collection<Authorization> of ApiResources @throws \Stripe\Exception\ApiErrorException if the request fails
all
php
stripe/stripe-php
lib/Issuing/Authorization.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Authorization.php
MIT
public static function retrieve($id, $opts = null) { $opts = \Stripe\Util\RequestOptions::parse($opts); $instance = new static($id, $opts); $instance->refresh(); return $instance; }
Retrieves an Issuing <code>Authorization</code> object. @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key @param null|array|string $opts @return Authorization @throws \Stripe\Exception\ApiErrorException if the request fails
retrieve
php
stripe/stripe-php
lib/Issuing/Authorization.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Authorization.php
MIT
public static function update($id, $params = null, $opts = null) { self::_validateParams($params); $url = static::resourceUrl($id); list($response, $opts) = static::_staticRequest('post', $url, $params, $opts); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; }
Updates the specified Issuing <code>Authorization</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. @param string $id the ID of the resource to update @param null|array{expand?: string[], metadata?: null|\Stripe\StripeObject} $params @param null|array|string $opts @return Authorization the updated resource @throws \Stripe\Exception\ApiErrorException if the request fails
update
php
stripe/stripe-php
lib/Issuing/Authorization.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Authorization.php
MIT
public function approve($params = null, $opts = null) { $url = $this->instanceUrl() . '/approve'; list($response, $opts) = $this->_request('post', $url, $params, $opts); $this->refreshFrom($response, $opts); return $this; }
@param null|array $params @param null|array|string $opts @return Authorization the approved authorization @throws \Stripe\Exception\ApiErrorException if the request fails
approve
php
stripe/stripe-php
lib/Issuing/Authorization.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Authorization.php
MIT
public function decline($params = null, $opts = null) { $url = $this->instanceUrl() . '/decline'; list($response, $opts) = $this->_request('post', $url, $params, $opts); $this->refreshFrom($response, $opts); return $this; }
@param null|array $params @param null|array|string $opts @return Authorization the declined authorization @throws \Stripe\Exception\ApiErrorException if the request fails
decline
php
stripe/stripe-php
lib/Issuing/Authorization.php
https://github.com/stripe/stripe-php/blob/master/lib/Issuing/Authorization.php
MIT
public static function all($params = null, $opts = null) { $url = static::classUrl(); return static::_requestPage($url, \Stripe\Collection::class, $params, $opts); }
Returns a list of scheduled query runs. @param null|array{ending_before?: string, expand?: string[], limit?: int, starting_after?: string} $params @param null|array|string $opts @return \Stripe\Collection<ScheduledQueryRun> of ApiResources @throws \Stripe\Exception\ApiErrorException if the request fails
all
php
stripe/stripe-php
lib/Sigma/ScheduledQueryRun.php
https://github.com/stripe/stripe-php/blob/master/lib/Sigma/ScheduledQueryRun.php
MIT
public static function retrieve($id, $opts = null) { $opts = \Stripe\Util\RequestOptions::parse($opts); $instance = new static($id, $opts); $instance->refresh(); return $instance; }
Retrieves the details of an scheduled query run. @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key @param null|array|string $opts @return ScheduledQueryRun @throws \Stripe\Exception\ApiErrorException if the request fails
retrieve
php
stripe/stripe-php
lib/Sigma/ScheduledQueryRun.php
https://github.com/stripe/stripe-php/blob/master/lib/Sigma/ScheduledQueryRun.php
MIT
public static function create($params = null, $options = null) { self::_validateParams($params); $url = static::classUrl(); list($response, $opts) = static::_staticRequest('post', $url, $params, $options); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; }
Creates a VerificationSession object. After the VerificationSession is created, display a verification modal using the session <code>client_secret</code> or send your users to the session’s <code>url</code>. If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode. Related guide: <a href="/docs/identity/verify-identity-documents">Verify your users’ identity documents</a> @param null|array{client_reference_id?: string, expand?: string[], metadata?: \Stripe\StripeObject, options?: array{document?: null|array{allowed_types?: string[], require_id_number?: bool, require_live_capture?: bool, require_matching_selfie?: bool}}, provided_details?: array{email?: string, phone?: string}, related_customer?: string, return_url?: string, type?: string, verification_flow?: string} $params @param null|array|string $options @return VerificationSession the created resource @throws \Stripe\Exception\ApiErrorException if the request fails
create
php
stripe/stripe-php
lib/Identity/VerificationSession.php
https://github.com/stripe/stripe-php/blob/master/lib/Identity/VerificationSession.php
MIT
public static function all($params = null, $opts = null) { $url = static::classUrl(); return static::_requestPage($url, \Stripe\Collection::class, $params, $opts); }
Returns a list of VerificationSessions. @param null|array{client_reference_id?: string, created?: array|int, ending_before?: string, expand?: string[], limit?: int, related_customer?: string, starting_after?: string, status?: string} $params @param null|array|string $opts @return \Stripe\Collection<VerificationSession> of ApiResources @throws \Stripe\Exception\ApiErrorException if the request fails
all
php
stripe/stripe-php
lib/Identity/VerificationSession.php
https://github.com/stripe/stripe-php/blob/master/lib/Identity/VerificationSession.php
MIT
public static function retrieve($id, $opts = null) { $opts = \Stripe\Util\RequestOptions::parse($opts); $instance = new static($id, $opts); $instance->refresh(); return $instance; }
Retrieves the details of a VerificationSession that was previously created. When the session status is <code>requires_input</code>, you can use this method to retrieve a valid <code>client_secret</code> or <code>url</code> to allow re-submission. @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key @param null|array|string $opts @return VerificationSession @throws \Stripe\Exception\ApiErrorException if the request fails
retrieve
php
stripe/stripe-php
lib/Identity/VerificationSession.php
https://github.com/stripe/stripe-php/blob/master/lib/Identity/VerificationSession.php
MIT
public static function update($id, $params = null, $opts = null) { self::_validateParams($params); $url = static::resourceUrl($id); list($response, $opts) = static::_staticRequest('post', $url, $params, $opts); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; }
Updates a VerificationSession object. When the session status is <code>requires_input</code>, you can use this method to update the verification check and options. @param string $id the ID of the resource to update @param null|array{expand?: string[], metadata?: \Stripe\StripeObject, options?: array{document?: null|array{allowed_types?: string[], require_id_number?: bool, require_live_capture?: bool, require_matching_selfie?: bool}}, provided_details?: array{email?: string, phone?: string}, type?: string} $params @param null|array|string $opts @return VerificationSession the updated resource @throws \Stripe\Exception\ApiErrorException if the request fails
update
php
stripe/stripe-php
lib/Identity/VerificationSession.php
https://github.com/stripe/stripe-php/blob/master/lib/Identity/VerificationSession.php
MIT
public function cancel($params = null, $opts = null) { $url = $this->instanceUrl() . '/cancel'; list($response, $opts) = $this->_request('post', $url, $params, $opts); $this->refreshFrom($response, $opts); return $this; }
@param null|array $params @param null|array|string $opts @return VerificationSession the canceled verification session @throws \Stripe\Exception\ApiErrorException if the request fails
cancel
php
stripe/stripe-php
lib/Identity/VerificationSession.php
https://github.com/stripe/stripe-php/blob/master/lib/Identity/VerificationSession.php
MIT
public function redact($params = null, $opts = null) { $url = $this->instanceUrl() . '/redact'; list($response, $opts) = $this->_request('post', $url, $params, $opts); $this->refreshFrom($response, $opts); return $this; }
@param null|array $params @param null|array|string $opts @return VerificationSession the redacted verification session @throws \Stripe\Exception\ApiErrorException if the request fails
redact
php
stripe/stripe-php
lib/Identity/VerificationSession.php
https://github.com/stripe/stripe-php/blob/master/lib/Identity/VerificationSession.php
MIT
public static function all($params = null, $opts = null) { $url = static::classUrl(); return static::_requestPage($url, \Stripe\Collection::class, $params, $opts); }
List all verification reports. @param null|array{client_reference_id?: string, created?: array|int, ending_before?: string, expand?: string[], limit?: int, starting_after?: string, type?: string, verification_session?: string} $params @param null|array|string $opts @return \Stripe\Collection<VerificationReport> of ApiResources @throws \Stripe\Exception\ApiErrorException if the request fails
all
php
stripe/stripe-php
lib/Identity/VerificationReport.php
https://github.com/stripe/stripe-php/blob/master/lib/Identity/VerificationReport.php
MIT
public static function retrieve($id, $opts = null) { $opts = \Stripe\Util\RequestOptions::parse($opts); $instance = new static($id, $opts); $instance->refresh(); return $instance; }
Retrieves an existing VerificationReport. @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key @param null|array|string $opts @return VerificationReport @throws \Stripe\Exception\ApiErrorException if the request fails
retrieve
php
stripe/stripe-php
lib/Identity/VerificationReport.php
https://github.com/stripe/stripe-php/blob/master/lib/Identity/VerificationReport.php
MIT
public static function create($params = null, $options = null) { self::_validateParams($params); $url = static::classUrl(); list($response, $opts) = static::_staticRequest('post', $url, $params, $options); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; }
To launch the Financial Connections authorization flow, create a <code>Session</code>. The session’s <code>client_secret</code> can be used to launch the flow using Stripe.js. @param null|array{account_holder: array{account?: string, customer?: string, type: string}, expand?: string[], filters?: array{account_subcategories?: string[], countries?: string[]}, permissions: string[], prefetch?: string[], return_url?: string} $params @param null|array|string $options @return Session the created resource @throws \Stripe\Exception\ApiErrorException if the request fails
create
php
stripe/stripe-php
lib/FinancialConnections/Session.php
https://github.com/stripe/stripe-php/blob/master/lib/FinancialConnections/Session.php
MIT
public static function retrieve($id, $opts = null) { $opts = \Stripe\Util\RequestOptions::parse($opts); $instance = new static($id, $opts); $instance->refresh(); return $instance; }
Retrieves the details of a Financial Connections <code>Session</code>. @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key @param null|array|string $opts @return Session @throws \Stripe\Exception\ApiErrorException if the request fails
retrieve
php
stripe/stripe-php
lib/FinancialConnections/Session.php
https://github.com/stripe/stripe-php/blob/master/lib/FinancialConnections/Session.php
MIT
public static function all($params = null, $opts = null) { $url = static::classUrl(); return static::_requestPage($url, \Stripe\Collection::class, $params, $opts); }
Returns a list of Financial Connections <code>Account</code> objects. @param null|array{account_holder?: array{account?: string, customer?: string}, ending_before?: string, expand?: string[], limit?: int, session?: string, starting_after?: string} $params @param null|array|string $opts @return \Stripe\Collection<Account> of ApiResources @throws \Stripe\Exception\ApiErrorException if the request fails
all
php
stripe/stripe-php
lib/FinancialConnections/Account.php
https://github.com/stripe/stripe-php/blob/master/lib/FinancialConnections/Account.php
MIT
public static function retrieve($id, $opts = null) { $opts = \Stripe\Util\RequestOptions::parse($opts); $instance = new static($id, $opts); $instance->refresh(); return $instance; }
Retrieves the details of an Financial Connections <code>Account</code>. @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key @param null|array|string $opts @return Account @throws \Stripe\Exception\ApiErrorException if the request fails
retrieve
php
stripe/stripe-php
lib/FinancialConnections/Account.php
https://github.com/stripe/stripe-php/blob/master/lib/FinancialConnections/Account.php
MIT
public function disconnect($params = null, $opts = null) { $url = $this->instanceUrl() . '/disconnect'; list($response, $opts) = $this->_request('post', $url, $params, $opts); $this->refreshFrom($response, $opts); return $this; }
@param null|array $params @param null|array|string $opts @return Account the disconnected account @throws \Stripe\Exception\ApiErrorException if the request fails
disconnect
php
stripe/stripe-php
lib/FinancialConnections/Account.php
https://github.com/stripe/stripe-php/blob/master/lib/FinancialConnections/Account.php
MIT
public static function allOwners($id, $params = null, $opts = null) { $url = static::resourceUrl($id) . '/owners'; list($response, $opts) = static::_staticRequest('get', $url, $params, $opts); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; }
@param string $id @param null|array $params @param null|array|string $opts @return \Stripe\Collection<AccountOwner> list of account owners @throws \Stripe\Exception\ApiErrorException if the request fails
allOwners
php
stripe/stripe-php
lib/FinancialConnections/Account.php
https://github.com/stripe/stripe-php/blob/master/lib/FinancialConnections/Account.php
MIT
public function refreshAccount($params = null, $opts = null) { $url = $this->instanceUrl() . '/refresh'; list($response, $opts) = $this->_request('post', $url, $params, $opts); $this->refreshFrom($response, $opts); return $this; }
@param null|array $params @param null|array|string $opts @return Account the refreshed account @throws \Stripe\Exception\ApiErrorException if the request fails
refreshAccount
php
stripe/stripe-php
lib/FinancialConnections/Account.php
https://github.com/stripe/stripe-php/blob/master/lib/FinancialConnections/Account.php
MIT
public function subscribe($params = null, $opts = null) { $url = $this->instanceUrl() . '/subscribe'; list($response, $opts) = $this->_request('post', $url, $params, $opts); $this->refreshFrom($response, $opts); return $this; }
@param null|array $params @param null|array|string $opts @return Account the subscribed account @throws \Stripe\Exception\ApiErrorException if the request fails
subscribe
php
stripe/stripe-php
lib/FinancialConnections/Account.php
https://github.com/stripe/stripe-php/blob/master/lib/FinancialConnections/Account.php
MIT
public function unsubscribe($params = null, $opts = null) { $url = $this->instanceUrl() . '/unsubscribe'; list($response, $opts) = $this->_request('post', $url, $params, $opts); $this->refreshFrom($response, $opts); return $this; }
@param null|array $params @param null|array|string $opts @return Account the unsubscribed account @throws \Stripe\Exception\ApiErrorException if the request fails
unsubscribe
php
stripe/stripe-php
lib/FinancialConnections/Account.php
https://github.com/stripe/stripe-php/blob/master/lib/FinancialConnections/Account.php
MIT
public static function all($params = null, $opts = null) { $url = static::classUrl(); return static::_requestPage($url, \Stripe\Collection::class, $params, $opts); }
Returns a list of Financial Connections <code>Transaction</code> objects. @param null|array{account: string, ending_before?: string, expand?: string[], limit?: int, starting_after?: string, transacted_at?: array|int, transaction_refresh?: array{after: string}} $params @param null|array|string $opts @return \Stripe\Collection<Transaction> of ApiResources @throws \Stripe\Exception\ApiErrorException if the request fails
all
php
stripe/stripe-php
lib/FinancialConnections/Transaction.php
https://github.com/stripe/stripe-php/blob/master/lib/FinancialConnections/Transaction.php
MIT
public static function retrieve($id, $opts = null) { $opts = \Stripe\Util\RequestOptions::parse($opts); $instance = new static($id, $opts); $instance->refresh(); return $instance; }
Retrieves the details of a Financial Connections <code>Transaction</code>. @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key @param null|array|string $opts @return Transaction @throws \Stripe\Exception\ApiErrorException if the request fails
retrieve
php
stripe/stripe-php
lib/FinancialConnections/Transaction.php
https://github.com/stripe/stripe-php/blob/master/lib/FinancialConnections/Transaction.php
MIT
public static function factory( $message, $httpStatus = null, $httpBody = null, $jsonBody = null, $httpHeaders = null, $stripeCode = null ) { $instance = new static($message); $instance->setHttpStatus($httpStatus); $instance->setHttpBody($httpBody); $instance->setJsonBody($jsonBody); $instance->setHttpHeaders($httpHeaders); $instance->setStripeCode($stripeCode); $instance->setRequestId(null); if ($httpHeaders && isset($httpHeaders['Request-Id'])) { $instance->setRequestId($httpHeaders['Request-Id']); } $instance->setError($instance->constructErrorObject()); return $instance; }
Creates a new API error exception. @param string $message the exception message @param null|int $httpStatus the HTTP status code @param null|string $httpBody the HTTP body as a string @param null|array $jsonBody the JSON deserialized body @param null|array|\Stripe\Util\CaseInsensitiveArray $httpHeaders the HTTP headers array @param null|string $stripeCode the Stripe error code @return static
factory
php
stripe/stripe-php
lib/Exception/ApiErrorException.php
https://github.com/stripe/stripe-php/blob/master/lib/Exception/ApiErrorException.php
MIT
public function getError() { return $this->error; }
Gets the Stripe error object. @return null|\Stripe\ErrorObject
getError
php
stripe/stripe-php
lib/Exception/ApiErrorException.php
https://github.com/stripe/stripe-php/blob/master/lib/Exception/ApiErrorException.php
MIT