com.squareup.square.legacy.api.TerminalApi Maven / Gradle / Ivy
package com.squareup.square.legacy.api;
import com.squareup.square.legacy.exceptions.ApiException;
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 java.io.IOException;
import java.util.concurrent.CompletableFuture;
/**
* This interface lists all the endpoints of the group.
* This can be overridden for the mock calls.
*/
public interface TerminalApi {
/**
* 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.
*/
CreateTerminalActionResponse createTerminalAction(final CreateTerminalActionRequest body)
throws ApiException, IOException;
/**
* 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
*/
CompletableFuture createTerminalActionAsync(final CreateTerminalActionRequest body);
/**
* 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.
*/
SearchTerminalActionsResponse searchTerminalActions(final SearchTerminalActionsRequest body)
throws ApiException, IOException;
/**
* 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
*/
CompletableFuture searchTerminalActionsAsync(
final SearchTerminalActionsRequest body);
/**
* 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.
*/
GetTerminalActionResponse getTerminalAction(final String actionId) throws ApiException, IOException;
/**
* 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
*/
CompletableFuture getTerminalActionAsync(final String actionId);
/**
* 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.
*/
CancelTerminalActionResponse cancelTerminalAction(final String actionId) throws ApiException, IOException;
/**
* 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
*/
CompletableFuture cancelTerminalActionAsync(final String actionId);
/**
* 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.
*/
DismissTerminalActionResponse dismissTerminalAction(final String actionId) throws ApiException, IOException;
/**
* 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
*/
CompletableFuture dismissTerminalActionAsync(final String actionId);
/**
* 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.
*/
CreateTerminalCheckoutResponse createTerminalCheckout(final CreateTerminalCheckoutRequest body)
throws ApiException, IOException;
/**
* 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
*/
CompletableFuture createTerminalCheckoutAsync(
final CreateTerminalCheckoutRequest body);
/**
* 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.
*/
SearchTerminalCheckoutsResponse searchTerminalCheckouts(final SearchTerminalCheckoutsRequest body)
throws ApiException, IOException;
/**
* 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
*/
CompletableFuture searchTerminalCheckoutsAsync(
final SearchTerminalCheckoutsRequest body);
/**
* 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.
*/
GetTerminalCheckoutResponse getTerminalCheckout(final String checkoutId) throws ApiException, IOException;
/**
* 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
*/
CompletableFuture getTerminalCheckoutAsync(final String checkoutId);
/**
* 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.
*/
CancelTerminalCheckoutResponse cancelTerminalCheckout(final String checkoutId) throws ApiException, IOException;
/**
* 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
*/
CompletableFuture cancelTerminalCheckoutAsync(final String checkoutId);
/**
* 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.
*/
DismissTerminalCheckoutResponse dismissTerminalCheckout(final String checkoutId) throws ApiException, IOException;
/**
* 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
*/
CompletableFuture dismissTerminalCheckoutAsync(final String checkoutId);
/**
* 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.
*/
CreateTerminalRefundResponse createTerminalRefund(final CreateTerminalRefundRequest body)
throws ApiException, IOException;
/**
* 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
*/
CompletableFuture createTerminalRefundAsync(final CreateTerminalRefundRequest body);
/**
* 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.
*/
SearchTerminalRefundsResponse searchTerminalRefunds(final SearchTerminalRefundsRequest body)
throws ApiException, IOException;
/**
* 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
*/
CompletableFuture searchTerminalRefundsAsync(
final SearchTerminalRefundsRequest body);
/**
* 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.
*/
GetTerminalRefundResponse getTerminalRefund(final String terminalRefundId) throws ApiException, IOException;
/**
* 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
*/
CompletableFuture getTerminalRefundAsync(final String terminalRefundId);
/**
* 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.
*/
CancelTerminalRefundResponse cancelTerminalRefund(final String terminalRefundId) throws ApiException, IOException;
/**
* 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
*/
CompletableFuture cancelTerminalRefundAsync(final String terminalRefundId);
/**
* 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.
*/
DismissTerminalRefundResponse dismissTerminalRefund(final String terminalRefundId) throws ApiException, IOException;
/**
* 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
*/
CompletableFuture dismissTerminalRefundAsync(final String terminalRefundId);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy