public interface LaborApi
ListBreakTypesResponse listBreakTypes(String locationId, Integer limit, String cursor) throws ApiException, IOException
locationId - 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.CompletableFuture<ListBreakTypesResponse> listBreakTypesAsync(String locationId, Integer limit, String cursor)
locationId - 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.CreateBreakTypeResponse createBreakType(CreateBreakTypeRequest body) throws ApiException, IOException
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.CompletableFuture<CreateBreakTypeResponse> createBreakTypeAsync(CreateBreakTypeRequest body)
body - Required parameter: An object containing the fields to POST for the request.
See the corresponding object definition for field details.DeleteBreakTypeResponse deleteBreakType(String id) throws ApiException, IOException
id - 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.CompletableFuture<DeleteBreakTypeResponse> deleteBreakTypeAsync(String id)
id - Required parameter: The UUID for the `BreakType` being deleted.GetBreakTypeResponse getBreakType(String id) throws ApiException, IOException
id - 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.CompletableFuture<GetBreakTypeResponse> getBreakTypeAsync(String id)
id - Required parameter: The UUID for the `BreakType` being retrieved.UpdateBreakTypeResponse updateBreakType(String id, UpdateBreakTypeRequest body) throws ApiException, IOException
id - 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.CompletableFuture<UpdateBreakTypeResponse> updateBreakTypeAsync(String id, UpdateBreakTypeRequest body)
id - 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 ListEmployeeWagesResponse listEmployeeWages(String employeeId, Integer limit, String cursor) throws ApiException, IOException
employeeId - 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 CompletableFuture<ListEmployeeWagesResponse> listEmployeeWagesAsync(String employeeId, Integer limit, String cursor)
employeeId - 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 GetEmployeeWageResponse getEmployeeWage(String id) throws ApiException, IOException
id - 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 CompletableFuture<GetEmployeeWageResponse> getEmployeeWageAsync(String id)
id - Required parameter: The UUID for the `EmployeeWage` being retrieved.CreateShiftResponse createShift(CreateShiftRequest body) throws ApiException, IOException
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.CompletableFuture<CreateShiftResponse> createShiftAsync(CreateShiftRequest body)
body - Required parameter: An object containing the fields to POST for the request.
See the corresponding object definition for field details.SearchShiftsResponse searchShifts(SearchShiftsRequest body) throws ApiException, IOException
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.CompletableFuture<SearchShiftsResponse> searchShiftsAsync(SearchShiftsRequest body)
body - Required parameter: An object containing the fields to POST for the request.
See the corresponding object definition for field details.DeleteShiftResponse deleteShift(String id) throws ApiException, IOException
id - 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.CompletableFuture<DeleteShiftResponse> deleteShiftAsync(String id)
id - Required parameter: The UUID for the `Shift` being deleted.GetShiftResponse getShift(String id) throws ApiException, IOException
id - 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.CompletableFuture<GetShiftResponse> getShiftAsync(String id)
id - Required parameter: The UUID for the `Shift` being retrieved.UpdateShiftResponse updateShift(String id, UpdateShiftRequest body) throws ApiException, IOException
id - 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.CompletableFuture<UpdateShiftResponse> updateShiftAsync(String id, UpdateShiftRequest body)
id - 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.ListTeamMemberWagesResponse listTeamMemberWages(String teamMemberId, Integer limit, String cursor) throws ApiException, IOException
teamMemberId - 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.CompletableFuture<ListTeamMemberWagesResponse> listTeamMemberWagesAsync(String teamMemberId, Integer limit, String cursor)
teamMemberId - 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.GetTeamMemberWageResponse getTeamMemberWage(String id) throws ApiException, IOException
id - 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.CompletableFuture<GetTeamMemberWageResponse> getTeamMemberWageAsync(String id)
id - Required parameter: The UUID for the `TeamMemberWage` being retrieved.ListWorkweekConfigsResponse listWorkweekConfigs(Integer limit, String cursor) throws ApiException, IOException
limit - 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.CompletableFuture<ListWorkweekConfigsResponse> listWorkweekConfigsAsync(Integer limit, String cursor)
limit - 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.UpdateWorkweekConfigResponse updateWorkweekConfig(String id, UpdateWorkweekConfigRequest body) throws ApiException, IOException
id - 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.CompletableFuture<UpdateWorkweekConfigResponse> updateWorkweekConfigAsync(String id, UpdateWorkweekConfigRequest body)
id - 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.