summaryrefslogtreecommitdiffstats
path: root/vendor/stripe/stripe-php/lib/Capability.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/stripe/stripe-php/lib/Capability.php')
-rw-r--r--vendor/stripe/stripe-php/lib/Capability.php87
1 files changed, 87 insertions, 0 deletions
diff --git a/vendor/stripe/stripe-php/lib/Capability.php b/vendor/stripe/stripe-php/lib/Capability.php
new file mode 100644
index 0000000..3580df6
--- /dev/null
+++ b/vendor/stripe/stripe-php/lib/Capability.php
@@ -0,0 +1,87 @@
+<?php
+
+// File generated from our OpenAPI spec
+
+namespace Stripe;
+
+/**
+ * This is an object representing a capability for a Stripe account.
+ *
+ * Related guide: <a
+ * href="https://stripe.com/docs/connect/account-capabilities">Account
+ * capabilities</a>.
+ *
+ * @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 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 <code>active</code>, <code>inactive</code>, <code>pending</code>, or <code>unrequested</code>.
+ */
+class Capability extends ApiResource
+{
+ const OBJECT_NAME = 'capability';
+
+ use ApiOperations\Update;
+
+ const STATUS_ACTIVE = 'active';
+ const STATUS_INACTIVE = 'inactive';
+ const STATUS_PENDING = 'pending';
+ const STATUS_UNREQUESTED = 'unrequested';
+
+ /**
+ * @return string the API URL for this Stripe account reversal
+ */
+ public function instanceUrl()
+ {
+ $id = $this['id'];
+ $account = $this['account'];
+ if (!$id) {
+ throw new Exception\UnexpectedValueException(
+ 'Could not determine which URL to request: ' .
+ "class instance has invalid ID: {$id}",
+ null
+ );
+ }
+ $id = Util\Util::utf8($id);
+ $account = Util\Util::utf8($account);
+
+ $base = Account::classUrl();
+ $accountExtn = \urlencode($account);
+ $extn = \urlencode($id);
+
+ return "{$base}/{$accountExtn}/capabilities/{$extn}";
+ }
+
+ /**
+ * @param array|string $_id
+ * @param null|array|string $_opts
+ *
+ * @throws \Stripe\Exception\BadMethodCallException
+ */
+ public static function retrieve($_id, $_opts = null)
+ {
+ $msg = 'Capabilities cannot be retrieved without an account ID. ' .
+ 'Retrieve a capability using `Account::retrieveCapability(' .
+ "'account_id', 'capability_id')`.";
+
+ throw new Exception\BadMethodCallException($msg);
+ }
+
+ /**
+ * @param string $_id
+ * @param null|array $_params
+ * @param null|array|string $_options
+ *
+ * @throws \Stripe\Exception\BadMethodCallException
+ */
+ public static function update($_id, $_params = null, $_options = null)
+ {
+ $msg = 'Capabilities cannot be updated without an account ID. ' .
+ 'Update a capability using `Account::updateCapability(' .
+ "'account_id', 'capability_id', \$updateParams)`.";
+
+ throw new Exception\BadMethodCallException($msg);
+ }
+}