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 TerminalApi extends BaseApi
{
public function __construct(ConfigurationInterface $config, array $authManagers, ?HttpCallBack $httpCallBack)
{
parent::__construct($config, $authManagers, $httpCallBack);
}
/**
* Creates a Terminal checkout request and sends it to the specified device to take a payment
* for the requested amount.
*
* @param \Square\Models\CreateTerminalCheckoutRequest $body An object containing the fields to
* POST for the request.
*
* See the corresponding object definition for field details.
*
* @return ApiResponse Response from the API call
*
* @throws ApiException Thrown if API call fails
*/
public function createTerminalCheckout(\Square\Models\CreateTerminalCheckoutRequest $body): ApiResponse
{
//prepare query string for API call
$_queryBuilder = '/v2/terminals/checkouts';
//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(),
'Content-Type' => 'application/json'
];
$_headers = ApiHelper::mergeHeaders($_headers, $this->config->getAdditionalHeaders());
//json encode body
$_bodyJson = Request\Body::Json($body);
$_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(), $_bodyJson);
} 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\\CreateTerminalCheckoutResponse');
return ApiResponse::createFromContext($response->body, $deserializedResponse, $_httpContext);
}
/**
* Retrieves a filtered list of Terminal checkout requests created by the account making the request.
*
* @param \Square\Models\SearchTerminalCheckoutsRequest $body An object containing the fields to
* POST for the request.
*
* See the corresponding object definition for field details.
*
* @return ApiResponse Response from the API call
*
* @throws ApiException Thrown if API call fails
*/
public function searchTerminalCheckouts(\Square\Models\SearchTerminalCheckoutsRequest $body): ApiResponse
{
//prepare query string for API call
$_queryBuilder = '/v2/terminals/checkouts/search';
//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(),
'Content-Type' => 'application/json'
];
$_headers = ApiHelper::mergeHeaders($_headers, $this->config->getAdditionalHeaders());
//json encode body
$_bodyJson = Request\Body::Json($body);
$_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(), $_bodyJson);
} 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\\SearchTerminalCheckoutsResponse');
return ApiResponse::createFromContext($response->body, $deserializedResponse, $_httpContext);
}
/**
* Retrieves a Terminal checkout request by `checkout_id`.
*
* @param string $checkoutId The unique ID for the desired `TerminalCheckout`.
*
* @return ApiResponse Response from the API call
*
* @throws ApiException Thrown if API call fails
*/
public function getTerminalCheckout(string $checkoutId): ApiResponse
{
//prepare query string for API call
$_queryBuilder = '/v2/terminals/checkouts/{checkout_id}';
//process optional query parameters
$_queryBuilder = ApiHelper::appendUrlWithTemplateParameters($_queryBuilder, [
'checkout_id' => $checkoutId,
]);
//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\\GetTerminalCheckoutResponse');
return ApiResponse::createFromContext($response->body, $deserializedResponse, $_httpContext);
}
/**
* Cancels a Terminal checkout request if the status of the request permits it.
*
* @param string $checkoutId The unique ID for the desired `TerminalCheckout`.
*
* @return ApiResponse Response from the API call
*
* @throws ApiException Thrown if API call fails
*/
public function cancelTerminalCheckout(string $checkoutId): ApiResponse
{
//prepare query string for API call
$_queryBuilder = '/v2/terminals/checkouts/{checkout_id}/cancel';
//process optional query parameters
$_queryBuilder = ApiHelper::appendUrlWithTemplateParameters($_queryBuilder, [
'checkout_id' => $checkoutId,
]);
//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\\CancelTerminalCheckoutResponse');
return ApiResponse::createFromContext($response->body, $deserializedResponse, $_httpContext);
}
/**
* Creates a request to refund an Interac payment completed on a Square Terminal.
*
* @param \Square\Models\CreateTerminalRefundRequest $body An object containing the fields to
* POST for the request.
*
* See the corresponding object definition for field details.
*
* @return ApiResponse Response from the API call
*
* @throws ApiException Thrown if API call fails
*/
public function createTerminalRefund(\Square\Models\CreateTerminalRefundRequest $body): ApiResponse
{
//prepare query string for API call
$_queryBuilder = '/v2/terminals/refunds';
//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(),
'Content-Type' => 'application/json'
];
$_headers = ApiHelper::mergeHeaders($_headers, $this->config->getAdditionalHeaders());
//json encode body
$_bodyJson = Request\Body::Json($body);
$_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(), $_bodyJson);
} 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\\CreateTerminalRefundResponse');
return ApiResponse::createFromContext($response->body, $deserializedResponse, $_httpContext);
}
/**
* Retrieves a filtered list of Interac Terminal refund requests created by the seller making the
* request.
*
* @param \Square\Models\SearchTerminalRefundsRequest $body An object containing the fields to
* POST for the request.
*
* See the corresponding object definition for field details.
*
* @return ApiResponse Response from the API call
*
* @throws ApiException Thrown if API call fails
*/
public function searchTerminalRefunds(\Square\Models\SearchTerminalRefundsRequest $body): ApiResponse
{
//prepare query string for API call
$_queryBuilder = '/v2/terminals/refunds/search';
//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(),
'Content-Type' => 'application/json'
];
$_headers = ApiHelper::mergeHeaders($_headers, $this->config->getAdditionalHeaders());
//json encode body
$_bodyJson = Request\Body::Json($body);
$_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(), $_bodyJson);
} 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\\SearchTerminalRefundsResponse');
return ApiResponse::createFromContext($response->body, $deserializedResponse, $_httpContext);
}
/**
* Retrieves an Interac Terminal refund object by ID.
*
* @param string $terminalRefundId The unique ID for the desired `TerminalRefund`.
*
* @return ApiResponse Response from the API call
*
* @throws ApiException Thrown if API call fails
*/
public function getTerminalRefund(string $terminalRefundId): ApiResponse
{
//prepare query string for API call
$_queryBuilder = '/v2/terminals/refunds/{terminal_refund_id}';
//process optional query parameters
$_queryBuilder = ApiHelper::appendUrlWithTemplateParameters($_queryBuilder, [
'terminal_refund_id' => $terminalRefundId,
]);
//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\\GetTerminalRefundResponse');
return ApiResponse::createFromContext($response->body, $deserializedResponse, $_httpContext);
}
/**
* Cancels an Interac Terminal refund request by refund request ID if the status of the request
* permits it.
*
* @param string $terminalRefundId The unique ID for the desired `TerminalRefund`.
*
* @return ApiResponse Response from the API call
*
* @throws ApiException Thrown if API call fails
*/
public function cancelTerminalRefund(string $terminalRefundId): ApiResponse
{
//prepare query string for API call
$_queryBuilder = '/v2/terminals/refunds/{terminal_refund_id}/cancel';
//process optional query parameters
$_queryBuilder = ApiHelper::appendUrlWithTemplateParameters($_queryBuilder, [
'terminal_refund_id' => $terminalRefundId,
]);
//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\\CancelTerminalRefundResponse');
return ApiResponse::createFromContext($response->body, $deserializedResponse, $_httpContext);
}
}
Zerion Mini Shell 1.0