com.squareup.square.api

Class DefaultEmployeesApi

java.lang.Object

com.squareup.square.api.BaseApi

com.squareup.square.api.DefaultEmployeesApi

All Implemented Interfaces:

EmployeesApi

public final class DefaultEmployeesApi
extends BaseApi
implements EmployeesApi

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
DefaultEmployeesApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers) Initializes the controller.
DefaultEmployeesApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers, HttpCallback httpCallback) Initializes the controller with HTTPCallback.

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.

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

DefaultEmployeesApi

public DefaultEmployeesApi(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.

DefaultEmployeesApi

public DefaultEmployeesApi(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

listEmployees

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

Deprecated.

ListEmployees.

Specified by:

listEmployees in interface EmployeesApi

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
public CompletableFuture<ListEmployeesResponse> listEmployeesAsync(String locationId,
                                                                               String status,
                                                                               Integer limit,
                                                                               String cursor)

Deprecated.

ListEmployees.

Specified by:

listEmployeesAsync in interface EmployeesApi

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
public RetrieveEmployeeResponse retrieveEmployee(String id)
                                                      throws ApiException,
                                                             IOException

Deprecated.

RetrieveEmployee.

Specified by:

retrieveEmployee in interface EmployeesApi

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
public CompletableFuture<RetrieveEmployeeResponse> retrieveEmployeeAsync(String id)

Deprecated.

RetrieveEmployee.

Specified by:

retrieveEmployeeAsync in interface EmployeesApi

Parameters:

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

Returns:

Returns the RetrieveEmployeeResponse response from the API call