/home/desid573/public_html/gcdriver/square/lib/Api
Edit: /home/desid573/public_html/gcdriver/square/lib/Api/PaymentsApi.php (26578B)
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 PaymentsApi
*/
public function setApiClient(ApiClient $apiClient)
{
$this->apiClient = $apiClient;
return $this;
}
/**
* cancelPayment
*
* CancelPayment
*
* @param string $payment_id `payment_id` identifying the payment to be canceled. (required)
* @return \SquareConnect\Model\CancelPaymentResponse
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function cancelPayment($payment_id)
{
list($response, $statusCode, $httpHeader) = $this->cancelPaymentWithHttpInfo ($payment_id);
return $response;
}
/**
* cancelPaymentWithHttpInfo
*
* CancelPayment
*
* @param string $payment_id `payment_id` identifying the payment to be canceled. (required)
* @return Array of \SquareConnect\Model\CancelPaymentResponse, HTTP status code, HTTP response headers (array of strings)
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function cancelPaymentWithHttpInfo($payment_id)
{
// verify the required parameter 'payment_id' is set
if ($payment_id === null) {
throw new \InvalidArgumentException('Missing the required parameter $payment_id when calling cancelPayment');
}
// parse inputs
$resourcePath = "/v2/payments/{payment_id}/cancel";
$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 ($payment_id !== null) {
$resourcePath = str_replace(
"{" . "payment_id" . "}",
$this->apiClient->getSerializer()->toPathValue($payment_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, 'POST',
$queryParams, $httpBody,
$headerParams, '\SquareConnect\Model\CancelPaymentResponse'
);
if (!$response) {
return array(null, $statusCode, $httpHeader);
}
return array(\SquareConnect\ObjectSerializer::deserialize($response, '\SquareConnect\Model\CancelPaymentResponse', $httpHeader), $statusCode, $httpHeader);
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = \SquareConnect\ObjectSerializer::deserialize($e->getResponseBody(), '\SquareConnect\Model\CancelPaymentResponse', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* cancelPaymentByIdempotencyKey
*
* CancelPaymentByIdempotencyKey
*
* @param \SquareConnect\Model\CancelPaymentByIdempotencyKeyRequest $body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required)
* @return \SquareConnect\Model\CancelPaymentByIdempotencyKeyResponse
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function cancelPaymentByIdempotencyKey($body)
{
list($response, $statusCode, $httpHeader) = $this->cancelPaymentByIdempotencyKeyWithHttpInfo ($body);
return $response;
}
/**
* cancelPaymentByIdempotencyKeyWithHttpInfo
*
* CancelPaymentByIdempotencyKey
*
* @param \SquareConnect\Model\CancelPaymentByIdempotencyKeyRequest $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\CancelPaymentByIdempotencyKeyResponse, HTTP status code, HTTP response headers (array of strings)
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function cancelPaymentByIdempotencyKeyWithHttpInfo($body)
{
// verify the required parameter 'body' is set
if ($body === null) {
throw new \InvalidArgumentException('Missing the required parameter $body when calling cancelPaymentByIdempotencyKey');
}
// parse inputs
$resourcePath = "/v2/payments/cancel";
$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\CancelPaymentByIdempotencyKeyResponse'
);
if (!$response) {
return array(null, $statusCode, $httpHeader);
}
return array(\SquareConnect\ObjectSerializer::deserialize($response, '\SquareConnect\Model\CancelPaymentByIdempotencyKeyResponse', $httpHeader), $statusCode, $httpHeader);
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = \SquareConnect\ObjectSerializer::deserialize($e->getResponseBody(), '\SquareConnect\Model\CancelPaymentByIdempotencyKeyResponse', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* completePayment
*
* CompletePayment
*
* @param string $payment_id Unique ID identifying the payment to be completed. (required)
* @return \SquareConnect\Model\CompletePaymentResponse
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function completePayment($payment_id)
{
list($response, $statusCode, $httpHeader) = $this->completePaymentWithHttpInfo ($payment_id);
return $response;
}
/**
* completePaymentWithHttpInfo
*
* CompletePayment
*
* @param string $payment_id Unique ID identifying the payment to be completed. (required)
* @return Array of \SquareConnect\Model\CompletePaymentResponse, HTTP status code, HTTP response headers (array of strings)
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function completePaymentWithHttpInfo($payment_id)
{
// verify the required parameter 'payment_id' is set
if ($payment_id === null) {
throw new \InvalidArgumentException('Missing the required parameter $payment_id when calling completePayment');
}
// parse inputs
$resourcePath = "/v2/payments/{payment_id}/complete";
$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 ($payment_id !== null) {
$resourcePath = str_replace(
"{" . "payment_id" . "}",
$this->apiClient->getSerializer()->toPathValue($payment_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, 'POST',
$queryParams, $httpBody,
$headerParams, '\SquareConnect\Model\CompletePaymentResponse'
);
if (!$response) {
return array(null, $statusCode, $httpHeader);
}
return array(\SquareConnect\ObjectSerializer::deserialize($response, '\SquareConnect\Model\CompletePaymentResponse', $httpHeader), $statusCode, $httpHeader);
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = \SquareConnect\ObjectSerializer::deserialize($e->getResponseBody(), '\SquareConnect\Model\CompletePaymentResponse', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* createPayment
*
* CreatePayment
*
* @param \SquareConnect\Model\CreatePaymentRequest $body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required)
* @return \SquareConnect\Model\CreatePaymentResponse
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function createPayment($body)
{
list($response, $statusCode, $httpHeader) = $this->createPaymentWithHttpInfo ($body);
return $response;
}
/**
* createPaymentWithHttpInfo
*
* CreatePayment
*
* @param \SquareConnect\Model\CreatePaymentRequest $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\CreatePaymentResponse, HTTP status code, HTTP response headers (array of strings)
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function createPaymentWithHttpInfo($body)
{
// verify the required parameter 'body' is set
if ($body === null) {
throw new \InvalidArgumentException('Missing the required parameter $body when calling createPayment');
}
// parse inputs
$resourcePath = "/v2/payments";
$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\CreatePaymentResponse'
);
if (!$response) {
return array(null, $statusCode, $httpHeader);
}
return array(\SquareConnect\ObjectSerializer::deserialize($response, '\SquareConnect\Model\CreatePaymentResponse', $httpHeader), $statusCode, $httpHeader);
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = \SquareConnect\ObjectSerializer::deserialize($e->getResponseBody(), '\SquareConnect\Model\CreatePaymentResponse', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* getPayment
*
* GetPayment
*
* @param string $payment_id Unique ID for the desired `Payment`. (required)
* @return \SquareConnect\Model\GetPaymentResponse
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function getPayment($payment_id)
{
list($response, $statusCode, $httpHeader) = $this->getPaymentWithHttpInfo ($payment_id);
return $response;
}
/**
* getPaymentWithHttpInfo
*
* GetPayment
*
* @param string $payment_id Unique ID for the desired `Payment`. (required)
* @return Array of \SquareConnect\Model\GetPaymentResponse, HTTP status code, HTTP response headers (array of strings)
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function getPaymentWithHttpInfo($payment_id)
{
// verify the required parameter 'payment_id' is set
if ($payment_id === null) {
throw new \InvalidArgumentException('Missing the required parameter $payment_id when calling getPayment');
}
// parse inputs
$resourcePath = "/v2/payments/{payment_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 ($payment_id !== null) {
$resourcePath = str_replace(
"{" . "payment_id" . "}",
$this->apiClient->getSerializer()->toPathValue($payment_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\GetPaymentResponse'
);
if (!$response) {
return array(null, $statusCode, $httpHeader);
}
return array(\SquareConnect\ObjectSerializer::deserialize($response, '\SquareConnect\Model\GetPaymentResponse', $httpHeader), $statusCode, $httpHeader);
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = \SquareConnect\ObjectSerializer::deserialize($e->getResponseBody(), '\SquareConnect\Model\GetPaymentResponse', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* listPayments
*
* ListPayments
*
* @param string $begin_time Timestamp for the beginning of the reporting period, in RFC 3339 format. Inclusive. 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 int $total The exact amount in the total_money for a `Payment`. (optional)
* @param string $last_4 The last 4 digits of `Payment` card. (optional)
* @param string $card_brand The brand of `Payment` card. For example, `VISA` (optional)
* @return \SquareConnect\Model\ListPaymentsResponse
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function listPayments($begin_time = null, $end_time = null, $sort_order = null, $cursor = null, $location_id = null, $total = null, $last_4 = null, $card_brand = null)
{
list($response, $statusCode, $httpHeader) = $this->listPaymentsWithHttpInfo ($begin_time, $end_time, $sort_order, $cursor, $location_id, $total, $last_4, $card_brand);
return $response;
}
/**
* listPaymentsWithHttpInfo
*
* ListPayments
*
* @param string $begin_time Timestamp for the beginning of the reporting period, in RFC 3339 format. Inclusive. 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 int $total The exact amount in the total_money for a `Payment`. (optional)
* @param string $last_4 The last 4 digits of `Payment` card. (optional)
* @param string $card_brand The brand of `Payment` card. For example, `VISA` (optional)
* @return Array of \SquareConnect\Model\ListPaymentsResponse, HTTP status code, HTTP response headers (array of strings)
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function listPaymentsWithHttpInfo($begin_time = null, $end_time = null, $sort_order = null, $cursor = null, $location_id = null, $total = null, $last_4 = null, $card_brand = null)
{
// parse inputs
$resourcePath = "/v2/payments";
$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 ($total !== null) {
$queryParams['total'] = $this->apiClient->getSerializer()->toQueryValue($total);
}// query params
if ($last_4 !== null) {
$queryParams['last_4'] = $this->apiClient->getSerializer()->toQueryValue($last_4);
}// query params
if ($card_brand !== null) {
$queryParams['card_brand'] = $this->apiClient->getSerializer()->toQueryValue($card_brand);
}
// 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\ListPaymentsResponse'
);
if (!$response) {
return array(null, $statusCode, $httpHeader);
}
return array(\SquareConnect\ObjectSerializer::deserialize($response, '\SquareConnect\Model\ListPaymentsResponse', $httpHeader), $statusCode, $httpHeader);
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = \SquareConnect\ObjectSerializer::deserialize($e->getResponseBody(), '\SquareConnect\Model\ListPaymentsResponse', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
throw $e;
}
}
}