com.squareup.square.api

Class DefaultCashDrawersApi

java.lang.Object

com.squareup.square.api.BaseApi

com.squareup.square.api.DefaultCashDrawersApi

All Implemented Interfaces:

CashDrawersApi

public final class DefaultCashDrawersApi
extends BaseApi
implements CashDrawersApi

This class lists all the endpoints of the groups.

Nested Class Summary

Nested classes/interfaces inherited from class com.squareup.square.api.BaseApi

BaseApi.RequestExecutor, BaseApi.RequestSupplier, BaseApi.ResponseHandler<T>

Field Summary

Fields inherited from class com.squareup.square.api.BaseApi

authManagers, config, httpCallback, internalUserAgent

Constructor Summary

Constructors

Constructor and Description
DefaultCashDrawersApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers) Initializes the controller.
DefaultCashDrawersApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers, HttpCallback httpCallback) Initializes the controller with HTTPCallback.

Method Summary

Modifier and Type	Method and Description
ListCashDrawerShiftEventsResponse	listCashDrawerShiftEvents(String locationId, String shiftId, Integer limit, String cursor) Provides a paginated list of events for a single cash drawer shift.
CompletableFuture<ListCashDrawerShiftEventsResponse>	listCashDrawerShiftEventsAsync(String locationId, String shiftId, Integer limit, String cursor) Provides a paginated list of events for a single cash drawer shift.
ListCashDrawerShiftsResponse	listCashDrawerShifts(String locationId, String sortOrder, String beginTime, String endTime, Integer limit, String cursor) Provides the details for all of the cash drawer shifts for a location in a date range.
CompletableFuture<ListCashDrawerShiftsResponse>	listCashDrawerShiftsAsync(String locationId, String sortOrder, String beginTime, String endTime, Integer limit, String cursor) Provides the details for all of the cash drawer shifts for a location in a date range.
RetrieveCashDrawerShiftResponse	retrieveCashDrawerShift(String locationId, String shiftId) Provides the summary details for a single cash drawer shift.
CompletableFuture<RetrieveCashDrawerShiftResponse>	retrieveCashDrawerShiftAsync(String locationId, String shiftId) Provides the summary details for a single cash drawer shift.

Methods inherited from class com.squareup.square.api.BaseApi

getClientInstance, getHttpCallback, makeHttpCallAsync, validateResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultCashDrawersApi

public DefaultCashDrawersApi(Configuration config,
                             HttpClient httpClient,
                             Map<String,AuthManager> authManagers)

Initializes the controller.

Parameters:

config - Configurations added in client.

httpClient - Send HTTP requests and read the responses.

authManagers - Apply authorization to requests.

DefaultCashDrawersApi

public DefaultCashDrawersApi(Configuration config,
                             HttpClient httpClient,
                             Map<String,AuthManager> authManagers,
                             HttpCallback httpCallback)

Initializes the controller with HTTPCallback.

Parameters:

config - Configurations added in client.

httpClient - Send HTTP requests and read the responses.

authManagers - Apply authorization to requests.

httpCallback - Callback to be called before and after the HTTP call.

Method Detail

listCashDrawerShifts

public ListCashDrawerShiftsResponse listCashDrawerShifts(String locationId,
                                                         String sortOrder,
                                                         String beginTime,
                                                         String endTime,
                                                         Integer limit,
                                                         String cursor)
                                                  throws ApiException,
                                                         IOException

Provides the details for all of the cash drawer shifts for a location in a date range.

Specified by:

listCashDrawerShifts in interface CashDrawersApi

Parameters:

locationId - Required parameter: The ID of the location to query for a list of cash drawer shifts.

sortOrder - Optional parameter: The order in which cash drawer shifts are listed in the response, based on their opened_at field. Default value: ASC

beginTime - Optional parameter: The inclusive start time of the query on opened_at, in ISO 8601 format.

endTime - Optional parameter: The exclusive end date of the query on opened_at, in ISO 8601 format.

limit - Optional parameter: Number of cash drawer shift events in a page of results (200 by default, 1000 max).

cursor - Optional parameter: Opaque cursor for fetching the next page of results.

Returns:

Returns the ListCashDrawerShiftsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

listCashDrawerShiftsAsync

public CompletableFuture<ListCashDrawerShiftsResponse> listCashDrawerShiftsAsync(String locationId,
                                                                                 String sortOrder,
                                                                                 String beginTime,
                                                                                 String endTime,
                                                                                 Integer limit,
                                                                                 String cursor)

Provides the details for all of the cash drawer shifts for a location in a date range.

Specified by:

listCashDrawerShiftsAsync in interface CashDrawersApi

Parameters:

locationId - Required parameter: The ID of the location to query for a list of cash drawer shifts.

sortOrder - Optional parameter: The order in which cash drawer shifts are listed in the response, based on their opened_at field. Default value: ASC

beginTime - Optional parameter: The inclusive start time of the query on opened_at, in ISO 8601 format.

endTime - Optional parameter: The exclusive end date of the query on opened_at, in ISO 8601 format.

limit - Optional parameter: Number of cash drawer shift events in a page of results (200 by default, 1000 max).

cursor - Optional parameter: Opaque cursor for fetching the next page of results.

Returns:

Returns the ListCashDrawerShiftsResponse response from the API call

retrieveCashDrawerShift

public RetrieveCashDrawerShiftResponse retrieveCashDrawerShift(String locationId,
                                                               String shiftId)
                                                        throws ApiException,
                                                               IOException

Provides the summary details for a single cash drawer shift. See [ListCashDrawerShiftEvents]($e/CashDrawers/ListCashDrawerShiftEvents) for a list of cash drawer shift events.

Specified by:

retrieveCashDrawerShift in interface CashDrawersApi

Parameters:

locationId - Required parameter: The ID of the location to retrieve cash drawer shifts from.

shiftId - Required parameter: The shift ID.

Returns:

Returns the RetrieveCashDrawerShiftResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveCashDrawerShiftAsync

public CompletableFuture<RetrieveCashDrawerShiftResponse> retrieveCashDrawerShiftAsync(String locationId,
                                                                                       String shiftId)

Provides the summary details for a single cash drawer shift. See [ListCashDrawerShiftEvents]($e/CashDrawers/ListCashDrawerShiftEvents) for a list of cash drawer shift events.

Specified by:

retrieveCashDrawerShiftAsync in interface CashDrawersApi

Parameters:

locationId - Required parameter: The ID of the location to retrieve cash drawer shifts from.

shiftId - Required parameter: The shift ID.

Returns:

Returns the RetrieveCashDrawerShiftResponse response from the API call

listCashDrawerShiftEvents

public ListCashDrawerShiftEventsResponse listCashDrawerShiftEvents(String locationId,
                                                                   String shiftId,
                                                                   Integer limit,
                                                                   String cursor)
                                                            throws ApiException,
                                                                   IOException

Provides a paginated list of events for a single cash drawer shift.

Specified by:

listCashDrawerShiftEvents in interface CashDrawersApi

Parameters:

locationId - Required parameter: The ID of the location to list cash drawer shifts for.

shiftId - Required parameter: The shift ID.

limit - Optional parameter: Number of resources to be returned in a page of results (200 by default, 1000 max).

cursor - Optional parameter: Opaque cursor for fetching the next page of results.

Returns:

Returns the ListCashDrawerShiftEventsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

listCashDrawerShiftEventsAsync

public CompletableFuture<ListCashDrawerShiftEventsResponse> listCashDrawerShiftEventsAsync(String locationId,
                                                                                           String shiftId,
                                                                                           Integer limit,
                                                                                           String cursor)

Provides a paginated list of events for a single cash drawer shift.

Specified by:

listCashDrawerShiftEventsAsync in interface CashDrawersApi

Parameters:

locationId - Required parameter: The ID of the location to list cash drawer shifts for.

shiftId - Required parameter: The shift ID.

limit - Optional parameter: Number of resources to be returned in a page of results (200 by default, 1000 max).

cursor - Optional parameter: Opaque cursor for fetching the next page of results.

Returns:

Returns the ListCashDrawerShiftEventsResponse response from the API call