com.squareup.square.api

Interface EmployeesApi

All Known Implementing Classes:

DefaultEmployeesApi

public interface EmployeesApi

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
ListEmployeesResponse	listEmployees(String locationId, String status, Integer limit, String cursor) Deprecated.
CompletableFuture<ListEmployeesResponse>	listEmployeesAsync(String locationId, String status, Integer limit, String cursor) Deprecated.
RetrieveEmployeeResponse	retrieveEmployee(String id) Deprecated.
CompletableFuture<RetrieveEmployeeResponse>	retrieveEmployeeAsync(String id) Deprecated.

Method Detail

listEmployees

@Deprecated
ListEmployeesResponse listEmployees(String locationId,
                                                String status,
                                                Integer limit,
                                                String cursor)
                                         throws ApiException,
                                                IOException

Deprecated.

ListEmployees.

Parameters:

locationId - Optional parameter: Example:

status - Optional parameter: Specifies the EmployeeStatus to filter the employee by.

limit - Optional parameter: The number of employees to be returned on each page.

cursor - Optional parameter: The token required to retrieve the specified page of results.

Returns:

Returns the ListEmployeesResponse 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.

listEmployeesAsync

@Deprecated
CompletableFuture<ListEmployeesResponse> listEmployeesAsync(String locationId,
                                                                        String status,
                                                                        Integer limit,
                                                                        String cursor)

Deprecated.

ListEmployees.

Parameters:

locationId - Optional parameter: Example:

status - Optional parameter: Specifies the EmployeeStatus to filter the employee by.

limit - Optional parameter: The number of employees to be returned on each page.

cursor - Optional parameter: The token required to retrieve the specified page of results.

Returns:

Returns the ListEmployeesResponse response from the API call

retrieveEmployee

@Deprecated
RetrieveEmployeeResponse retrieveEmployee(String id)
                                               throws ApiException,
                                                      IOException

Deprecated.

RetrieveEmployee.

Parameters:

id - Required parameter: UUID for the employee that was requested.

Returns:

Returns the RetrieveEmployeeResponse 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.

retrieveEmployeeAsync

@Deprecated
CompletableFuture<RetrieveEmployeeResponse> retrieveEmployeeAsync(String id)

Deprecated.

RetrieveEmployee.

Parameters:

id - Required parameter: UUID for the employee that was requested.

Returns:

Returns the RetrieveEmployeeResponse response from the API call