summaryrefslogtreecommitdiffstats
path: root/vendor/stripe/stripe-php/lib/StripeClientInterface.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/stripe/stripe-php/lib/StripeClientInterface.php')
-rw-r--r--vendor/stripe/stripe-php/lib/StripeClientInterface.php56
1 files changed, 56 insertions, 0 deletions
diff --git a/vendor/stripe/stripe-php/lib/StripeClientInterface.php b/vendor/stripe/stripe-php/lib/StripeClientInterface.php
new file mode 100644
index 0000000..adcef3f
--- /dev/null
+++ b/vendor/stripe/stripe-php/lib/StripeClientInterface.php
@@ -0,0 +1,56 @@
+<?php
+
+namespace Stripe;
+
+/**
+ * Interface for a Stripe client.
+ */
+interface StripeClientInterface
+{
+ /**
+ * Gets the API key used by the client to send requests.
+ *
+ * @return null|string the API key used by the client to send requests
+ */
+ public function getApiKey();
+
+ /**
+ * Gets the client ID used by the client in OAuth requests.
+ *
+ * @return null|string the client ID used by the client in OAuth requests
+ */
+ public function getClientId();
+
+ /**
+ * Gets the base URL for Stripe's API.
+ *
+ * @return string the base URL for Stripe's API
+ */
+ public function getApiBase();
+
+ /**
+ * Gets the base URL for Stripe's OAuth API.
+ *
+ * @return string the base URL for Stripe's OAuth API
+ */
+ public function getConnectBase();
+
+ /**
+ * Gets the base URL for Stripe's Files API.
+ *
+ * @return string the base URL for Stripe's Files API
+ */
+ public function getFilesBase();
+
+ /**
+ * Sends a request to Stripe's API.
+ *
+ * @param string $method the HTTP method
+ * @param string $path the path of the request
+ * @param array $params the parameters of the request
+ * @param array|\Stripe\Util\RequestOptions $opts the special modifiers of the request
+ *
+ * @return \Stripe\StripeObject the object returned by Stripe's API
+ */
+ public function request($method, $path, $params, $opts);
+}