ok
Mini Shell
<?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 TransactionsApi extends BaseApi
{
public function __construct(ConfigurationInterface $config, array $authManagers, ?HttpCallBack $httpCallBack)
{
parent::__construct($config, $authManagers, $httpCallBack);
}
/**
* Lists transactions for a particular location.
*
* Transactions include payment information from sales and exchanges and refund
* information from returns and exchanges.
*
* Max results per [page](https://developer.squareup.com/docs/working-with-apis/pagination): 50
*
* @deprecated
*
* @param string $locationId The ID of the location to list transactions for.
* @param string|null $beginTime The beginning of the requested reporting period, in RFC 3339
* format.
*
* See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-
* dates) for details on date inclusivity/exclusivity.
*
* Default value: The current time minus one year.
* @param string|null $endTime The end of the requested reporting period, in RFC 3339 format.
* See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-
* dates) for details on date inclusivity/exclusivity.
*
* Default value: The current time.
* @param string|null $sortOrder The order in which results are listed in the response (`ASC`
* for
* oldest first, `DESC` for newest first).
*
* Default value: `DESC`
* @param string|null $cursor A pagination cursor returned by a previous call to this endpoint.
* Provide this to retrieve the next set of results for your original query.
*
* See [Paginating results](https://developer.squareup.com/docs/working-with-
* apis/pagination) for more information.
*
* @return ApiResponse Response from the API call
*
* @throws ApiException Thrown if API call fails
*/
public function listTransactions(
string $locationId,
?string $beginTime = null,
?string $endTime = null,
?string $sortOrder = null,
?string $cursor = null
): ApiResponse {
trigger_error('Method ' . __METHOD__ . ' is deprecated.', E_USER_DEPRECATED);
//prepare query string for API call
$_queryBuilder = '/v2/locations/{location_id}/transactions';
//process optional query parameters
$_queryBuilder = ApiHelper::appendUrlWithTemplateParameters($_queryBuilder, [
'location_id' => $locationId,
]);
//process optional query parameters
ApiHelper::appendUrlWithQueryParameters($_queryBuilder, [
'begin_time' => $beginTime,
'end_time' => $endTime,
'sort_order' => $sortOrder,
'cursor' => $cursor,
]);
//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\\ListTransactionsResponse');
return ApiResponse::createFromContext($response->body, $deserializedResponse, $_httpContext);
}
/**
* Retrieves details for a single transaction.
*
* @deprecated
*
* @param string $locationId The ID of the transaction's associated location.
* @param string $transactionId The ID of the transaction to retrieve.
*
* @return ApiResponse Response from the API call
*
* @throws ApiException Thrown if API call fails
*/
public function retrieveTransaction(string $locationId, string $transactionId): ApiResponse
{
trigger_error('Method ' . __METHOD__ . ' is deprecated.', E_USER_DEPRECATED);
//prepare query string for API call
$_queryBuilder = '/v2/locations/{location_id}/transactions/{transaction_id}';
//process optional query parameters
$_queryBuilder = ApiHelper::appendUrlWithTemplateParameters($_queryBuilder, [
'location_id' => $locationId,
'transaction_id' => $transactionId,
]);
//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\\RetrieveTransactionResponse');
return ApiResponse::createFromContext($response->body, $deserializedResponse, $_httpContext);
}
/**
* Captures a transaction that was created with the [Charge]($e/Transactions/Charge)
* endpoint with a `delay_capture` value of `true`.
*
*
* See [Delayed capture transactions](https://developer.squareup.
* com/docs/payments/transactions/overview#delayed-capture)
* for more information.
*
* @deprecated
*
* @param string $locationId
* @param string $transactionId
*
* @return ApiResponse Response from the API call
*
* @throws ApiException Thrown if API call fails
*/
public function captureTransaction(string $locationId, string $transactionId): ApiResponse
{
trigger_error('Method ' . __METHOD__ . ' is deprecated.', E_USER_DEPRECATED);
//prepare query string for API call
$_queryBuilder = '/v2/locations/{location_id}/transactions/{transaction_id}/capture';
//process optional query parameters
$_queryBuilder = ApiHelper::appendUrlWithTemplateParameters($_queryBuilder, [
'location_id' => $locationId,
'transaction_id' => $transactionId,
]);
//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::POST, $_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::post($_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\\CaptureTransactionResponse');
return ApiResponse::createFromContext($response->body, $deserializedResponse, $_httpContext);
}
/**
* Cancels a transaction that was created with the [Charge]($e/Transactions/Charge)
* endpoint with a `delay_capture` value of `true`.
*
*
* See [Delayed capture transactions](https://developer.squareup.
* com/docs/payments/transactions/overview#delayed-capture)
* for more information.
*
* @deprecated
*
* @param string $locationId
* @param string $transactionId
*
* @return ApiResponse Response from the API call
*
* @throws ApiException Thrown if API call fails
*/
public function voidTransaction(string $locationId, string $transactionId): ApiResponse
{
trigger_error('Method ' . __METHOD__ . ' is deprecated.', E_USER_DEPRECATED);
//prepare query string for API call
$_queryBuilder = '/v2/locations/{location_id}/transactions/{transaction_id}/void';
//process optional query parameters
$_queryBuilder = ApiHelper::appendUrlWithTemplateParameters($_queryBuilder, [
'location_id' => $locationId,
'transaction_id' => $transactionId,
]);
//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::POST, $_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::post($_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\\VoidTransactionResponse');
return ApiResponse::createFromContext($response->body, $deserializedResponse, $_httpContext);
}
}
Zerion Mini Shell 1.0