| 1 |
<?php |
| 2 |
|
| 3 |
// File generated from our OpenAPI spec |
| 4 |
|
| 5 |
namespace Stripe; |
| 6 |
|
| 7 |
/** |
| 8 |
* This is an object representing a capability for a Stripe account. |
| 9 |
* |
| 10 |
* Related guide: <a |
| 11 |
* href="https://stripe.com/docs/connect/account-capabilities">Account |
| 12 |
* capabilities</a>. |
| 13 |
* |
| 14 |
* @property string $id The identifier for the capability. |
| 15 |
* @property string $object String representing the object's type. Objects of the same type share the same value. |
| 16 |
* @property string|\Stripe\Account $account The account for which the capability enables functionality. |
| 17 |
* @property \Stripe\StripeObject $future_requirements |
| 18 |
* @property bool $requested Whether the capability has been requested. |
| 19 |
* @property null|int $requested_at Time at which the capability was requested. Measured in seconds since the Unix epoch. |
| 20 |
* @property \Stripe\StripeObject $requirements |
| 21 |
* @property string $status The status of the capability. Can be <code>active</code>, <code>inactive</code>, <code>pending</code>, or <code>unrequested</code>. |
| 22 |
*/ |
| 23 |
class Capability extends ApiResource |
| 24 |
{ |
| 25 |
const OBJECT_NAME = 'capability'; |
| 26 |
|
| 27 |
use ApiOperations\Update; |
| 28 |
|
| 29 |
const STATUS_ACTIVE = 'active'; |
| 30 |
const STATUS_INACTIVE = 'inactive'; |
| 31 |
const STATUS_PENDING = 'pending'; |
| 32 |
const STATUS_UNREQUESTED = 'unrequested'; |
| 33 |
|
| 34 |
/** |
| 35 |
* @return string the API URL for this Stripe account reversal |
| 36 |
*/ |
| 37 |
public function instanceUrl() |
| 38 |
{ |
| 39 |
$id = $this['id']; |
| 40 |
$account = $this['account']; |
| 41 |
if (!$id) { |
| 42 |
throw new Exception\UnexpectedValueException( |
| 43 |
'Could not determine which URL to request: ' . |
| 44 |
"class instance has invalid ID: {$id}", |
| 45 |
null |
| 46 |
); |
| 47 |
} |
| 48 |
$id = Util\Util::utf8($id); |
| 49 |
$account = Util\Util::utf8($account); |
| 50 |
|
| 51 |
$base = Account::classUrl(); |
| 52 |
$accountExtn = \urlencode($account); |
| 53 |
$extn = \urlencode($id); |
| 54 |
|
| 55 |
return "{$base}/{$accountExtn}/capabilities/{$extn}"; |
| 56 |
} |
| 57 |
|
| 58 |
/** |
| 59 |
* @param array|string $_id |
| 60 |
* @param null|array|string $_opts |
| 61 |
* |
| 62 |
* @throws \Stripe\Exception\BadMethodCallException |
| 63 |
*/ |
| 64 |
public static function retrieve($_id, $_opts = null) |
| 65 |
{ |
| 66 |
$msg = 'Capabilities cannot be retrieved without an account ID. ' . |
| 67 |
'Retrieve a capability using `Account::retrieveCapability(' . |
| 68 |
"'account_id', 'capability_id')`."; |
| 69 |
|
| 70 |
throw new Exception\BadMethodCallException($msg); |
| 71 |
} |
| 72 |
|
| 73 |
/** |
| 74 |
* @param string $_id |
| 75 |
* @param null|array $_params |
| 76 |
* @param null|array|string $_options |
| 77 |
* |
| 78 |
* @throws \Stripe\Exception\BadMethodCallException |
| 79 |
*/ |
| 80 |
public static function update($_id, $_params = null, $_options = null) |
| 81 |
{ |
| 82 |
$msg = 'Capabilities cannot be updated without an account ID. ' . |
| 83 |
'Update a capability using `Account::updateCapability(' . |
| 84 |
"'account_id', 'capability_id', \$updateParams)`."; |
| 85 |
|
| 86 |
throw new Exception\BadMethodCallException($msg); |
| 87 |
} |
| 88 |
} |
| 89 |
|
