com.squareup.square.legacy.api.DefaultTerminalApi Maven / Gradle / Ivy
package com.squareup.square.legacy.api;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.squareup.square.legacy.ApiHelper;
import com.squareup.square.legacy.Server;
import com.squareup.square.legacy.exceptions.ApiException;
import com.squareup.square.legacy.http.client.HttpContext;
import com.squareup.square.legacy.http.request.HttpMethod;
import com.squareup.square.legacy.models.CancelTerminalActionResponse;
import com.squareup.square.legacy.models.CancelTerminalCheckoutResponse;
import com.squareup.square.legacy.models.CancelTerminalRefundResponse;
import com.squareup.square.legacy.models.CreateTerminalActionRequest;
import com.squareup.square.legacy.models.CreateTerminalActionResponse;
import com.squareup.square.legacy.models.CreateTerminalCheckoutRequest;
import com.squareup.square.legacy.models.CreateTerminalCheckoutResponse;
import com.squareup.square.legacy.models.CreateTerminalRefundRequest;
import com.squareup.square.legacy.models.CreateTerminalRefundResponse;
import com.squareup.square.legacy.models.DismissTerminalActionResponse;
import com.squareup.square.legacy.models.DismissTerminalCheckoutResponse;
import com.squareup.square.legacy.models.DismissTerminalRefundResponse;
import com.squareup.square.legacy.models.GetTerminalActionResponse;
import com.squareup.square.legacy.models.GetTerminalCheckoutResponse;
import com.squareup.square.legacy.models.GetTerminalRefundResponse;
import com.squareup.square.legacy.models.SearchTerminalActionsRequest;
import com.squareup.square.legacy.models.SearchTerminalActionsResponse;
import com.squareup.square.legacy.models.SearchTerminalCheckoutsRequest;
import com.squareup.square.legacy.models.SearchTerminalCheckoutsResponse;
import com.squareup.square.legacy.models.SearchTerminalRefundsRequest;
import com.squareup.square.legacy.models.SearchTerminalRefundsResponse;
import io.apimatic.core.ApiCall;
import io.apimatic.core.GlobalConfiguration;
import java.io.IOException;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionException;
/**
* This class lists all the endpoints of the groups.
*/
public final class DefaultTerminalApi extends BaseApi implements TerminalApi {
/**
* Initializes the controller.
* @param globalConfig Configurations added in client.
*/
public DefaultTerminalApi(GlobalConfiguration globalConfig) {
super(globalConfig);
}
/**
* Creates a Terminal action request and sends it to the specified device.
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the CreateTerminalActionResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
public CreateTerminalActionResponse createTerminalAction(final CreateTerminalActionRequest body)
throws ApiException, IOException {
return prepareCreateTerminalActionRequest(body).execute();
}
/**
* Creates a Terminal action request and sends it to the specified device.
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the CreateTerminalActionResponse response from the API call
*/
public CompletableFuture createTerminalActionAsync(
final CreateTerminalActionRequest body) {
try {
return prepareCreateTerminalActionRequest(body).executeAsync();
} catch (Exception e) {
throw new CompletionException(e);
}
}
/**
* Builds the ApiCall object for createTerminalAction.
*/
private ApiCall prepareCreateTerminalActionRequest(
final CreateTerminalActionRequest body) throws JsonProcessingException, IOException {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
.server(Server.ENUM_DEFAULT.value())
.path("/v2/terminals/actions")
.bodyParam(param -> param.value(body))
.bodySerializer(() -> ApiHelper.serialize(body))
.headerParam(param -> param.key("Content-Type")
.value("application/json")
.isRequired(false))
.headerParam(param -> param.key("accept").value("application/json"))
.withAuth(auth -> auth.add("global"))
.httpMethod(HttpMethod.POST))
.responseHandler(responseHandler -> responseHandler
.deserializer(response -> ApiHelper.deserialize(response, CreateTerminalActionResponse.class))
.nullify404(false)
.contextInitializer((context, result) -> result.toBuilder()
.httpContext((HttpContext) context)
.build())
.globalErrorCase(GLOBAL_ERROR_CASES))
.build();
}
/**
* Retrieves a filtered list of Terminal action requests created by the account making the
* request. Terminal action requests are available for 30 days.
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the SearchTerminalActionsResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
public SearchTerminalActionsResponse searchTerminalActions(final SearchTerminalActionsRequest body)
throws ApiException, IOException {
return prepareSearchTerminalActionsRequest(body).execute();
}
/**
* Retrieves a filtered list of Terminal action requests created by the account making the
* request. Terminal action requests are available for 30 days.
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the SearchTerminalActionsResponse response from the API call
*/
public CompletableFuture searchTerminalActionsAsync(
final SearchTerminalActionsRequest body) {
try {
return prepareSearchTerminalActionsRequest(body).executeAsync();
} catch (Exception e) {
throw new CompletionException(e);
}
}
/**
* Builds the ApiCall object for searchTerminalActions.
*/
private ApiCall prepareSearchTerminalActionsRequest(
final SearchTerminalActionsRequest body) throws JsonProcessingException, IOException {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
.server(Server.ENUM_DEFAULT.value())
.path("/v2/terminals/actions/search")
.bodyParam(param -> param.value(body))
.bodySerializer(() -> ApiHelper.serialize(body))
.headerParam(param -> param.key("Content-Type")
.value("application/json")
.isRequired(false))
.headerParam(param -> param.key("accept").value("application/json"))
.withAuth(auth -> auth.add("global"))
.httpMethod(HttpMethod.POST))
.responseHandler(responseHandler -> responseHandler
.deserializer(response -> ApiHelper.deserialize(response, SearchTerminalActionsResponse.class))
.nullify404(false)
.contextInitializer((context, result) -> result.toBuilder()
.httpContext((HttpContext) context)
.build())
.globalErrorCase(GLOBAL_ERROR_CASES))
.build();
}
/**
* Retrieves a Terminal action request by `action_id`. Terminal action requests are available
* for 30 days.
* @param actionId Required parameter: Unique ID for the desired `TerminalAction`.
* @return Returns the GetTerminalActionResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
public GetTerminalActionResponse getTerminalAction(final String actionId) throws ApiException, IOException {
return prepareGetTerminalActionRequest(actionId).execute();
}
/**
* Retrieves a Terminal action request by `action_id`. Terminal action requests are available
* for 30 days.
* @param actionId Required parameter: Unique ID for the desired `TerminalAction`.
* @return Returns the GetTerminalActionResponse response from the API call
*/
public CompletableFuture getTerminalActionAsync(final String actionId) {
try {
return prepareGetTerminalActionRequest(actionId).executeAsync();
} catch (Exception e) {
throw new CompletionException(e);
}
}
/**
* Builds the ApiCall object for getTerminalAction.
*/
private ApiCall prepareGetTerminalActionRequest(final String actionId)
throws IOException {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
.server(Server.ENUM_DEFAULT.value())
.path("/v2/terminals/actions/{action_id}")
.templateParam(
param -> param.key("action_id").value(actionId).shouldEncode(true))
.headerParam(param -> param.key("accept").value("application/json"))
.withAuth(auth -> auth.add("global"))
.httpMethod(HttpMethod.GET))
.responseHandler(responseHandler -> responseHandler
.deserializer(response -> ApiHelper.deserialize(response, GetTerminalActionResponse.class))
.nullify404(false)
.contextInitializer((context, result) -> result.toBuilder()
.httpContext((HttpContext) context)
.build())
.globalErrorCase(GLOBAL_ERROR_CASES))
.build();
}
/**
* Cancels a Terminal action request if the status of the request permits it.
* @param actionId Required parameter: Unique ID for the desired `TerminalAction`.
* @return Returns the CancelTerminalActionResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
public CancelTerminalActionResponse cancelTerminalAction(final String actionId) throws ApiException, IOException {
return prepareCancelTerminalActionRequest(actionId).execute();
}
/**
* Cancels a Terminal action request if the status of the request permits it.
* @param actionId Required parameter: Unique ID for the desired `TerminalAction`.
* @return Returns the CancelTerminalActionResponse response from the API call
*/
public CompletableFuture cancelTerminalActionAsync(final String actionId) {
try {
return prepareCancelTerminalActionRequest(actionId).executeAsync();
} catch (Exception e) {
throw new CompletionException(e);
}
}
/**
* Builds the ApiCall object for cancelTerminalAction.
*/
private ApiCall prepareCancelTerminalActionRequest(
final String actionId) throws IOException {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
.server(Server.ENUM_DEFAULT.value())
.path("/v2/terminals/actions/{action_id}/cancel")
.templateParam(
param -> param.key("action_id").value(actionId).shouldEncode(true))
.headerParam(param -> param.key("accept").value("application/json"))
.withAuth(auth -> auth.add("global"))
.httpMethod(HttpMethod.POST))
.responseHandler(responseHandler -> responseHandler
.deserializer(response -> ApiHelper.deserialize(response, CancelTerminalActionResponse.class))
.nullify404(false)
.contextInitializer((context, result) -> result.toBuilder()
.httpContext((HttpContext) context)
.build())
.globalErrorCase(GLOBAL_ERROR_CASES))
.build();
}
/**
* Dismisses a Terminal action request if the status and type of the request permits it. See
* [Link and Dismiss
* Actions](https://developer.squareup.com/docs/terminal-api/advanced-features/custom-workflows/link-and-dismiss-actions)
* for more details.
* @param actionId Required parameter: Unique ID for the `TerminalAction` associated with the
* action to be dismissed.
* @return Returns the DismissTerminalActionResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
public DismissTerminalActionResponse dismissTerminalAction(final String actionId) throws ApiException, IOException {
return prepareDismissTerminalActionRequest(actionId).execute();
}
/**
* Dismisses a Terminal action request if the status and type of the request permits it. See
* [Link and Dismiss
* Actions](https://developer.squareup.com/docs/terminal-api/advanced-features/custom-workflows/link-and-dismiss-actions)
* for more details.
* @param actionId Required parameter: Unique ID for the `TerminalAction` associated with the
* action to be dismissed.
* @return Returns the DismissTerminalActionResponse response from the API call
*/
public CompletableFuture dismissTerminalActionAsync(final String actionId) {
try {
return prepareDismissTerminalActionRequest(actionId).executeAsync();
} catch (Exception e) {
throw new CompletionException(e);
}
}
/**
* Builds the ApiCall object for dismissTerminalAction.
*/
private ApiCall prepareDismissTerminalActionRequest(
final String actionId) throws IOException {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
.server(Server.ENUM_DEFAULT.value())
.path("/v2/terminals/actions/{action_id}/dismiss")
.templateParam(
param -> param.key("action_id").value(actionId).shouldEncode(true))
.headerParam(param -> param.key("accept").value("application/json"))
.withAuth(auth -> auth.add("global"))
.httpMethod(HttpMethod.POST))
.responseHandler(responseHandler -> responseHandler
.deserializer(response -> ApiHelper.deserialize(response, DismissTerminalActionResponse.class))
.nullify404(false)
.contextInitializer((context, result) -> result.toBuilder()
.httpContext((HttpContext) context)
.build())
.globalErrorCase(GLOBAL_ERROR_CASES))
.build();
}
/**
* Creates a Terminal checkout request and sends it to the specified device to take a payment
* for the requested amount.
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the CreateTerminalCheckoutResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
public CreateTerminalCheckoutResponse createTerminalCheckout(final CreateTerminalCheckoutRequest body)
throws ApiException, IOException {
return prepareCreateTerminalCheckoutRequest(body).execute();
}
/**
* Creates a Terminal checkout request and sends it to the specified device to take a payment
* for the requested amount.
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the CreateTerminalCheckoutResponse response from the API call
*/
public CompletableFuture createTerminalCheckoutAsync(
final CreateTerminalCheckoutRequest body) {
try {
return prepareCreateTerminalCheckoutRequest(body).executeAsync();
} catch (Exception e) {
throw new CompletionException(e);
}
}
/**
* Builds the ApiCall object for createTerminalCheckout.
*/
private ApiCall prepareCreateTerminalCheckoutRequest(
final CreateTerminalCheckoutRequest body) throws JsonProcessingException, IOException {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
.server(Server.ENUM_DEFAULT.value())
.path("/v2/terminals/checkouts")
.bodyParam(param -> param.value(body))
.bodySerializer(() -> ApiHelper.serialize(body))
.headerParam(param -> param.key("Content-Type")
.value("application/json")
.isRequired(false))
.headerParam(param -> param.key("accept").value("application/json"))
.withAuth(auth -> auth.add("global"))
.httpMethod(HttpMethod.POST))
.responseHandler(responseHandler -> responseHandler
.deserializer(response -> ApiHelper.deserialize(response, CreateTerminalCheckoutResponse.class))
.nullify404(false)
.contextInitializer((context, result) -> result.toBuilder()
.httpContext((HttpContext) context)
.build())
.globalErrorCase(GLOBAL_ERROR_CASES))
.build();
}
/**
* Returns a filtered list of Terminal checkout requests created by the application making the
* request. Only Terminal checkout requests created for the merchant scoped to the OAuth token
* are returned. Terminal checkout requests are available for 30 days.
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the SearchTerminalCheckoutsResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
public SearchTerminalCheckoutsResponse searchTerminalCheckouts(final SearchTerminalCheckoutsRequest body)
throws ApiException, IOException {
return prepareSearchTerminalCheckoutsRequest(body).execute();
}
/**
* Returns a filtered list of Terminal checkout requests created by the application making the
* request. Only Terminal checkout requests created for the merchant scoped to the OAuth token
* are returned. Terminal checkout requests are available for 30 days.
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the SearchTerminalCheckoutsResponse response from the API call
*/
public CompletableFuture searchTerminalCheckoutsAsync(
final SearchTerminalCheckoutsRequest body) {
try {
return prepareSearchTerminalCheckoutsRequest(body).executeAsync();
} catch (Exception e) {
throw new CompletionException(e);
}
}
/**
* Builds the ApiCall object for searchTerminalCheckouts.
*/
private ApiCall prepareSearchTerminalCheckoutsRequest(
final SearchTerminalCheckoutsRequest body) throws JsonProcessingException, IOException {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
.server(Server.ENUM_DEFAULT.value())
.path("/v2/terminals/checkouts/search")
.bodyParam(param -> param.value(body))
.bodySerializer(() -> ApiHelper.serialize(body))
.headerParam(param -> param.key("Content-Type")
.value("application/json")
.isRequired(false))
.headerParam(param -> param.key("accept").value("application/json"))
.withAuth(auth -> auth.add("global"))
.httpMethod(HttpMethod.POST))
.responseHandler(responseHandler -> responseHandler
.deserializer(
response -> ApiHelper.deserialize(response, SearchTerminalCheckoutsResponse.class))
.nullify404(false)
.contextInitializer((context, result) -> result.toBuilder()
.httpContext((HttpContext) context)
.build())
.globalErrorCase(GLOBAL_ERROR_CASES))
.build();
}
/**
* Retrieves a Terminal checkout request by `checkout_id`. Terminal checkout requests are
* available for 30 days.
* @param checkoutId Required parameter: The unique ID for the desired `TerminalCheckout`.
* @return Returns the GetTerminalCheckoutResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
public GetTerminalCheckoutResponse getTerminalCheckout(final String checkoutId) throws ApiException, IOException {
return prepareGetTerminalCheckoutRequest(checkoutId).execute();
}
/**
* Retrieves a Terminal checkout request by `checkout_id`. Terminal checkout requests are
* available for 30 days.
* @param checkoutId Required parameter: The unique ID for the desired `TerminalCheckout`.
* @return Returns the GetTerminalCheckoutResponse response from the API call
*/
public CompletableFuture getTerminalCheckoutAsync(final String checkoutId) {
try {
return prepareGetTerminalCheckoutRequest(checkoutId).executeAsync();
} catch (Exception e) {
throw new CompletionException(e);
}
}
/**
* Builds the ApiCall object for getTerminalCheckout.
*/
private ApiCall prepareGetTerminalCheckoutRequest(
final String checkoutId) throws IOException {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
.server(Server.ENUM_DEFAULT.value())
.path("/v2/terminals/checkouts/{checkout_id}")
.templateParam(param ->
param.key("checkout_id").value(checkoutId).shouldEncode(true))
.headerParam(param -> param.key("accept").value("application/json"))
.withAuth(auth -> auth.add("global"))
.httpMethod(HttpMethod.GET))
.responseHandler(responseHandler -> responseHandler
.deserializer(response -> ApiHelper.deserialize(response, GetTerminalCheckoutResponse.class))
.nullify404(false)
.contextInitializer((context, result) -> result.toBuilder()
.httpContext((HttpContext) context)
.build())
.globalErrorCase(GLOBAL_ERROR_CASES))
.build();
}
/**
* Cancels a Terminal checkout request if the status of the request permits it.
* @param checkoutId Required parameter: The unique ID for the desired `TerminalCheckout`.
* @return Returns the CancelTerminalCheckoutResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
public CancelTerminalCheckoutResponse cancelTerminalCheckout(final String checkoutId)
throws ApiException, IOException {
return prepareCancelTerminalCheckoutRequest(checkoutId).execute();
}
/**
* Cancels a Terminal checkout request if the status of the request permits it.
* @param checkoutId Required parameter: The unique ID for the desired `TerminalCheckout`.
* @return Returns the CancelTerminalCheckoutResponse response from the API call
*/
public CompletableFuture cancelTerminalCheckoutAsync(final String checkoutId) {
try {
return prepareCancelTerminalCheckoutRequest(checkoutId).executeAsync();
} catch (Exception e) {
throw new CompletionException(e);
}
}
/**
* Builds the ApiCall object for cancelTerminalCheckout.
*/
private ApiCall prepareCancelTerminalCheckoutRequest(
final String checkoutId) throws IOException {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
.server(Server.ENUM_DEFAULT.value())
.path("/v2/terminals/checkouts/{checkout_id}/cancel")
.templateParam(param ->
param.key("checkout_id").value(checkoutId).shouldEncode(true))
.headerParam(param -> param.key("accept").value("application/json"))
.withAuth(auth -> auth.add("global"))
.httpMethod(HttpMethod.POST))
.responseHandler(responseHandler -> responseHandler
.deserializer(response -> ApiHelper.deserialize(response, CancelTerminalCheckoutResponse.class))
.nullify404(false)
.contextInitializer((context, result) -> result.toBuilder()
.httpContext((HttpContext) context)
.build())
.globalErrorCase(GLOBAL_ERROR_CASES))
.build();
}
/**
* Dismisses a Terminal checkout request if the status and type of the request permits it.
* @param checkoutId Required parameter: Unique ID for the `TerminalCheckout` associated with
* the checkout to be dismissed.
* @return Returns the DismissTerminalCheckoutResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
public DismissTerminalCheckoutResponse dismissTerminalCheckout(final String checkoutId)
throws ApiException, IOException {
return prepareDismissTerminalCheckoutRequest(checkoutId).execute();
}
/**
* Dismisses a Terminal checkout request if the status and type of the request permits it.
* @param checkoutId Required parameter: Unique ID for the `TerminalCheckout` associated with
* the checkout to be dismissed.
* @return Returns the DismissTerminalCheckoutResponse response from the API call
*/
public CompletableFuture dismissTerminalCheckoutAsync(final String checkoutId) {
try {
return prepareDismissTerminalCheckoutRequest(checkoutId).executeAsync();
} catch (Exception e) {
throw new CompletionException(e);
}
}
/**
* Builds the ApiCall object for dismissTerminalCheckout.
*/
private ApiCall prepareDismissTerminalCheckoutRequest(
final String checkoutId) throws IOException {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
.server(Server.ENUM_DEFAULT.value())
.path("/v2/terminals/checkouts/{checkout_id}/dismiss")
.templateParam(param ->
param.key("checkout_id").value(checkoutId).shouldEncode(true))
.headerParam(param -> param.key("accept").value("application/json"))
.withAuth(auth -> auth.add("global"))
.httpMethod(HttpMethod.POST))
.responseHandler(responseHandler -> responseHandler
.deserializer(
response -> ApiHelper.deserialize(response, DismissTerminalCheckoutResponse.class))
.nullify404(false)
.contextInitializer((context, result) -> result.toBuilder()
.httpContext((HttpContext) context)
.build())
.globalErrorCase(GLOBAL_ERROR_CASES))
.build();
}
/**
* Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for
* Interac payments on a Square Terminal are supported only for Interac debit cards in Canada.
* Other refunds for Terminal payments should use the Refunds API. For more information, see
* [Refunds API]($e/Refunds).
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the CreateTerminalRefundResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
public CreateTerminalRefundResponse createTerminalRefund(final CreateTerminalRefundRequest body)
throws ApiException, IOException {
return prepareCreateTerminalRefundRequest(body).execute();
}
/**
* Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for
* Interac payments on a Square Terminal are supported only for Interac debit cards in Canada.
* Other refunds for Terminal payments should use the Refunds API. For more information, see
* [Refunds API]($e/Refunds).
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the CreateTerminalRefundResponse response from the API call
*/
public CompletableFuture createTerminalRefundAsync(
final CreateTerminalRefundRequest body) {
try {
return prepareCreateTerminalRefundRequest(body).executeAsync();
} catch (Exception e) {
throw new CompletionException(e);
}
}
/**
* Builds the ApiCall object for createTerminalRefund.
*/
private ApiCall prepareCreateTerminalRefundRequest(
final CreateTerminalRefundRequest body) throws JsonProcessingException, IOException {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
.server(Server.ENUM_DEFAULT.value())
.path("/v2/terminals/refunds")
.bodyParam(param -> param.value(body))
.bodySerializer(() -> ApiHelper.serialize(body))
.headerParam(param -> param.key("Content-Type")
.value("application/json")
.isRequired(false))
.headerParam(param -> param.key("accept").value("application/json"))
.withAuth(auth -> auth.add("global"))
.httpMethod(HttpMethod.POST))
.responseHandler(responseHandler -> responseHandler
.deserializer(response -> ApiHelper.deserialize(response, CreateTerminalRefundResponse.class))
.nullify404(false)
.contextInitializer((context, result) -> result.toBuilder()
.httpContext((HttpContext) context)
.build())
.globalErrorCase(GLOBAL_ERROR_CASES))
.build();
}
/**
* Retrieves a filtered list of Interac Terminal refund requests created by the seller making
* the request. Terminal refund requests are available for 30 days.
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the SearchTerminalRefundsResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
public SearchTerminalRefundsResponse searchTerminalRefunds(final SearchTerminalRefundsRequest body)
throws ApiException, IOException {
return prepareSearchTerminalRefundsRequest(body).execute();
}
/**
* Retrieves a filtered list of Interac Terminal refund requests created by the seller making
* the request. Terminal refund requests are available for 30 days.
* @param body Required parameter: An object containing the fields to POST for the request.
* See the corresponding object definition for field details.
* @return Returns the SearchTerminalRefundsResponse response from the API call
*/
public CompletableFuture searchTerminalRefundsAsync(
final SearchTerminalRefundsRequest body) {
try {
return prepareSearchTerminalRefundsRequest(body).executeAsync();
} catch (Exception e) {
throw new CompletionException(e);
}
}
/**
* Builds the ApiCall object for searchTerminalRefunds.
*/
private ApiCall prepareSearchTerminalRefundsRequest(
final SearchTerminalRefundsRequest body) throws JsonProcessingException, IOException {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
.server(Server.ENUM_DEFAULT.value())
.path("/v2/terminals/refunds/search")
.bodyParam(param -> param.value(body))
.bodySerializer(() -> ApiHelper.serialize(body))
.headerParam(param -> param.key("Content-Type")
.value("application/json")
.isRequired(false))
.headerParam(param -> param.key("accept").value("application/json"))
.withAuth(auth -> auth.add("global"))
.httpMethod(HttpMethod.POST))
.responseHandler(responseHandler -> responseHandler
.deserializer(response -> ApiHelper.deserialize(response, SearchTerminalRefundsResponse.class))
.nullify404(false)
.contextInitializer((context, result) -> result.toBuilder()
.httpContext((HttpContext) context)
.build())
.globalErrorCase(GLOBAL_ERROR_CASES))
.build();
}
/**
* Retrieves an Interac Terminal refund object by ID. Terminal refund objects are available for
* 30 days.
* @param terminalRefundId Required parameter: The unique ID for the desired `TerminalRefund`.
* @return Returns the GetTerminalRefundResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
public GetTerminalRefundResponse getTerminalRefund(final String terminalRefundId) throws ApiException, IOException {
return prepareGetTerminalRefundRequest(terminalRefundId).execute();
}
/**
* Retrieves an Interac Terminal refund object by ID. Terminal refund objects are available for
* 30 days.
* @param terminalRefundId Required parameter: The unique ID for the desired `TerminalRefund`.
* @return Returns the GetTerminalRefundResponse response from the API call
*/
public CompletableFuture getTerminalRefundAsync(final String terminalRefundId) {
try {
return prepareGetTerminalRefundRequest(terminalRefundId).executeAsync();
} catch (Exception e) {
throw new CompletionException(e);
}
}
/**
* Builds the ApiCall object for getTerminalRefund.
*/
private ApiCall prepareGetTerminalRefundRequest(
final String terminalRefundId) throws IOException {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
.server(Server.ENUM_DEFAULT.value())
.path("/v2/terminals/refunds/{terminal_refund_id}")
.templateParam(param -> param.key("terminal_refund_id")
.value(terminalRefundId)
.shouldEncode(true))
.headerParam(param -> param.key("accept").value("application/json"))
.withAuth(auth -> auth.add("global"))
.httpMethod(HttpMethod.GET))
.responseHandler(responseHandler -> responseHandler
.deserializer(response -> ApiHelper.deserialize(response, GetTerminalRefundResponse.class))
.nullify404(false)
.contextInitializer((context, result) -> result.toBuilder()
.httpContext((HttpContext) context)
.build())
.globalErrorCase(GLOBAL_ERROR_CASES))
.build();
}
/**
* Cancels an Interac Terminal refund request by refund request ID if the status of the request
* permits it.
* @param terminalRefundId Required parameter: The unique ID for the desired `TerminalRefund`.
* @return Returns the CancelTerminalRefundResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
public CancelTerminalRefundResponse cancelTerminalRefund(final String terminalRefundId)
throws ApiException, IOException {
return prepareCancelTerminalRefundRequest(terminalRefundId).execute();
}
/**
* Cancels an Interac Terminal refund request by refund request ID if the status of the request
* permits it.
* @param terminalRefundId Required parameter: The unique ID for the desired `TerminalRefund`.
* @return Returns the CancelTerminalRefundResponse response from the API call
*/
public CompletableFuture cancelTerminalRefundAsync(final String terminalRefundId) {
try {
return prepareCancelTerminalRefundRequest(terminalRefundId).executeAsync();
} catch (Exception e) {
throw new CompletionException(e);
}
}
/**
* Builds the ApiCall object for cancelTerminalRefund.
*/
private ApiCall prepareCancelTerminalRefundRequest(
final String terminalRefundId) throws IOException {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
.server(Server.ENUM_DEFAULT.value())
.path("/v2/terminals/refunds/{terminal_refund_id}/cancel")
.templateParam(param -> param.key("terminal_refund_id")
.value(terminalRefundId)
.shouldEncode(true))
.headerParam(param -> param.key("accept").value("application/json"))
.withAuth(auth -> auth.add("global"))
.httpMethod(HttpMethod.POST))
.responseHandler(responseHandler -> responseHandler
.deserializer(response -> ApiHelper.deserialize(response, CancelTerminalRefundResponse.class))
.nullify404(false)
.contextInitializer((context, result) -> result.toBuilder()
.httpContext((HttpContext) context)
.build())
.globalErrorCase(GLOBAL_ERROR_CASES))
.build();
}
/**
* Dismisses a Terminal refund request if the status and type of the request permits it.
* @param terminalRefundId Required parameter: Unique ID for the `TerminalRefund` associated
* with the refund to be dismissed.
* @return Returns the DismissTerminalRefundResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
public DismissTerminalRefundResponse dismissTerminalRefund(final String terminalRefundId)
throws ApiException, IOException {
return prepareDismissTerminalRefundRequest(terminalRefundId).execute();
}
/**
* Dismisses a Terminal refund request if the status and type of the request permits it.
* @param terminalRefundId Required parameter: Unique ID for the `TerminalRefund` associated
* with the refund to be dismissed.
* @return Returns the DismissTerminalRefundResponse response from the API call
*/
public CompletableFuture dismissTerminalRefundAsync(final String terminalRefundId) {
try {
return prepareDismissTerminalRefundRequest(terminalRefundId).executeAsync();
} catch (Exception e) {
throw new CompletionException(e);
}
}
/**
* Builds the ApiCall object for dismissTerminalRefund.
*/
private ApiCall prepareDismissTerminalRefundRequest(
final String terminalRefundId) throws IOException {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
.server(Server.ENUM_DEFAULT.value())
.path("/v2/terminals/refunds/{terminal_refund_id}/dismiss")
.templateParam(param -> param.key("terminal_refund_id")
.value(terminalRefundId)
.shouldEncode(true))
.headerParam(param -> param.key("accept").value("application/json"))
.withAuth(auth -> auth.add("global"))
.httpMethod(HttpMethod.POST))
.responseHandler(responseHandler -> responseHandler
.deserializer(response -> ApiHelper.deserialize(response, DismissTerminalRefundResponse.class))
.nullify404(false)
.contextInitializer((context, result) -> result.toBuilder()
.httpContext((HttpContext) context)
.build())
.globalErrorCase(GLOBAL_ERROR_CASES))
.build();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy