56 lines
1.5 KiB
PHP
Executable file
56 lines
1.5 KiB
PHP
Executable file
<?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);
|
|
}
|