Current File : /home2/selectio/www/fms-worksuite/vendor/square/square/src/Apis/BankAccountsApi.php
<?php
declare(strict_types=1);
namespace Square\Apis;
use Square\Exceptions\ApiException;
use Square\ApiHelper;
use Square\ConfigurationInterface;
use Square\Http\ApiResponse;
use Square\Http\HttpRequest;
use Square\Http\HttpResponse;
use Square\Http\HttpMethod;
use Square\Http\HttpContext;
use Square\Http\HttpCallBack;
use Unirest\Request;
class BankAccountsApi extends BaseApi
{
public function __construct(ConfigurationInterface $config, array $authManagers, ?HttpCallBack $httpCallBack)
{
parent::__construct($config, $authManagers, $httpCallBack);
}
/**
* Returns a list of [BankAccount]($m/BankAccount) objects linked to a Square account.
*
* @param string|null $cursor The pagination cursor returned by a previous call to this
* endpoint.
* Use it in the next `ListBankAccounts` request to retrieve the next set
* of results.
*
* See the [Pagination](https://developer.squareup.com/docs/working-with-
* apis/pagination) guide for more information.
* @param int|null $limit Upper limit on the number of bank accounts to return in the response.
* Currently, 1000 is the largest supported limit. You can specify a limit
* of up to 1000 bank accounts. This is also the default limit.
* @param string|null $locationId Location ID. You can specify this optional filter to retrieve
* only the linked bank accounts belonging to a specific location.
*
* @return ApiResponse Response from the API call
*
* @throws ApiException Thrown if API call fails
*/
public function listBankAccounts(
?string $cursor = null,
?int $limit = null,
?string $locationId = null
): ApiResponse {
//prepare query string for API call
$_queryBuilder = '/v2/bank-accounts';
//process optional query parameters
ApiHelper::appendUrlWithQueryParameters($_queryBuilder, [
'cursor' => $cursor,
'limit' => $limit,
'location_id' => $locationId,
]);
//validate and preprocess url
$_queryUrl = ApiHelper::cleanUrl($this->config->getBaseUri() . $_queryBuilder);
//prepare headers
$_headers = [
'user-agent' => BaseApi::USER_AGENT,
'Accept' => 'application/json',
'Square-Version' => $this->config->getSquareVersion()
];
$_headers = ApiHelper::mergeHeaders($_headers, $this->config->getAdditionalHeaders());
$_httpRequest = new HttpRequest(HttpMethod::GET, $_headers, $_queryUrl);
// Apply authorization to request
$this->getAuthManager('global')->apply($_httpRequest);
//call on-before Http callback
if ($this->getHttpCallBack() != null) {
$this->getHttpCallBack()->callOnBeforeRequest($_httpRequest);
}
// and invoke the API call request to fetch the response
try {
$response = Request::get($_httpRequest->getQueryUrl(), $_httpRequest->getHeaders());
} catch (\Unirest\Exception $ex) {
throw new ApiException($ex->getMessage(), $_httpRequest);
}
$_httpResponse = new HttpResponse($response->code, $response->headers, $response->raw_body);
$_httpContext = new HttpContext($_httpRequest, $_httpResponse);
//call on-after Http callback
if ($this->getHttpCallBack() != null) {
$this->getHttpCallBack()->callOnAfterRequest($_httpContext);
}
if (!$this->isValidResponse($_httpResponse)) {
return ApiResponse::createFromContext($response->body, null, $_httpContext);
}
$mapper = $this->getJsonMapper();
$deserializedResponse = $mapper->mapClass($response->body, 'Square\\Models\\ListBankAccountsResponse');
return ApiResponse::createFromContext($response->body, $deserializedResponse, $_httpContext);
}
/**
* Returns details of a [BankAccount]($m/BankAccount) identified by V1 bank account ID.
*
* @param string $v1BankAccountId Connect V1 ID of the desired `BankAccount`. For more
* information, see
* [Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https:
* //developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-
* id-issued-by-v1-bank-accounts-api).
*
* @return ApiResponse Response from the API call
*
* @throws ApiException Thrown if API call fails
*/
public function getBankAccountByV1Id(string $v1BankAccountId): ApiResponse
{
//prepare query string for API call
$_queryBuilder = '/v2/bank-accounts/by-v1-id/{v1_bank_account_id}';
//process optional query parameters
$_queryBuilder = ApiHelper::appendUrlWithTemplateParameters($_queryBuilder, [
'v1_bank_account_id' => $v1BankAccountId,
]);
//validate and preprocess url
$_queryUrl = ApiHelper::cleanUrl($this->config->getBaseUri() . $_queryBuilder);
//prepare headers
$_headers = [
'user-agent' => BaseApi::USER_AGENT,
'Accept' => 'application/json',
'Square-Version' => $this->config->getSquareVersion()
];
$_headers = ApiHelper::mergeHeaders($_headers, $this->config->getAdditionalHeaders());
$_httpRequest = new HttpRequest(HttpMethod::GET, $_headers, $_queryUrl);
// Apply authorization to request
$this->getAuthManager('global')->apply($_httpRequest);
//call on-before Http callback
if ($this->getHttpCallBack() != null) {
$this->getHttpCallBack()->callOnBeforeRequest($_httpRequest);
}
// and invoke the API call request to fetch the response
try {
$response = Request::get($_httpRequest->getQueryUrl(), $_httpRequest->getHeaders());
} catch (\Unirest\Exception $ex) {
throw new ApiException($ex->getMessage(), $_httpRequest);
}
$_httpResponse = new HttpResponse($response->code, $response->headers, $response->raw_body);
$_httpContext = new HttpContext($_httpRequest, $_httpResponse);
//call on-after Http callback
if ($this->getHttpCallBack() != null) {
$this->getHttpCallBack()->callOnAfterRequest($_httpContext);
}
if (!$this->isValidResponse($_httpResponse)) {
return ApiResponse::createFromContext($response->body, null, $_httpContext);
}
$mapper = $this->getJsonMapper();
$deserializedResponse = $mapper->mapClass($response->body, 'Square\\Models\\GetBankAccountByV1IdResponse');
return ApiResponse::createFromContext($response->body, $deserializedResponse, $_httpContext);
}
/**
* Returns details of a [BankAccount]($m/BankAccount)
* linked to a Square account.
*
* @param string $bankAccountId Square-issued ID of the desired `BankAccount`.
*
* @return ApiResponse Response from the API call
*
* @throws ApiException Thrown if API call fails
*/
public function getBankAccount(string $bankAccountId): ApiResponse
{
//prepare query string for API call
$_queryBuilder = '/v2/bank-accounts/{bank_account_id}';
//process optional query parameters
$_queryBuilder = ApiHelper::appendUrlWithTemplateParameters($_queryBuilder, [
'bank_account_id' => $bankAccountId,
]);
//validate and preprocess url
$_queryUrl = ApiHelper::cleanUrl($this->config->getBaseUri() . $_queryBuilder);
//prepare headers
$_headers = [
'user-agent' => BaseApi::USER_AGENT,
'Accept' => 'application/json',
'Square-Version' => $this->config->getSquareVersion()
];
$_headers = ApiHelper::mergeHeaders($_headers, $this->config->getAdditionalHeaders());
$_httpRequest = new HttpRequest(HttpMethod::GET, $_headers, $_queryUrl);
// Apply authorization to request
$this->getAuthManager('global')->apply($_httpRequest);
//call on-before Http callback
if ($this->getHttpCallBack() != null) {
$this->getHttpCallBack()->callOnBeforeRequest($_httpRequest);
}
// and invoke the API call request to fetch the response
try {
$response = Request::get($_httpRequest->getQueryUrl(), $_httpRequest->getHeaders());
} catch (\Unirest\Exception $ex) {
throw new ApiException($ex->getMessage(), $_httpRequest);
}
$_httpResponse = new HttpResponse($response->code, $response->headers, $response->raw_body);
$_httpContext = new HttpContext($_httpRequest, $_httpResponse);
//call on-after Http callback
if ($this->getHttpCallBack() != null) {
$this->getHttpCallBack()->callOnAfterRequest($_httpContext);
}
if (!$this->isValidResponse($_httpResponse)) {
return ApiResponse::createFromContext($response->body, null, $_httpContext);
}
$mapper = $this->getJsonMapper();
$deserializedResponse = $mapper->mapClass($response->body, 'Square\\Models\\GetBankAccountResponse');
return ApiResponse::createFromContext($response->body, $deserializedResponse, $_httpContext);
}
}
Mini Shell