com.squareup.square.api

Interface CashDrawersApi

All Known Implementing Classes:

DefaultCashDrawersApi

public interface CashDrawersApi

This interface lists all the endpoints of the group. This can be overridden for the mock calls.

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.

Method Detail

listCashDrawerShifts

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.

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

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.

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

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.

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

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.

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

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.

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

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

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

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