ApiOperations
2 years ago
BillingPortal
2 years ago
Checkout
2 years ago
Exception
4 years ago
FinancialConnections
2 years ago
HttpClient
2 years ago
Identity
2 years ago
Issuing
2 years ago
Radar
2 years ago
Reporting
4 years ago
Service
2 years ago
Sigma
4 years ago
Terminal
2 years ago
TestHelpers
2 years ago
Util
2 years ago
Account.php
2 years ago
AccountLink.php
4 years ago
AlipayAccount.php
4 years ago
ApiRequestor.php
2 years ago
ApiResource.php
2 years ago
ApiResponse.php
4 years ago
ApplePayDomain.php
4 years ago
ApplicationFee.php
2 years ago
ApplicationFeeRefund.php
4 years ago
Balance.php
4 years ago
BalanceTransaction.php
4 years ago
BankAccount.php
4 years ago
BaseStripeClient.php
2 years ago
BaseStripeClientInterface.php
4 years ago
BitcoinReceiver.php
2 years ago
BitcoinTransaction.php
4 years ago
Capability.php
4 years ago
Card.php
2 years ago
CashBalance.php
2 years ago
Charge.php
2 years ago
Collection.php
2 years ago
CountrySpec.php
4 years ago
Coupon.php
2 years ago
CreditNote.php
2 years ago
CreditNoteLineItem.php
4 years ago
Customer.php
2 years ago
CustomerBalanceTransaction.php
4 years ago
Discount.php
2 years ago
Dispute.php
4 years ago
EphemeralKey.php
4 years ago
ErrorObject.php
4 years ago
Event.php
2 years ago
ExchangeRate.php
4 years ago
File.php
2 years ago
FileLink.php
4 years ago
FundingInstructions.php
2 years ago
Invoice.php
2 years ago
InvoiceItem.php
2 years ago
InvoiceLineItem.php
2 years ago
LineItem.php
4 years ago
LoginLink.php
4 years ago
Mandate.php
4 years ago
OAuth.php
4 years ago
OAuthErrorObject.php
4 years ago
Order.php
2 years ago
OrderItem.php
4 years ago
OrderReturn.php
4 years ago
PaymentIntent.php
2 years ago
PaymentLink.php
2 years ago
PaymentMethod.php
2 years ago
Payout.php
4 years ago
Person.php
2 years ago
Plan.php
2 years ago
Price.php
2 years ago
Product.php
2 years ago
PromotionCode.php
2 years ago
Quote.php
2 years ago
Recipient.php
2 years ago
RecipientTransfer.php
4 years ago
Refund.php
2 years ago
RequestTelemetry.php
4 years ago
Review.php
4 years ago
SKU.php
2 years ago
SearchResult.php
2 years ago
SetupAttempt.php
4 years ago
SetupIntent.php
2 years ago
ShippingRate.php
2 years ago
SingletonApiResource.php
2 years ago
Source.php
4 years ago
SourceTransaction.php
4 years ago
Stripe.php
2 years ago
StripeClient.php
2 years ago
StripeClientInterface.php
4 years ago
StripeObject.php
2 years ago
StripeStreamingClientInterface.php
4 years ago
Subscription.php
2 years ago
SubscriptionItem.php
2 years ago
SubscriptionSchedule.php
2 years ago
TaxCode.php
2 years ago
TaxId.php
2 years ago
TaxRate.php
4 years ago
ThreeDSecure.php
4 years ago
Token.php
4 years ago
Topup.php
4 years ago
Transfer.php
2 years ago
TransferReversal.php
4 years ago
UsageRecord.php
4 years ago
UsageRecordSummary.php
4 years ago
Webhook.php
4 years ago
WebhookEndpoint.php
4 years ago
WebhookSignature.php
4 years ago
Capability.php
89 lines
| 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 |