Current File : /home2/selectio/www/fms-worksuite/vendor/square/square/src/Apis/RefundsApi.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 RefundsApi extends BaseApi
{
public function __construct(ConfigurationInterface $config, array $authManagers, ?HttpCallBack $httpCallBack)
{
parent::__construct($config, $authManagers, $httpCallBack);
}
/**
* Retrieves a list of refunds for the account making the request.
*
* Results are eventually consistent, and new refunds or changes to refunds might take several
* seconds to appear.
*
* The maximum results per page is 100.
*
* @param string|null $beginTime The timestamp for the beginning of the requested reporting
* period, in RFC 3339 format.
*
* Default: The current time minus one year.
* @param string|null $endTime The timestamp for the end of the requested reporting period, in
* RFC 3339 format.
*
* Default: The current time.
* @param string|null $sortOrder The order in which results are listed: - `ASC` - Oldest to
* newest.
* - `DESC` - Newest to oldest (default).
* @param string|null $cursor A pagination cursor returned by a previous call to this endpoint.
* Provide this cursor to retrieve the next set of results for the original query.
*
* For more information, see [Pagination](https://developer.squareup.
* com/docs/basics/api101/pagination).
* @param string|null $locationId Limit results to the location supplied. By default, results
* are returned
* for all locations associated with the seller.
* @param string|null $status If provided, only refunds with the given status are returned. For
* a list of refund status values, see [PaymentRefund]($m/PaymentRefund).
*
* Default: If omitted, refunds are returned regardless of their status.
* @param string|null $sourceType If provided, only refunds with the given source type are
* returned.
* - `CARD` - List refunds only for payments where `CARD` was specified as the payment
* source.
*
* Default: If omitted, refunds are returned regardless of the source type.
* @param int|null $limit The maximum number of results to be returned in a single page. It is
* possible to receive fewer results than the specified limit on a given page.
*
* If the supplied value is greater than 100, no more than 100 results are returned.
*
* Default: 100
*
* @return ApiResponse Response from the API call
*
* @throws ApiException Thrown if API call fails
*/
public function listPaymentRefunds(
?string $beginTime = null,
?string $endTime = null,
?string $sortOrder = null,
?string $cursor = null,
?string $locationId = null,
?string $status = null,
?string $sourceType = null,
?int $limit = null
): ApiResponse {
//prepare query string for API call
$_queryBuilder = '/v2/refunds';
//process optional query parameters
ApiHelper::appendUrlWithQueryParameters($_queryBuilder, [
'begin_time' => $beginTime,
'end_time' => $endTime,
'sort_order' => $sortOrder,
'cursor' => $cursor,
'location_id' => $locationId,
'status' => $status,
'source_type' => $sourceType,
'limit' => $limit,
]);
//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\\ListPaymentRefundsResponse');
return ApiResponse::createFromContext($response->body, $deserializedResponse, $_httpContext);
}
/**
* Refunds a payment. You can refund the entire payment amount or a
* portion of it. You can use this endpoint to refund a card payment or record a
* refund of a cash or external payment. For more information, see
* [Refund Payment](https://developer.squareup.com/docs/payments-api/refund-payments).
*
* @param \Square\Models\RefundPaymentRequest $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 refundPayment(\Square\Models\RefundPaymentRequest $body): ApiResponse
{
//prepare query string for API call
$_queryBuilder = '/v2/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\\RefundPaymentResponse');
return ApiResponse::createFromContext($response->body, $deserializedResponse, $_httpContext);
}
/**
* Retrieves a specific refund using the `refund_id`.
*
* @param string $refundId The unique ID for the desired `PaymentRefund`.
*
* @return ApiResponse Response from the API call
*
* @throws ApiException Thrown if API call fails
*/
public function getPaymentRefund(string $refundId): ApiResponse
{
//prepare query string for API call
$_queryBuilder = '/v2/refunds/{refund_id}';
//process optional query parameters
$_queryBuilder = ApiHelper::appendUrlWithTemplateParameters($_queryBuilder, [
'refund_id' => $refundId,
]);
//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\\GetPaymentRefundResponse');
return ApiResponse::createFromContext($response->body, $deserializedResponse, $_httpContext);
}
}
Mini Shell