/home/desid573/public_html/gcdriver/square/lib/Api
Edit: /home/desid573/public_html/gcdriver/square/lib/Api/RefundsApi.php (15866B)
getConfig()->setHost('https://connect.squareup.com');
}
$this->apiClient = $apiClient;
}
/**
* Get API client
* @return \SquareConnect\ApiClient get the API client
*/
public function getApiClient()
{
return $this->apiClient;
}
/**
* Set the API client
* @param \SquareConnect\ApiClient $apiClient set the API client
* @return RefundsApi
*/
public function setApiClient(ApiClient $apiClient)
{
$this->apiClient = $apiClient;
return $this;
}
/**
* getPaymentRefund
*
* GetPaymentRefund
*
* @param string $refund_id Unique ID for the desired `PaymentRefund`. (required)
* @return \SquareConnect\Model\GetPaymentRefundResponse
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function getPaymentRefund($refund_id)
{
list($response, $statusCode, $httpHeader) = $this->getPaymentRefundWithHttpInfo ($refund_id);
return $response;
}
/**
* getPaymentRefundWithHttpInfo
*
* GetPaymentRefund
*
* @param string $refund_id Unique ID for the desired `PaymentRefund`. (required)
* @return Array of \SquareConnect\Model\GetPaymentRefundResponse, HTTP status code, HTTP response headers (array of strings)
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function getPaymentRefundWithHttpInfo($refund_id)
{
// verify the required parameter 'refund_id' is set
if ($refund_id === null) {
throw new \InvalidArgumentException('Missing the required parameter $refund_id when calling getPaymentRefund');
}
// parse inputs
$resourcePath = "/v2/refunds/{refund_id}";
$httpBody = '';
$queryParams = array();
$headerParams = array();
$formParams = array();
$_header_accept = ApiClient::selectHeaderAccept(array('application/json'));
if (!is_null($_header_accept)) {
$headerParams['Accept'] = $_header_accept;
}
$headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
$headerParams['Square-Version'] = "2019-08-14";
// path params
if ($refund_id !== null) {
$resourcePath = str_replace(
"{" . "refund_id" . "}",
$this->apiClient->getSerializer()->toPathValue($refund_id),
$resourcePath
);
}
// default format to json
$resourcePath = str_replace("{format}", "json", $resourcePath);
// for model (json/xml)
if (isset($_tempBody)) {
$httpBody = $_tempBody; // $_tempBody is the method argument, if present
} elseif (count($formParams) > 0) {
$httpBody = $formParams; // for HTTP post (form)
}
// this endpoint requires OAuth (access token)
if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) {
$headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken();
}
// make the API Call
try {
list($response, $statusCode, $httpHeader) = $this->apiClient->callApi(
$resourcePath, 'GET',
$queryParams, $httpBody,
$headerParams, '\SquareConnect\Model\GetPaymentRefundResponse'
);
if (!$response) {
return array(null, $statusCode, $httpHeader);
}
return array(\SquareConnect\ObjectSerializer::deserialize($response, '\SquareConnect\Model\GetPaymentRefundResponse', $httpHeader), $statusCode, $httpHeader);
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = \SquareConnect\ObjectSerializer::deserialize($e->getResponseBody(), '\SquareConnect\Model\GetPaymentRefundResponse', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* listPaymentRefunds
*
* ListPaymentRefunds
*
* @param string $begin_time Timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year. (optional)
* @param string $end_time Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. (optional)
* @param string $sort_order The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). (optional)
* @param string $cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](/basics/api101/pagination) for more information. (optional)
* @param string $location_id ID of location associated with payment. (optional)
* @param string $status If provided, only refunds with the given status are returned. For a list of refund status values, see [PaymentRefund](#type-paymentrefund). Default: If omitted refunds are returned regardless of status. (optional)
* @param string $source_type If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. (optional)
* @return \SquareConnect\Model\ListPaymentRefundsResponse
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function listPaymentRefunds($begin_time = null, $end_time = null, $sort_order = null, $cursor = null, $location_id = null, $status = null, $source_type = null)
{
list($response, $statusCode, $httpHeader) = $this->listPaymentRefundsWithHttpInfo ($begin_time, $end_time, $sort_order, $cursor, $location_id, $status, $source_type);
return $response;
}
/**
* listPaymentRefundsWithHttpInfo
*
* ListPaymentRefunds
*
* @param string $begin_time Timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year. (optional)
* @param string $end_time Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. (optional)
* @param string $sort_order The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). (optional)
* @param string $cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](/basics/api101/pagination) for more information. (optional)
* @param string $location_id ID of location associated with payment. (optional)
* @param string $status If provided, only refunds with the given status are returned. For a list of refund status values, see [PaymentRefund](#type-paymentrefund). Default: If omitted refunds are returned regardless of status. (optional)
* @param string $source_type If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. (optional)
* @return Array of \SquareConnect\Model\ListPaymentRefundsResponse, HTTP status code, HTTP response headers (array of strings)
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function listPaymentRefundsWithHttpInfo($begin_time = null, $end_time = null, $sort_order = null, $cursor = null, $location_id = null, $status = null, $source_type = null)
{
// parse inputs
$resourcePath = "/v2/refunds";
$httpBody = '';
$queryParams = array();
$headerParams = array();
$formParams = array();
$_header_accept = ApiClient::selectHeaderAccept(array('application/json'));
if (!is_null($_header_accept)) {
$headerParams['Accept'] = $_header_accept;
}
$headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
$headerParams['Square-Version'] = "2019-08-14";
// query params
if ($begin_time !== null) {
$queryParams['begin_time'] = $this->apiClient->getSerializer()->toQueryValue($begin_time);
}// query params
if ($end_time !== null) {
$queryParams['end_time'] = $this->apiClient->getSerializer()->toQueryValue($end_time);
}// query params
if ($sort_order !== null) {
$queryParams['sort_order'] = $this->apiClient->getSerializer()->toQueryValue($sort_order);
}// query params
if ($cursor !== null) {
$queryParams['cursor'] = $this->apiClient->getSerializer()->toQueryValue($cursor);
}// query params
if ($location_id !== null) {
$queryParams['location_id'] = $this->apiClient->getSerializer()->toQueryValue($location_id);
}// query params
if ($status !== null) {
$queryParams['status'] = $this->apiClient->getSerializer()->toQueryValue($status);
}// query params
if ($source_type !== null) {
$queryParams['source_type'] = $this->apiClient->getSerializer()->toQueryValue($source_type);
}
// default format to json
$resourcePath = str_replace("{format}", "json", $resourcePath);
// for model (json/xml)
if (isset($_tempBody)) {
$httpBody = $_tempBody; // $_tempBody is the method argument, if present
} elseif (count($formParams) > 0) {
$httpBody = $formParams; // for HTTP post (form)
}
// this endpoint requires OAuth (access token)
if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) {
$headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken();
}
// make the API Call
try {
list($response, $statusCode, $httpHeader) = $this->apiClient->callApi(
$resourcePath, 'GET',
$queryParams, $httpBody,
$headerParams, '\SquareConnect\Model\ListPaymentRefundsResponse'
);
if (!$response) {
return array(null, $statusCode, $httpHeader);
}
return array(\SquareConnect\ObjectSerializer::deserialize($response, '\SquareConnect\Model\ListPaymentRefundsResponse', $httpHeader), $statusCode, $httpHeader);
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = \SquareConnect\ObjectSerializer::deserialize($e->getResponseBody(), '\SquareConnect\Model\ListPaymentRefundsResponse', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* refundPayment
*
* RefundPayment
*
* @param \SquareConnect\Model\RefundPaymentRequest $body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required)
* @return \SquareConnect\Model\RefundPaymentResponse
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function refundPayment($body)
{
list($response, $statusCode, $httpHeader) = $this->refundPaymentWithHttpInfo ($body);
return $response;
}
/**
* refundPaymentWithHttpInfo
*
* RefundPayment
*
* @param \SquareConnect\Model\RefundPaymentRequest $body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required)
* @return Array of \SquareConnect\Model\RefundPaymentResponse, HTTP status code, HTTP response headers (array of strings)
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function refundPaymentWithHttpInfo($body)
{
// verify the required parameter 'body' is set
if ($body === null) {
throw new \InvalidArgumentException('Missing the required parameter $body when calling refundPayment');
}
// parse inputs
$resourcePath = "/v2/refunds";
$httpBody = '';
$queryParams = array();
$headerParams = array();
$formParams = array();
$_header_accept = ApiClient::selectHeaderAccept(array('application/json'));
if (!is_null($_header_accept)) {
$headerParams['Accept'] = $_header_accept;
}
$headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
$headerParams['Square-Version'] = "2019-08-14";
// default format to json
$resourcePath = str_replace("{format}", "json", $resourcePath);
// body params
$_tempBody = null;
if (isset($body)) {
$_tempBody = $body;
}
// for model (json/xml)
if (isset($_tempBody)) {
$httpBody = $_tempBody; // $_tempBody is the method argument, if present
} elseif (count($formParams) > 0) {
$httpBody = $formParams; // for HTTP post (form)
}
// this endpoint requires OAuth (access token)
if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) {
$headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken();
}
// make the API Call
try {
list($response, $statusCode, $httpHeader) = $this->apiClient->callApi(
$resourcePath, 'POST',
$queryParams, $httpBody,
$headerParams, '\SquareConnect\Model\RefundPaymentResponse'
);
if (!$response) {
return array(null, $statusCode, $httpHeader);
}
return array(\SquareConnect\ObjectSerializer::deserialize($response, '\SquareConnect\Model\RefundPaymentResponse', $httpHeader), $statusCode, $httpHeader);
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = \SquareConnect\ObjectSerializer::deserialize($e->getResponseBody(), '\SquareConnect\Model\RefundPaymentResponse', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
throw $e;
}
}
}