com.squareup.connect.api.V1TransactionsApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of connect Show documentation
Show all versions of connect Show documentation
Java client library for the Square Connect API
package com.squareup.connect.api;
import com.squareup.connect.ApiException;
import com.squareup.connect.ApiClient;
import com.squareup.connect.Configuration;
import com.squareup.connect.Pair;
import com.squareup.connect.CompleteResponse;
import javax.ws.rs.core.GenericType;
import com.squareup.connect.models.V1BankAccount;
import com.squareup.connect.models.V1CreateRefundRequest;
import com.squareup.connect.models.V1Order;
import com.squareup.connect.models.V1Payment;
import com.squareup.connect.models.V1Refund;
import com.squareup.connect.models.V1Settlement;
import com.squareup.connect.models.V1UpdateOrderRequest;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class V1TransactionsApi {
private ApiClient apiClient;
public V1TransactionsApi() {
this(Configuration.getDefaultApiClient());
}
public V1TransactionsApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
public ApiClient getApiClient() {
return apiClient;
}
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* CreateRefund
* Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment. You cannot issue a partial refund for a split tender payment. You must instead issue a full or partial refund for a particular tender, by providing the applicable tender id to the V1CreateRefund endpoint. Issuing a full refund for a split tender payment refunds all tenders associated with the payment. Issuing a refund for a card payment is not reversible. For development purposes, you can create fake cash payments in Square Point of Sale and refund them.
* @param locationId The ID of the original payment's associated location. (required)
* @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required)
* @return V1Refund
* @throws ApiException if fails to make API call
*/
public V1Refund createRefund(String locationId, V1CreateRefundRequest body) throws ApiException {
Object localVarPostBody = body;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling createRefund");
}
// verify the required parameter 'body' is set
if (body == null) {
throw new ApiException(400, "Missing the required parameter 'body' when calling createRefund");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/refunds"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.put("Square-Version", "2019-03-27");
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType localVarReturnType = new GenericType() {};
CompleteResponse completeResponse = (CompleteResponse)apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
return completeResponse.getData();
}
/**
* CreateRefund
* Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment. You cannot issue a partial refund for a split tender payment. You must instead issue a full or partial refund for a particular tender, by providing the applicable tender id to the V1CreateRefund endpoint. Issuing a full refund for a split tender payment refunds all tenders associated with the payment. Issuing a refund for a card payment is not reversible. For development purposes, you can create fake cash payments in Square Point of Sale and refund them.
* @param locationId The ID of the original payment's associated location. (required)
* @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required)
* @return CompleteResponse
* @throws ApiException if fails to make API call
*/
public CompleteResponsecreateRefundWithHttpInfo(String locationId, V1CreateRefundRequest body) throws ApiException {
Object localVarPostBody = body;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling createRefund");
}
// verify the required parameter 'body' is set
if (body == null) {
throw new ApiException(400, "Missing the required parameter 'body' when calling createRefund");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/refunds"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType localVarReturnType = new GenericType() {};
return (CompleteResponse)apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* ListBankAccounts
* Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.
* @param locationId The ID of the location to list bank accounts for. (required)
* @return List<V1BankAccount>
* @throws ApiException if fails to make API call
*/
public List listBankAccounts(String locationId) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling listBankAccounts");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/bank-accounts"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.put("Square-Version", "2019-03-27");
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType> localVarReturnType = new GenericType>() {};
CompleteResponse> completeResponse = (CompleteResponse>)apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
return completeResponse.getData();
}
/**
* ListBankAccounts
* Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.
* @param locationId The ID of the location to list bank accounts for. (required)
* @return CompleteResponse>
* @throws ApiException if fails to make API call
*/
public CompleteResponse>listBankAccountsWithHttpInfo(String locationId) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling listBankAccounts");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/bank-accounts"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType> localVarReturnType = new GenericType>() {};
return (CompleteResponse>)apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* ListOrders
* Provides summary information for a merchant's online store orders.
* @param locationId The ID of the location to list online store orders for. (required)
* @param order TThe order in which payments are listed in the response. (optional)
* @param limit The maximum number of payments to return in a single response. This value cannot exceed 200. (optional)
* @param batchToken A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional)
* @return List<V1Order>
* @throws ApiException if fails to make API call
*/
public List listOrders(String locationId, String order, Integer limit, String batchToken) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling listOrders");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/orders"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.put("Square-Version", "2019-03-27");
localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "batch_token", batchToken));
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType> localVarReturnType = new GenericType>() {};
CompleteResponse> completeResponse = (CompleteResponse>)apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
return completeResponse.getData();
}
/**
* ListOrders
* Provides summary information for a merchant's online store orders.
* @param locationId The ID of the location to list online store orders for. (required)
* @param order TThe order in which payments are listed in the response. (optional)
* @param limit The maximum number of payments to return in a single response. This value cannot exceed 200. (optional)
* @param batchToken A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional)
* @return CompleteResponse>
* @throws ApiException if fails to make API call
*/
public CompleteResponse>listOrdersWithHttpInfo(String locationId, String order, Integer limit, String batchToken) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling listOrders");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/orders"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "batch_token", batchToken));
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType> localVarReturnType = new GenericType>() {};
return (CompleteResponse>)apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* ListPayments
* Provides summary information for all payments taken for a given Square account during a date range. Date ranges cannot exceed 1 year in length. See Date ranges for details of inclusive and exclusive dates. *Note**: Details for payments processed with Square Point of Sale while in offline mode may not be transmitted to Square for up to 72 hours. Offline payments have a `created_at` value that reflects the time the payment was originally processed, not the time it was subsequently transmitted to Square. Consequently, the ListPayments endpoint might list an offline payment chronologically between online payments that were seen in a previous request.
* @param locationId 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 order The order in which payments are listed in the response. (optional)
* @param beginTime 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 endTime 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 limit The maximum number of payments to return in a single response. This value cannot exceed 200. (optional)
* @param batchToken A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional)
* @param includePartial 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 List<V1Payment>
* @throws ApiException if fails to make API call
*/
public List listPayments(String locationId, String order, String beginTime, String endTime, Integer limit, String batchToken, Boolean includePartial) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling listPayments");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/payments"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.put("Square-Version", "2019-03-27");
localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "batch_token", batchToken));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "include_partial", includePartial));
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType> localVarReturnType = new GenericType>() {};
CompleteResponse> completeResponse = (CompleteResponse>)apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
return completeResponse.getData();
}
/**
* ListPayments
* Provides summary information for all payments taken for a given Square account during a date range. Date ranges cannot exceed 1 year in length. See Date ranges for details of inclusive and exclusive dates. *Note**: Details for payments processed with Square Point of Sale while in offline mode may not be transmitted to Square for up to 72 hours. Offline payments have a `created_at` value that reflects the time the payment was originally processed, not the time it was subsequently transmitted to Square. Consequently, the ListPayments endpoint might list an offline payment chronologically between online payments that were seen in a previous request.
* @param locationId 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 order The order in which payments are listed in the response. (optional)
* @param beginTime 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 endTime 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 limit The maximum number of payments to return in a single response. This value cannot exceed 200. (optional)
* @param batchToken A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional)
* @param includePartial 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 CompleteResponse>
* @throws ApiException if fails to make API call
*/
public CompleteResponse>listPaymentsWithHttpInfo(String locationId, String order, String beginTime, String endTime, Integer limit, String batchToken, Boolean includePartial) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling listPayments");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/payments"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "batch_token", batchToken));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "include_partial", includePartial));
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType> localVarReturnType = new GenericType>() {};
return (CompleteResponse>)apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* ListRefunds
* Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length.
* @param locationId The ID of the location to list refunds for. (required)
* @param order TThe order in which payments are listed in the response. (optional)
* @param beginTime 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 endTime 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 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 batchToken A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional)
* @return List<V1Refund>
* @throws ApiException if fails to make API call
*/
public List listRefunds(String locationId, String order, String beginTime, String endTime, Integer limit, String batchToken) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling listRefunds");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/refunds"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.put("Square-Version", "2019-03-27");
localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "batch_token", batchToken));
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType> localVarReturnType = new GenericType>() {};
CompleteResponse> completeResponse = (CompleteResponse>)apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
return completeResponse.getData();
}
/**
* ListRefunds
* Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length.
* @param locationId The ID of the location to list refunds for. (required)
* @param order TThe order in which payments are listed in the response. (optional)
* @param beginTime 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 endTime 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 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 batchToken A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional)
* @return CompleteResponse>
* @throws ApiException if fails to make API call
*/
public CompleteResponse>listRefundsWithHttpInfo(String locationId, String order, String beginTime, String endTime, Integer limit, String batchToken) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling listRefunds");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/refunds"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "batch_token", batchToken));
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType> localVarReturnType = new GenericType>() {};
return (CompleteResponse>)apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* ListSettlements
* Provides summary information for all deposits and withdrawals initiated by Square to a linked bank account during a date range. Date ranges cannot exceed one year in length. *Note**: the ListSettlements endpoint does not provide entry information.
* @param locationId 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 order TThe order in which payments are listed in the response. (optional)
* @param beginTime 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 endTime 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 limit The maximum number of payments to return in a single response. This value cannot exceed 200. (optional)
* @param status Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED). (optional)
* @param batchToken A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional)
* @return List<V1Settlement>
* @throws ApiException if fails to make API call
*/
public List listSettlements(String locationId, String order, String beginTime, String endTime, Integer limit, String status, String batchToken) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling listSettlements");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/settlements"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.put("Square-Version", "2019-03-27");
localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "status", status));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "batch_token", batchToken));
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType> localVarReturnType = new GenericType>() {};
CompleteResponse> completeResponse = (CompleteResponse>)apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
return completeResponse.getData();
}
/**
* ListSettlements
* Provides summary information for all deposits and withdrawals initiated by Square to a linked bank account during a date range. Date ranges cannot exceed one year in length. *Note**: the ListSettlements endpoint does not provide entry information.
* @param locationId 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 order TThe order in which payments are listed in the response. (optional)
* @param beginTime 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 endTime 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 limit The maximum number of payments to return in a single response. This value cannot exceed 200. (optional)
* @param status Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED). (optional)
* @param batchToken A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional)
* @return CompleteResponse>
* @throws ApiException if fails to make API call
*/
public CompleteResponse>listSettlementsWithHttpInfo(String locationId, String order, String beginTime, String endTime, Integer limit, String status, String batchToken) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling listSettlements");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/settlements"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "status", status));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "batch_token", batchToken));
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType> localVarReturnType = new GenericType>() {};
return (CompleteResponse>)apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* RetrieveBankAccount
* Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.
* @param locationId The ID of the bank account's associated location. (required)
* @param bankAccountId The bank account's Square-issued ID. You obtain this value from Settlement objects returned. (required)
* @return V1BankAccount
* @throws ApiException if fails to make API call
*/
public V1BankAccount retrieveBankAccount(String locationId, String bankAccountId) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling retrieveBankAccount");
}
// verify the required parameter 'bankAccountId' is set
if (bankAccountId == null) {
throw new ApiException(400, "Missing the required parameter 'bankAccountId' when calling retrieveBankAccount");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/bank-accounts/{bank_account_id}"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()))
.replaceAll("\\{" + "bank_account_id" + "\\}", apiClient.escapeString(bankAccountId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.put("Square-Version", "2019-03-27");
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType localVarReturnType = new GenericType() {};
CompleteResponse completeResponse = (CompleteResponse)apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
return completeResponse.getData();
}
/**
* RetrieveBankAccount
* Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.
* @param locationId The ID of the bank account's associated location. (required)
* @param bankAccountId The bank account's Square-issued ID. You obtain this value from Settlement objects returned. (required)
* @return CompleteResponse
* @throws ApiException if fails to make API call
*/
public CompleteResponseretrieveBankAccountWithHttpInfo(String locationId, String bankAccountId) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling retrieveBankAccount");
}
// verify the required parameter 'bankAccountId' is set
if (bankAccountId == null) {
throw new ApiException(400, "Missing the required parameter 'bankAccountId' when calling retrieveBankAccount");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/bank-accounts/{bank_account_id}"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()))
.replaceAll("\\{" + "bank_account_id" + "\\}", apiClient.escapeString(bankAccountId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType localVarReturnType = new GenericType() {};
return (CompleteResponse)apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* RetrieveOrder
* Provides comprehensive information for a single online store order, including the order's history.
* @param locationId The ID of the order's associated location. (required)
* @param orderId The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint (required)
* @return V1Order
* @throws ApiException if fails to make API call
*/
public V1Order retrieveOrder(String locationId, String orderId) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling retrieveOrder");
}
// verify the required parameter 'orderId' is set
if (orderId == null) {
throw new ApiException(400, "Missing the required parameter 'orderId' when calling retrieveOrder");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/orders/{order_id}"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()))
.replaceAll("\\{" + "order_id" + "\\}", apiClient.escapeString(orderId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.put("Square-Version", "2019-03-27");
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType localVarReturnType = new GenericType() {};
CompleteResponse completeResponse = (CompleteResponse)apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
return completeResponse.getData();
}
/**
* RetrieveOrder
* Provides comprehensive information for a single online store order, including the order's history.
* @param locationId The ID of the order's associated location. (required)
* @param orderId The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint (required)
* @return CompleteResponse
* @throws ApiException if fails to make API call
*/
public CompleteResponseretrieveOrderWithHttpInfo(String locationId, String orderId) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling retrieveOrder");
}
// verify the required parameter 'orderId' is set
if (orderId == null) {
throw new ApiException(400, "Missing the required parameter 'orderId' when calling retrieveOrder");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/orders/{order_id}"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()))
.replaceAll("\\{" + "order_id" + "\\}", apiClient.escapeString(orderId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType localVarReturnType = new GenericType() {};
return (CompleteResponse)apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* RetrievePayment
* Provides comprehensive information for a single payment.
* @param locationId The ID of the payment's associated location. (required)
* @param paymentId 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 V1Payment
* @throws ApiException if fails to make API call
*/
public V1Payment retrievePayment(String locationId, String paymentId) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling retrievePayment");
}
// verify the required parameter 'paymentId' is set
if (paymentId == null) {
throw new ApiException(400, "Missing the required parameter 'paymentId' when calling retrievePayment");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/payments/{payment_id}"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()))
.replaceAll("\\{" + "payment_id" + "\\}", apiClient.escapeString(paymentId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.put("Square-Version", "2019-03-27");
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType localVarReturnType = new GenericType() {};
CompleteResponse completeResponse = (CompleteResponse)apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
return completeResponse.getData();
}
/**
* RetrievePayment
* Provides comprehensive information for a single payment.
* @param locationId The ID of the payment's associated location. (required)
* @param paymentId 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 CompleteResponse
* @throws ApiException if fails to make API call
*/
public CompleteResponseretrievePaymentWithHttpInfo(String locationId, String paymentId) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling retrievePayment");
}
// verify the required parameter 'paymentId' is set
if (paymentId == null) {
throw new ApiException(400, "Missing the required parameter 'paymentId' when calling retrievePayment");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/payments/{payment_id}"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()))
.replaceAll("\\{" + "payment_id" + "\\}", apiClient.escapeString(paymentId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType localVarReturnType = new GenericType() {};
return (CompleteResponse)apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* RetrieveSettlement
* Provides comprehensive information for a single settlement. The returned `Settlement` objects include an `entries` field that lists the transactions that contribute to the settlement total. Most settlement entries correspond to a payment payout, but settlement entries are also generated for less common events, like refunds, manual adjustments, or chargeback holds. Square initiates its regular deposits as indicated in the [Deposit Options with Square](https://squareup.com/help/us/en/article/3807) help article. Details for a regular deposit are usually not available from Connect API endpoints before 10 p.m. PST the same day. Square does not know when an initiated settlement **completes**, only whether it has failed. A completed settlement is typically reflected in a bank account within 3 business days, but in exceptional cases it may take longer.
* @param locationId The ID of the settlements's associated location. (required)
* @param settlementId The settlement's Square-issued ID. You obtain this value from Settlement objects returned by the List Settlements endpoint. (required)
* @return V1Settlement
* @throws ApiException if fails to make API call
*/
public V1Settlement retrieveSettlement(String locationId, String settlementId) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling retrieveSettlement");
}
// verify the required parameter 'settlementId' is set
if (settlementId == null) {
throw new ApiException(400, "Missing the required parameter 'settlementId' when calling retrieveSettlement");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/settlements/{settlement_id}"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()))
.replaceAll("\\{" + "settlement_id" + "\\}", apiClient.escapeString(settlementId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.put("Square-Version", "2019-03-27");
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType localVarReturnType = new GenericType() {};
CompleteResponse completeResponse = (CompleteResponse)apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
return completeResponse.getData();
}
/**
* RetrieveSettlement
* Provides comprehensive information for a single settlement. The returned `Settlement` objects include an `entries` field that lists the transactions that contribute to the settlement total. Most settlement entries correspond to a payment payout, but settlement entries are also generated for less common events, like refunds, manual adjustments, or chargeback holds. Square initiates its regular deposits as indicated in the [Deposit Options with Square](https://squareup.com/help/us/en/article/3807) help article. Details for a regular deposit are usually not available from Connect API endpoints before 10 p.m. PST the same day. Square does not know when an initiated settlement **completes**, only whether it has failed. A completed settlement is typically reflected in a bank account within 3 business days, but in exceptional cases it may take longer.
* @param locationId The ID of the settlements's associated location. (required)
* @param settlementId The settlement's Square-issued ID. You obtain this value from Settlement objects returned by the List Settlements endpoint. (required)
* @return CompleteResponse
* @throws ApiException if fails to make API call
*/
public CompleteResponseretrieveSettlementWithHttpInfo(String locationId, String settlementId) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling retrieveSettlement");
}
// verify the required parameter 'settlementId' is set
if (settlementId == null) {
throw new ApiException(400, "Missing the required parameter 'settlementId' when calling retrieveSettlement");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/settlements/{settlement_id}"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()))
.replaceAll("\\{" + "settlement_id" + "\\}", apiClient.escapeString(settlementId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType localVarReturnType = new GenericType() {};
return (CompleteResponse)apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* UpdateOrder
* Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:
* @param locationId The ID of the order's associated location. (required)
* @param orderId The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint (required)
* @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required)
* @return V1Order
* @throws ApiException if fails to make API call
*/
public V1Order updateOrder(String locationId, String orderId, V1UpdateOrderRequest body) throws ApiException {
Object localVarPostBody = body;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling updateOrder");
}
// verify the required parameter 'orderId' is set
if (orderId == null) {
throw new ApiException(400, "Missing the required parameter 'orderId' when calling updateOrder");
}
// verify the required parameter 'body' is set
if (body == null) {
throw new ApiException(400, "Missing the required parameter 'body' when calling updateOrder");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/orders/{order_id}"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()))
.replaceAll("\\{" + "order_id" + "\\}", apiClient.escapeString(orderId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.put("Square-Version", "2019-03-27");
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType localVarReturnType = new GenericType() {};
CompleteResponse completeResponse = (CompleteResponse)apiClient.invokeAPI(localVarPath, "PUT", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
return completeResponse.getData();
}
/**
* UpdateOrder
* Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:
* @param locationId The ID of the order's associated location. (required)
* @param orderId The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint (required)
* @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required)
* @return CompleteResponse
* @throws ApiException if fails to make API call
*/
public CompleteResponseupdateOrderWithHttpInfo(String locationId, String orderId, V1UpdateOrderRequest body) throws ApiException {
Object localVarPostBody = body;
// verify the required parameter 'locationId' is set
if (locationId == null) {
throw new ApiException(400, "Missing the required parameter 'locationId' when calling updateOrder");
}
// verify the required parameter 'orderId' is set
if (orderId == null) {
throw new ApiException(400, "Missing the required parameter 'orderId' when calling updateOrder");
}
// verify the required parameter 'body' is set
if (body == null) {
throw new ApiException(400, "Missing the required parameter 'body' when calling updateOrder");
}
// create path and map variables
String localVarPath = "/v1/{location_id}/orders/{order_id}"
.replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString()))
.replaceAll("\\{" + "order_id" + "\\}", apiClient.escapeString(orderId.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "oauth2" };
GenericType localVarReturnType = new GenericType() {};
return (CompleteResponse)apiClient.invokeAPI(localVarPath, "PUT", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
}