BaseApi.RequestExecutor, BaseApi.RequestSupplier, BaseApi.ResponseHandler<T>authManagers, config, httpCallback, internalUserAgent| Constructor and Description |
|---|
DefaultLaborApi(Configuration config,
HttpClient httpClient,
Map<String,AuthManager> authManagers)
Initializes the controller.
|
DefaultLaborApi(Configuration config,
HttpClient httpClient,
Map<String,AuthManager> authManagers,
HttpCallback httpCallback)
Initializes the controller with HTTPCallback.
|
getClientInstance, getHttpCallback, makeHttpCallAsync, validateResponsepublic DefaultLaborApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers)
config - Configurations added in client.httpClient - Send HTTP requests and read the responses.authManagers - Apply authorization to requests.public DefaultLaborApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers, HttpCallback httpCallback)
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.public ListBreakTypesResponse listBreakTypes(String locationId, Integer limit, String cursor) throws ApiException, IOException
listBreakTypes in interface LaborApilocationId - Optional parameter: Filter the returned `BreakType` results to only those
that are associated with the specified location.limit - Optional parameter: The maximum number of `BreakType` results to return per
page. The number can range between 1 and 200. The default is 200.cursor - Optional parameter: A pointer to the next page of `BreakType` results to
fetch.ApiException - Represents error response from the server.IOException - Signals that an I/O exception of some sort has occurred.public CompletableFuture<ListBreakTypesResponse> listBreakTypesAsync(String locationId, Integer limit, String cursor)
listBreakTypesAsync in interface LaborApilocationId - Optional parameter: Filter the returned `BreakType` results to only those
that are associated with the specified location.limit - Optional parameter: The maximum number of `BreakType` results to return per
page. The number can range between 1 and 200. The default is 200.cursor - Optional parameter: A pointer to the next page of `BreakType` results to
fetch.public CreateBreakTypeResponse createBreakType(CreateBreakTypeRequest body) throws ApiException, IOException
createBreakType in interface LaborApibody - Required parameter: An object containing the fields to POST for the request.
See the corresponding object definition for field details.ApiException - Represents error response from the server.IOException - Signals that an I/O exception of some sort has occurred.public CompletableFuture<CreateBreakTypeResponse> createBreakTypeAsync(CreateBreakTypeRequest body)
createBreakTypeAsync in interface LaborApibody - Required parameter: An object containing the fields to POST for the request.
See the corresponding object definition for field details.public DeleteBreakTypeResponse deleteBreakType(String id) throws ApiException, IOException
deleteBreakType in interface LaborApiid - Required parameter: The UUID for the `BreakType` being deleted.ApiException - Represents error response from the server.IOException - Signals that an I/O exception of some sort has occurred.public CompletableFuture<DeleteBreakTypeResponse> deleteBreakTypeAsync(String id)
deleteBreakTypeAsync in interface LaborApiid - Required parameter: The UUID for the `BreakType` being deleted.public GetBreakTypeResponse getBreakType(String id) throws ApiException, IOException
getBreakType in interface LaborApiid - Required parameter: The UUID for the `BreakType` being retrieved.ApiException - Represents error response from the server.IOException - Signals that an I/O exception of some sort has occurred.public CompletableFuture<GetBreakTypeResponse> getBreakTypeAsync(String id)
getBreakTypeAsync in interface LaborApiid - Required parameter: The UUID for the `BreakType` being retrieved.public UpdateBreakTypeResponse updateBreakType(String id, UpdateBreakTypeRequest body) throws ApiException, IOException
updateBreakType in interface LaborApiid - Required parameter: The UUID for the `BreakType` being updated.body - Required parameter: An object containing the fields to POST for the request.
See the corresponding object definition for field details.ApiException - Represents error response from the server.IOException - Signals that an I/O exception of some sort has occurred.public CompletableFuture<UpdateBreakTypeResponse> updateBreakTypeAsync(String id, UpdateBreakTypeRequest body)
updateBreakTypeAsync in interface LaborApiid - Required parameter: The UUID for the `BreakType` being updated.body - Required parameter: An object containing the fields to POST for the request.
See the corresponding object definition for field details.@Deprecated public ListEmployeeWagesResponse listEmployeeWages(String employeeId, Integer limit, String cursor) throws ApiException, IOException
listEmployeeWages in interface LaborApiemployeeId - Optional parameter: Filter the returned wages to only those that are
associated with the specified employee.limit - Optional parameter: The maximum number of `EmployeeWage` results to return per
page. The number can range between 1 and 200. The default is 200.cursor - Optional parameter: A pointer to the next page of `EmployeeWage` results to
fetch.ApiException - Represents error response from the server.IOException - Signals that an I/O exception of some sort has occurred.@Deprecated public CompletableFuture<ListEmployeeWagesResponse> listEmployeeWagesAsync(String employeeId, Integer limit, String cursor)
listEmployeeWagesAsync in interface LaborApiemployeeId - Optional parameter: Filter the returned wages to only those that are
associated with the specified employee.limit - Optional parameter: The maximum number of `EmployeeWage` results to return per
page. The number can range between 1 and 200. The default is 200.cursor - Optional parameter: A pointer to the next page of `EmployeeWage` results to
fetch.@Deprecated public GetEmployeeWageResponse getEmployeeWage(String id) throws ApiException, IOException
getEmployeeWage in interface LaborApiid - Required parameter: The UUID for the `EmployeeWage` being retrieved.ApiException - Represents error response from the server.IOException - Signals that an I/O exception of some sort has occurred.@Deprecated public CompletableFuture<GetEmployeeWageResponse> getEmployeeWageAsync(String id)
getEmployeeWageAsync in interface LaborApiid - Required parameter: The UUID for the `EmployeeWage` being retrieved.public CreateShiftResponse createShift(CreateShiftRequest body) throws ApiException, IOException
createShift in interface LaborApibody - Required parameter: An object containing the fields to POST for the request.
See the corresponding object definition for field details.ApiException - Represents error response from the server.IOException - Signals that an I/O exception of some sort has occurred.public CompletableFuture<CreateShiftResponse> createShiftAsync(CreateShiftRequest body)
createShiftAsync in interface LaborApibody - Required parameter: An object containing the fields to POST for the request.
See the corresponding object definition for field details.public SearchShiftsResponse searchShifts(SearchShiftsRequest body) throws ApiException, IOException
searchShifts in interface LaborApibody - Required parameter: An object containing the fields to POST for the request.
See the corresponding object definition for field details.ApiException - Represents error response from the server.IOException - Signals that an I/O exception of some sort has occurred.public CompletableFuture<SearchShiftsResponse> searchShiftsAsync(SearchShiftsRequest body)
searchShiftsAsync in interface LaborApibody - Required parameter: An object containing the fields to POST for the request.
See the corresponding object definition for field details.public DeleteShiftResponse deleteShift(String id) throws ApiException, IOException
deleteShift in interface LaborApiid - Required parameter: The UUID for the `Shift` being deleted.ApiException - Represents error response from the server.IOException - Signals that an I/O exception of some sort has occurred.public CompletableFuture<DeleteShiftResponse> deleteShiftAsync(String id)
deleteShiftAsync in interface LaborApiid - Required parameter: The UUID for the `Shift` being deleted.public GetShiftResponse getShift(String id) throws ApiException, IOException
getShift in interface LaborApiid - Required parameter: The UUID for the `Shift` being retrieved.ApiException - Represents error response from the server.IOException - Signals that an I/O exception of some sort has occurred.public CompletableFuture<GetShiftResponse> getShiftAsync(String id)
getShiftAsync in interface LaborApiid - Required parameter: The UUID for the `Shift` being retrieved.public UpdateShiftResponse updateShift(String id, UpdateShiftRequest body) throws ApiException, IOException
updateShift in interface LaborApiid - Required parameter: The ID of the object being updated.body - Required parameter: An object containing the fields to POST for the request.
See the corresponding object definition for field details.ApiException - Represents error response from the server.IOException - Signals that an I/O exception of some sort has occurred.public CompletableFuture<UpdateShiftResponse> updateShiftAsync(String id, UpdateShiftRequest body)
updateShiftAsync in interface LaborApiid - Required parameter: The ID of the object being updated.body - Required parameter: An object containing the fields to POST for the request.
See the corresponding object definition for field details.public ListTeamMemberWagesResponse listTeamMemberWages(String teamMemberId, Integer limit, String cursor) throws ApiException, IOException
listTeamMemberWages in interface LaborApiteamMemberId - Optional parameter: Filter the returned wages to only those that are
associated with the specified team member.limit - Optional parameter: The maximum number of `TeamMemberWage` results to return
per page. The number can range between 1 and 200. The default is 200.cursor - Optional parameter: A pointer to the next page of `EmployeeWage` results to
fetch.ApiException - Represents error response from the server.IOException - Signals that an I/O exception of some sort has occurred.public CompletableFuture<ListTeamMemberWagesResponse> listTeamMemberWagesAsync(String teamMemberId, Integer limit, String cursor)
listTeamMemberWagesAsync in interface LaborApiteamMemberId - Optional parameter: Filter the returned wages to only those that are
associated with the specified team member.limit - Optional parameter: The maximum number of `TeamMemberWage` results to return
per page. The number can range between 1 and 200. The default is 200.cursor - Optional parameter: A pointer to the next page of `EmployeeWage` results to
fetch.public GetTeamMemberWageResponse getTeamMemberWage(String id) throws ApiException, IOException
getTeamMemberWage in interface LaborApiid - Required parameter: The UUID for the `TeamMemberWage` being retrieved.ApiException - Represents error response from the server.IOException - Signals that an I/O exception of some sort has occurred.public CompletableFuture<GetTeamMemberWageResponse> getTeamMemberWageAsync(String id)
getTeamMemberWageAsync in interface LaborApiid - Required parameter: The UUID for the `TeamMemberWage` being retrieved.public ListWorkweekConfigsResponse listWorkweekConfigs(Integer limit, String cursor) throws ApiException, IOException
listWorkweekConfigs in interface LaborApilimit - Optional parameter: The maximum number of `WorkweekConfigs` results to return
per page.cursor - Optional parameter: A pointer to the next page of `WorkweekConfig` results to
fetch.ApiException - Represents error response from the server.IOException - Signals that an I/O exception of some sort has occurred.public CompletableFuture<ListWorkweekConfigsResponse> listWorkweekConfigsAsync(Integer limit, String cursor)
listWorkweekConfigsAsync in interface LaborApilimit - Optional parameter: The maximum number of `WorkweekConfigs` results to return
per page.cursor - Optional parameter: A pointer to the next page of `WorkweekConfig` results to
fetch.public UpdateWorkweekConfigResponse updateWorkweekConfig(String id, UpdateWorkweekConfigRequest body) throws ApiException, IOException
updateWorkweekConfig in interface LaborApiid - Required parameter: The UUID for the `WorkweekConfig` object being updated.body - Required parameter: An object containing the fields to POST for the request.
See the corresponding object definition for field details.ApiException - Represents error response from the server.IOException - Signals that an I/O exception of some sort has occurred.public CompletableFuture<UpdateWorkweekConfigResponse> updateWorkweekConfigAsync(String id, UpdateWorkweekConfigRequest body)
updateWorkweekConfigAsync in interface LaborApiid - Required parameter: The UUID for the `WorkweekConfig` object being updated.body - Required parameter: An object containing the fields to POST for the request.
See the corresponding object definition for field details.Copyright © 2022. All rights reserved.