/home/desid573/public_html/gcdriver/square/lib/Api
Edit: /home/desid573/public_html/gcdriver/square/lib/Api/V1TransactionsApi.php (58449B)
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 V1TransactionsApi
*/
public function setApiClient(ApiClient $apiClient)
{
$this->apiClient = $apiClient;
return $this;
}
/**
* createRefund
*
* CreateRefund
*
* @param string $location_id The ID of the original payment's associated location. (required)
* @param \SquareConnect\Model\V1CreateRefundRequest $body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required)
* @return \SquareConnect\Model\V1Refund
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function createRefund($location_id, $body)
{
list($response, $statusCode, $httpHeader) = $this->createRefundWithHttpInfo ($location_id, $body);
return $response;
}
/**
* createRefundWithHttpInfo
*
* CreateRefund
*
* @param string $location_id The ID of the original payment's associated location. (required)
* @param \SquareConnect\Model\V1CreateRefundRequest $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\V1Refund, HTTP status code, HTTP response headers (array of strings)
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function createRefundWithHttpInfo($location_id, $body)
{
// verify the required parameter 'location_id' is set
if ($location_id === null) {
throw new \InvalidArgumentException('Missing the required parameter $location_id when calling createRefund');
}
// verify the required parameter 'body' is set
if ($body === null) {
throw new \InvalidArgumentException('Missing the required parameter $body when calling createRefund');
}
// parse inputs
$resourcePath = "/v1/{location_id}/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";
// path params
if ($location_id !== null) {
$resourcePath = str_replace(
"{" . "location_id" . "}",
$this->apiClient->getSerializer()->toPathValue($location_id),
$resourcePath
);
}
// 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\V1Refund'
);
if (!$response) {
return array(null, $statusCode, $httpHeader);
}
return array(\SquareConnect\ObjectSerializer::deserialize($response, '\SquareConnect\Model\V1Refund', $httpHeader), $statusCode, $httpHeader);
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = \SquareConnect\ObjectSerializer::deserialize($e->getResponseBody(), '\SquareConnect\Model\V1Refund', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* listBankAccounts
*
* ListBankAccounts
*
* @param string $location_id The ID of the location to list bank accounts for. (required)
* @return \SquareConnect\Model\V1BankAccount[]
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function listBankAccounts($location_id)
{
list($response, $statusCode, $httpHeader) = $this->listBankAccountsWithHttpInfo ($location_id);
return $response;
}
/**
* listBankAccountsWithHttpInfo
*
* ListBankAccounts
*
* @param string $location_id The ID of the location to list bank accounts for. (required)
* @return Array of \SquareConnect\Model\V1BankAccount[], HTTP status code, HTTP response headers (array of strings)
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function listBankAccountsWithHttpInfo($location_id)
{
// verify the required parameter 'location_id' is set
if ($location_id === null) {
throw new \InvalidArgumentException('Missing the required parameter $location_id when calling listBankAccounts');
}
// parse inputs
$resourcePath = "/v1/{location_id}/bank-accounts";
$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 ($location_id !== null) {
$resourcePath = str_replace(
"{" . "location_id" . "}",
$this->apiClient->getSerializer()->toPathValue($location_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\V1BankAccount[]'
);
if (!$response) {
return array(null, $statusCode, $httpHeader);
}
return array(\SquareConnect\ObjectSerializer::deserialize($response, '\SquareConnect\Model\V1BankAccount[]', $httpHeader), $statusCode, $httpHeader);
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = \SquareConnect\ObjectSerializer::deserialize($e->getResponseBody(), '\SquareConnect\Model\V1BankAccount[]', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* listOrders
*
* ListOrders
*
* @param string $location_id The ID of the location to list online store orders for. (required)
* @param string $order TThe order in which payments are listed in the response. (optional)
* @param int $limit The maximum number of payments to return in a single response. This value cannot exceed 200. (optional)
* @param string $batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional)
* @return \SquareConnect\Model\V1Order[]
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function listOrders($location_id, $order = null, $limit = null, $batch_token = null)
{
list($response, $statusCode, $httpHeader) = $this->listOrdersWithHttpInfo ($location_id, $order, $limit, $batch_token);
return $response;
}
/**
* listOrdersWithHttpInfo
*
* ListOrders
*
* @param string $location_id The ID of the location to list online store orders for. (required)
* @param string $order TThe order in which payments are listed in the response. (optional)
* @param int $limit The maximum number of payments to return in a single response. This value cannot exceed 200. (optional)
* @param string $batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional)
* @return Array of \SquareConnect\Model\V1Order[], HTTP status code, HTTP response headers (array of strings)
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function listOrdersWithHttpInfo($location_id, $order = null, $limit = null, $batch_token = null)
{
// verify the required parameter 'location_id' is set
if ($location_id === null) {
throw new \InvalidArgumentException('Missing the required parameter $location_id when calling listOrders');
}
// parse inputs
$resourcePath = "/v1/{location_id}/orders";
$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 ($order !== null) {
$queryParams['order'] = $this->apiClient->getSerializer()->toQueryValue($order);
}// query params
if ($limit !== null) {
$queryParams['limit'] = $this->apiClient->getSerializer()->toQueryValue($limit);
}// query params
if ($batch_token !== null) {
$queryParams['batch_token'] = $this->apiClient->getSerializer()->toQueryValue($batch_token);
}
// path params
if ($location_id !== null) {
$resourcePath = str_replace(
"{" . "location_id" . "}",
$this->apiClient->getSerializer()->toPathValue($location_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\V1Order[]'
);
if (!$response) {
return array(null, $statusCode, $httpHeader);
}
return array(\SquareConnect\ObjectSerializer::deserialize($response, '\SquareConnect\Model\V1Order[]', $httpHeader), $statusCode, $httpHeader);
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = \SquareConnect\ObjectSerializer::deserialize($e->getResponseBody(), '\SquareConnect\Model\V1Order[]', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* listPayments
*
* ListPayments
*
* @param string $location_id The ID of the location to list payments for. If you specify me, this endpoint returns payments aggregated from all of the business's locations. (required)
* @param string $order The order in which payments are listed in the response. (optional)
* @param string $begin_time The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year. (optional)
* @param string $end_time The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. (optional)
* @param int $limit The maximum number of payments to return in a single response. This value cannot exceed 200. (optional)
* @param string $batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional)
* @param bool $include_partial Indicates whether or not to include partial payments in the response. Partial payments will have the tenders collected so far, but the itemizations will be empty until the payment is completed. (optional)
* @return \SquareConnect\Model\V1Payment[]
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function listPayments($location_id, $order = null, $begin_time = null, $end_time = null, $limit = null, $batch_token = null, $include_partial = null)
{
list($response, $statusCode, $httpHeader) = $this->listPaymentsWithHttpInfo ($location_id, $order, $begin_time, $end_time, $limit, $batch_token, $include_partial);
return $response;
}
/**
* listPaymentsWithHttpInfo
*
* ListPayments
*
* @param string $location_id The ID of the location to list payments for. If you specify me, this endpoint returns payments aggregated from all of the business's locations. (required)
* @param string $order The order in which payments are listed in the response. (optional)
* @param string $begin_time The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year. (optional)
* @param string $end_time The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. (optional)
* @param int $limit The maximum number of payments to return in a single response. This value cannot exceed 200. (optional)
* @param string $batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional)
* @param bool $include_partial Indicates whether or not to include partial payments in the response. Partial payments will have the tenders collected so far, but the itemizations will be empty until the payment is completed. (optional)
* @return Array of \SquareConnect\Model\V1Payment[], HTTP status code, HTTP response headers (array of strings)
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function listPaymentsWithHttpInfo($location_id, $order = null, $begin_time = null, $end_time = null, $limit = null, $batch_token = null, $include_partial = null)
{
// verify the required parameter 'location_id' is set
if ($location_id === null) {
throw new \InvalidArgumentException('Missing the required parameter $location_id when calling listPayments');
}
// parse inputs
$resourcePath = "/v1/{location_id}/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 ($order !== null) {
$queryParams['order'] = $this->apiClient->getSerializer()->toQueryValue($order);
}// 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 ($limit !== null) {
$queryParams['limit'] = $this->apiClient->getSerializer()->toQueryValue($limit);
}// query params
if ($batch_token !== null) {
$queryParams['batch_token'] = $this->apiClient->getSerializer()->toQueryValue($batch_token);
}// query params
if ($include_partial !== null) {
$queryParams['include_partial'] = $this->apiClient->getSerializer()->toQueryValue($include_partial);
}
// path params
if ($location_id !== null) {
$resourcePath = str_replace(
"{" . "location_id" . "}",
$this->apiClient->getSerializer()->toPathValue($location_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\V1Payment[]'
);
if (!$response) {
return array(null, $statusCode, $httpHeader);
}
return array(\SquareConnect\ObjectSerializer::deserialize($response, '\SquareConnect\Model\V1Payment[]', $httpHeader), $statusCode, $httpHeader);
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = \SquareConnect\ObjectSerializer::deserialize($e->getResponseBody(), '\SquareConnect\Model\V1Payment[]', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* listRefunds
*
* ListRefunds
*
* @param string $location_id The ID of the location to list refunds for. (required)
* @param string $order TThe order in which payments are listed in the response. (optional)
* @param string $begin_time The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year. (optional)
* @param string $end_time The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. (optional)
* @param int $limit The approximate number of refunds to return in a single response. Default: 100. Max: 200. Response may contain more results than the prescribed limit when refunds are made simultaneously to multiple tenders in a payment or when refunds are generated in an exchange to account for the value of returned goods. (optional)
* @param string $batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional)
* @return \SquareConnect\Model\V1Refund[]
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function listRefunds($location_id, $order = null, $begin_time = null, $end_time = null, $limit = null, $batch_token = null)
{
list($response, $statusCode, $httpHeader) = $this->listRefundsWithHttpInfo ($location_id, $order, $begin_time, $end_time, $limit, $batch_token);
return $response;
}
/**
* listRefundsWithHttpInfo
*
* ListRefunds
*
* @param string $location_id The ID of the location to list refunds for. (required)
* @param string $order TThe order in which payments are listed in the response. (optional)
* @param string $begin_time The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year. (optional)
* @param string $end_time The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. (optional)
* @param int $limit The approximate number of refunds to return in a single response. Default: 100. Max: 200. Response may contain more results than the prescribed limit when refunds are made simultaneously to multiple tenders in a payment or when refunds are generated in an exchange to account for the value of returned goods. (optional)
* @param string $batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional)
* @return Array of \SquareConnect\Model\V1Refund[], HTTP status code, HTTP response headers (array of strings)
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function listRefundsWithHttpInfo($location_id, $order = null, $begin_time = null, $end_time = null, $limit = null, $batch_token = null)
{
// verify the required parameter 'location_id' is set
if ($location_id === null) {
throw new \InvalidArgumentException('Missing the required parameter $location_id when calling listRefunds');
}
// parse inputs
$resourcePath = "/v1/{location_id}/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 ($order !== null) {
$queryParams['order'] = $this->apiClient->getSerializer()->toQueryValue($order);
}// 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 ($limit !== null) {
$queryParams['limit'] = $this->apiClient->getSerializer()->toQueryValue($limit);
}// query params
if ($batch_token !== null) {
$queryParams['batch_token'] = $this->apiClient->getSerializer()->toQueryValue($batch_token);
}
// path params
if ($location_id !== null) {
$resourcePath = str_replace(
"{" . "location_id" . "}",
$this->apiClient->getSerializer()->toPathValue($location_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\V1Refund[]'
);
if (!$response) {
return array(null, $statusCode, $httpHeader);
}
return array(\SquareConnect\ObjectSerializer::deserialize($response, '\SquareConnect\Model\V1Refund[]', $httpHeader), $statusCode, $httpHeader);
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = \SquareConnect\ObjectSerializer::deserialize($e->getResponseBody(), '\SquareConnect\Model\V1Refund[]', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* listSettlements
*
* ListSettlements
*
* @param string $location_id The ID of the location to list settlements for. If you specify me, this endpoint returns payments aggregated from all of the business's locations. (required)
* @param string $order TThe order in which payments are listed in the response. (optional)
* @param string $begin_time The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year. (optional)
* @param string $end_time The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. (optional)
* @param int $limit The maximum number of payments to return in a single response. This value cannot exceed 200. (optional)
* @param string $status Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED). (optional)
* @param string $batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional)
* @return \SquareConnect\Model\V1Settlement[]
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function listSettlements($location_id, $order = null, $begin_time = null, $end_time = null, $limit = null, $status = null, $batch_token = null)
{
list($response, $statusCode, $httpHeader) = $this->listSettlementsWithHttpInfo ($location_id, $order, $begin_time, $end_time, $limit, $status, $batch_token);
return $response;
}
/**
* listSettlementsWithHttpInfo
*
* ListSettlements
*
* @param string $location_id The ID of the location to list settlements for. If you specify me, this endpoint returns payments aggregated from all of the business's locations. (required)
* @param string $order TThe order in which payments are listed in the response. (optional)
* @param string $begin_time The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year. (optional)
* @param string $end_time The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. (optional)
* @param int $limit The maximum number of payments to return in a single response. This value cannot exceed 200. (optional)
* @param string $status Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED). (optional)
* @param string $batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional)
* @return Array of \SquareConnect\Model\V1Settlement[], HTTP status code, HTTP response headers (array of strings)
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function listSettlementsWithHttpInfo($location_id, $order = null, $begin_time = null, $end_time = null, $limit = null, $status = null, $batch_token = null)
{
// verify the required parameter 'location_id' is set
if ($location_id === null) {
throw new \InvalidArgumentException('Missing the required parameter $location_id when calling listSettlements');
}
// parse inputs
$resourcePath = "/v1/{location_id}/settlements";
$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 ($order !== null) {
$queryParams['order'] = $this->apiClient->getSerializer()->toQueryValue($order);
}// 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 ($limit !== null) {
$queryParams['limit'] = $this->apiClient->getSerializer()->toQueryValue($limit);
}// query params
if ($status !== null) {
$queryParams['status'] = $this->apiClient->getSerializer()->toQueryValue($status);
}// query params
if ($batch_token !== null) {
$queryParams['batch_token'] = $this->apiClient->getSerializer()->toQueryValue($batch_token);
}
// path params
if ($location_id !== null) {
$resourcePath = str_replace(
"{" . "location_id" . "}",
$this->apiClient->getSerializer()->toPathValue($location_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\V1Settlement[]'
);
if (!$response) {
return array(null, $statusCode, $httpHeader);
}
return array(\SquareConnect\ObjectSerializer::deserialize($response, '\SquareConnect\Model\V1Settlement[]', $httpHeader), $statusCode, $httpHeader);
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = \SquareConnect\ObjectSerializer::deserialize($e->getResponseBody(), '\SquareConnect\Model\V1Settlement[]', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* retrieveBankAccount
*
* RetrieveBankAccount
*
* @param string $location_id The ID of the bank account's associated location. (required)
* @param string $bank_account_id The bank account's Square-issued ID. You obtain this value from Settlement objects returned. (required)
* @return \SquareConnect\Model\V1BankAccount
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function retrieveBankAccount($location_id, $bank_account_id)
{
list($response, $statusCode, $httpHeader) = $this->retrieveBankAccountWithHttpInfo ($location_id, $bank_account_id);
return $response;
}
/**
* retrieveBankAccountWithHttpInfo
*
* RetrieveBankAccount
*
* @param string $location_id The ID of the bank account's associated location. (required)
* @param string $bank_account_id The bank account's Square-issued ID. You obtain this value from Settlement objects returned. (required)
* @return Array of \SquareConnect\Model\V1BankAccount, HTTP status code, HTTP response headers (array of strings)
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function retrieveBankAccountWithHttpInfo($location_id, $bank_account_id)
{
// verify the required parameter 'location_id' is set
if ($location_id === null) {
throw new \InvalidArgumentException('Missing the required parameter $location_id when calling retrieveBankAccount');
}
// verify the required parameter 'bank_account_id' is set
if ($bank_account_id === null) {
throw new \InvalidArgumentException('Missing the required parameter $bank_account_id when calling retrieveBankAccount');
}
// parse inputs
$resourcePath = "/v1/{location_id}/bank-accounts/{bank_account_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 ($location_id !== null) {
$resourcePath = str_replace(
"{" . "location_id" . "}",
$this->apiClient->getSerializer()->toPathValue($location_id),
$resourcePath
);
}// path params
if ($bank_account_id !== null) {
$resourcePath = str_replace(
"{" . "bank_account_id" . "}",
$this->apiClient->getSerializer()->toPathValue($bank_account_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\V1BankAccount'
);
if (!$response) {
return array(null, $statusCode, $httpHeader);
}
return array(\SquareConnect\ObjectSerializer::deserialize($response, '\SquareConnect\Model\V1BankAccount', $httpHeader), $statusCode, $httpHeader);
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = \SquareConnect\ObjectSerializer::deserialize($e->getResponseBody(), '\SquareConnect\Model\V1BankAccount', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* retrieveOrder
*
* RetrieveOrder
*
* @param string $location_id The ID of the order's associated location. (required)
* @param string $order_id The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint (required)
* @return \SquareConnect\Model\V1Order
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function retrieveOrder($location_id, $order_id)
{
list($response, $statusCode, $httpHeader) = $this->retrieveOrderWithHttpInfo ($location_id, $order_id);
return $response;
}
/**
* retrieveOrderWithHttpInfo
*
* RetrieveOrder
*
* @param string $location_id The ID of the order's associated location. (required)
* @param string $order_id The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint (required)
* @return Array of \SquareConnect\Model\V1Order, HTTP status code, HTTP response headers (array of strings)
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function retrieveOrderWithHttpInfo($location_id, $order_id)
{
// verify the required parameter 'location_id' is set
if ($location_id === null) {
throw new \InvalidArgumentException('Missing the required parameter $location_id when calling retrieveOrder');
}
// verify the required parameter 'order_id' is set
if ($order_id === null) {
throw new \InvalidArgumentException('Missing the required parameter $order_id when calling retrieveOrder');
}
// parse inputs
$resourcePath = "/v1/{location_id}/orders/{order_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 ($location_id !== null) {
$resourcePath = str_replace(
"{" . "location_id" . "}",
$this->apiClient->getSerializer()->toPathValue($location_id),
$resourcePath
);
}// path params
if ($order_id !== null) {
$resourcePath = str_replace(
"{" . "order_id" . "}",
$this->apiClient->getSerializer()->toPathValue($order_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\V1Order'
);
if (!$response) {
return array(null, $statusCode, $httpHeader);
}
return array(\SquareConnect\ObjectSerializer::deserialize($response, '\SquareConnect\Model\V1Order', $httpHeader), $statusCode, $httpHeader);
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = \SquareConnect\ObjectSerializer::deserialize($e->getResponseBody(), '\SquareConnect\Model\V1Order', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* retrievePayment
*
* RetrievePayment
*
* @param string $location_id The ID of the payment's associated location. (required)
* @param string $payment_id The Square-issued payment ID. payment_id comes from Payment objects returned by the List Payments endpoint, Settlement objects returned by the List Settlements endpoint, or Refund objects returned by the List Refunds endpoint. (required)
* @return \SquareConnect\Model\V1Payment
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function retrievePayment($location_id, $payment_id)
{
list($response, $statusCode, $httpHeader) = $this->retrievePaymentWithHttpInfo ($location_id, $payment_id);
return $response;
}
/**
* retrievePaymentWithHttpInfo
*
* RetrievePayment
*
* @param string $location_id The ID of the payment's associated location. (required)
* @param string $payment_id The Square-issued payment ID. payment_id comes from Payment objects returned by the List Payments endpoint, Settlement objects returned by the List Settlements endpoint, or Refund objects returned by the List Refunds endpoint. (required)
* @return Array of \SquareConnect\Model\V1Payment, HTTP status code, HTTP response headers (array of strings)
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function retrievePaymentWithHttpInfo($location_id, $payment_id)
{
// verify the required parameter 'location_id' is set
if ($location_id === null) {
throw new \InvalidArgumentException('Missing the required parameter $location_id when calling retrievePayment');
}
// verify the required parameter 'payment_id' is set
if ($payment_id === null) {
throw new \InvalidArgumentException('Missing the required parameter $payment_id when calling retrievePayment');
}
// parse inputs
$resourcePath = "/v1/{location_id}/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 ($location_id !== null) {
$resourcePath = str_replace(
"{" . "location_id" . "}",
$this->apiClient->getSerializer()->toPathValue($location_id),
$resourcePath
);
}// 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\V1Payment'
);
if (!$response) {
return array(null, $statusCode, $httpHeader);
}
return array(\SquareConnect\ObjectSerializer::deserialize($response, '\SquareConnect\Model\V1Payment', $httpHeader), $statusCode, $httpHeader);
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = \SquareConnect\ObjectSerializer::deserialize($e->getResponseBody(), '\SquareConnect\Model\V1Payment', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* retrieveSettlement
*
* RetrieveSettlement
*
* @param string $location_id The ID of the settlements's associated location. (required)
* @param string $settlement_id The settlement's Square-issued ID. You obtain this value from Settlement objects returned by the List Settlements endpoint. (required)
* @return \SquareConnect\Model\V1Settlement
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function retrieveSettlement($location_id, $settlement_id)
{
list($response, $statusCode, $httpHeader) = $this->retrieveSettlementWithHttpInfo ($location_id, $settlement_id);
return $response;
}
/**
* retrieveSettlementWithHttpInfo
*
* RetrieveSettlement
*
* @param string $location_id The ID of the settlements's associated location. (required)
* @param string $settlement_id The settlement's Square-issued ID. You obtain this value from Settlement objects returned by the List Settlements endpoint. (required)
* @return Array of \SquareConnect\Model\V1Settlement, HTTP status code, HTTP response headers (array of strings)
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function retrieveSettlementWithHttpInfo($location_id, $settlement_id)
{
// verify the required parameter 'location_id' is set
if ($location_id === null) {
throw new \InvalidArgumentException('Missing the required parameter $location_id when calling retrieveSettlement');
}
// verify the required parameter 'settlement_id' is set
if ($settlement_id === null) {
throw new \InvalidArgumentException('Missing the required parameter $settlement_id when calling retrieveSettlement');
}
// parse inputs
$resourcePath = "/v1/{location_id}/settlements/{settlement_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 ($location_id !== null) {
$resourcePath = str_replace(
"{" . "location_id" . "}",
$this->apiClient->getSerializer()->toPathValue($location_id),
$resourcePath
);
}// path params
if ($settlement_id !== null) {
$resourcePath = str_replace(
"{" . "settlement_id" . "}",
$this->apiClient->getSerializer()->toPathValue($settlement_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\V1Settlement'
);
if (!$response) {
return array(null, $statusCode, $httpHeader);
}
return array(\SquareConnect\ObjectSerializer::deserialize($response, '\SquareConnect\Model\V1Settlement', $httpHeader), $statusCode, $httpHeader);
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = \SquareConnect\ObjectSerializer::deserialize($e->getResponseBody(), '\SquareConnect\Model\V1Settlement', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* updateOrder
*
* UpdateOrder
*
* @param string $location_id The ID of the order's associated location. (required)
* @param string $order_id The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint (required)
* @param \SquareConnect\Model\V1UpdateOrderRequest $body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required)
* @return \SquareConnect\Model\V1Order
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function updateOrder($location_id, $order_id, $body)
{
list($response, $statusCode, $httpHeader) = $this->updateOrderWithHttpInfo ($location_id, $order_id, $body);
return $response;
}
/**
* updateOrderWithHttpInfo
*
* UpdateOrder
*
* @param string $location_id The ID of the order's associated location. (required)
* @param string $order_id The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint (required)
* @param \SquareConnect\Model\V1UpdateOrderRequest $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\V1Order, HTTP status code, HTTP response headers (array of strings)
* @throws \SquareConnect\ApiException on non-2xx response
*/
public function updateOrderWithHttpInfo($location_id, $order_id, $body)
{
// verify the required parameter 'location_id' is set
if ($location_id === null) {
throw new \InvalidArgumentException('Missing the required parameter $location_id when calling updateOrder');
}
// verify the required parameter 'order_id' is set
if ($order_id === null) {
throw new \InvalidArgumentException('Missing the required parameter $order_id when calling updateOrder');
}
// verify the required parameter 'body' is set
if ($body === null) {
throw new \InvalidArgumentException('Missing the required parameter $body when calling updateOrder');
}
// parse inputs
$resourcePath = "/v1/{location_id}/orders/{order_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 ($location_id !== null) {
$resourcePath = str_replace(
"{" . "location_id" . "}",
$this->apiClient->getSerializer()->toPathValue($location_id),
$resourcePath
);
}// path params
if ($order_id !== null) {
$resourcePath = str_replace(
"{" . "order_id" . "}",
$this->apiClient->getSerializer()->toPathValue($order_id),
$resourcePath
);
}
// 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, 'PUT',
$queryParams, $httpBody,
$headerParams, '\SquareConnect\Model\V1Order'
);
if (!$response) {
return array(null, $statusCode, $httpHeader);
}
return array(\SquareConnect\ObjectSerializer::deserialize($response, '\SquareConnect\Model\V1Order', $httpHeader), $statusCode, $httpHeader);
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = \SquareConnect\ObjectSerializer::deserialize($e->getResponseBody(), '\SquareConnect\Model\V1Order', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
throw $e;
}
}
}