Package com.mypurecloud.sdk.v2.api

Class WorkforceManagementApi

java.lang.Object
com.mypurecloud.sdk.v2.api.WorkforceManagementApi
public class WorkforceManagementApi extends Object

  • Constructor Details

    • WorkforceManagementApi

      public WorkforceManagementApi()

    • WorkforceManagementApi

      public WorkforceManagementApi(ApiClient apiClient)

  • Method Details

    • deleteWorkforcemanagementBusinessunit

      public void deleteWorkforcemanagementBusinessunit(String businessUnitId) throws IOException, ApiException
      Delete business unit A business unit cannot be deleted if it contains one or more management units
      Parameters:
      businessUnitId - The ID of the business unit, or 'mine' for the business unit of the logged-in user. (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitWithHttpInfo

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitWithHttpInfo(String businessUnitId) throws IOException
      Delete business unit A business unit cannot be deleted if it contains one or more management units
      Parameters:
      businessUnitId - The ID of the business unit, or 'mine' for the business unit of the logged-in user. (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunit

      public void deleteWorkforcemanagementBusinessunit(DeleteWorkforcemanagementBusinessunitRequest request) throws IOException, ApiException
      Delete business unit A business unit cannot be deleted if it contains one or more management units
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunit

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunit(ApiRequest<Void> request) throws IOException
      Delete business unit A business unit cannot be deleted if it contains one or more management units
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitActivitycode

      public void deleteWorkforcemanagementBusinessunitActivitycode(String businessUnitId, String activityCodeId) throws IOException, ApiException
      Deletes an activity code
      Parameters:
      businessUnitId - The ID of the business unit, or 'mine' for the business unit of the logged-in user. (required)
      activityCodeId - The ID of the activity code to delete (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitActivitycodeWithHttpInfo

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitActivitycodeWithHttpInfo(String businessUnitId, String activityCodeId) throws IOException
      Deletes an activity code
      Parameters:
      businessUnitId - The ID of the business unit, or 'mine' for the business unit of the logged-in user. (required)
      activityCodeId - The ID of the activity code to delete (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitActivitycode

      public void deleteWorkforcemanagementBusinessunitActivitycode(DeleteWorkforcemanagementBusinessunitActivitycodeRequest request) throws IOException, ApiException
      Deletes an activity code
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitActivitycode

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitActivitycode(ApiRequest<Void> request) throws IOException
      Deletes an activity code
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistory

      public void deleteWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistory(String businessUnitId, String capacityPlanId, LocalDate beforeDateId) throws IOException, ApiException
      Delete staffing group allocations history created for a capacity plan before the given date
      Parameters:
      businessUnitId - The ID of the business unit (required)
      capacityPlanId - The ID of the capacity plan (required)
      beforeDateId - The date to delete records that are created on or before this date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryWithHttpInfo

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryWithHttpInfo(String businessUnitId, String capacityPlanId, LocalDate beforeDateId) throws IOException
      Delete staffing group allocations history created for a capacity plan before the given date
      Parameters:
      businessUnitId - The ID of the business unit (required)
      capacityPlanId - The ID of the capacity plan (required)
      beforeDateId - The date to delete records that are created on or before this date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistory

      public void deleteWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistory(DeleteWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryRequest request) throws IOException, ApiException
      Delete staffing group allocations history created for a capacity plan before the given date
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistory

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistory(ApiRequest<Void> request) throws IOException
      Delete staffing group allocations history created for a capacity plan before the given date
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitPlanninggroup

      public void deleteWorkforcemanagementBusinessunitPlanninggroup(String businessUnitId, String planningGroupId) throws IOException, ApiException
      Deletes the planning group
      Parameters:
      businessUnitId - The ID of the business unit. (required)
      planningGroupId - The ID of a planning group to delete (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitPlanninggroupWithHttpInfo

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitPlanninggroupWithHttpInfo(String businessUnitId, String planningGroupId) throws IOException
      Deletes the planning group
      Parameters:
      businessUnitId - The ID of the business unit. (required)
      planningGroupId - The ID of a planning group to delete (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitPlanninggroup

      public void deleteWorkforcemanagementBusinessunitPlanninggroup(DeleteWorkforcemanagementBusinessunitPlanninggroupRequest request) throws IOException, ApiException
      Deletes the planning group
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitPlanninggroup

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitPlanninggroup(ApiRequest<Void> request) throws IOException
      Deletes the planning group
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitSchedulingRun

      public void deleteWorkforcemanagementBusinessunitSchedulingRun(String businessUnitId, String runId) throws IOException, ApiException
      Cancel a scheduling run
      Parameters:
      businessUnitId - The ID of the business unit (required)
      runId - The ID of the schedule run (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitSchedulingRunWithHttpInfo

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitSchedulingRunWithHttpInfo(String businessUnitId, String runId) throws IOException
      Cancel a scheduling run
      Parameters:
      businessUnitId - The ID of the business unit (required)
      runId - The ID of the schedule run (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitSchedulingRun

      public void deleteWorkforcemanagementBusinessunitSchedulingRun(DeleteWorkforcemanagementBusinessunitSchedulingRunRequest request) throws IOException, ApiException
      Cancel a scheduling run
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitSchedulingRun

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitSchedulingRun(ApiRequest<Void> request) throws IOException
      Cancel a scheduling run
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitServicegoaltemplate

      public void deleteWorkforcemanagementBusinessunitServicegoaltemplate(String businessUnitId, String serviceGoalTemplateId) throws IOException, ApiException
      Delete a service goal template
      Parameters:
      businessUnitId - The ID of the business unit. (required)
      serviceGoalTemplateId - The ID of the service goal template to delete (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitServicegoaltemplateWithHttpInfo

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitServicegoaltemplateWithHttpInfo(String businessUnitId, String serviceGoalTemplateId) throws IOException
      Delete a service goal template
      Parameters:
      businessUnitId - The ID of the business unit. (required)
      serviceGoalTemplateId - The ID of the service goal template to delete (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitServicegoaltemplate

      public void deleteWorkforcemanagementBusinessunitServicegoaltemplate(DeleteWorkforcemanagementBusinessunitServicegoaltemplateRequest request) throws IOException, ApiException
      Delete a service goal template
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitServicegoaltemplate

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitServicegoaltemplate(ApiRequest<Void> request) throws IOException
      Delete a service goal template
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitStaffinggroup

      public void deleteWorkforcemanagementBusinessunitStaffinggroup(String businessUnitId, String staffingGroupId) throws IOException, ApiException
      Deletes a staffing group
      Parameters:
      businessUnitId - The ID of the business unit (required)
      staffingGroupId - The ID of the staffing group to delete (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitStaffinggroupWithHttpInfo

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitStaffinggroupWithHttpInfo(String businessUnitId, String staffingGroupId) throws IOException
      Deletes a staffing group
      Parameters:
      businessUnitId - The ID of the business unit (required)
      staffingGroupId - The ID of the staffing group to delete (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitStaffinggroup

      public void deleteWorkforcemanagementBusinessunitStaffinggroup(DeleteWorkforcemanagementBusinessunitStaffinggroupRequest request) throws IOException, ApiException
      Deletes a staffing group
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitStaffinggroup

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitStaffinggroup(ApiRequest<Void> request) throws IOException
      Deletes a staffing group
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitTimeofflimit

      public void deleteWorkforcemanagementBusinessunitTimeofflimit(String businessUnitId, String timeOffLimitId) throws IOException, ApiException
      Deletes a time-off limit object
      Parameters:
      businessUnitId - The ID of the business unit (required)
      timeOffLimitId - The ID of the time-off limit object to delete (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitTimeofflimitWithHttpInfo

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitTimeofflimitWithHttpInfo(String businessUnitId, String timeOffLimitId) throws IOException
      Deletes a time-off limit object
      Parameters:
      businessUnitId - The ID of the business unit (required)
      timeOffLimitId - The ID of the time-off limit object to delete (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitTimeofflimit

      public void deleteWorkforcemanagementBusinessunitTimeofflimit(DeleteWorkforcemanagementBusinessunitTimeofflimitRequest request) throws IOException, ApiException
      Deletes a time-off limit object
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitTimeofflimit

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitTimeofflimit(ApiRequest<Void> request) throws IOException
      Deletes a time-off limit object
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitTimeoffplan

      public void deleteWorkforcemanagementBusinessunitTimeoffplan(String businessUnitId, String timeOffPlanId) throws IOException, ApiException
      Deletes a time-off plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      timeOffPlanId - The ID of the time-off plan to delete (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitTimeoffplanWithHttpInfo

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitTimeoffplanWithHttpInfo(String businessUnitId, String timeOffPlanId) throws IOException
      Deletes a time-off plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      timeOffPlanId - The ID of the time-off plan to delete (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitTimeoffplan

      public void deleteWorkforcemanagementBusinessunitTimeoffplan(DeleteWorkforcemanagementBusinessunitTimeoffplanRequest request) throws IOException, ApiException
      Deletes a time-off plan
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitTimeoffplan

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitTimeoffplan(ApiRequest<Void> request) throws IOException
      Deletes a time-off plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitWeekSchedule

      public BuAsyncScheduleResponse deleteWorkforcemanagementBusinessunitWeekSchedule(String businessUnitId, LocalDate weekId, String scheduleId) throws IOException, ApiException
      Delete a schedule
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      scheduleId - The ID of the schedule (required)
      Returns:
      BuAsyncScheduleResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitWeekScheduleWithHttpInfo

      public ApiResponse<BuAsyncScheduleResponse> deleteWorkforcemanagementBusinessunitWeekScheduleWithHttpInfo(String businessUnitId, LocalDate weekId, String scheduleId) throws IOException
      Delete a schedule
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      scheduleId - The ID of the schedule (required)
      Returns:
      BuAsyncScheduleResponse
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitWeekSchedule

      public BuAsyncScheduleResponse deleteWorkforcemanagementBusinessunitWeekSchedule(DeleteWorkforcemanagementBusinessunitWeekScheduleRequest request) throws IOException, ApiException
      Delete a schedule
      Parameters:
      request - The request object
      Returns:
      BuAsyncScheduleResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitWeekSchedule

      public ApiResponse<BuAsyncScheduleResponse> deleteWorkforcemanagementBusinessunitWeekSchedule(ApiRequest<Void> request) throws IOException
      Delete a schedule
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitWeekShorttermforecast

      public void deleteWorkforcemanagementBusinessunitWeekShorttermforecast(String businessUnitId, LocalDate weekDateId, String forecastId) throws IOException, ApiException
      Delete a short term forecast Must not be tied to any schedules
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      forecastId - The ID of the forecast (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitWeekShorttermforecastWithHttpInfo

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitWeekShorttermforecastWithHttpInfo(String businessUnitId, LocalDate weekDateId, String forecastId) throws IOException
      Delete a short term forecast Must not be tied to any schedules
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      forecastId - The ID of the forecast (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitWeekShorttermforecast

      public void deleteWorkforcemanagementBusinessunitWeekShorttermforecast(DeleteWorkforcemanagementBusinessunitWeekShorttermforecastRequest request) throws IOException, ApiException
      Delete a short term forecast Must not be tied to any schedules
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitWeekShorttermforecast

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitWeekShorttermforecast(ApiRequest<Void> request) throws IOException
      Delete a short term forecast Must not be tied to any schedules
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitWorkplanbid

      public void deleteWorkforcemanagementBusinessunitWorkplanbid(String businessUnitId, String bidId) throws IOException, ApiException
      Delete a work plan bid
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The ID of the work plan bid (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitWorkplanbidWithHttpInfo

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitWorkplanbidWithHttpInfo(String businessUnitId, String bidId) throws IOException
      Delete a work plan bid
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The ID of the work plan bid (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitWorkplanbid

      public void deleteWorkforcemanagementBusinessunitWorkplanbid(DeleteWorkforcemanagementBusinessunitWorkplanbidRequest request) throws IOException, ApiException
      Delete a work plan bid
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitWorkplanbid

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitWorkplanbid(ApiRequest<Void> request) throws IOException
      Delete a work plan bid
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitWorkplanbidGroup

      public void deleteWorkforcemanagementBusinessunitWorkplanbidGroup(String businessUnitId, String bidId, String bidGroupId) throws IOException, ApiException
      Delete a bid group by bid group Id
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The work plan bid id of the bid groups (required)
      bidGroupId - Work Plan Bid Group id (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitWorkplanbidGroupWithHttpInfo

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitWorkplanbidGroupWithHttpInfo(String businessUnitId, String bidId, String bidGroupId) throws IOException
      Delete a bid group by bid group Id
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The work plan bid id of the bid groups (required)
      bidGroupId - Work Plan Bid Group id (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitWorkplanbidGroup

      public void deleteWorkforcemanagementBusinessunitWorkplanbidGroup(DeleteWorkforcemanagementBusinessunitWorkplanbidGroupRequest request) throws IOException, ApiException
      Delete a bid group by bid group Id
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementBusinessunitWorkplanbidGroup

      public ApiResponse<Void> deleteWorkforcemanagementBusinessunitWorkplanbidGroup(ApiRequest<Void> request) throws IOException
      Delete a bid group by bid group Id
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementCalendarUrlIcs

      public void deleteWorkforcemanagementCalendarUrlIcs() throws IOException, ApiException
      Disable generated calendar link for the current user
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementCalendarUrlIcsWithHttpInfo

      public ApiResponse<Void> deleteWorkforcemanagementCalendarUrlIcsWithHttpInfo() throws IOException
      Disable generated calendar link for the current user
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementCalendarUrlIcs

      public void deleteWorkforcemanagementCalendarUrlIcs(DeleteWorkforcemanagementCalendarUrlIcsRequest request) throws IOException, ApiException
      Disable generated calendar link for the current user
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementCalendarUrlIcs

      public ApiResponse<Void> deleteWorkforcemanagementCalendarUrlIcs(ApiRequest<Void> request) throws IOException
      Disable generated calendar link for the current user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementManagementunit

      public void deleteWorkforcemanagementManagementunit(String managementUnitId) throws IOException, ApiException
      Delete management unit
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementManagementunitWithHttpInfo

      public ApiResponse<Void> deleteWorkforcemanagementManagementunitWithHttpInfo(String managementUnitId) throws IOException
      Delete management unit
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementManagementunit

      public void deleteWorkforcemanagementManagementunit(DeleteWorkforcemanagementManagementunitRequest request) throws IOException, ApiException
      Delete management unit
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementManagementunit

      public ApiResponse<Void> deleteWorkforcemanagementManagementunit(ApiRequest<Void> request) throws IOException
      Delete management unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementManagementunitTimeofflimit

      public void deleteWorkforcemanagementManagementunitTimeofflimit(String managementUnitId, String timeOffLimitId) throws IOException, ApiException
      Deletes a time off limit object
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      timeOffLimitId - The ID of the time off limit object to delete (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementManagementunitTimeofflimitWithHttpInfo

      public ApiResponse<Void> deleteWorkforcemanagementManagementunitTimeofflimitWithHttpInfo(String managementUnitId, String timeOffLimitId) throws IOException
      Deletes a time off limit object
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      timeOffLimitId - The ID of the time off limit object to delete (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementManagementunitTimeofflimit

      public void deleteWorkforcemanagementManagementunitTimeofflimit(DeleteWorkforcemanagementManagementunitTimeofflimitRequest request) throws IOException, ApiException
      Deletes a time off limit object
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementManagementunitTimeofflimit

      public ApiResponse<Void> deleteWorkforcemanagementManagementunitTimeofflimit(ApiRequest<Void> request) throws IOException
      Deletes a time off limit object
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementManagementunitTimeoffplan

      public void deleteWorkforcemanagementManagementunitTimeoffplan(String managementUnitId, String timeOffPlanId) throws IOException, ApiException
      Deletes a time off plan
      Parameters:
      managementUnitId - The ID of the management unit (required)
      timeOffPlanId - The ID of the time off plan to delete (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementManagementunitTimeoffplanWithHttpInfo

      public ApiResponse<Void> deleteWorkforcemanagementManagementunitTimeoffplanWithHttpInfo(String managementUnitId, String timeOffPlanId) throws IOException
      Deletes a time off plan
      Parameters:
      managementUnitId - The ID of the management unit (required)
      timeOffPlanId - The ID of the time off plan to delete (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementManagementunitTimeoffplan

      public void deleteWorkforcemanagementManagementunitTimeoffplan(DeleteWorkforcemanagementManagementunitTimeoffplanRequest request) throws IOException, ApiException
      Deletes a time off plan
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementManagementunitTimeoffplan

      public ApiResponse<Void> deleteWorkforcemanagementManagementunitTimeoffplan(ApiRequest<Void> request) throws IOException
      Deletes a time off plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementManagementunitWorkplan

      public void deleteWorkforcemanagementManagementunitWorkplan(String managementUnitId, String workPlanId) throws IOException, ApiException
      Delete a work plan
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      workPlanId - The ID of the work plan to delete (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementManagementunitWorkplanWithHttpInfo

      public ApiResponse<Void> deleteWorkforcemanagementManagementunitWorkplanWithHttpInfo(String managementUnitId, String workPlanId) throws IOException
      Delete a work plan
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      workPlanId - The ID of the work plan to delete (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementManagementunitWorkplan

      public void deleteWorkforcemanagementManagementunitWorkplan(DeleteWorkforcemanagementManagementunitWorkplanRequest request) throws IOException, ApiException
      Delete a work plan
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementManagementunitWorkplan

      public ApiResponse<Void> deleteWorkforcemanagementManagementunitWorkplan(ApiRequest<Void> request) throws IOException
      Delete a work plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementManagementunitWorkplanrotation

      public void deleteWorkforcemanagementManagementunitWorkplanrotation(String managementUnitId, String workPlanRotationId) throws IOException, ApiException
      Delete a work plan rotation
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      workPlanRotationId - The ID of the work plan rotation to be deleted (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementManagementunitWorkplanrotationWithHttpInfo

      public ApiResponse<Void> deleteWorkforcemanagementManagementunitWorkplanrotationWithHttpInfo(String managementUnitId, String workPlanRotationId) throws IOException
      Delete a work plan rotation
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      workPlanRotationId - The ID of the work plan rotation to be deleted (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementManagementunitWorkplanrotation

      public void deleteWorkforcemanagementManagementunitWorkplanrotation(DeleteWorkforcemanagementManagementunitWorkplanrotationRequest request) throws IOException, ApiException
      Delete a work plan rotation
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteWorkforcemanagementManagementunitWorkplanrotation

      public ApiResponse<Void> deleteWorkforcemanagementManagementunitWorkplanrotation(ApiRequest<Void> request) throws IOException
      Delete a work plan rotation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAdherence

      public List<UserScheduleAdherence> getWorkforcemanagementAdherence(List<String> userId) throws IOException, ApiException
      Get a list of UserScheduleAdherence records for the requested users
      Parameters:
      userId - User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request (required)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAdherenceWithHttpInfo

      public ApiResponse<List<UserScheduleAdherence>> getWorkforcemanagementAdherenceWithHttpInfo(List<String> userId) throws IOException
      Get a list of UserScheduleAdherence records for the requested users
      Parameters:
      userId - User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request (required)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAdherence

      public List<UserScheduleAdherence> getWorkforcemanagementAdherence(GetWorkforcemanagementAdherenceRequest request) throws IOException, ApiException
      Get a list of UserScheduleAdherence records for the requested users
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAdherence

      public ApiResponse<List<UserScheduleAdherence>> getWorkforcemanagementAdherence(ApiRequest<Void> request) throws IOException
      Get a list of UserScheduleAdherence records for the requested users
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAdherenceExplanation

      public AdherenceExplanationResponse getWorkforcemanagementAdherenceExplanation(String explanationId) throws IOException, ApiException
      Get an adherence explanation for the current user
      Parameters:
      explanationId - The ID of the explanation to update (required)
      Returns:
      AdherenceExplanationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAdherenceExplanationWithHttpInfo

      public ApiResponse<AdherenceExplanationResponse> getWorkforcemanagementAdherenceExplanationWithHttpInfo(String explanationId) throws IOException
      Get an adherence explanation for the current user
      Parameters:
      explanationId - The ID of the explanation to update (required)
      Returns:
      AdherenceExplanationResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAdherenceExplanation

      public AdherenceExplanationResponse getWorkforcemanagementAdherenceExplanation(GetWorkforcemanagementAdherenceExplanationRequest request) throws IOException, ApiException
      Get an adherence explanation for the current user
      Parameters:
      request - The request object
      Returns:
      AdherenceExplanationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAdherenceExplanation

      public ApiResponse<AdherenceExplanationResponse> getWorkforcemanagementAdherenceExplanation(ApiRequest<Void> request) throws IOException
      Get an adherence explanation for the current user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAdherenceExplanationsJob

      public AdherenceExplanationJob getWorkforcemanagementAdherenceExplanationsJob(String jobId) throws IOException, ApiException
      Query the status of an adherence explanation operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      jobId - The ID of the job (required)
      Returns:
      AdherenceExplanationJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAdherenceExplanationsJobWithHttpInfo

      public ApiResponse<AdherenceExplanationJob> getWorkforcemanagementAdherenceExplanationsJobWithHttpInfo(String jobId) throws IOException
      Query the status of an adherence explanation operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      jobId - The ID of the job (required)
      Returns:
      AdherenceExplanationJob
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAdherenceExplanationsJob

      public AdherenceExplanationJob getWorkforcemanagementAdherenceExplanationsJob(GetWorkforcemanagementAdherenceExplanationsJobRequest request) throws IOException, ApiException
      Query the status of an adherence explanation operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      AdherenceExplanationJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAdherenceExplanationsJob

      public ApiResponse<AdherenceExplanationJob> getWorkforcemanagementAdherenceExplanationsJob(ApiRequest<Void> request) throws IOException
      Query the status of an adherence explanation operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAdherenceHistoricalBulkJob

      public WfmHistoricalAdherenceBulkResponse getWorkforcemanagementAdherenceHistoricalBulkJob(String jobId) throws IOException, ApiException
      Request to fetch the status of the historical adherence bulk job. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      jobId - ID of the job to get (required)
      Returns:
      WfmHistoricalAdherenceBulkResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAdherenceHistoricalBulkJobWithHttpInfo

      public ApiResponse<WfmHistoricalAdherenceBulkResponse> getWorkforcemanagementAdherenceHistoricalBulkJobWithHttpInfo(String jobId) throws IOException
      Request to fetch the status of the historical adherence bulk job. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      jobId - ID of the job to get (required)
      Returns:
      WfmHistoricalAdherenceBulkResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAdherenceHistoricalBulkJob

      public WfmHistoricalAdherenceBulkResponse getWorkforcemanagementAdherenceHistoricalBulkJob(GetWorkforcemanagementAdherenceHistoricalBulkJobRequest request) throws IOException, ApiException
      Request to fetch the status of the historical adherence bulk job. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      WfmHistoricalAdherenceBulkResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAdherenceHistoricalBulkJob

      public ApiResponse<WfmHistoricalAdherenceBulkResponse> getWorkforcemanagementAdherenceHistoricalBulkJob(ApiRequest<Void> request) throws IOException
      Request to fetch the status of the historical adherence bulk job. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAdherenceHistoricalJob

      public WfmHistoricalAdherenceResponse getWorkforcemanagementAdherenceHistoricalJob(String jobId) throws IOException, ApiException
      Query the status of a historical adherence request operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      jobId - jobId (required)
      Returns:
      WfmHistoricalAdherenceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAdherenceHistoricalJobWithHttpInfo

      public ApiResponse<WfmHistoricalAdherenceResponse> getWorkforcemanagementAdherenceHistoricalJobWithHttpInfo(String jobId) throws IOException
      Query the status of a historical adherence request operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      jobId - jobId (required)
      Returns:
      WfmHistoricalAdherenceResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAdherenceHistoricalJob

      public WfmHistoricalAdherenceResponse getWorkforcemanagementAdherenceHistoricalJob(GetWorkforcemanagementAdherenceHistoricalJobRequest request) throws IOException, ApiException
      Query the status of a historical adherence request operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      WfmHistoricalAdherenceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAdherenceHistoricalJob

      public ApiResponse<WfmHistoricalAdherenceResponse> getWorkforcemanagementAdherenceHistoricalJob(ApiRequest<Void> request) throws IOException
      Query the status of a historical adherence request operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAgentAdherenceExplanation

      public AdherenceExplanationResponse getWorkforcemanagementAgentAdherenceExplanation(String agentId, String explanationId) throws IOException, ApiException
      Get an adherence explanation
      Parameters:
      agentId - The ID of the agent to query (required)
      explanationId - The ID of the explanation to update (required)
      Returns:
      AdherenceExplanationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAgentAdherenceExplanationWithHttpInfo

      public ApiResponse<AdherenceExplanationResponse> getWorkforcemanagementAgentAdherenceExplanationWithHttpInfo(String agentId, String explanationId) throws IOException
      Get an adherence explanation
      Parameters:
      agentId - The ID of the agent to query (required)
      explanationId - The ID of the explanation to update (required)
      Returns:
      AdherenceExplanationResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAgentAdherenceExplanation

      public AdherenceExplanationResponse getWorkforcemanagementAgentAdherenceExplanation(GetWorkforcemanagementAgentAdherenceExplanationRequest request) throws IOException, ApiException
      Get an adherence explanation
      Parameters:
      request - The request object
      Returns:
      AdherenceExplanationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAgentAdherenceExplanation

      public ApiResponse<AdherenceExplanationResponse> getWorkforcemanagementAgentAdherenceExplanation(ApiRequest<Void> request) throws IOException
      Get an adherence explanation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAgentManagementunit

      public AgentManagementUnitReference getWorkforcemanagementAgentManagementunit(String agentId) throws IOException, ApiException
      Get the management unit to which the agent belongs
      Parameters:
      agentId - The ID of the agent to look up (required)
      Returns:
      AgentManagementUnitReference
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAgentManagementunitWithHttpInfo

      public ApiResponse<AgentManagementUnitReference> getWorkforcemanagementAgentManagementunitWithHttpInfo(String agentId) throws IOException
      Get the management unit to which the agent belongs
      Parameters:
      agentId - The ID of the agent to look up (required)
      Returns:
      AgentManagementUnitReference
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAgentManagementunit

      public AgentManagementUnitReference getWorkforcemanagementAgentManagementunit(GetWorkforcemanagementAgentManagementunitRequest request) throws IOException, ApiException
      Get the management unit to which the agent belongs
      Parameters:
      request - The request object
      Returns:
      AgentManagementUnitReference
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAgentManagementunit

      public ApiResponse<AgentManagementUnitReference> getWorkforcemanagementAgentManagementunit(ApiRequest<Void> request) throws IOException
      Get the management unit to which the agent belongs
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAgentsMeAdherenceHistoricalJob

      public WfmAgentHistoricalAdherenceResponse getWorkforcemanagementAgentsMeAdherenceHistoricalJob(String jobId) throws IOException, ApiException
      Request to fetch the status of the agent adherence job. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      jobId - ID of the job to get (required)
      Returns:
      WfmAgentHistoricalAdherenceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAgentsMeAdherenceHistoricalJobWithHttpInfo

      public ApiResponse<WfmAgentHistoricalAdherenceResponse> getWorkforcemanagementAgentsMeAdherenceHistoricalJobWithHttpInfo(String jobId) throws IOException
      Request to fetch the status of the agent adherence job. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      jobId - ID of the job to get (required)
      Returns:
      WfmAgentHistoricalAdherenceResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAgentsMeAdherenceHistoricalJob

      public WfmAgentHistoricalAdherenceResponse getWorkforcemanagementAgentsMeAdherenceHistoricalJob(GetWorkforcemanagementAgentsMeAdherenceHistoricalJobRequest request) throws IOException, ApiException
      Request to fetch the status of the agent adherence job. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      WfmAgentHistoricalAdherenceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAgentsMeAdherenceHistoricalJob

      public ApiResponse<WfmAgentHistoricalAdherenceResponse> getWorkforcemanagementAgentsMeAdherenceHistoricalJob(ApiRequest<Void> request) throws IOException
      Request to fetch the status of the agent adherence job. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAgentsMeManagementunit

      public AgentManagementUnitReference getWorkforcemanagementAgentsMeManagementunit() throws IOException, ApiException
      Get the management unit to which the currently logged in agent belongs
      Returns:
      AgentManagementUnitReference
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAgentsMeManagementunitWithHttpInfo

      public ApiResponse<AgentManagementUnitReference> getWorkforcemanagementAgentsMeManagementunitWithHttpInfo() throws IOException
      Get the management unit to which the currently logged in agent belongs
      Returns:
      AgentManagementUnitReference
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAgentsMeManagementunit

      public AgentManagementUnitReference getWorkforcemanagementAgentsMeManagementunit(GetWorkforcemanagementAgentsMeManagementunitRequest request) throws IOException, ApiException
      Get the management unit to which the currently logged in agent belongs
      Parameters:
      request - The request object
      Returns:
      AgentManagementUnitReference
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAgentsMeManagementunit

      public ApiResponse<AgentManagementUnitReference> getWorkforcemanagementAgentsMeManagementunit(ApiRequest<Void> request) throws IOException
      Get the management unit to which the currently logged in agent belongs
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsOffersJob

      public AlternativeShiftJobResponse getWorkforcemanagementAlternativeshiftsOffersJob(String jobId) throws IOException, ApiException
      Query the status of an alternative shift offers operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      jobId - The ID of the job (required)
      Returns:
      AlternativeShiftJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsOffersJobWithHttpInfo

      public ApiResponse<AlternativeShiftJobResponse> getWorkforcemanagementAlternativeshiftsOffersJobWithHttpInfo(String jobId) throws IOException
      Query the status of an alternative shift offers operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      jobId - The ID of the job (required)
      Returns:
      AlternativeShiftJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsOffersJob

      public AlternativeShiftJobResponse getWorkforcemanagementAlternativeshiftsOffersJob(GetWorkforcemanagementAlternativeshiftsOffersJobRequest request) throws IOException, ApiException
      Query the status of an alternative shift offers operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      AlternativeShiftJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsOffersJob

      public ApiResponse<AlternativeShiftJobResponse> getWorkforcemanagementAlternativeshiftsOffersJob(ApiRequest<Void> request) throws IOException
      Query the status of an alternative shift offers operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsOffersSearchJob

      public AlternativeShiftJobResponse getWorkforcemanagementAlternativeshiftsOffersSearchJob(String jobId) throws IOException, ApiException
      Query the status of an alternative shift search offers operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      jobId - The ID of the job (required)
      Returns:
      AlternativeShiftJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsOffersSearchJobWithHttpInfo

      public ApiResponse<AlternativeShiftJobResponse> getWorkforcemanagementAlternativeshiftsOffersSearchJobWithHttpInfo(String jobId) throws IOException
      Query the status of an alternative shift search offers operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      jobId - The ID of the job (required)
      Returns:
      AlternativeShiftJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsOffersSearchJob

      public AlternativeShiftJobResponse getWorkforcemanagementAlternativeshiftsOffersSearchJob(GetWorkforcemanagementAlternativeshiftsOffersSearchJobRequest request) throws IOException, ApiException
      Query the status of an alternative shift search offers operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      AlternativeShiftJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsOffersSearchJob

      public ApiResponse<AlternativeShiftJobResponse> getWorkforcemanagementAlternativeshiftsOffersSearchJob(ApiRequest<Void> request) throws IOException
      Query the status of an alternative shift search offers operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsSettings

      public AlternativeShiftBuSettingsResponse getWorkforcemanagementAlternativeshiftsSettings() throws IOException, ApiException
      Get alternative shifts settings from the current logged in agent’s business unit
      Returns:
      AlternativeShiftBuSettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsSettingsWithHttpInfo

      public ApiResponse<AlternativeShiftBuSettingsResponse> getWorkforcemanagementAlternativeshiftsSettingsWithHttpInfo() throws IOException
      Get alternative shifts settings from the current logged in agent’s business unit
      Returns:
      AlternativeShiftBuSettingsResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsSettings

      public AlternativeShiftBuSettingsResponse getWorkforcemanagementAlternativeshiftsSettings(GetWorkforcemanagementAlternativeshiftsSettingsRequest request) throws IOException, ApiException
      Get alternative shifts settings from the current logged in agent’s business unit
      Parameters:
      request - The request object
      Returns:
      AlternativeShiftBuSettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsSettings

      public ApiResponse<AlternativeShiftBuSettingsResponse> getWorkforcemanagementAlternativeshiftsSettings(ApiRequest<Void> request) throws IOException
      Get alternative shifts settings from the current logged in agent’s business unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsTrade

      public AlternativeShiftTradeResponse getWorkforcemanagementAlternativeshiftsTrade(String tradeId) throws IOException, ApiException
      Get my alternative shift trade by trade ID
      Parameters:
      tradeId - The ID of the alternative shift trade (required)
      Returns:
      AlternativeShiftTradeResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsTradeWithHttpInfo

      public ApiResponse<AlternativeShiftTradeResponse> getWorkforcemanagementAlternativeshiftsTradeWithHttpInfo(String tradeId) throws IOException
      Get my alternative shift trade by trade ID
      Parameters:
      tradeId - The ID of the alternative shift trade (required)
      Returns:
      AlternativeShiftTradeResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsTrade

      public AlternativeShiftTradeResponse getWorkforcemanagementAlternativeshiftsTrade(GetWorkforcemanagementAlternativeshiftsTradeRequest request) throws IOException, ApiException
      Get my alternative shift trade by trade ID
      Parameters:
      request - The request object
      Returns:
      AlternativeShiftTradeResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsTrade

      public ApiResponse<AlternativeShiftTradeResponse> getWorkforcemanagementAlternativeshiftsTrade(ApiRequest<Void> request) throws IOException
      Get my alternative shift trade by trade ID
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsTrades

      public ListAlternativeShiftTradesResponse getWorkforcemanagementAlternativeshiftsTrades(Boolean forceAsync) throws IOException, ApiException
      Get a list of my alternative shifts trades
      Parameters:
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      ListAlternativeShiftTradesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsTradesWithHttpInfo

      public ApiResponse<ListAlternativeShiftTradesResponse> getWorkforcemanagementAlternativeshiftsTradesWithHttpInfo(Boolean forceAsync) throws IOException
      Get a list of my alternative shifts trades
      Parameters:
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      ListAlternativeShiftTradesResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsTrades

      public ListAlternativeShiftTradesResponse getWorkforcemanagementAlternativeshiftsTrades(GetWorkforcemanagementAlternativeshiftsTradesRequest request) throws IOException, ApiException
      Get a list of my alternative shifts trades
      Parameters:
      request - The request object
      Returns:
      ListAlternativeShiftTradesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsTrades

      public ApiResponse<ListAlternativeShiftTradesResponse> getWorkforcemanagementAlternativeshiftsTrades(ApiRequest<Void> request) throws IOException
      Get a list of my alternative shifts trades
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsTradesJob

      public AlternativeShiftJobResponse getWorkforcemanagementAlternativeshiftsTradesJob(String jobId) throws IOException, ApiException
      Query the status of an alternative shift trades operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      jobId - The ID of the job (required)
      Returns:
      AlternativeShiftJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsTradesJobWithHttpInfo

      public ApiResponse<AlternativeShiftJobResponse> getWorkforcemanagementAlternativeshiftsTradesJobWithHttpInfo(String jobId) throws IOException
      Query the status of an alternative shift trades operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      jobId - The ID of the job (required)
      Returns:
      AlternativeShiftJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsTradesJob

      public AlternativeShiftJobResponse getWorkforcemanagementAlternativeshiftsTradesJob(GetWorkforcemanagementAlternativeshiftsTradesJobRequest request) throws IOException, ApiException
      Query the status of an alternative shift trades operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      AlternativeShiftJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsTradesJob

      public ApiResponse<AlternativeShiftJobResponse> getWorkforcemanagementAlternativeshiftsTradesJob(ApiRequest<Void> request) throws IOException
      Query the status of an alternative shift trades operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsTradesStateJob

      public AlternativeShiftJobResponse getWorkforcemanagementAlternativeshiftsTradesStateJob(String jobId) throws IOException, ApiException
      Query the status of an alternative shift trade state operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      jobId - The ID of the job (required)
      Returns:
      AlternativeShiftJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsTradesStateJobWithHttpInfo

      public ApiResponse<AlternativeShiftJobResponse> getWorkforcemanagementAlternativeshiftsTradesStateJobWithHttpInfo(String jobId) throws IOException
      Query the status of an alternative shift trade state operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      jobId - The ID of the job (required)
      Returns:
      AlternativeShiftJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsTradesStateJob

      public AlternativeShiftJobResponse getWorkforcemanagementAlternativeshiftsTradesStateJob(GetWorkforcemanagementAlternativeshiftsTradesStateJobRequest request) throws IOException, ApiException
      Query the status of an alternative shift trade state operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      AlternativeShiftJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementAlternativeshiftsTradesStateJob

      public ApiResponse<AlternativeShiftJobResponse> getWorkforcemanagementAlternativeshiftsTradesStateJob(ApiRequest<Void> request) throws IOException
      Query the status of an alternative shift trade state operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunit

      public BusinessUnitResponse getWorkforcemanagementBusinessunit(String businessUnitId, List<String> expand, Boolean includeSchedulingDefaultMessageSeverities) throws IOException, ApiException
      Get business unit Expanding \"settings\" will retrieve all settings. All other expands will retrieve only the requested settings field(s).
      Parameters:
      businessUnitId - The ID of the business unit, or 'mine' for the business unit of the logged-in user. (required)
      expand - Include to access additional data on the business unit (optional)
      includeSchedulingDefaultMessageSeverities - Whether to include scheduling default message severities (optional)
      Returns:
      BusinessUnitResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWithHttpInfo

      public ApiResponse<BusinessUnitResponse> getWorkforcemanagementBusinessunitWithHttpInfo(String businessUnitId, List<String> expand, Boolean includeSchedulingDefaultMessageSeverities) throws IOException
      Get business unit Expanding \"settings\" will retrieve all settings. All other expands will retrieve only the requested settings field(s).
      Parameters:
      businessUnitId - The ID of the business unit, or 'mine' for the business unit of the logged-in user. (required)
      expand - Include to access additional data on the business unit (optional)
      includeSchedulingDefaultMessageSeverities - Whether to include scheduling default message severities (optional)
      Returns:
      BusinessUnitResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunit

      public BusinessUnitResponse getWorkforcemanagementBusinessunit(GetWorkforcemanagementBusinessunitRequest request) throws IOException, ApiException
      Get business unit Expanding \"settings\" will retrieve all settings. All other expands will retrieve only the requested settings field(s).
      Parameters:
      request - The request object
      Returns:
      BusinessUnitResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunit

      public ApiResponse<BusinessUnitResponse> getWorkforcemanagementBusinessunit(ApiRequest<Void> request) throws IOException
      Get business unit Expanding \"settings\" will retrieve all settings. All other expands will retrieve only the requested settings field(s).
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivitycode

      public BusinessUnitActivityCode getWorkforcemanagementBusinessunitActivitycode(String businessUnitId, String activityCodeId) throws IOException, ApiException
      Get an activity code
      Parameters:
      businessUnitId - The ID of the business unit, or 'mine' for the business unit of the logged-in user. (required)
      activityCodeId - The ID of the activity code to fetch (required)
      Returns:
      BusinessUnitActivityCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivitycodeWithHttpInfo

      public ApiResponse<BusinessUnitActivityCode> getWorkforcemanagementBusinessunitActivitycodeWithHttpInfo(String businessUnitId, String activityCodeId) throws IOException
      Get an activity code
      Parameters:
      businessUnitId - The ID of the business unit, or 'mine' for the business unit of the logged-in user. (required)
      activityCodeId - The ID of the activity code to fetch (required)
      Returns:
      BusinessUnitActivityCode
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivitycode

      public BusinessUnitActivityCode getWorkforcemanagementBusinessunitActivitycode(GetWorkforcemanagementBusinessunitActivitycodeRequest request) throws IOException, ApiException
      Get an activity code
      Parameters:
      request - The request object
      Returns:
      BusinessUnitActivityCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivitycode

      public ApiResponse<BusinessUnitActivityCode> getWorkforcemanagementBusinessunitActivitycode(ApiRequest<Void> request) throws IOException
      Get an activity code
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivitycodes

      public BusinessUnitActivityCodeListing getWorkforcemanagementBusinessunitActivitycodes(String businessUnitId, Boolean forceDownloadService) throws IOException, ApiException
      Get activity codes
      Parameters:
      businessUnitId - The ID of the business unit, or 'mine' for the business unit of the logged-in user. (required)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      BusinessUnitActivityCodeListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivitycodesWithHttpInfo

      public ApiResponse<BusinessUnitActivityCodeListing> getWorkforcemanagementBusinessunitActivitycodesWithHttpInfo(String businessUnitId, Boolean forceDownloadService) throws IOException
      Get activity codes
      Parameters:
      businessUnitId - The ID of the business unit, or 'mine' for the business unit of the logged-in user. (required)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      BusinessUnitActivityCodeListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivitycodes

      public BusinessUnitActivityCodeListing getWorkforcemanagementBusinessunitActivitycodes(GetWorkforcemanagementBusinessunitActivitycodesRequest request) throws IOException, ApiException
      Get activity codes
      Parameters:
      request - The request object
      Returns:
      BusinessUnitActivityCodeListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivitycodes

      public ApiResponse<BusinessUnitActivityCodeListing> getWorkforcemanagementBusinessunitActivitycodes(ApiRequest<Void> request) throws IOException
      Get activity codes
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivityplan

      public ActivityPlanResponse getWorkforcemanagementBusinessunitActivityplan(String businessUnitId, String activityPlanId) throws IOException, ApiException
      Get an activity plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      activityPlanId - The ID of the activity plan to fetch (required)
      Returns:
      ActivityPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivityplanWithHttpInfo

      public ApiResponse<ActivityPlanResponse> getWorkforcemanagementBusinessunitActivityplanWithHttpInfo(String businessUnitId, String activityPlanId) throws IOException
      Get an activity plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      activityPlanId - The ID of the activity plan to fetch (required)
      Returns:
      ActivityPlanResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivityplan

      public ActivityPlanResponse getWorkforcemanagementBusinessunitActivityplan(GetWorkforcemanagementBusinessunitActivityplanRequest request) throws IOException, ApiException
      Get an activity plan
      Parameters:
      request - The request object
      Returns:
      ActivityPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivityplan

      public ApiResponse<ActivityPlanResponse> getWorkforcemanagementBusinessunitActivityplan(ApiRequest<Void> request) throws IOException
      Get an activity plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivityplanRunsJob

      public ActivityPlanJobResponse getWorkforcemanagementBusinessunitActivityplanRunsJob(String businessUnitId, String activityPlanId, String jobId) throws IOException, ApiException
      Gets an activity plan run job
      Parameters:
      businessUnitId - The ID of the business unit (required)
      activityPlanId - The ID of the activity plan associated with the run job (required)
      jobId - The ID of the activity plan run job (required)
      Returns:
      ActivityPlanJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivityplanRunsJobWithHttpInfo

      public ApiResponse<ActivityPlanJobResponse> getWorkforcemanagementBusinessunitActivityplanRunsJobWithHttpInfo(String businessUnitId, String activityPlanId, String jobId) throws IOException
      Gets an activity plan run job
      Parameters:
      businessUnitId - The ID of the business unit (required)
      activityPlanId - The ID of the activity plan associated with the run job (required)
      jobId - The ID of the activity plan run job (required)
      Returns:
      ActivityPlanJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivityplanRunsJob

      public ActivityPlanJobResponse getWorkforcemanagementBusinessunitActivityplanRunsJob(GetWorkforcemanagementBusinessunitActivityplanRunsJobRequest request) throws IOException, ApiException
      Gets an activity plan run job
      Parameters:
      request - The request object
      Returns:
      ActivityPlanJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivityplanRunsJob

      public ApiResponse<ActivityPlanJobResponse> getWorkforcemanagementBusinessunitActivityplanRunsJob(ApiRequest<Void> request) throws IOException
      Gets an activity plan run job
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivityplans

      public ActivityPlanListing getWorkforcemanagementBusinessunitActivityplans(String businessUnitId, String state) throws IOException, ApiException
      Get activity plans
      Parameters:
      businessUnitId - The ID of the business unit (required)
      state - Optionally filter by activity plan state (optional)
      Returns:
      ActivityPlanListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivityplansWithHttpInfo

      public ApiResponse<ActivityPlanListing> getWorkforcemanagementBusinessunitActivityplansWithHttpInfo(String businessUnitId, String state) throws IOException
      Get activity plans
      Parameters:
      businessUnitId - The ID of the business unit (required)
      state - Optionally filter by activity plan state (optional)
      Returns:
      ActivityPlanListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivityplans

      public ActivityPlanListing getWorkforcemanagementBusinessunitActivityplans(GetWorkforcemanagementBusinessunitActivityplansRequest request) throws IOException, ApiException
      Get activity plans
      Parameters:
      request - The request object
      Returns:
      ActivityPlanListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivityplans

      public ApiResponse<ActivityPlanListing> getWorkforcemanagementBusinessunitActivityplans(ApiRequest<Void> request) throws IOException
      Get activity plans
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivityplansJobs

      public ActivityPlanJobListing getWorkforcemanagementBusinessunitActivityplansJobs(String businessUnitId) throws IOException, ApiException
      Gets the latest job for all activity plans in the business unit
      Parameters:
      businessUnitId - The ID of the business unit (required)
      Returns:
      ActivityPlanJobListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivityplansJobsWithHttpInfo

      public ApiResponse<ActivityPlanJobListing> getWorkforcemanagementBusinessunitActivityplansJobsWithHttpInfo(String businessUnitId) throws IOException
      Gets the latest job for all activity plans in the business unit
      Parameters:
      businessUnitId - The ID of the business unit (required)
      Returns:
      ActivityPlanJobListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivityplansJobs

      public ActivityPlanJobListing getWorkforcemanagementBusinessunitActivityplansJobs(GetWorkforcemanagementBusinessunitActivityplansJobsRequest request) throws IOException, ApiException
      Gets the latest job for all activity plans in the business unit
      Parameters:
      request - The request object
      Returns:
      ActivityPlanJobListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitActivityplansJobs

      public ApiResponse<ActivityPlanJobListing> getWorkforcemanagementBusinessunitActivityplansJobs(ApiRequest<Void> request) throws IOException
      Gets the latest job for all activity plans in the business unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitAlternativeshiftsSettings

      public AlternativeShiftBuSettingsResponse getWorkforcemanagementBusinessunitAlternativeshiftsSettings(String businessUnitId) throws IOException, ApiException
      Get alternative shifts settings for a business unit
      Parameters:
      businessUnitId - The ID of the business unit (required)
      Returns:
      AlternativeShiftBuSettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitAlternativeshiftsSettingsWithHttpInfo

      public ApiResponse<AlternativeShiftBuSettingsResponse> getWorkforcemanagementBusinessunitAlternativeshiftsSettingsWithHttpInfo(String businessUnitId) throws IOException
      Get alternative shifts settings for a business unit
      Parameters:
      businessUnitId - The ID of the business unit (required)
      Returns:
      AlternativeShiftBuSettingsResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitAlternativeshiftsSettings

      public AlternativeShiftBuSettingsResponse getWorkforcemanagementBusinessunitAlternativeshiftsSettings(GetWorkforcemanagementBusinessunitAlternativeshiftsSettingsRequest request) throws IOException, ApiException
      Get alternative shifts settings for a business unit
      Parameters:
      request - The request object
      Returns:
      AlternativeShiftBuSettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitAlternativeshiftsSettings

      public ApiResponse<AlternativeShiftBuSettingsResponse> getWorkforcemanagementBusinessunitAlternativeshiftsSettings(ApiRequest<Void> request) throws IOException
      Get alternative shifts settings for a business unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitAlternativeshiftsTrade

      public AlternativeShiftTradeResponse getWorkforcemanagementBusinessunitAlternativeshiftsTrade(String businessUnitId, String tradeId) throws IOException, ApiException
      Get an alternative shifts trade in a business unit for a given trade ID
      Parameters:
      businessUnitId - The ID of the business unit (required)
      tradeId - The ID of the alternative shift trade (required)
      Returns:
      AlternativeShiftTradeResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitAlternativeshiftsTradeWithHttpInfo

      public ApiResponse<AlternativeShiftTradeResponse> getWorkforcemanagementBusinessunitAlternativeshiftsTradeWithHttpInfo(String businessUnitId, String tradeId) throws IOException
      Get an alternative shifts trade in a business unit for a given trade ID
      Parameters:
      businessUnitId - The ID of the business unit (required)
      tradeId - The ID of the alternative shift trade (required)
      Returns:
      AlternativeShiftTradeResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitAlternativeshiftsTrade

      public AlternativeShiftTradeResponse getWorkforcemanagementBusinessunitAlternativeshiftsTrade(GetWorkforcemanagementBusinessunitAlternativeshiftsTradeRequest request) throws IOException, ApiException
      Get an alternative shifts trade in a business unit for a given trade ID
      Parameters:
      request - The request object
      Returns:
      AlternativeShiftTradeResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitAlternativeshiftsTrade

      public ApiResponse<AlternativeShiftTradeResponse> getWorkforcemanagementBusinessunitAlternativeshiftsTrade(ApiRequest<Void> request) throws IOException
      Get an alternative shifts trade in a business unit for a given trade ID
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob

      public BuAlternativeShiftJobResponse getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob(String businessUnitId, String jobId) throws IOException, ApiException
      Query the status of an alternative shift search trade operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      businessUnitId - The ID of the business unit (required)
      jobId - The ID of the job (required)
      Returns:
      BuAlternativeShiftJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJobWithHttpInfo

      public ApiResponse<BuAlternativeShiftJobResponse> getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJobWithHttpInfo(String businessUnitId, String jobId) throws IOException
      Query the status of an alternative shift search trade operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      businessUnitId - The ID of the business unit (required)
      jobId - The ID of the job (required)
      Returns:
      BuAlternativeShiftJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob

      public BuAlternativeShiftJobResponse getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob(GetWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJobRequest request) throws IOException, ApiException
      Query the status of an alternative shift search trade operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      BuAlternativeShiftJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob

      public ApiResponse<BuAlternativeShiftJobResponse> getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob(ApiRequest<Void> request) throws IOException
      Query the status of an alternative shift search trade operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitCapacityplan

      public CapacityPlanResponse getWorkforcemanagementBusinessunitCapacityplan(String businessUnitId, String capacityPlanId) throws IOException, ApiException
      Get a capacity plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      capacityPlanId - The ID of the capacity plan (required)
      Returns:
      CapacityPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitCapacityplanWithHttpInfo

      public ApiResponse<CapacityPlanResponse> getWorkforcemanagementBusinessunitCapacityplanWithHttpInfo(String businessUnitId, String capacityPlanId) throws IOException
      Get a capacity plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      capacityPlanId - The ID of the capacity plan (required)
      Returns:
      CapacityPlanResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitCapacityplan

      public CapacityPlanResponse getWorkforcemanagementBusinessunitCapacityplan(GetWorkforcemanagementBusinessunitCapacityplanRequest request) throws IOException, ApiException
      Get a capacity plan
      Parameters:
      request - The request object
      Returns:
      CapacityPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitCapacityplan

      public ApiResponse<CapacityPlanResponse> getWorkforcemanagementBusinessunitCapacityplan(ApiRequest<Void> request) throws IOException
      Get a capacity plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations

      public CapacityPlanStaffingGroupAllocationsResponse getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations(String businessUnitId, String capacityPlanId, String granularity) throws IOException, ApiException
      Get a capacity plan's staffing group allocations
      Parameters:
      businessUnitId - The ID of the business unit (required)
      capacityPlanId - The ID of the capacity plan (required)
      granularity - Granularity to access staffing group data, defaults to weekly (optional)
      Returns:
      CapacityPlanStaffingGroupAllocationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationsWithHttpInfo

      public ApiResponse<CapacityPlanStaffingGroupAllocationsResponse> getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationsWithHttpInfo(String businessUnitId, String capacityPlanId, String granularity) throws IOException
      Get a capacity plan's staffing group allocations
      Parameters:
      businessUnitId - The ID of the business unit (required)
      capacityPlanId - The ID of the capacity plan (required)
      granularity - Granularity to access staffing group data, defaults to weekly (optional)
      Returns:
      CapacityPlanStaffingGroupAllocationsResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations

      public CapacityPlanStaffingGroupAllocationsResponse getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations(GetWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationsRequest request) throws IOException, ApiException
      Get a capacity plan's staffing group allocations
      Parameters:
      request - The request object
      Returns:
      CapacityPlanStaffingGroupAllocationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations

      public ApiResponse<CapacityPlanStaffingGroupAllocationsResponse> getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations(ApiRequest<Void> request) throws IOException
      Get a capacity plan's staffing group allocations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitCapacityplanStaffingrequirements

      public CapacityPlanStaffingRequirementResult getWorkforcemanagementBusinessunitCapacityplanStaffingrequirements(String businessUnitId, String capacityPlanId) throws IOException, ApiException
      Get a capacity plan's staffing requirements
      Parameters:
      businessUnitId - The ID of the business unit (required)
      capacityPlanId - The ID of the capacity plan (required)
      Returns:
      CapacityPlanStaffingRequirementResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitCapacityplanStaffingrequirementsWithHttpInfo

      public ApiResponse<CapacityPlanStaffingRequirementResult> getWorkforcemanagementBusinessunitCapacityplanStaffingrequirementsWithHttpInfo(String businessUnitId, String capacityPlanId) throws IOException
      Get a capacity plan's staffing requirements
      Parameters:
      businessUnitId - The ID of the business unit (required)
      capacityPlanId - The ID of the capacity plan (required)
      Returns:
      CapacityPlanStaffingRequirementResult
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitCapacityplanStaffingrequirements

      public CapacityPlanStaffingRequirementResult getWorkforcemanagementBusinessunitCapacityplanStaffingrequirements(GetWorkforcemanagementBusinessunitCapacityplanStaffingrequirementsRequest request) throws IOException, ApiException
      Get a capacity plan's staffing requirements
      Parameters:
      request - The request object
      Returns:
      CapacityPlanStaffingRequirementResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitCapacityplanStaffingrequirements

      public ApiResponse<CapacityPlanStaffingRequirementResult> getWorkforcemanagementBusinessunitCapacityplanStaffingrequirements(ApiRequest<Void> request) throws IOException
      Get a capacity plan's staffing requirements
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast

      public LongTermRequirementsResponse getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast(String businessUnitId, LocalDate weekDateId, String forecastId, String granularity) throws IOException, ApiException
      Get the latest long term staffing requirements for a business unit
      Parameters:
      businessUnitId - (required)
      weekDateId - weekDateId of forecast, format yyyy-MM-dd. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      forecastId - forecastId of forecast (required)
      granularity - Granularity to access staffing requirements data, defaults to weekly (optional)
      Returns:
      LongTermRequirementsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastWithHttpInfo

      public ApiResponse<LongTermRequirementsResponse> getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastWithHttpInfo(String businessUnitId, LocalDate weekDateId, String forecastId, String granularity) throws IOException
      Get the latest long term staffing requirements for a business unit
      Parameters:
      businessUnitId - (required)
      weekDateId - weekDateId of forecast, format yyyy-MM-dd. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      forecastId - forecastId of forecast (required)
      granularity - Granularity to access staffing requirements data, defaults to weekly (optional)
      Returns:
      LongTermRequirementsResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast

      public LongTermRequirementsResponse getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast(GetWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastRequest request) throws IOException, ApiException
      Get the latest long term staffing requirements for a business unit
      Parameters:
      request - The request object
      Returns:
      LongTermRequirementsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast

      public ApiResponse<LongTermRequirementsResponse> getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast(ApiRequest<Void> request) throws IOException
      Get the latest long term staffing requirements for a business unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitCapacityplans

      public CapacityPlansListResponse getWorkforcemanagementBusinessunitCapacityplans(String businessUnitId) throws IOException, ApiException
      Get list of capacity plans for a business unit
      Parameters:
      businessUnitId - The ID of the business unit (required)
      Returns:
      CapacityPlansListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitCapacityplansWithHttpInfo

      public ApiResponse<CapacityPlansListResponse> getWorkforcemanagementBusinessunitCapacityplansWithHttpInfo(String businessUnitId) throws IOException
      Get list of capacity plans for a business unit
      Parameters:
      businessUnitId - The ID of the business unit (required)
      Returns:
      CapacityPlansListResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitCapacityplans

      public CapacityPlansListResponse getWorkforcemanagementBusinessunitCapacityplans(GetWorkforcemanagementBusinessunitCapacityplansRequest request) throws IOException, ApiException
      Get list of capacity plans for a business unit
      Parameters:
      request - The request object
      Returns:
      CapacityPlansListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitCapacityplans

      public ApiResponse<CapacityPlansListResponse> getWorkforcemanagementBusinessunitCapacityplans(ApiRequest<Void> request) throws IOException
      Get list of capacity plans for a business unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitIntradayPlanninggroups

      public WfmIntradayPlanningGroupListing getWorkforcemanagementBusinessunitIntradayPlanninggroups(String businessUnitId, LocalDate date) throws IOException, ApiException
      Get intraday planning groups for the given date
      Parameters:
      businessUnitId - The ID of the business unit (required)
      date - yyyy-MM-dd date string interpreted in the configured business unit time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      Returns:
      WfmIntradayPlanningGroupListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitIntradayPlanninggroupsWithHttpInfo

      public ApiResponse<WfmIntradayPlanningGroupListing> getWorkforcemanagementBusinessunitIntradayPlanninggroupsWithHttpInfo(String businessUnitId, LocalDate date) throws IOException
      Get intraday planning groups for the given date
      Parameters:
      businessUnitId - The ID of the business unit (required)
      date - yyyy-MM-dd date string interpreted in the configured business unit time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      Returns:
      WfmIntradayPlanningGroupListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitIntradayPlanninggroups

      public WfmIntradayPlanningGroupListing getWorkforcemanagementBusinessunitIntradayPlanninggroups(GetWorkforcemanagementBusinessunitIntradayPlanninggroupsRequest request) throws IOException, ApiException
      Get intraday planning groups for the given date
      Parameters:
      request - The request object
      Returns:
      WfmIntradayPlanningGroupListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitIntradayPlanninggroups

      public ApiResponse<WfmIntradayPlanningGroupListing> getWorkforcemanagementBusinessunitIntradayPlanninggroups(ApiRequest<Void> request) throws IOException
      Get intraday planning groups for the given date
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitMainforecastContinuousforecastSession

      public ContinuousForecastGetSessionResponse getWorkforcemanagementBusinessunitMainforecastContinuousforecastSession(String businessUnitId) throws IOException, ApiException
      Get the latest session for the business unit ID getWorkforcemanagementBusinessunitMainforecastContinuousforecastSession is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      businessUnitId - (required)
      Returns:
      ContinuousForecastGetSessionResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionWithHttpInfo

      public ApiResponse<ContinuousForecastGetSessionResponse> getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionWithHttpInfo(String businessUnitId) throws IOException
      Get the latest session for the business unit ID getWorkforcemanagementBusinessunitMainforecastContinuousforecastSession is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      businessUnitId - (required)
      Returns:
      ContinuousForecastGetSessionResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitMainforecastContinuousforecastSession

      public ContinuousForecastGetSessionResponse getWorkforcemanagementBusinessunitMainforecastContinuousforecastSession(GetWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionRequest request) throws IOException, ApiException
      Get the latest session for the business unit ID getWorkforcemanagementBusinessunitMainforecastContinuousforecastSession is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      ContinuousForecastGetSessionResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitMainforecastContinuousforecastSession

      public ApiResponse<ContinuousForecastGetSessionResponse> getWorkforcemanagementBusinessunitMainforecastContinuousforecastSession(ApiRequest<Void> request) throws IOException
      Get the latest session for the business unit ID getWorkforcemanagementBusinessunitMainforecastContinuousforecastSession is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId

      public ContinuousForecastSessionResponse getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId(String businessUnitId, String sessionId) throws IOException, ApiException
      Get the session details for the session ID getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      businessUnitId - (required)
      sessionId - (required)
      Returns:
      ContinuousForecastSessionResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdWithHttpInfo

      public ApiResponse<ContinuousForecastSessionResponse> getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdWithHttpInfo(String businessUnitId, String sessionId) throws IOException
      Get the session details for the session ID getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      businessUnitId - (required)
      sessionId - (required)
      Returns:
      ContinuousForecastSessionResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId

      public ContinuousForecastSessionResponse getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId(GetWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdRequest request) throws IOException, ApiException
      Get the session details for the session ID getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      ContinuousForecastSessionResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId

      public ApiResponse<ContinuousForecastSessionResponse> getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId(ApiRequest<Void> request) throws IOException
      Get the session details for the session ID getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId

      public ContinuousForecastSnapshotResponse getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId(String businessUnitId, String sessionId, String snapshotId) throws IOException, ApiException
      Get the snapshot details for the snapshot ID getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      businessUnitId - (required)
      sessionId - (required)
      snapshotId - (required)
      Returns:
      ContinuousForecastSnapshotResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotIdWithHttpInfo

      public ApiResponse<ContinuousForecastSnapshotResponse> getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotIdWithHttpInfo(String businessUnitId, String sessionId, String snapshotId) throws IOException
      Get the snapshot details for the snapshot ID getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      businessUnitId - (required)
      sessionId - (required)
      snapshotId - (required)
      Returns:
      ContinuousForecastSnapshotResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId

      public ContinuousForecastSnapshotResponse getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId(GetWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotIdRequest request) throws IOException, ApiException
      Get the snapshot details for the snapshot ID getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      ContinuousForecastSnapshotResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId

      public ApiResponse<ContinuousForecastSnapshotResponse> getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId(ApiRequest<Void> request) throws IOException
      Get the snapshot details for the snapshot ID getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitManagementunits

      public ManagementUnitListing getWorkforcemanagementBusinessunitManagementunits(String businessUnitId, String feature, String divisionId) throws IOException, ApiException
      Get all authorized management units in the business unit
      Parameters:
      businessUnitId - The ID of the business unit, or 'mine' for the business unit of the logged-in user. (required)
      feature - If specified, the list of management units for which the user is authorized to use the requested feature will be returned (optional)
      divisionId - If specified, the list of management units belonging to the specified division will be returned (optional)
      Returns:
      ManagementUnitListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitManagementunitsWithHttpInfo

      public ApiResponse<ManagementUnitListing> getWorkforcemanagementBusinessunitManagementunitsWithHttpInfo(String businessUnitId, String feature, String divisionId) throws IOException
      Get all authorized management units in the business unit
      Parameters:
      businessUnitId - The ID of the business unit, or 'mine' for the business unit of the logged-in user. (required)
      feature - If specified, the list of management units for which the user is authorized to use the requested feature will be returned (optional)
      divisionId - If specified, the list of management units belonging to the specified division will be returned (optional)
      Returns:
      ManagementUnitListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitManagementunits

      public ManagementUnitListing getWorkforcemanagementBusinessunitManagementunits(GetWorkforcemanagementBusinessunitManagementunitsRequest request) throws IOException, ApiException
      Get all authorized management units in the business unit
      Parameters:
      request - The request object
      Returns:
      ManagementUnitListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitManagementunits

      public ApiResponse<ManagementUnitListing> getWorkforcemanagementBusinessunitManagementunits(ApiRequest<Void> request) throws IOException
      Get all authorized management units in the business unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitMinimumstaffingSettings

      public MinimumStaffingResponse getWorkforcemanagementBusinessunitMinimumstaffingSettings(String businessUnitId) throws IOException, ApiException
      Get minimum staffing settings for a business unit
      Parameters:
      businessUnitId - The ID of the business unit (required)
      Returns:
      MinimumStaffingResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitMinimumstaffingSettingsWithHttpInfo

      public ApiResponse<MinimumStaffingResponse> getWorkforcemanagementBusinessunitMinimumstaffingSettingsWithHttpInfo(String businessUnitId) throws IOException
      Get minimum staffing settings for a business unit
      Parameters:
      businessUnitId - The ID of the business unit (required)
      Returns:
      MinimumStaffingResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitMinimumstaffingSettings

      public MinimumStaffingResponse getWorkforcemanagementBusinessunitMinimumstaffingSettings(GetWorkforcemanagementBusinessunitMinimumstaffingSettingsRequest request) throws IOException, ApiException
      Get minimum staffing settings for a business unit
      Parameters:
      request - The request object
      Returns:
      MinimumStaffingResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitMinimumstaffingSettings

      public ApiResponse<MinimumStaffingResponse> getWorkforcemanagementBusinessunitMinimumstaffingSettings(ApiRequest<Void> request) throws IOException
      Get minimum staffing settings for a business unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitOpportunity

      public OpportunityResultWithAgentIds getWorkforcemanagementBusinessunitOpportunity(String businessUnitId, String opportunityId, String expand) throws IOException, ApiException
      Get opportunity details
      Parameters:
      businessUnitId - The ID of the business unit (required)
      opportunityId - The ID of the opportunity (required)
      expand - List of resources to expand (optional)
      Returns:
      OpportunityResultWithAgentIds
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitOpportunityWithHttpInfo

      public ApiResponse<OpportunityResultWithAgentIds> getWorkforcemanagementBusinessunitOpportunityWithHttpInfo(String businessUnitId, String opportunityId, String expand) throws IOException
      Get opportunity details
      Parameters:
      businessUnitId - The ID of the business unit (required)
      opportunityId - The ID of the opportunity (required)
      expand - List of resources to expand (optional)
      Returns:
      OpportunityResultWithAgentIds
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitOpportunity

      public OpportunityResultWithAgentIds getWorkforcemanagementBusinessunitOpportunity(GetWorkforcemanagementBusinessunitOpportunityRequest request) throws IOException, ApiException
      Get opportunity details
      Parameters:
      request - The request object
      Returns:
      OpportunityResultWithAgentIds
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitOpportunity

      public ApiResponse<OpportunityResultWithAgentIds> getWorkforcemanagementBusinessunitOpportunity(ApiRequest<Void> request) throws IOException
      Get opportunity details
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitPlanninggroup

      public PlanningGroup getWorkforcemanagementBusinessunitPlanninggroup(String businessUnitId, String planningGroupId) throws IOException, ApiException
      Get a planning group
      Parameters:
      businessUnitId - The ID of the business unit. (required)
      planningGroupId - The ID of a planning group to fetch (required)
      Returns:
      PlanningGroup
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitPlanninggroupWithHttpInfo

      public ApiResponse<PlanningGroup> getWorkforcemanagementBusinessunitPlanninggroupWithHttpInfo(String businessUnitId, String planningGroupId) throws IOException
      Get a planning group
      Parameters:
      businessUnitId - The ID of the business unit. (required)
      planningGroupId - The ID of a planning group to fetch (required)
      Returns:
      PlanningGroup
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitPlanninggroup

      public PlanningGroup getWorkforcemanagementBusinessunitPlanninggroup(GetWorkforcemanagementBusinessunitPlanninggroupRequest request) throws IOException, ApiException
      Get a planning group
      Parameters:
      request - The request object
      Returns:
      PlanningGroup
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitPlanninggroup

      public ApiResponse<PlanningGroup> getWorkforcemanagementBusinessunitPlanninggroup(ApiRequest<Void> request) throws IOException
      Get a planning group
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitPlanninggroups

      public PlanningGroupList getWorkforcemanagementBusinessunitPlanninggroups(String businessUnitId) throws IOException, ApiException
      Gets list of planning groups
      Parameters:
      businessUnitId - The ID of the business unit. (required)
      Returns:
      PlanningGroupList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitPlanninggroupsWithHttpInfo

      public ApiResponse<PlanningGroupList> getWorkforcemanagementBusinessunitPlanninggroupsWithHttpInfo(String businessUnitId) throws IOException
      Gets list of planning groups
      Parameters:
      businessUnitId - The ID of the business unit. (required)
      Returns:
      PlanningGroupList
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitPlanninggroups

      public PlanningGroupList getWorkforcemanagementBusinessunitPlanninggroups(GetWorkforcemanagementBusinessunitPlanninggroupsRequest request) throws IOException, ApiException
      Gets list of planning groups
      Parameters:
      request - The request object
      Returns:
      PlanningGroupList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitPlanninggroups

      public ApiResponse<PlanningGroupList> getWorkforcemanagementBusinessunitPlanninggroups(ApiRequest<Void> request) throws IOException
      Gets list of planning groups
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitSchedulerSettings

      public BuSchedulerSettingsResponse getWorkforcemanagementBusinessunitSchedulerSettings(String businessUnitId) throws IOException, ApiException
      Get scheduler settings for a business unit
      Parameters:
      businessUnitId - The ID of the business unit (required)
      Returns:
      BuSchedulerSettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitSchedulerSettingsWithHttpInfo

      public ApiResponse<BuSchedulerSettingsResponse> getWorkforcemanagementBusinessunitSchedulerSettingsWithHttpInfo(String businessUnitId) throws IOException
      Get scheduler settings for a business unit
      Parameters:
      businessUnitId - The ID of the business unit (required)
      Returns:
      BuSchedulerSettingsResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitSchedulerSettings

      public BuSchedulerSettingsResponse getWorkforcemanagementBusinessunitSchedulerSettings(GetWorkforcemanagementBusinessunitSchedulerSettingsRequest request) throws IOException, ApiException
      Get scheduler settings for a business unit
      Parameters:
      request - The request object
      Returns:
      BuSchedulerSettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitSchedulerSettings

      public ApiResponse<BuSchedulerSettingsResponse> getWorkforcemanagementBusinessunitSchedulerSettings(ApiRequest<Void> request) throws IOException
      Get scheduler settings for a business unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitSchedulingRun

      public BuScheduleRun getWorkforcemanagementBusinessunitSchedulingRun(String businessUnitId, String runId) throws IOException, ApiException
      Get a scheduling run
      Parameters:
      businessUnitId - The ID of the business unit (required)
      runId - The ID of the schedule run (required)
      Returns:
      BuScheduleRun
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitSchedulingRunWithHttpInfo

      public ApiResponse<BuScheduleRun> getWorkforcemanagementBusinessunitSchedulingRunWithHttpInfo(String businessUnitId, String runId) throws IOException
      Get a scheduling run
      Parameters:
      businessUnitId - The ID of the business unit (required)
      runId - The ID of the schedule run (required)
      Returns:
      BuScheduleRun
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitSchedulingRun

      public BuScheduleRun getWorkforcemanagementBusinessunitSchedulingRun(GetWorkforcemanagementBusinessunitSchedulingRunRequest request) throws IOException, ApiException
      Get a scheduling run
      Parameters:
      request - The request object
      Returns:
      BuScheduleRun
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitSchedulingRun

      public ApiResponse<BuScheduleRun> getWorkforcemanagementBusinessunitSchedulingRun(ApiRequest<Void> request) throws IOException
      Get a scheduling run
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitSchedulingRunResult

      public BuRescheduleResult getWorkforcemanagementBusinessunitSchedulingRunResult(String businessUnitId, String runId, List<String> managementUnitIds, List<String> expand) throws IOException, ApiException
      Get the result of a rescheduling operation
      Parameters:
      businessUnitId - The ID of the business unit (required)
      runId - The ID of the schedule run (required)
      managementUnitIds - The IDs of the management units for which to fetch the reschedule results (required)
      expand - The fields to expand. Omitting will return an empty response (required)
      Returns:
      BuRescheduleResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitSchedulingRunResultWithHttpInfo

      public ApiResponse<BuRescheduleResult> getWorkforcemanagementBusinessunitSchedulingRunResultWithHttpInfo(String businessUnitId, String runId, List<String> managementUnitIds, List<String> expand) throws IOException
      Get the result of a rescheduling operation
      Parameters:
      businessUnitId - The ID of the business unit (required)
      runId - The ID of the schedule run (required)
      managementUnitIds - The IDs of the management units for which to fetch the reschedule results (required)
      expand - The fields to expand. Omitting will return an empty response (required)
      Returns:
      BuRescheduleResult
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitSchedulingRunResult

      public BuRescheduleResult getWorkforcemanagementBusinessunitSchedulingRunResult(GetWorkforcemanagementBusinessunitSchedulingRunResultRequest request) throws IOException, ApiException
      Get the result of a rescheduling operation
      Parameters:
      request - The request object
      Returns:
      BuRescheduleResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitSchedulingRunResult

      public ApiResponse<BuRescheduleResult> getWorkforcemanagementBusinessunitSchedulingRunResult(ApiRequest<Void> request) throws IOException
      Get the result of a rescheduling operation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitSchedulingRuns

      public BuScheduleRunListing getWorkforcemanagementBusinessunitSchedulingRuns(String businessUnitId) throws IOException, ApiException
      Get the list of scheduling runs
      Parameters:
      businessUnitId - The ID of the business unit (required)
      Returns:
      BuScheduleRunListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitSchedulingRunsWithHttpInfo

      public ApiResponse<BuScheduleRunListing> getWorkforcemanagementBusinessunitSchedulingRunsWithHttpInfo(String businessUnitId) throws IOException
      Get the list of scheduling runs
      Parameters:
      businessUnitId - The ID of the business unit (required)
      Returns:
      BuScheduleRunListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitSchedulingRuns

      public BuScheduleRunListing getWorkforcemanagementBusinessunitSchedulingRuns(GetWorkforcemanagementBusinessunitSchedulingRunsRequest request) throws IOException, ApiException
      Get the list of scheduling runs
      Parameters:
      request - The request object
      Returns:
      BuScheduleRunListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitSchedulingRuns

      public ApiResponse<BuScheduleRunListing> getWorkforcemanagementBusinessunitSchedulingRuns(ApiRequest<Void> request) throws IOException
      Get the list of scheduling runs
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitServicegoaltemplate

      public ServiceGoalTemplate getWorkforcemanagementBusinessunitServicegoaltemplate(String businessUnitId, String serviceGoalTemplateId, List<String> expand) throws IOException, ApiException
      Get a service goal template
      Parameters:
      businessUnitId - The ID of the business unit. (required)
      serviceGoalTemplateId - The ID of a service goal template to fetch (required)
      expand - Include to access additional data on the service goal template (optional)
      Returns:
      ServiceGoalTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitServicegoaltemplateWithHttpInfo

      public ApiResponse<ServiceGoalTemplate> getWorkforcemanagementBusinessunitServicegoaltemplateWithHttpInfo(String businessUnitId, String serviceGoalTemplateId, List<String> expand) throws IOException
      Get a service goal template
      Parameters:
      businessUnitId - The ID of the business unit. (required)
      serviceGoalTemplateId - The ID of a service goal template to fetch (required)
      expand - Include to access additional data on the service goal template (optional)
      Returns:
      ServiceGoalTemplate
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitServicegoaltemplate

      public ServiceGoalTemplate getWorkforcemanagementBusinessunitServicegoaltemplate(GetWorkforcemanagementBusinessunitServicegoaltemplateRequest request) throws IOException, ApiException
      Get a service goal template
      Parameters:
      request - The request object
      Returns:
      ServiceGoalTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitServicegoaltemplate

      public ApiResponse<ServiceGoalTemplate> getWorkforcemanagementBusinessunitServicegoaltemplate(ApiRequest<Void> request) throws IOException
      Get a service goal template
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitServicegoaltemplates

      public ServiceGoalTemplateList getWorkforcemanagementBusinessunitServicegoaltemplates(String businessUnitId, List<String> expand) throws IOException, ApiException
      Gets list of service goal templates
      Parameters:
      businessUnitId - The ID of the business unit. (required)
      expand - Include to access additional data on the service goal template (optional)
      Returns:
      ServiceGoalTemplateList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitServicegoaltemplatesWithHttpInfo

      public ApiResponse<ServiceGoalTemplateList> getWorkforcemanagementBusinessunitServicegoaltemplatesWithHttpInfo(String businessUnitId, List<String> expand) throws IOException
      Gets list of service goal templates
      Parameters:
      businessUnitId - The ID of the business unit. (required)
      expand - Include to access additional data on the service goal template (optional)
      Returns:
      ServiceGoalTemplateList
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitServicegoaltemplates

      public ServiceGoalTemplateList getWorkforcemanagementBusinessunitServicegoaltemplates(GetWorkforcemanagementBusinessunitServicegoaltemplatesRequest request) throws IOException, ApiException
      Gets list of service goal templates
      Parameters:
      request - The request object
      Returns:
      ServiceGoalTemplateList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitServicegoaltemplates

      public ApiResponse<ServiceGoalTemplateList> getWorkforcemanagementBusinessunitServicegoaltemplates(ApiRequest<Void> request) throws IOException
      Gets list of service goal templates
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitShifttradingTradesEvaluateJob

      public ShiftTradeEvaluateTradesBuJobResponse getWorkforcemanagementBusinessunitShifttradingTradesEvaluateJob(String businessUnitId, String jobId) throws IOException, ApiException
      View results of the evaluate shift trades in a management unit per week operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      businessUnitId - The ID of the business unit (required)
      jobId - The ID of the job (required)
      Returns:
      ShiftTradeEvaluateTradesBuJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitShifttradingTradesEvaluateJobWithHttpInfo

      public ApiResponse<ShiftTradeEvaluateTradesBuJobResponse> getWorkforcemanagementBusinessunitShifttradingTradesEvaluateJobWithHttpInfo(String businessUnitId, String jobId) throws IOException
      View results of the evaluate shift trades in a management unit per week operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      businessUnitId - The ID of the business unit (required)
      jobId - The ID of the job (required)
      Returns:
      ShiftTradeEvaluateTradesBuJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitShifttradingTradesEvaluateJob

      public ShiftTradeEvaluateTradesBuJobResponse getWorkforcemanagementBusinessunitShifttradingTradesEvaluateJob(GetWorkforcemanagementBusinessunitShifttradingTradesEvaluateJobRequest request) throws IOException, ApiException
      View results of the evaluate shift trades in a management unit per week operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      ShiftTradeEvaluateTradesBuJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitShifttradingTradesEvaluateJob

      public ApiResponse<ShiftTradeEvaluateTradesBuJobResponse> getWorkforcemanagementBusinessunitShifttradingTradesEvaluateJob(ApiRequest<Void> request) throws IOException
      View results of the evaluate shift trades in a management unit per week operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitShifttradingTradesQueryJob

      public ShiftTradeQueryTradesBuJobResponse getWorkforcemanagementBusinessunitShifttradingTradesQueryJob(String businessUnitId, String jobId) throws IOException, ApiException
      View results of the query shift trades in a management unit per user operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      businessUnitId - The ID of the business unit (required)
      jobId - The ID of the job (required)
      Returns:
      ShiftTradeQueryTradesBuJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitShifttradingTradesQueryJobWithHttpInfo

      public ApiResponse<ShiftTradeQueryTradesBuJobResponse> getWorkforcemanagementBusinessunitShifttradingTradesQueryJobWithHttpInfo(String businessUnitId, String jobId) throws IOException
      View results of the query shift trades in a management unit per user operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      businessUnitId - The ID of the business unit (required)
      jobId - The ID of the job (required)
      Returns:
      ShiftTradeQueryTradesBuJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitShifttradingTradesQueryJob

      public ShiftTradeQueryTradesBuJobResponse getWorkforcemanagementBusinessunitShifttradingTradesQueryJob(GetWorkforcemanagementBusinessunitShifttradingTradesQueryJobRequest request) throws IOException, ApiException
      View results of the query shift trades in a management unit per user operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      ShiftTradeQueryTradesBuJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitShifttradingTradesQueryJob

      public ApiResponse<ShiftTradeQueryTradesBuJobResponse> getWorkforcemanagementBusinessunitShifttradingTradesQueryJob(ApiRequest<Void> request) throws IOException
      View results of the query shift trades in a management unit per user operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitShifttradingTradesStateBulkJob

      public ShiftTradeBulkUpdateTradeStateBuJobResponse getWorkforcemanagementBusinessunitShifttradingTradesStateBulkJob(String businessUnitId, String jobId) throws IOException, ApiException
      View results of bulk update trades states operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      businessUnitId - The ID of the business unit (required)
      jobId - The ID of the job (required)
      Returns:
      ShiftTradeBulkUpdateTradeStateBuJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitShifttradingTradesStateBulkJobWithHttpInfo

      public ApiResponse<ShiftTradeBulkUpdateTradeStateBuJobResponse> getWorkforcemanagementBusinessunitShifttradingTradesStateBulkJobWithHttpInfo(String businessUnitId, String jobId) throws IOException
      View results of bulk update trades states operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      businessUnitId - The ID of the business unit (required)
      jobId - The ID of the job (required)
      Returns:
      ShiftTradeBulkUpdateTradeStateBuJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitShifttradingTradesStateBulkJob

      public ShiftTradeBulkUpdateTradeStateBuJobResponse getWorkforcemanagementBusinessunitShifttradingTradesStateBulkJob(GetWorkforcemanagementBusinessunitShifttradingTradesStateBulkJobRequest request) throws IOException, ApiException
      View results of bulk update trades states operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      ShiftTradeBulkUpdateTradeStateBuJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitShifttradingTradesStateBulkJob

      public ApiResponse<ShiftTradeBulkUpdateTradeStateBuJobResponse> getWorkforcemanagementBusinessunitShifttradingTradesStateBulkJob(ApiRequest<Void> request) throws IOException
      View results of bulk update trades states operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJob

      public ShiftTradeSearchUnmatchedTradesBuJobResponse getWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJob(String businessUnitId, String jobId) throws IOException, ApiException
      View result of potential shift trade matches for the current user. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      businessUnitId - The ID of the business unit (required)
      jobId - The ID of the job (required)
      Returns:
      ShiftTradeSearchUnmatchedTradesBuJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJobWithHttpInfo

      public ApiResponse<ShiftTradeSearchUnmatchedTradesBuJobResponse> getWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJobWithHttpInfo(String businessUnitId, String jobId) throws IOException
      View result of potential shift trade matches for the current user. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      businessUnitId - The ID of the business unit (required)
      jobId - The ID of the job (required)
      Returns:
      ShiftTradeSearchUnmatchedTradesBuJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJob

      public ShiftTradeSearchUnmatchedTradesBuJobResponse getWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJob(GetWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJobRequest request) throws IOException, ApiException
      View result of potential shift trade matches for the current user. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      ShiftTradeSearchUnmatchedTradesBuJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJob

      public ApiResponse<ShiftTradeSearchUnmatchedTradesBuJobResponse> getWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJob(ApiRequest<Void> request) throws IOException
      View result of potential shift trade matches for the current user. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitShifttradingWeeksSummaryJob

      public ShiftTradeQueryWeekSummariesBuJobResponse getWorkforcemanagementBusinessunitShifttradingWeeksSummaryJob(String businessUnitId, String jobId) throws IOException, ApiException
      View results of the retrieve the summary of shift trades in a matched state per week operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      businessUnitId - The ID of the business unit (required)
      jobId - The ID of the job (required)
      Returns:
      ShiftTradeQueryWeekSummariesBuJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitShifttradingWeeksSummaryJobWithHttpInfo

      public ApiResponse<ShiftTradeQueryWeekSummariesBuJobResponse> getWorkforcemanagementBusinessunitShifttradingWeeksSummaryJobWithHttpInfo(String businessUnitId, String jobId) throws IOException
      View results of the retrieve the summary of shift trades in a matched state per week operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      businessUnitId - The ID of the business unit (required)
      jobId - The ID of the job (required)
      Returns:
      ShiftTradeQueryWeekSummariesBuJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitShifttradingWeeksSummaryJob

      public ShiftTradeQueryWeekSummariesBuJobResponse getWorkforcemanagementBusinessunitShifttradingWeeksSummaryJob(GetWorkforcemanagementBusinessunitShifttradingWeeksSummaryJobRequest request) throws IOException, ApiException
      View results of the retrieve the summary of shift trades in a matched state per week operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      ShiftTradeQueryWeekSummariesBuJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitShifttradingWeeksSummaryJob

      public ApiResponse<ShiftTradeQueryWeekSummariesBuJobResponse> getWorkforcemanagementBusinessunitShifttradingWeeksSummaryJob(ApiRequest<Void> request) throws IOException
      View results of the retrieve the summary of shift trades in a matched state per week operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitStaffinggroup

      public StaffingGroupResponse getWorkforcemanagementBusinessunitStaffinggroup(String businessUnitId, String staffingGroupId) throws IOException, ApiException
      Gets a staffing group
      Parameters:
      businessUnitId - The ID of the business unit (required)
      staffingGroupId - The ID of the staffing group to fetch (required)
      Returns:
      StaffingGroupResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitStaffinggroupWithHttpInfo

      public ApiResponse<StaffingGroupResponse> getWorkforcemanagementBusinessunitStaffinggroupWithHttpInfo(String businessUnitId, String staffingGroupId) throws IOException
      Gets a staffing group
      Parameters:
      businessUnitId - The ID of the business unit (required)
      staffingGroupId - The ID of the staffing group to fetch (required)
      Returns:
      StaffingGroupResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitStaffinggroup

      public StaffingGroupResponse getWorkforcemanagementBusinessunitStaffinggroup(GetWorkforcemanagementBusinessunitStaffinggroupRequest request) throws IOException, ApiException
      Gets a staffing group
      Parameters:
      request - The request object
      Returns:
      StaffingGroupResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitStaffinggroup

      public ApiResponse<StaffingGroupResponse> getWorkforcemanagementBusinessunitStaffinggroup(ApiRequest<Void> request) throws IOException
      Gets a staffing group
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitStaffinggroups

      public StaffingGroupListing getWorkforcemanagementBusinessunitStaffinggroups(String businessUnitId, String managementUnitId, Boolean forceDownloadService) throws IOException, ApiException
      Gets a list of staffing groups
      Parameters:
      businessUnitId - The ID of the business unit (required)
      managementUnitId - The ID of the management unit to get management unit specific staffing groups (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      StaffingGroupListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitStaffinggroupsWithHttpInfo

      public ApiResponse<StaffingGroupListing> getWorkforcemanagementBusinessunitStaffinggroupsWithHttpInfo(String businessUnitId, String managementUnitId, Boolean forceDownloadService) throws IOException
      Gets a list of staffing groups
      Parameters:
      businessUnitId - The ID of the business unit (required)
      managementUnitId - The ID of the management unit to get management unit specific staffing groups (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      StaffingGroupListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitStaffinggroups

      public StaffingGroupListing getWorkforcemanagementBusinessunitStaffinggroups(GetWorkforcemanagementBusinessunitStaffinggroupsRequest request) throws IOException, ApiException
      Gets a list of staffing groups
      Parameters:
      request - The request object
      Returns:
      StaffingGroupListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitStaffinggroups

      public ApiResponse<StaffingGroupListing> getWorkforcemanagementBusinessunitStaffinggroups(ApiRequest<Void> request) throws IOException
      Gets a list of staffing groups
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitTimeofflimit

      public BuTimeOffLimitResponse getWorkforcemanagementBusinessunitTimeofflimit(String businessUnitId, String timeOffLimitId) throws IOException, ApiException
      Gets a time-off limit object Returns properties of time-off limit object, but not daily values
      Parameters:
      businessUnitId - The ID of the business unit (required)
      timeOffLimitId - The ID of the time-off limit to fetch (required)
      Returns:
      BuTimeOffLimitResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitTimeofflimitWithHttpInfo

      public ApiResponse<BuTimeOffLimitResponse> getWorkforcemanagementBusinessunitTimeofflimitWithHttpInfo(String businessUnitId, String timeOffLimitId) throws IOException
      Gets a time-off limit object Returns properties of time-off limit object, but not daily values
      Parameters:
      businessUnitId - The ID of the business unit (required)
      timeOffLimitId - The ID of the time-off limit to fetch (required)
      Returns:
      BuTimeOffLimitResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitTimeofflimit

      public BuTimeOffLimitResponse getWorkforcemanagementBusinessunitTimeofflimit(GetWorkforcemanagementBusinessunitTimeofflimitRequest request) throws IOException, ApiException
      Gets a time-off limit object Returns properties of time-off limit object, but not daily values
      Parameters:
      request - The request object
      Returns:
      BuTimeOffLimitResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitTimeofflimit

      public ApiResponse<BuTimeOffLimitResponse> getWorkforcemanagementBusinessunitTimeofflimit(ApiRequest<Void> request) throws IOException
      Gets a time-off limit object Returns properties of time-off limit object, but not daily values
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitTimeofflimits

      public BuTimeOffLimitListing getWorkforcemanagementBusinessunitTimeofflimits(String businessUnitId, String managementUnitId) throws IOException, ApiException
      Gets a list of time-off limit objects
      Parameters:
      businessUnitId - The ID of the business unit (required)
      managementUnitId - The ID of the management unit to get management unit specific time-off limit objects (optional)
      Returns:
      BuTimeOffLimitListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitTimeofflimitsWithHttpInfo

      public ApiResponse<BuTimeOffLimitListing> getWorkforcemanagementBusinessunitTimeofflimitsWithHttpInfo(String businessUnitId, String managementUnitId) throws IOException
      Gets a list of time-off limit objects
      Parameters:
      businessUnitId - The ID of the business unit (required)
      managementUnitId - The ID of the management unit to get management unit specific time-off limit objects (optional)
      Returns:
      BuTimeOffLimitListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitTimeofflimits

      public BuTimeOffLimitListing getWorkforcemanagementBusinessunitTimeofflimits(GetWorkforcemanagementBusinessunitTimeofflimitsRequest request) throws IOException, ApiException
      Gets a list of time-off limit objects
      Parameters:
      request - The request object
      Returns:
      BuTimeOffLimitListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitTimeofflimits

      public ApiResponse<BuTimeOffLimitListing> getWorkforcemanagementBusinessunitTimeofflimits(ApiRequest<Void> request) throws IOException
      Gets a list of time-off limit objects
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitTimeoffplan

      public BuTimeOffPlanResponse getWorkforcemanagementBusinessunitTimeoffplan(String businessUnitId, String timeOffPlanId) throws IOException, ApiException
      Gets a time-off plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      timeOffPlanId - The ID of the time-off plan to fetch (required)
      Returns:
      BuTimeOffPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitTimeoffplanWithHttpInfo

      public ApiResponse<BuTimeOffPlanResponse> getWorkforcemanagementBusinessunitTimeoffplanWithHttpInfo(String businessUnitId, String timeOffPlanId) throws IOException
      Gets a time-off plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      timeOffPlanId - The ID of the time-off plan to fetch (required)
      Returns:
      BuTimeOffPlanResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitTimeoffplan

      public BuTimeOffPlanResponse getWorkforcemanagementBusinessunitTimeoffplan(GetWorkforcemanagementBusinessunitTimeoffplanRequest request) throws IOException, ApiException
      Gets a time-off plan
      Parameters:
      request - The request object
      Returns:
      BuTimeOffPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitTimeoffplan

      public ApiResponse<BuTimeOffPlanResponse> getWorkforcemanagementBusinessunitTimeoffplan(ApiRequest<Void> request) throws IOException
      Gets a time-off plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitTimeoffplans

      public BuTimeOffPlanListing getWorkforcemanagementBusinessunitTimeoffplans(String businessUnitId, String managementUnitId, Boolean forceDownloadService, List<String> expand) throws IOException, ApiException
      Gets a list of time-off plans
      Parameters:
      businessUnitId - The ID of the business unit (required)
      managementUnitId - The ID of the management unit to get management unit specific staffing groups (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      expand - Include to access additional data for the time-off plans (optional)
      Returns:
      BuTimeOffPlanListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitTimeoffplansWithHttpInfo

      public ApiResponse<BuTimeOffPlanListing> getWorkforcemanagementBusinessunitTimeoffplansWithHttpInfo(String businessUnitId, String managementUnitId, Boolean forceDownloadService, List<String> expand) throws IOException
      Gets a list of time-off plans
      Parameters:
      businessUnitId - The ID of the business unit (required)
      managementUnitId - The ID of the management unit to get management unit specific staffing groups (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      expand - Include to access additional data for the time-off plans (optional)
      Returns:
      BuTimeOffPlanListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitTimeoffplans

      public BuTimeOffPlanListing getWorkforcemanagementBusinessunitTimeoffplans(GetWorkforcemanagementBusinessunitTimeoffplansRequest request) throws IOException, ApiException
      Gets a list of time-off plans
      Parameters:
      request - The request object
      Returns:
      BuTimeOffPlanListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitTimeoffplans

      public ApiResponse<BuTimeOffPlanListing> getWorkforcemanagementBusinessunitTimeoffplans(ApiRequest<Void> request) throws IOException
      Gets a list of time-off plans
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitUsers

      public BuUserListing getWorkforcemanagementBusinessunitUsers(String businessUnitId, List<String> managementUnitIds) throws IOException, ApiException
      Get users in the business unit
      Parameters:
      businessUnitId - The ID of the business unit (required)
      managementUnitIds - The IDs of the management units for which to retrieve users (optional)
      Returns:
      BuUserListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitUsersWithHttpInfo

      public ApiResponse<BuUserListing> getWorkforcemanagementBusinessunitUsersWithHttpInfo(String businessUnitId, List<String> managementUnitIds) throws IOException
      Get users in the business unit
      Parameters:
      businessUnitId - The ID of the business unit (required)
      managementUnitIds - The IDs of the management units for which to retrieve users (optional)
      Returns:
      BuUserListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitUsers

      public BuUserListing getWorkforcemanagementBusinessunitUsers(GetWorkforcemanagementBusinessunitUsersRequest request) throws IOException, ApiException
      Get users in the business unit
      Parameters:
      request - The request object
      Returns:
      BuUserListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitUsers

      public ApiResponse<BuUserListing> getWorkforcemanagementBusinessunitUsers(ApiRequest<Void> request) throws IOException
      Get users in the business unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekSchedule

      public BuScheduleMetadata getWorkforcemanagementBusinessunitWeekSchedule(String businessUnitId, LocalDate weekId, String scheduleId, String expand) throws IOException, ApiException
      Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      scheduleId - The ID of the schedule (required)
      expand - expand (optional)
      Returns:
      BuScheduleMetadata
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekScheduleWithHttpInfo

      public ApiResponse<BuScheduleMetadata> getWorkforcemanagementBusinessunitWeekScheduleWithHttpInfo(String businessUnitId, LocalDate weekId, String scheduleId, String expand) throws IOException
      Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      scheduleId - The ID of the schedule (required)
      expand - expand (optional)
      Returns:
      BuScheduleMetadata
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekSchedule

      public BuScheduleMetadata getWorkforcemanagementBusinessunitWeekSchedule(GetWorkforcemanagementBusinessunitWeekScheduleRequest request) throws IOException, ApiException
      Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route
      Parameters:
      request - The request object
      Returns:
      BuScheduleMetadata
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekSchedule

      public ApiResponse<BuScheduleMetadata> getWorkforcemanagementBusinessunitWeekSchedule(ApiRequest<Void> request) throws IOException
      Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekScheduleGenerationresults

      public ScheduleGenerationResult getWorkforcemanagementBusinessunitWeekScheduleGenerationresults(String businessUnitId, LocalDate weekId, String scheduleId) throws IOException, ApiException
      Get the generation results for a generated schedule
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      scheduleId - The ID of the schedule (required)
      Returns:
      ScheduleGenerationResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekScheduleGenerationresultsWithHttpInfo

      public ApiResponse<ScheduleGenerationResult> getWorkforcemanagementBusinessunitWeekScheduleGenerationresultsWithHttpInfo(String businessUnitId, LocalDate weekId, String scheduleId) throws IOException
      Get the generation results for a generated schedule
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      scheduleId - The ID of the schedule (required)
      Returns:
      ScheduleGenerationResult
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekScheduleGenerationresults

      public ScheduleGenerationResult getWorkforcemanagementBusinessunitWeekScheduleGenerationresults(GetWorkforcemanagementBusinessunitWeekScheduleGenerationresultsRequest request) throws IOException, ApiException
      Get the generation results for a generated schedule
      Parameters:
      request - The request object
      Returns:
      ScheduleGenerationResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekScheduleGenerationresults

      public ApiResponse<ScheduleGenerationResult> getWorkforcemanagementBusinessunitWeekScheduleGenerationresults(ApiRequest<Void> request) throws IOException
      Get the generation results for a generated schedule
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast

      public BuHeadcountForecastResponse getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast(String businessUnitId, LocalDate weekId, String scheduleId, Boolean forceDownload) throws IOException, ApiException
      Get the headcount forecast by planning group for the schedule
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      scheduleId - The ID of the schedule (required)
      forceDownload - Whether to force the result to come via download url. For testing purposes only (optional)
      Returns:
      BuHeadcountForecastResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecastWithHttpInfo

      public ApiResponse<BuHeadcountForecastResponse> getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecastWithHttpInfo(String businessUnitId, LocalDate weekId, String scheduleId, Boolean forceDownload) throws IOException
      Get the headcount forecast by planning group for the schedule
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      scheduleId - The ID of the schedule (required)
      forceDownload - Whether to force the result to come via download url. For testing purposes only (optional)
      Returns:
      BuHeadcountForecastResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast

      public BuHeadcountForecastResponse getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast(GetWorkforcemanagementBusinessunitWeekScheduleHeadcountforecastRequest request) throws IOException, ApiException
      Get the headcount forecast by planning group for the schedule
      Parameters:
      request - The request object
      Returns:
      BuHeadcountForecastResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast

      public ApiResponse<BuHeadcountForecastResponse> getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast(ApiRequest<Void> request) throws IOException
      Get the headcount forecast by planning group for the schedule
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent

      public BuAgentScheduleHistoryResponse getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent(String businessUnitId, LocalDate weekId, String scheduleId, String agentId) throws IOException, ApiException
      Loads agent's schedule history.
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      scheduleId - The ID of the schedule (required)
      agentId - THe ID of the agent (required)
      Returns:
      BuAgentScheduleHistoryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekScheduleHistoryAgentWithHttpInfo

      public ApiResponse<BuAgentScheduleHistoryResponse> getWorkforcemanagementBusinessunitWeekScheduleHistoryAgentWithHttpInfo(String businessUnitId, LocalDate weekId, String scheduleId, String agentId) throws IOException
      Loads agent's schedule history.
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      scheduleId - The ID of the schedule (required)
      agentId - THe ID of the agent (required)
      Returns:
      BuAgentScheduleHistoryResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent

      public BuAgentScheduleHistoryResponse getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent(GetWorkforcemanagementBusinessunitWeekScheduleHistoryAgentRequest request) throws IOException, ApiException
      Loads agent's schedule history.
      Parameters:
      request - The request object
      Returns:
      BuAgentScheduleHistoryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent

      public ApiResponse<BuAgentScheduleHistoryResponse> getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent(ApiRequest<Void> request) throws IOException
      Loads agent's schedule history.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions

      public PerformancePredictionResponse getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions(String businessUnitId, String weekId, String scheduleId) throws IOException, ApiException
      Get the performance prediction for the associated schedule
      Parameters:
      businessUnitId - The ID of the business unit to which the performance prediction belongs (required)
      weekId - First day of schedule week in yyyy-MM-dd format (required)
      scheduleId - The ID of the schedule the performance prediction belongs to (required)
      Returns:
      PerformancePredictionResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsWithHttpInfo

      public ApiResponse<PerformancePredictionResponse> getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsWithHttpInfo(String businessUnitId, String weekId, String scheduleId) throws IOException
      Get the performance prediction for the associated schedule
      Parameters:
      businessUnitId - The ID of the business unit to which the performance prediction belongs (required)
      weekId - First day of schedule week in yyyy-MM-dd format (required)
      scheduleId - The ID of the schedule the performance prediction belongs to (required)
      Returns:
      PerformancePredictionResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions

      public PerformancePredictionResponse getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions(GetWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRequest request) throws IOException, ApiException
      Get the performance prediction for the associated schedule
      Parameters:
      request - The request object
      Returns:
      PerformancePredictionResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions

      public ApiResponse<PerformancePredictionResponse> getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions(ApiRequest<Void> request) throws IOException
      Get the performance prediction for the associated schedule
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation

      public PerformancePredictionRecalculationResponse getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation(String businessUnitId, String weekId, String scheduleId, String recalculationId) throws IOException, ApiException
      Get recalculated performance prediction result
      Parameters:
      businessUnitId - The ID of the business unit to which the performance prediction belongs (required)
      weekId - First day of schedule week in yyyy-MM-dd format (required)
      scheduleId - The ID of the schedule the recalculation belongs to (required)
      recalculationId - The ID of the recalculation request (required)
      Returns:
      PerformancePredictionRecalculationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationWithHttpInfo

      public ApiResponse<PerformancePredictionRecalculationResponse> getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationWithHttpInfo(String businessUnitId, String weekId, String scheduleId, String recalculationId) throws IOException
      Get recalculated performance prediction result
      Parameters:
      businessUnitId - The ID of the business unit to which the performance prediction belongs (required)
      weekId - First day of schedule week in yyyy-MM-dd format (required)
      scheduleId - The ID of the schedule the recalculation belongs to (required)
      recalculationId - The ID of the recalculation request (required)
      Returns:
      PerformancePredictionRecalculationResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation

      public PerformancePredictionRecalculationResponse getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation(GetWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationRequest request) throws IOException, ApiException
      Get recalculated performance prediction result
      Parameters:
      request - The request object
      Returns:
      PerformancePredictionRecalculationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation

      public ApiResponse<PerformancePredictionRecalculationResponse> getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation(ApiRequest<Void> request) throws IOException
      Get recalculated performance prediction result
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekSchedules

      public BuScheduleListing getWorkforcemanagementBusinessunitWeekSchedules(String businessUnitId, String weekId, LocalDate earliestWeekDate, LocalDate latestWeekDate, Boolean includeOnlyPublished, String expand) throws IOException, ApiException
      Get the list of week schedules for the specified week Use \"recent\" (without quotes) for the `weekId` path parameter to fetch all schedules for up to +/- 26 weeks from the current date. Response will include any schedule which spans the specified week
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format, or 'recent' (without quotes) to get recent schedules (required)
      earliestWeekDate - If weekId == 'recent', specify the earliest schedule start week date (inclusive) to include in the 'recent' range, in yyyy-MM-dd format. Ignored if weekId != 'recent'. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      latestWeekDate - If weekId == 'recent', specify the latest schedule start week date (inclusive) to include in the 'recent' range, in yyyy-MM-dd format. Ignored if weekId != 'recent'. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      includeOnlyPublished - includeOnlyPublished (optional)
      expand - expand (optional)
      Returns:
      BuScheduleListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekSchedulesWithHttpInfo

      public ApiResponse<BuScheduleListing> getWorkforcemanagementBusinessunitWeekSchedulesWithHttpInfo(String businessUnitId, String weekId, LocalDate earliestWeekDate, LocalDate latestWeekDate, Boolean includeOnlyPublished, String expand) throws IOException
      Get the list of week schedules for the specified week Use \"recent\" (without quotes) for the `weekId` path parameter to fetch all schedules for up to +/- 26 weeks from the current date. Response will include any schedule which spans the specified week
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format, or 'recent' (without quotes) to get recent schedules (required)
      earliestWeekDate - If weekId == 'recent', specify the earliest schedule start week date (inclusive) to include in the 'recent' range, in yyyy-MM-dd format. Ignored if weekId != 'recent'. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      latestWeekDate - If weekId == 'recent', specify the latest schedule start week date (inclusive) to include in the 'recent' range, in yyyy-MM-dd format. Ignored if weekId != 'recent'. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      includeOnlyPublished - includeOnlyPublished (optional)
      expand - expand (optional)
      Returns:
      BuScheduleListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekSchedules

      public BuScheduleListing getWorkforcemanagementBusinessunitWeekSchedules(GetWorkforcemanagementBusinessunitWeekSchedulesRequest request) throws IOException, ApiException
      Get the list of week schedules for the specified week Use \"recent\" (without quotes) for the `weekId` path parameter to fetch all schedules for up to +/- 26 weeks from the current date. Response will include any schedule which spans the specified week
      Parameters:
      request - The request object
      Returns:
      BuScheduleListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekSchedules

      public ApiResponse<BuScheduleListing> getWorkforcemanagementBusinessunitWeekSchedules(ApiRequest<Void> request) throws IOException
      Get the list of week schedules for the specified week Use \"recent\" (without quotes) for the `weekId` path parameter to fetch all schedules for up to +/- 26 weeks from the current date. Response will include any schedule which spans the specified week
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecast

      public BuShortTermForecast getWorkforcemanagementBusinessunitWeekShorttermforecast(String businessUnitId, LocalDate weekDateId, String forecastId, List<String> expand) throws IOException, ApiException
      Get a short term forecast
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      forecastId - The ID of the forecast (required)
      expand - Include to access additional data on the forecast (optional)
      Returns:
      BuShortTermForecast
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastWithHttpInfo

      public ApiResponse<BuShortTermForecast> getWorkforcemanagementBusinessunitWeekShorttermforecastWithHttpInfo(String businessUnitId, LocalDate weekDateId, String forecastId, List<String> expand) throws IOException
      Get a short term forecast
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      forecastId - The ID of the forecast (required)
      expand - Include to access additional data on the forecast (optional)
      Returns:
      BuShortTermForecast
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecast

      public BuShortTermForecast getWorkforcemanagementBusinessunitWeekShorttermforecast(GetWorkforcemanagementBusinessunitWeekShorttermforecastRequest request) throws IOException, ApiException
      Get a short term forecast
      Parameters:
      request - The request object
      Returns:
      BuShortTermForecast
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecast

      public ApiResponse<BuShortTermForecast> getWorkforcemanagementBusinessunitWeekShorttermforecast(ApiRequest<Void> request) throws IOException
      Get a short term forecast
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastData

      public BuForecastResultResponse getWorkforcemanagementBusinessunitWeekShorttermforecastData(String businessUnitId, LocalDate weekDateId, String forecastId, Integer weekNumber, Boolean forceDownloadService) throws IOException, ApiException
      Get the result of a short term forecast calculation Includes modifications unless you pass the doNotApplyModifications query parameter
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      forecastId - The ID of the forecast (required)
      weekNumber - The week number to fetch (for multi-week forecasts) (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      BuForecastResultResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastDataWithHttpInfo

      public ApiResponse<BuForecastResultResponse> getWorkforcemanagementBusinessunitWeekShorttermforecastDataWithHttpInfo(String businessUnitId, LocalDate weekDateId, String forecastId, Integer weekNumber, Boolean forceDownloadService) throws IOException
      Get the result of a short term forecast calculation Includes modifications unless you pass the doNotApplyModifications query parameter
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      forecastId - The ID of the forecast (required)
      weekNumber - The week number to fetch (for multi-week forecasts) (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      BuForecastResultResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastData

      public BuForecastResultResponse getWorkforcemanagementBusinessunitWeekShorttermforecastData(GetWorkforcemanagementBusinessunitWeekShorttermforecastDataRequest request) throws IOException, ApiException
      Get the result of a short term forecast calculation Includes modifications unless you pass the doNotApplyModifications query parameter
      Parameters:
      request - The request object
      Returns:
      BuForecastResultResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastData

      public ApiResponse<BuForecastResultResponse> getWorkforcemanagementBusinessunitWeekShorttermforecastData(ApiRequest<Void> request) throws IOException
      Get the result of a short term forecast calculation Includes modifications unless you pass the doNotApplyModifications query parameter
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults

      public BuForecastGenerationResult getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults(String businessUnitId, LocalDate weekDateId, String forecastId) throws IOException, ApiException
      Gets the forecast generation results
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      forecastId - The ID of the forecast (required)
      Returns:
      BuForecastGenerationResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresultsWithHttpInfo

      public ApiResponse<BuForecastGenerationResult> getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresultsWithHttpInfo(String businessUnitId, LocalDate weekDateId, String forecastId) throws IOException
      Gets the forecast generation results
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      forecastId - The ID of the forecast (required)
      Returns:
      BuForecastGenerationResult
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults

      public BuForecastGenerationResult getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults(GetWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresultsRequest request) throws IOException, ApiException
      Gets the forecast generation results
      Parameters:
      request - The request object
      Returns:
      BuForecastGenerationResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults

      public ApiResponse<BuForecastGenerationResult> getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults(ApiRequest<Void> request) throws IOException
      Gets the forecast generation results
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata

      public LongTermForecastResultResponse getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata(String businessUnitId, LocalDate weekDateId, String forecastId, Boolean forceDownloadService) throws IOException, ApiException
      Get the result of a long term forecast calculation Includes modifications unless you pass the doNotApplyModifications query parameter
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      forecastId - The ID of the forecast (required)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      LongTermForecastResultResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdataWithHttpInfo

      public ApiResponse<LongTermForecastResultResponse> getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdataWithHttpInfo(String businessUnitId, LocalDate weekDateId, String forecastId, Boolean forceDownloadService) throws IOException
      Get the result of a long term forecast calculation Includes modifications unless you pass the doNotApplyModifications query parameter
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      forecastId - The ID of the forecast (required)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      LongTermForecastResultResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata

      public LongTermForecastResultResponse getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata(GetWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdataRequest request) throws IOException, ApiException
      Get the result of a long term forecast calculation Includes modifications unless you pass the doNotApplyModifications query parameter
      Parameters:
      request - The request object
      Returns:
      LongTermForecastResultResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata

      public ApiResponse<LongTermForecastResultResponse> getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata(ApiRequest<Void> request) throws IOException
      Get the result of a long term forecast calculation Includes modifications unless you pass the doNotApplyModifications query parameter
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups

      public ForecastPlanningGroupsResponse getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups(String businessUnitId, LocalDate weekDateId, String forecastId) throws IOException, ApiException
      Gets the forecast planning group snapshot
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      forecastId - The ID of the forecast (required)
      Returns:
      ForecastPlanningGroupsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroupsWithHttpInfo

      public ApiResponse<ForecastPlanningGroupsResponse> getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroupsWithHttpInfo(String businessUnitId, LocalDate weekDateId, String forecastId) throws IOException
      Gets the forecast planning group snapshot
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      forecastId - The ID of the forecast (required)
      Returns:
      ForecastPlanningGroupsResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups

      public ForecastPlanningGroupsResponse getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups(GetWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroupsRequest request) throws IOException, ApiException
      Gets the forecast planning group snapshot
      Parameters:
      request - The request object
      Returns:
      ForecastPlanningGroupsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups

      public ApiResponse<ForecastPlanningGroupsResponse> getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups(ApiRequest<Void> request) throws IOException
      Gets the forecast planning group snapshot
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement

      public BuForecastStaffingRequirementsResultResponse getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement(String businessUnitId, LocalDate weekDateId, String forecastId, List<String> weekNumbers, List<String> expand) throws IOException, ApiException
      Get the staffing requirement by planning group for a forecast
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      forecastId - The ID of the forecast (required)
      weekNumbers - The week numbers to fetch (for multi-week forecasts) staffing requirements. Returns all week data if the list is not specified (optional)
      expand - Expand to include minimum staffing values in (staffing requirement response or applied to base staffing requirement values) (optional)
      Returns:
      BuForecastStaffingRequirementsResultResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirementWithHttpInfo

      public ApiResponse<BuForecastStaffingRequirementsResultResponse> getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirementWithHttpInfo(String businessUnitId, LocalDate weekDateId, String forecastId, List<String> weekNumbers, List<String> expand) throws IOException
      Get the staffing requirement by planning group for a forecast
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      forecastId - The ID of the forecast (required)
      weekNumbers - The week numbers to fetch (for multi-week forecasts) staffing requirements. Returns all week data if the list is not specified (optional)
      expand - Expand to include minimum staffing values in (staffing requirement response or applied to base staffing requirement values) (optional)
      Returns:
      BuForecastStaffingRequirementsResultResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement

      public BuForecastStaffingRequirementsResultResponse getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement(GetWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirementRequest request) throws IOException, ApiException
      Get the staffing requirement by planning group for a forecast
      Parameters:
      request - The request object
      Returns:
      BuForecastStaffingRequirementsResultResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement

      public ApiResponse<BuForecastStaffingRequirementsResultResponse> getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement(ApiRequest<Void> request) throws IOException
      Get the staffing requirement by planning group for a forecast
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecasts

      public BuShortTermForecastListing getWorkforcemanagementBusinessunitWeekShorttermforecasts(String businessUnitId, String weekDateId) throws IOException, ApiException
      Get short term forecasts Use \"recent\" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for up to +/- 26 weeks from the current date. Response will include any forecast which spans the specified week
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts (required)
      Returns:
      BuShortTermForecastListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecastsWithHttpInfo

      public ApiResponse<BuShortTermForecastListing> getWorkforcemanagementBusinessunitWeekShorttermforecastsWithHttpInfo(String businessUnitId, String weekDateId) throws IOException
      Get short term forecasts Use \"recent\" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for up to +/- 26 weeks from the current date. Response will include any forecast which spans the specified week
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts (required)
      Returns:
      BuShortTermForecastListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecasts

      public BuShortTermForecastListing getWorkforcemanagementBusinessunitWeekShorttermforecasts(GetWorkforcemanagementBusinessunitWeekShorttermforecastsRequest request) throws IOException, ApiException
      Get short term forecasts Use \"recent\" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for up to +/- 26 weeks from the current date. Response will include any forecast which spans the specified week
      Parameters:
      request - The request object
      Returns:
      BuShortTermForecastListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWeekShorttermforecasts

      public ApiResponse<BuShortTermForecastListing> getWorkforcemanagementBusinessunitWeekShorttermforecasts(ApiRequest<Void> request) throws IOException
      Get short term forecasts Use \"recent\" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for up to +/- 26 weeks from the current date. Response will include any forecast which spans the specified week
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWorkplanbid

      public WorkPlanBid getWorkforcemanagementBusinessunitWorkplanbid(String businessUnitId, String bidId) throws IOException, ApiException
      Get a work plan bid
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The id of the workplanbid (required)
      Returns:
      WorkPlanBid
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWorkplanbidWithHttpInfo

      public ApiResponse<WorkPlanBid> getWorkforcemanagementBusinessunitWorkplanbidWithHttpInfo(String businessUnitId, String bidId) throws IOException
      Get a work plan bid
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The id of the workplanbid (required)
      Returns:
      WorkPlanBid
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWorkplanbid

      public WorkPlanBid getWorkforcemanagementBusinessunitWorkplanbid(GetWorkforcemanagementBusinessunitWorkplanbidRequest request) throws IOException, ApiException
      Get a work plan bid
      Parameters:
      request - The request object
      Returns:
      WorkPlanBid
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWorkplanbid

      public ApiResponse<WorkPlanBid> getWorkforcemanagementBusinessunitWorkplanbid(ApiRequest<Void> request) throws IOException
      Get a work plan bid
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWorkplanbidGroup

      public WorkPlanBidGroupResponse getWorkforcemanagementBusinessunitWorkplanbidGroup(String businessUnitId, String bidId, String bidGroupId) throws IOException, ApiException
      Get a bid group by bid group Id
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The work plan bid id of the bid groups (required)
      bidGroupId - Work Plan Bid Group id (required)
      Returns:
      WorkPlanBidGroupResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWorkplanbidGroupWithHttpInfo

      public ApiResponse<WorkPlanBidGroupResponse> getWorkforcemanagementBusinessunitWorkplanbidGroupWithHttpInfo(String businessUnitId, String bidId, String bidGroupId) throws IOException
      Get a bid group by bid group Id
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The work plan bid id of the bid groups (required)
      bidGroupId - Work Plan Bid Group id (required)
      Returns:
      WorkPlanBidGroupResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWorkplanbidGroup

      public WorkPlanBidGroupResponse getWorkforcemanagementBusinessunitWorkplanbidGroup(GetWorkforcemanagementBusinessunitWorkplanbidGroupRequest request) throws IOException, ApiException
      Get a bid group by bid group Id
      Parameters:
      request - The request object
      Returns:
      WorkPlanBidGroupResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWorkplanbidGroup

      public ApiResponse<WorkPlanBidGroupResponse> getWorkforcemanagementBusinessunitWorkplanbidGroup(ApiRequest<Void> request) throws IOException
      Get a bid group by bid group Id
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences

      public AdminAgentWorkPlanPreferenceResponse getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(String businessUnitId, String bidId, String bidGroupId) throws IOException, ApiException
      Gets the work plan preferences of all the agents in the work plan bid group
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The work plan bid id of the bid groups (required)
      bidGroupId - The ID of the work plan bid group (required)
      Returns:
      AdminAgentWorkPlanPreferenceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWorkplanbidGroupPreferencesWithHttpInfo

      public ApiResponse<AdminAgentWorkPlanPreferenceResponse> getWorkforcemanagementBusinessunitWorkplanbidGroupPreferencesWithHttpInfo(String businessUnitId, String bidId, String bidGroupId) throws IOException
      Gets the work plan preferences of all the agents in the work plan bid group
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The work plan bid id of the bid groups (required)
      bidGroupId - The ID of the work plan bid group (required)
      Returns:
      AdminAgentWorkPlanPreferenceResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences

      public AdminAgentWorkPlanPreferenceResponse getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(GetWorkforcemanagementBusinessunitWorkplanbidGroupPreferencesRequest request) throws IOException, ApiException
      Gets the work plan preferences of all the agents in the work plan bid group
      Parameters:
      request - The request object
      Returns:
      AdminAgentWorkPlanPreferenceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences

      public ApiResponse<AdminAgentWorkPlanPreferenceResponse> getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(ApiRequest<Void> request) throws IOException
      Gets the work plan preferences of all the agents in the work plan bid group
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary

      public WorkPlanBidGroupSummaryList getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary(String businessUnitId, String bidId) throws IOException, ApiException
      Get summary of bid groups that belong to a work plan bid
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The work plan bid id of the bid groups (required)
      Returns:
      WorkPlanBidGroupSummaryList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWorkplanbidGroupsSummaryWithHttpInfo

      public ApiResponse<WorkPlanBidGroupSummaryList> getWorkforcemanagementBusinessunitWorkplanbidGroupsSummaryWithHttpInfo(String businessUnitId, String bidId) throws IOException
      Get summary of bid groups that belong to a work plan bid
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The work plan bid id of the bid groups (required)
      Returns:
      WorkPlanBidGroupSummaryList
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary

      public WorkPlanBidGroupSummaryList getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary(GetWorkforcemanagementBusinessunitWorkplanbidGroupsSummaryRequest request) throws IOException, ApiException
      Get summary of bid groups that belong to a work plan bid
      Parameters:
      request - The request object
      Returns:
      WorkPlanBidGroupSummaryList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary

      public ApiResponse<WorkPlanBidGroupSummaryList> getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary(ApiRequest<Void> request) throws IOException
      Get summary of bid groups that belong to a work plan bid
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWorkplanbids

      public WorkPlanBidListResponse getWorkforcemanagementBusinessunitWorkplanbids(String businessUnitId) throws IOException, ApiException
      Get list of work plan bids
      Parameters:
      businessUnitId - The ID of the business unit (required)
      Returns:
      WorkPlanBidListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWorkplanbidsWithHttpInfo

      public ApiResponse<WorkPlanBidListResponse> getWorkforcemanagementBusinessunitWorkplanbidsWithHttpInfo(String businessUnitId) throws IOException
      Get list of work plan bids
      Parameters:
      businessUnitId - The ID of the business unit (required)
      Returns:
      WorkPlanBidListResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWorkplanbids

      public WorkPlanBidListResponse getWorkforcemanagementBusinessunitWorkplanbids(GetWorkforcemanagementBusinessunitWorkplanbidsRequest request) throws IOException, ApiException
      Get list of work plan bids
      Parameters:
      request - The request object
      Returns:
      WorkPlanBidListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitWorkplanbids

      public ApiResponse<WorkPlanBidListResponse> getWorkforcemanagementBusinessunitWorkplanbids(ApiRequest<Void> request) throws IOException
      Get list of work plan bids
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunits

      public BusinessUnitListing getWorkforcemanagementBusinessunits(String feature, String divisionId) throws IOException, ApiException
      Get business units
      Parameters:
      feature - If specified, the list of business units for which the user is authorized to use the requested feature will be returned (optional)
      divisionId - If specified, the list of business units belonging to the specified division will be returned (optional)
      Returns:
      BusinessUnitListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitsWithHttpInfo

      public ApiResponse<BusinessUnitListing> getWorkforcemanagementBusinessunitsWithHttpInfo(String feature, String divisionId) throws IOException
      Get business units
      Parameters:
      feature - If specified, the list of business units for which the user is authorized to use the requested feature will be returned (optional)
      divisionId - If specified, the list of business units belonging to the specified division will be returned (optional)
      Returns:
      BusinessUnitListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunits

      public BusinessUnitListing getWorkforcemanagementBusinessunits(GetWorkforcemanagementBusinessunitsRequest request) throws IOException, ApiException
      Get business units
      Parameters:
      request - The request object
      Returns:
      BusinessUnitListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunits

      public ApiResponse<BusinessUnitListing> getWorkforcemanagementBusinessunits(ApiRequest<Void> request) throws IOException
      Get business units
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitsDivisionviews

      public BusinessUnitListing getWorkforcemanagementBusinessunitsDivisionviews(List<String> divisionId) throws IOException, ApiException
      Get business units across divisions
      Parameters:
      divisionId - The divisionIds to filter by. If omitted, will return business units in all divisions (optional)
      Returns:
      BusinessUnitListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitsDivisionviewsWithHttpInfo

      public ApiResponse<BusinessUnitListing> getWorkforcemanagementBusinessunitsDivisionviewsWithHttpInfo(List<String> divisionId) throws IOException
      Get business units across divisions
      Parameters:
      divisionId - The divisionIds to filter by. If omitted, will return business units in all divisions (optional)
      Returns:
      BusinessUnitListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitsDivisionviews

      public BusinessUnitListing getWorkforcemanagementBusinessunitsDivisionviews(GetWorkforcemanagementBusinessunitsDivisionviewsRequest request) throws IOException, ApiException
      Get business units across divisions
      Parameters:
      request - The request object
      Returns:
      BusinessUnitListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementBusinessunitsDivisionviews

      public ApiResponse<BusinessUnitListing> getWorkforcemanagementBusinessunitsDivisionviews(ApiRequest<Void> request) throws IOException
      Get business units across divisions
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementCalendarDataIcs

      public String getWorkforcemanagementCalendarDataIcs(String calendarId) throws IOException, ApiException
      Get ics formatted calendar based on shareable link
      Parameters:
      calendarId - The id of the ics-formatted calendar (required)
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementCalendarDataIcsWithHttpInfo

      public ApiResponse<String> getWorkforcemanagementCalendarDataIcsWithHttpInfo(String calendarId) throws IOException
      Get ics formatted calendar based on shareable link
      Parameters:
      calendarId - The id of the ics-formatted calendar (required)
      Returns:
      String
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementCalendarDataIcs

      public String getWorkforcemanagementCalendarDataIcs(GetWorkforcemanagementCalendarDataIcsRequest request) throws IOException, ApiException
      Get ics formatted calendar based on shareable link
      Parameters:
      request - The request object
      Returns:
      String
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementCalendarDataIcs

      public ApiResponse<String> getWorkforcemanagementCalendarDataIcs(ApiRequest<Void> request) throws IOException
      Get ics formatted calendar based on shareable link
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementCalendarUrlIcs

      public CalendarUrlResponse getWorkforcemanagementCalendarUrlIcs() throws IOException, ApiException
      Get existing calendar link for the current user
      Returns:
      CalendarUrlResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementCalendarUrlIcsWithHttpInfo

      public ApiResponse<CalendarUrlResponse> getWorkforcemanagementCalendarUrlIcsWithHttpInfo() throws IOException
      Get existing calendar link for the current user
      Returns:
      CalendarUrlResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementCalendarUrlIcs

      public CalendarUrlResponse getWorkforcemanagementCalendarUrlIcs(GetWorkforcemanagementCalendarUrlIcsRequest request) throws IOException, ApiException
      Get existing calendar link for the current user
      Parameters:
      request - The request object
      Returns:
      CalendarUrlResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementCalendarUrlIcs

      public ApiResponse<CalendarUrlResponse> getWorkforcemanagementCalendarUrlIcs(ApiRequest<Void> request) throws IOException
      Get existing calendar link for the current user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementHistoricaldataBulkRemoveJob

      public HistoricalImportDeleteFilesJobResponse getWorkforcemanagementHistoricaldataBulkRemoveJob(String jobId) throws IOException, ApiException
      Retrieves delete job status for historical data imports associated with the job id
      Parameters:
      jobId - The job ID of the historical data delete request (required)
      Returns:
      HistoricalImportDeleteFilesJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementHistoricaldataBulkRemoveJobWithHttpInfo

      public ApiResponse<HistoricalImportDeleteFilesJobResponse> getWorkforcemanagementHistoricaldataBulkRemoveJobWithHttpInfo(String jobId) throws IOException
      Retrieves delete job status for historical data imports associated with the job id
      Parameters:
      jobId - The job ID of the historical data delete request (required)
      Returns:
      HistoricalImportDeleteFilesJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementHistoricaldataBulkRemoveJob

      public HistoricalImportDeleteFilesJobResponse getWorkforcemanagementHistoricaldataBulkRemoveJob(GetWorkforcemanagementHistoricaldataBulkRemoveJobRequest request) throws IOException, ApiException
      Retrieves delete job status for historical data imports associated with the job id
      Parameters:
      request - The request object
      Returns:
      HistoricalImportDeleteFilesJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementHistoricaldataBulkRemoveJob

      public ApiResponse<HistoricalImportDeleteFilesJobResponse> getWorkforcemanagementHistoricaldataBulkRemoveJob(ApiRequest<Void> request) throws IOException
      Retrieves delete job status for historical data imports associated with the job id
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementHistoricaldataBulkRemoveJobs

      public HistoricalImportOverallDeleteStatusResponse getWorkforcemanagementHistoricaldataBulkRemoveJobs() throws IOException, ApiException
      Retrieves all delete job status for historical data
      Returns:
      HistoricalImportOverallDeleteStatusResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementHistoricaldataBulkRemoveJobsWithHttpInfo

      public ApiResponse<HistoricalImportOverallDeleteStatusResponse> getWorkforcemanagementHistoricaldataBulkRemoveJobsWithHttpInfo() throws IOException
      Retrieves all delete job status for historical data
      Returns:
      HistoricalImportOverallDeleteStatusResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementHistoricaldataBulkRemoveJobs

      public HistoricalImportOverallDeleteStatusResponse getWorkforcemanagementHistoricaldataBulkRemoveJobs(GetWorkforcemanagementHistoricaldataBulkRemoveJobsRequest request) throws IOException, ApiException
      Retrieves all delete job status for historical data
      Parameters:
      request - The request object
      Returns:
      HistoricalImportOverallDeleteStatusResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementHistoricaldataBulkRemoveJobs

      public ApiResponse<HistoricalImportOverallDeleteStatusResponse> getWorkforcemanagementHistoricaldataBulkRemoveJobs(ApiRequest<Void> request) throws IOException
      Retrieves all delete job status for historical data
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementHistoricaldataImportstatus

      public HistoricalImportStatusListing getWorkforcemanagementHistoricaldataImportstatus() throws IOException, ApiException
      Retrieves status of the historical data imports of the organization
      Returns:
      HistoricalImportStatusListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementHistoricaldataImportstatusWithHttpInfo

      public ApiResponse<HistoricalImportStatusListing> getWorkforcemanagementHistoricaldataImportstatusWithHttpInfo() throws IOException
      Retrieves status of the historical data imports of the organization
      Returns:
      HistoricalImportStatusListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementHistoricaldataImportstatus

      public HistoricalImportStatusListing getWorkforcemanagementHistoricaldataImportstatus(GetWorkforcemanagementHistoricaldataImportstatusRequest request) throws IOException, ApiException
      Retrieves status of the historical data imports of the organization
      Parameters:
      request - The request object
      Returns:
      HistoricalImportStatusListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementHistoricaldataImportstatus

      public ApiResponse<HistoricalImportStatusListing> getWorkforcemanagementHistoricaldataImportstatus(ApiRequest<Void> request) throws IOException
      Retrieves status of the historical data imports of the organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementHistoricaldataImportstatusJobId

      public HistoricalImportStatusJobResponse getWorkforcemanagementHistoricaldataImportstatusJobId(String jobId) throws IOException, ApiException
      Retrieves status of the historical data imports associated with job id
      Parameters:
      jobId - The job Id of the historical data import request (required)
      Returns:
      HistoricalImportStatusJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementHistoricaldataImportstatusJobIdWithHttpInfo

      public ApiResponse<HistoricalImportStatusJobResponse> getWorkforcemanagementHistoricaldataImportstatusJobIdWithHttpInfo(String jobId) throws IOException
      Retrieves status of the historical data imports associated with job id
      Parameters:
      jobId - The job Id of the historical data import request (required)
      Returns:
      HistoricalImportStatusJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementHistoricaldataImportstatusJobId

      public HistoricalImportStatusJobResponse getWorkforcemanagementHistoricaldataImportstatusJobId(GetWorkforcemanagementHistoricaldataImportstatusJobIdRequest request) throws IOException, ApiException
      Retrieves status of the historical data imports associated with job id
      Parameters:
      request - The request object
      Returns:
      HistoricalImportStatusJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementHistoricaldataImportstatusJobId

      public ApiResponse<HistoricalImportStatusJobResponse> getWorkforcemanagementHistoricaldataImportstatusJobId(ApiRequest<Void> request) throws IOException
      Retrieves status of the historical data imports associated with job id
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementIntegrationsHris

      public WfmIntegrationListing getWorkforcemanagementIntegrationsHris() throws IOException, ApiException
      Get integrations
      Returns:
      WfmIntegrationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementIntegrationsHrisWithHttpInfo

      public ApiResponse<WfmIntegrationListing> getWorkforcemanagementIntegrationsHrisWithHttpInfo() throws IOException
      Get integrations
      Returns:
      WfmIntegrationListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementIntegrationsHris

      public WfmIntegrationListing getWorkforcemanagementIntegrationsHris(GetWorkforcemanagementIntegrationsHrisRequest request) throws IOException, ApiException
      Get integrations
      Parameters:
      request - The request object
      Returns:
      WfmIntegrationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementIntegrationsHris

      public ApiResponse<WfmIntegrationListing> getWorkforcemanagementIntegrationsHris(ApiRequest<Void> request) throws IOException
      Get integrations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementIntegrationsHrisTimeofftypesJob

      public HrisTimeOffTypesJobResponse getWorkforcemanagementIntegrationsHrisTimeofftypesJob(String jobId) throws IOException, ApiException
      Query the results of time off types job
      Parameters:
      jobId - The ID of the job. (required)
      Returns:
      HrisTimeOffTypesJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementIntegrationsHrisTimeofftypesJobWithHttpInfo

      public ApiResponse<HrisTimeOffTypesJobResponse> getWorkforcemanagementIntegrationsHrisTimeofftypesJobWithHttpInfo(String jobId) throws IOException
      Query the results of time off types job
      Parameters:
      jobId - The ID of the job. (required)
      Returns:
      HrisTimeOffTypesJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementIntegrationsHrisTimeofftypesJob

      public HrisTimeOffTypesJobResponse getWorkforcemanagementIntegrationsHrisTimeofftypesJob(GetWorkforcemanagementIntegrationsHrisTimeofftypesJobRequest request) throws IOException, ApiException
      Query the results of time off types job
      Parameters:
      request - The request object
      Returns:
      HrisTimeOffTypesJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementIntegrationsHrisTimeofftypesJob

      public ApiResponse<HrisTimeOffTypesJobResponse> getWorkforcemanagementIntegrationsHrisTimeofftypesJob(ApiRequest<Void> request) throws IOException
      Query the results of time off types job
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunit

      public ManagementUnit getWorkforcemanagementManagementunit(String managementUnitId, List<String> expand) throws IOException, ApiException
      Get management unit settings.shortTermForecasting is deprecated and now lives on the business unit
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      expand - (optional)
      Returns:
      ManagementUnit
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWithHttpInfo

      public ApiResponse<ManagementUnit> getWorkforcemanagementManagementunitWithHttpInfo(String managementUnitId, List<String> expand) throws IOException
      Get management unit settings.shortTermForecasting is deprecated and now lives on the business unit
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      expand - (optional)
      Returns:
      ManagementUnit
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunit

      public ManagementUnit getWorkforcemanagementManagementunit(GetWorkforcemanagementManagementunitRequest request) throws IOException, ApiException
      Get management unit settings.shortTermForecasting is deprecated and now lives on the business unit
      Parameters:
      request - The request object
      Returns:
      ManagementUnit
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunit

      public ApiResponse<ManagementUnit> getWorkforcemanagementManagementunit(ApiRequest<Void> request) throws IOException
      Get management unit settings.shortTermForecasting is deprecated and now lives on the business unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitActivitycodes

      public ActivityCodeContainer getWorkforcemanagementManagementunitActivitycodes(String managementUnitId) throws IOException, ApiException
      Deprecated.
      Deprecated: Instead use /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes. Get the list of activity codes
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      Returns:
      ActivityCodeContainer
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitActivitycodesWithHttpInfo

      public ApiResponse<ActivityCodeContainer> getWorkforcemanagementManagementunitActivitycodesWithHttpInfo(String managementUnitId) throws IOException
      Deprecated.
      Deprecated: Instead use /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes. Get the list of activity codes
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      Returns:
      ActivityCodeContainer
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitActivitycodes

      public ActivityCodeContainer getWorkforcemanagementManagementunitActivitycodes(GetWorkforcemanagementManagementunitActivitycodesRequest request) throws IOException, ApiException
      Deprecated.
      Deprecated: Instead use /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes. Get the list of activity codes
      Parameters:
      request - The request object
      Returns:
      ActivityCodeContainer
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitActivitycodes

      public ApiResponse<ActivityCodeContainer> getWorkforcemanagementManagementunitActivitycodes(ApiRequest<Void> request) throws IOException
      Deprecated.
      Deprecated: Instead use /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes. Get the list of activity codes
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitAdherence

      public UserScheduleAdherenceListing getWorkforcemanagementManagementunitAdherence(String managementUnitId, Boolean forceDownloadService) throws IOException, ApiException
      Get a list of user schedule adherence records for the requested management unit
      Parameters:
      managementUnitId - The ID of the management unit (required)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      UserScheduleAdherenceListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitAdherenceWithHttpInfo

      public ApiResponse<UserScheduleAdherenceListing> getWorkforcemanagementManagementunitAdherenceWithHttpInfo(String managementUnitId, Boolean forceDownloadService) throws IOException
      Get a list of user schedule adherence records for the requested management unit
      Parameters:
      managementUnitId - The ID of the management unit (required)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      UserScheduleAdherenceListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitAdherence

      public UserScheduleAdherenceListing getWorkforcemanagementManagementunitAdherence(GetWorkforcemanagementManagementunitAdherenceRequest request) throws IOException, ApiException
      Get a list of user schedule adherence records for the requested management unit
      Parameters:
      request - The request object
      Returns:
      UserScheduleAdherenceListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitAdherence

      public ApiResponse<UserScheduleAdherenceListing> getWorkforcemanagementManagementunitAdherence(ApiRequest<Void> request) throws IOException
      Get a list of user schedule adherence records for the requested management unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitAgent

      public WfmAgent getWorkforcemanagementManagementunitAgent(String managementUnitId, String agentId, Boolean excludeCapabilities, List<String> expand) throws IOException, ApiException
      Get data for agent in the management unit
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      agentId - The agent id (required)
      excludeCapabilities - Excludes all capabilities of the agent such as queues, languages, and skills (optional)
      expand - (optional)
      Returns:
      WfmAgent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitAgentWithHttpInfo

      public ApiResponse<WfmAgent> getWorkforcemanagementManagementunitAgentWithHttpInfo(String managementUnitId, String agentId, Boolean excludeCapabilities, List<String> expand) throws IOException
      Get data for agent in the management unit
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      agentId - The agent id (required)
      excludeCapabilities - Excludes all capabilities of the agent such as queues, languages, and skills (optional)
      expand - (optional)
      Returns:
      WfmAgent
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitAgent

      public WfmAgent getWorkforcemanagementManagementunitAgent(GetWorkforcemanagementManagementunitAgentRequest request) throws IOException, ApiException
      Get data for agent in the management unit
      Parameters:
      request - The request object
      Returns:
      WfmAgent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitAgent

      public ApiResponse<WfmAgent> getWorkforcemanagementManagementunitAgent(ApiRequest<Void> request) throws IOException
      Get data for agent in the management unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitAgentShifttrades

      public ShiftTradeListResponse getWorkforcemanagementManagementunitAgentShifttrades(String managementUnitId, String agentId) throws IOException, ApiException
      Deprecated.
      Gets all the shift trades for a given agent Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/query/jobs)
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      agentId - The agent id (required)
      Returns:
      ShiftTradeListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitAgentShifttradesWithHttpInfo

      public ApiResponse<ShiftTradeListResponse> getWorkforcemanagementManagementunitAgentShifttradesWithHttpInfo(String managementUnitId, String agentId) throws IOException
      Deprecated.
      Gets all the shift trades for a given agent Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/query/jobs)
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      agentId - The agent id (required)
      Returns:
      ShiftTradeListResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitAgentShifttrades

      public ShiftTradeListResponse getWorkforcemanagementManagementunitAgentShifttrades(GetWorkforcemanagementManagementunitAgentShifttradesRequest request) throws IOException, ApiException
      Deprecated.
      Gets all the shift trades for a given agent Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/query/jobs)
      Parameters:
      request - The request object
      Returns:
      ShiftTradeListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitAgentShifttrades

      public ApiResponse<ShiftTradeListResponse> getWorkforcemanagementManagementunitAgentShifttrades(ApiRequest<Void> request) throws IOException
      Deprecated.
      Gets all the shift trades for a given agent Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/query/jobs)
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitShifttradesMatched

      public ShiftTradeMatchesSummaryResponse getWorkforcemanagementManagementunitShifttradesMatched(String managementUnitId) throws IOException, ApiException
      Deprecated.
      Gets a summary of all shift trades in the matched state Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs)
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      Returns:
      ShiftTradeMatchesSummaryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitShifttradesMatchedWithHttpInfo

      public ApiResponse<ShiftTradeMatchesSummaryResponse> getWorkforcemanagementManagementunitShifttradesMatchedWithHttpInfo(String managementUnitId) throws IOException
      Deprecated.
      Gets a summary of all shift trades in the matched state Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs)
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      Returns:
      ShiftTradeMatchesSummaryResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitShifttradesMatched

      public ShiftTradeMatchesSummaryResponse getWorkforcemanagementManagementunitShifttradesMatched(GetWorkforcemanagementManagementunitShifttradesMatchedRequest request) throws IOException, ApiException
      Deprecated.
      Gets a summary of all shift trades in the matched state Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs)
      Parameters:
      request - The request object
      Returns:
      ShiftTradeMatchesSummaryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitShifttradesMatched

      public ApiResponse<ShiftTradeMatchesSummaryResponse> getWorkforcemanagementManagementunitShifttradesMatched(ApiRequest<Void> request) throws IOException
      Deprecated.
      Gets a summary of all shift trades in the matched state Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs)
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitShifttradesUsers

      public WfmUserEntityListing getWorkforcemanagementManagementunitShifttradesUsers(String managementUnitId) throws IOException, ApiException
      Gets list of users available for whom you can send direct shift trade requests
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      Returns:
      WfmUserEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitShifttradesUsersWithHttpInfo

      public ApiResponse<WfmUserEntityListing> getWorkforcemanagementManagementunitShifttradesUsersWithHttpInfo(String managementUnitId) throws IOException
      Gets list of users available for whom you can send direct shift trade requests
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      Returns:
      WfmUserEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitShifttradesUsers

      public WfmUserEntityListing getWorkforcemanagementManagementunitShifttradesUsers(GetWorkforcemanagementManagementunitShifttradesUsersRequest request) throws IOException, ApiException
      Gets list of users available for whom you can send direct shift trade requests
      Parameters:
      request - The request object
      Returns:
      WfmUserEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitShifttradesUsers

      public ApiResponse<WfmUserEntityListing> getWorkforcemanagementManagementunitShifttradesUsers(ApiRequest<Void> request) throws IOException
      Gets list of users available for whom you can send direct shift trade requests
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitTimeofflimit

      public TimeOffLimit getWorkforcemanagementManagementunitTimeofflimit(String managementUnitId, String timeOffLimitId) throws IOException, ApiException
      Gets a time off limit object Returns properties of time off limit object, but not daily values.
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      timeOffLimitId - The ID of the time off limit to fetch (required)
      Returns:
      TimeOffLimit
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitTimeofflimitWithHttpInfo

      public ApiResponse<TimeOffLimit> getWorkforcemanagementManagementunitTimeofflimitWithHttpInfo(String managementUnitId, String timeOffLimitId) throws IOException
      Gets a time off limit object Returns properties of time off limit object, but not daily values.
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      timeOffLimitId - The ID of the time off limit to fetch (required)
      Returns:
      TimeOffLimit
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitTimeofflimit

      public TimeOffLimit getWorkforcemanagementManagementunitTimeofflimit(GetWorkforcemanagementManagementunitTimeofflimitRequest request) throws IOException, ApiException
      Gets a time off limit object Returns properties of time off limit object, but not daily values.
      Parameters:
      request - The request object
      Returns:
      TimeOffLimit
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitTimeofflimit

      public ApiResponse<TimeOffLimit> getWorkforcemanagementManagementunitTimeofflimit(ApiRequest<Void> request) throws IOException
      Gets a time off limit object Returns properties of time off limit object, but not daily values.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitTimeofflimits

      public TimeOffLimitListing getWorkforcemanagementManagementunitTimeofflimits(String managementUnitId) throws IOException, ApiException
      Gets a list of time off limit objects under management unit. Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      Returns:
      TimeOffLimitListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitTimeofflimitsWithHttpInfo

      public ApiResponse<TimeOffLimitListing> getWorkforcemanagementManagementunitTimeofflimitsWithHttpInfo(String managementUnitId) throws IOException
      Gets a list of time off limit objects under management unit. Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      Returns:
      TimeOffLimitListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitTimeofflimits

      public TimeOffLimitListing getWorkforcemanagementManagementunitTimeofflimits(GetWorkforcemanagementManagementunitTimeofflimitsRequest request) throws IOException, ApiException
      Gets a list of time off limit objects under management unit. Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
      Parameters:
      request - The request object
      Returns:
      TimeOffLimitListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitTimeofflimits

      public ApiResponse<TimeOffLimitListing> getWorkforcemanagementManagementunitTimeofflimits(ApiRequest<Void> request) throws IOException
      Gets a list of time off limit objects under management unit. Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitTimeoffplan

      public TimeOffPlan getWorkforcemanagementManagementunitTimeoffplan(String managementUnitId, String timeOffPlanId) throws IOException, ApiException
      Gets a time off plan
      Parameters:
      managementUnitId - The ID of the management unit (required)
      timeOffPlanId - The ID of the time off plan to fetch (required)
      Returns:
      TimeOffPlan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitTimeoffplanWithHttpInfo

      public ApiResponse<TimeOffPlan> getWorkforcemanagementManagementunitTimeoffplanWithHttpInfo(String managementUnitId, String timeOffPlanId) throws IOException
      Gets a time off plan
      Parameters:
      managementUnitId - The ID of the management unit (required)
      timeOffPlanId - The ID of the time off plan to fetch (required)
      Returns:
      TimeOffPlan
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitTimeoffplan

      public TimeOffPlan getWorkforcemanagementManagementunitTimeoffplan(GetWorkforcemanagementManagementunitTimeoffplanRequest request) throws IOException, ApiException
      Gets a time off plan
      Parameters:
      request - The request object
      Returns:
      TimeOffPlan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitTimeoffplan

      public ApiResponse<TimeOffPlan> getWorkforcemanagementManagementunitTimeoffplan(ApiRequest<Void> request) throws IOException
      Gets a time off plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitTimeoffplans

      public TimeOffPlanListing getWorkforcemanagementManagementunitTimeoffplans(String managementUnitId) throws IOException, ApiException
      Gets a list of time off plans
      Parameters:
      managementUnitId - The ID of the management unit (required)
      Returns:
      TimeOffPlanListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitTimeoffplansWithHttpInfo

      public ApiResponse<TimeOffPlanListing> getWorkforcemanagementManagementunitTimeoffplansWithHttpInfo(String managementUnitId) throws IOException
      Gets a list of time off plans
      Parameters:
      managementUnitId - The ID of the management unit (required)
      Returns:
      TimeOffPlanListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitTimeoffplans

      public TimeOffPlanListing getWorkforcemanagementManagementunitTimeoffplans(GetWorkforcemanagementManagementunitTimeoffplansRequest request) throws IOException, ApiException
      Gets a list of time off plans
      Parameters:
      request - The request object
      Returns:
      TimeOffPlanListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitTimeoffplans

      public ApiResponse<TimeOffPlanListing> getWorkforcemanagementManagementunitTimeoffplans(ApiRequest<Void> request) throws IOException
      Gets a list of time off plans
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitUserTimeoffrequest

      public TimeOffRequestResponse getWorkforcemanagementManagementunitUserTimeoffrequest(String managementUnitId, String userId, String timeOffRequestId) throws IOException, ApiException
      Get a time off request
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      userId - The userId to whom the Time Off Request applies. (required)
      timeOffRequestId - Time Off Request Id (required)
      Returns:
      TimeOffRequestResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitUserTimeoffrequestWithHttpInfo

      public ApiResponse<TimeOffRequestResponse> getWorkforcemanagementManagementunitUserTimeoffrequestWithHttpInfo(String managementUnitId, String userId, String timeOffRequestId) throws IOException
      Get a time off request
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      userId - The userId to whom the Time Off Request applies. (required)
      timeOffRequestId - Time Off Request Id (required)
      Returns:
      TimeOffRequestResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitUserTimeoffrequest

      public TimeOffRequestResponse getWorkforcemanagementManagementunitUserTimeoffrequest(GetWorkforcemanagementManagementunitUserTimeoffrequestRequest request) throws IOException, ApiException
      Get a time off request
      Parameters:
      request - The request object
      Returns:
      TimeOffRequestResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitUserTimeoffrequest

      public ApiResponse<TimeOffRequestResponse> getWorkforcemanagementManagementunitUserTimeoffrequest(ApiRequest<Void> request) throws IOException
      Get a time off request
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits

      public QueryTimeOffLimitValuesResponse getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits(String managementUnitId, String userId, String timeOffRequestId) throws IOException, ApiException
      Retrieves time off limit, allocated and waitlisted values according to specific time off request
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      userId - The userId to whom the time off request applies. (required)
      timeOffRequestId - The ID of the time off request, which dates and activityCodeId determine limit values to retrieve (required)
      Returns:
      QueryTimeOffLimitValuesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimitsWithHttpInfo

      public ApiResponse<QueryTimeOffLimitValuesResponse> getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimitsWithHttpInfo(String managementUnitId, String userId, String timeOffRequestId) throws IOException
      Retrieves time off limit, allocated and waitlisted values according to specific time off request
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      userId - The userId to whom the time off request applies. (required)
      timeOffRequestId - The ID of the time off request, which dates and activityCodeId determine limit values to retrieve (required)
      Returns:
      QueryTimeOffLimitValuesResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits

      public QueryTimeOffLimitValuesResponse getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits(GetWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimitsRequest request) throws IOException, ApiException
      Retrieves time off limit, allocated and waitlisted values according to specific time off request
      Parameters:
      request - The request object
      Returns:
      QueryTimeOffLimitValuesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits

      public ApiResponse<QueryTimeOffLimitValuesResponse> getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits(ApiRequest<Void> request) throws IOException
      Retrieves time off limit, allocated and waitlisted values according to specific time off request
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitUserTimeoffrequests

      public TimeOffRequestList getWorkforcemanagementManagementunitUserTimeoffrequests(String managementUnitId, String userId) throws IOException, ApiException
      Get a list of time off requests for a given user
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      userId - The userId to whom the Time Off Request applies. (required)
      Returns:
      TimeOffRequestList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitUserTimeoffrequestsWithHttpInfo

      public ApiResponse<TimeOffRequestList> getWorkforcemanagementManagementunitUserTimeoffrequestsWithHttpInfo(String managementUnitId, String userId) throws IOException
      Get a list of time off requests for a given user
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      userId - The userId to whom the Time Off Request applies. (required)
      Returns:
      TimeOffRequestList
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitUserTimeoffrequests

      public TimeOffRequestList getWorkforcemanagementManagementunitUserTimeoffrequests(GetWorkforcemanagementManagementunitUserTimeoffrequestsRequest request) throws IOException, ApiException
      Get a list of time off requests for a given user
      Parameters:
      request - The request object
      Returns:
      TimeOffRequestList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitUserTimeoffrequests

      public ApiResponse<TimeOffRequestList> getWorkforcemanagementManagementunitUserTimeoffrequests(ApiRequest<Void> request) throws IOException
      Get a list of time off requests for a given user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitUsers

      public WfmUserEntityListing getWorkforcemanagementManagementunitUsers(String managementUnitId) throws IOException, ApiException
      Get users in the management unit
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      Returns:
      WfmUserEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitUsersWithHttpInfo

      public ApiResponse<WfmUserEntityListing> getWorkforcemanagementManagementunitUsersWithHttpInfo(String managementUnitId) throws IOException
      Get users in the management unit
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      Returns:
      WfmUserEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitUsers

      public WfmUserEntityListing getWorkforcemanagementManagementunitUsers(GetWorkforcemanagementManagementunitUsersRequest request) throws IOException, ApiException
      Get users in the management unit
      Parameters:
      request - The request object
      Returns:
      WfmUserEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitUsers

      public ApiResponse<WfmUserEntityListing> getWorkforcemanagementManagementunitUsers(ApiRequest<Void> request) throws IOException
      Get users in the management unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWeekSchedule

      public WeekScheduleResponse getWorkforcemanagementManagementunitWeekSchedule(String managementUnitId, String weekId, String scheduleId, String expand, Boolean forceDownloadService) throws IOException, ApiException
      Deprecated.
      Deprecated. Use the equivalent business unit resource instead. Get a week schedule
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      weekId - First day of schedule week in yyyy-MM-dd format. (required)
      scheduleId - The ID of the schedule to fetch (required)
      expand - Which fields, if any, to expand (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      WeekScheduleResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWeekScheduleWithHttpInfo

      public ApiResponse<WeekScheduleResponse> getWorkforcemanagementManagementunitWeekScheduleWithHttpInfo(String managementUnitId, String weekId, String scheduleId, String expand, Boolean forceDownloadService) throws IOException
      Deprecated.
      Deprecated. Use the equivalent business unit resource instead. Get a week schedule
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      weekId - First day of schedule week in yyyy-MM-dd format. (required)
      scheduleId - The ID of the schedule to fetch (required)
      expand - Which fields, if any, to expand (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      WeekScheduleResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWeekSchedule

      public WeekScheduleResponse getWorkforcemanagementManagementunitWeekSchedule(GetWorkforcemanagementManagementunitWeekScheduleRequest request) throws IOException, ApiException
      Deprecated.
      Deprecated. Use the equivalent business unit resource instead. Get a week schedule
      Parameters:
      request - The request object
      Returns:
      WeekScheduleResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWeekSchedule

      public ApiResponse<WeekScheduleResponse> getWorkforcemanagementManagementunitWeekSchedule(ApiRequest<Void> request) throws IOException
      Deprecated.
      Deprecated. Use the equivalent business unit resource instead. Get a week schedule
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWeekSchedules

      public WeekScheduleListResponse getWorkforcemanagementManagementunitWeekSchedules(String managementUnitId, String weekId, Boolean includeOnlyPublished, String earliestWeekDate, String latestWeekDate) throws IOException, ApiException
      Deprecated.
      Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      weekId - First day of schedule week in yyyy-MM-dd format. (required)
      includeOnlyPublished - Return only published schedules (optional)
      earliestWeekDate - The start date of the earliest week to query in yyyy-MM-dd format (optional)
      latestWeekDate - The start date of the latest week to query in yyyy-MM-dd format (optional)
      Returns:
      WeekScheduleListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWeekSchedulesWithHttpInfo

      public ApiResponse<WeekScheduleListResponse> getWorkforcemanagementManagementunitWeekSchedulesWithHttpInfo(String managementUnitId, String weekId, Boolean includeOnlyPublished, String earliestWeekDate, String latestWeekDate) throws IOException
      Deprecated.
      Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      weekId - First day of schedule week in yyyy-MM-dd format. (required)
      includeOnlyPublished - Return only published schedules (optional)
      earliestWeekDate - The start date of the earliest week to query in yyyy-MM-dd format (optional)
      latestWeekDate - The start date of the latest week to query in yyyy-MM-dd format (optional)
      Returns:
      WeekScheduleListResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWeekSchedules

      public WeekScheduleListResponse getWorkforcemanagementManagementunitWeekSchedules(GetWorkforcemanagementManagementunitWeekSchedulesRequest request) throws IOException, ApiException
      Deprecated.
      Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit
      Parameters:
      request - The request object
      Returns:
      WeekScheduleListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWeekSchedules

      public ApiResponse<WeekScheduleListResponse> getWorkforcemanagementManagementunitWeekSchedules(ApiRequest<Void> request) throws IOException
      Deprecated.
      Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWeekShifttrades

      public WeekShiftTradeListResponse getWorkforcemanagementManagementunitWeekShifttrades(String managementUnitId, LocalDate weekDateId, Boolean evaluateMatches, Boolean includeCrossWeekShifts, Boolean forceDownloadService) throws IOException, ApiException
      Deprecated.
      Gets all the shift trades for a given week Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs)
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      weekDateId - The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      evaluateMatches - Whether to evaluate the matches for violations (optional, default to true)
      includeCrossWeekShifts - Whether to include all shift trades with either the initiating shift or the receiving shift in the week (optional, default to false)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      WeekShiftTradeListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWeekShifttradesWithHttpInfo

      public ApiResponse<WeekShiftTradeListResponse> getWorkforcemanagementManagementunitWeekShifttradesWithHttpInfo(String managementUnitId, LocalDate weekDateId, Boolean evaluateMatches, Boolean includeCrossWeekShifts, Boolean forceDownloadService) throws IOException
      Deprecated.
      Gets all the shift trades for a given week Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs)
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      weekDateId - The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      evaluateMatches - Whether to evaluate the matches for violations (optional, default to true)
      includeCrossWeekShifts - Whether to include all shift trades with either the initiating shift or the receiving shift in the week (optional, default to false)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      WeekShiftTradeListResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWeekShifttrades

      public WeekShiftTradeListResponse getWorkforcemanagementManagementunitWeekShifttrades(GetWorkforcemanagementManagementunitWeekShifttradesRequest request) throws IOException, ApiException
      Deprecated.
      Gets all the shift trades for a given week Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs)
      Parameters:
      request - The request object
      Returns:
      WeekShiftTradeListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWeekShifttrades

      public ApiResponse<WeekShiftTradeListResponse> getWorkforcemanagementManagementunitWeekShifttrades(ApiRequest<Void> request) throws IOException
      Deprecated.
      Gets all the shift trades for a given week Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs)
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWorkplan

      public WorkPlan getWorkforcemanagementManagementunitWorkplan(String managementUnitId, String workPlanId, List<String> includeOnly) throws IOException, ApiException
      Get a work plan
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      workPlanId - The ID of the work plan to fetch (required)
      includeOnly - limit response to the specified fields (optional)
      Returns:
      WorkPlan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWorkplanWithHttpInfo

      public ApiResponse<WorkPlan> getWorkforcemanagementManagementunitWorkplanWithHttpInfo(String managementUnitId, String workPlanId, List<String> includeOnly) throws IOException
      Get a work plan
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      workPlanId - The ID of the work plan to fetch (required)
      includeOnly - limit response to the specified fields (optional)
      Returns:
      WorkPlan
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWorkplan

      public WorkPlan getWorkforcemanagementManagementunitWorkplan(GetWorkforcemanagementManagementunitWorkplanRequest request) throws IOException, ApiException
      Get a work plan
      Parameters:
      request - The request object
      Returns:
      WorkPlan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWorkplan

      public ApiResponse<WorkPlan> getWorkforcemanagementManagementunitWorkplan(ApiRequest<Void> request) throws IOException
      Get a work plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWorkplanrotation

      public WorkPlanRotationResponse getWorkforcemanagementManagementunitWorkplanrotation(String managementUnitId, String workPlanRotationId) throws IOException, ApiException
      Get a work plan rotation
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      workPlanRotationId - The ID of the work plan rotation to fetch (required)
      Returns:
      WorkPlanRotationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWorkplanrotationWithHttpInfo

      public ApiResponse<WorkPlanRotationResponse> getWorkforcemanagementManagementunitWorkplanrotationWithHttpInfo(String managementUnitId, String workPlanRotationId) throws IOException
      Get a work plan rotation
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      workPlanRotationId - The ID of the work plan rotation to fetch (required)
      Returns:
      WorkPlanRotationResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWorkplanrotation

      public WorkPlanRotationResponse getWorkforcemanagementManagementunitWorkplanrotation(GetWorkforcemanagementManagementunitWorkplanrotationRequest request) throws IOException, ApiException
      Get a work plan rotation
      Parameters:
      request - The request object
      Returns:
      WorkPlanRotationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWorkplanrotation

      public ApiResponse<WorkPlanRotationResponse> getWorkforcemanagementManagementunitWorkplanrotation(ApiRequest<Void> request) throws IOException
      Get a work plan rotation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWorkplanrotations

      public WorkPlanRotationListResponse getWorkforcemanagementManagementunitWorkplanrotations(String managementUnitId, List<String> expand) throws IOException, ApiException
      Get work plan rotations
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      expand - (optional)
      Returns:
      WorkPlanRotationListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWorkplanrotationsWithHttpInfo

      public ApiResponse<WorkPlanRotationListResponse> getWorkforcemanagementManagementunitWorkplanrotationsWithHttpInfo(String managementUnitId, List<String> expand) throws IOException
      Get work plan rotations
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      expand - (optional)
      Returns:
      WorkPlanRotationListResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWorkplanrotations

      public WorkPlanRotationListResponse getWorkforcemanagementManagementunitWorkplanrotations(GetWorkforcemanagementManagementunitWorkplanrotationsRequest request) throws IOException, ApiException
      Get work plan rotations
      Parameters:
      request - The request object
      Returns:
      WorkPlanRotationListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWorkplanrotations

      public ApiResponse<WorkPlanRotationListResponse> getWorkforcemanagementManagementunitWorkplanrotations(ApiRequest<Void> request) throws IOException
      Get work plan rotations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWorkplans

      public WorkPlanListResponse getWorkforcemanagementManagementunitWorkplans(String managementUnitId, List<String> expand, List<String> exclude) throws IOException, ApiException
      Get work plans \"expand=details\" is deprecated
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      expand - Include to access additional data on the work plans (optional)
      exclude - Exclude specific data on the work plans from the response (optional)
      Returns:
      WorkPlanListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWorkplansWithHttpInfo

      public ApiResponse<WorkPlanListResponse> getWorkforcemanagementManagementunitWorkplansWithHttpInfo(String managementUnitId, List<String> expand, List<String> exclude) throws IOException
      Get work plans \"expand=details\" is deprecated
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      expand - Include to access additional data on the work plans (optional)
      exclude - Exclude specific data on the work plans from the response (optional)
      Returns:
      WorkPlanListResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWorkplans

      public WorkPlanListResponse getWorkforcemanagementManagementunitWorkplans(GetWorkforcemanagementManagementunitWorkplansRequest request) throws IOException, ApiException
      Get work plans \"expand=details\" is deprecated
      Parameters:
      request - The request object
      Returns:
      WorkPlanListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitWorkplans

      public ApiResponse<WorkPlanListResponse> getWorkforcemanagementManagementunitWorkplans(ApiRequest<Void> request) throws IOException
      Get work plans \"expand=details\" is deprecated
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunits

      public ManagementUnitListing getWorkforcemanagementManagementunits(Integer pageSize, Integer pageNumber, String expand, String feature, String divisionId) throws IOException, ApiException
      Get management units
      Parameters:
      pageSize - Deprecated, paging is not supported (optional)
      pageNumber - Deprecated, paging is not supported (optional)
      expand - Deprecated, expand settings on the single MU route (optional)
      feature - If specified, the list of management units for which the user is authorized to use the requested feature will be returned (optional)
      divisionId - If specified, the list of management units belonging to the specified division will be returned (optional)
      Returns:
      ManagementUnitListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitsWithHttpInfo

      public ApiResponse<ManagementUnitListing> getWorkforcemanagementManagementunitsWithHttpInfo(Integer pageSize, Integer pageNumber, String expand, String feature, String divisionId) throws IOException
      Get management units
      Parameters:
      pageSize - Deprecated, paging is not supported (optional)
      pageNumber - Deprecated, paging is not supported (optional)
      expand - Deprecated, expand settings on the single MU route (optional)
      feature - If specified, the list of management units for which the user is authorized to use the requested feature will be returned (optional)
      divisionId - If specified, the list of management units belonging to the specified division will be returned (optional)
      Returns:
      ManagementUnitListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunits

      public ManagementUnitListing getWorkforcemanagementManagementunits(GetWorkforcemanagementManagementunitsRequest request) throws IOException, ApiException
      Get management units
      Parameters:
      request - The request object
      Returns:
      ManagementUnitListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunits

      public ApiResponse<ManagementUnitListing> getWorkforcemanagementManagementunits(ApiRequest<Void> request) throws IOException
      Get management units
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitsDivisionviews

      public ManagementUnitListing getWorkforcemanagementManagementunitsDivisionviews(List<String> divisionId) throws IOException, ApiException
      Get management units across divisions
      Parameters:
      divisionId - The divisionIds to filter by. If omitted, will return all divisions (optional)
      Returns:
      ManagementUnitListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitsDivisionviewsWithHttpInfo

      public ApiResponse<ManagementUnitListing> getWorkforcemanagementManagementunitsDivisionviewsWithHttpInfo(List<String> divisionId) throws IOException
      Get management units across divisions
      Parameters:
      divisionId - The divisionIds to filter by. If omitted, will return all divisions (optional)
      Returns:
      ManagementUnitListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitsDivisionviews

      public ManagementUnitListing getWorkforcemanagementManagementunitsDivisionviews(GetWorkforcemanagementManagementunitsDivisionviewsRequest request) throws IOException, ApiException
      Get management units across divisions
      Parameters:
      request - The request object
      Returns:
      ManagementUnitListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementManagementunitsDivisionviews

      public ApiResponse<ManagementUnitListing> getWorkforcemanagementManagementunitsDivisionviews(ApiRequest<Void> request) throws IOException
      Get management units across divisions
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementNotifications

      public NotificationsResponse getWorkforcemanagementNotifications() throws IOException, ApiException
      Get a list of notifications for the current user Notifications are only initially sent if you have the relevant Notify and Edit permissions
      Returns:
      NotificationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementNotificationsWithHttpInfo

      public ApiResponse<NotificationsResponse> getWorkforcemanagementNotificationsWithHttpInfo() throws IOException
      Get a list of notifications for the current user Notifications are only initially sent if you have the relevant Notify and Edit permissions
      Returns:
      NotificationsResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementNotifications

      public NotificationsResponse getWorkforcemanagementNotifications(GetWorkforcemanagementNotificationsRequest request) throws IOException, ApiException
      Get a list of notifications for the current user Notifications are only initially sent if you have the relevant Notify and Edit permissions
      Parameters:
      request - The request object
      Returns:
      NotificationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementNotifications

      public ApiResponse<NotificationsResponse> getWorkforcemanagementNotifications(ApiRequest<Void> request) throws IOException
      Get a list of notifications for the current user Notifications are only initially sent if you have the relevant Notify and Edit permissions
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementSchedulingjob

      public SchedulingStatusResponse getWorkforcemanagementSchedulingjob(String jobId) throws IOException, ApiException
      Get status of the scheduling job
      Parameters:
      jobId - The id of the scheduling job (required)
      Returns:
      SchedulingStatusResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementSchedulingjobWithHttpInfo

      public ApiResponse<SchedulingStatusResponse> getWorkforcemanagementSchedulingjobWithHttpInfo(String jobId) throws IOException
      Get status of the scheduling job
      Parameters:
      jobId - The id of the scheduling job (required)
      Returns:
      SchedulingStatusResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementSchedulingjob

      public SchedulingStatusResponse getWorkforcemanagementSchedulingjob(GetWorkforcemanagementSchedulingjobRequest request) throws IOException, ApiException
      Get status of the scheduling job
      Parameters:
      request - The request object
      Returns:
      SchedulingStatusResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementSchedulingjob

      public ApiResponse<SchedulingStatusResponse> getWorkforcemanagementSchedulingjob(ApiRequest<Void> request) throws IOException
      Get status of the scheduling job
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttrades

      public ShiftTradeListResponse getWorkforcemanagementShifttrades() throws IOException, ApiException
      Deprecated.
      Gets all of my shift trades Deprecated. Use new route instead (/shifttrading/trades/mine/query/jobs)
      Returns:
      ShiftTradeListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttradesWithHttpInfo

      public ApiResponse<ShiftTradeListResponse> getWorkforcemanagementShifttradesWithHttpInfo() throws IOException
      Deprecated.
      Gets all of my shift trades Deprecated. Use new route instead (/shifttrading/trades/mine/query/jobs)
      Returns:
      ShiftTradeListResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttrades

      public ShiftTradeListResponse getWorkforcemanagementShifttrades(GetWorkforcemanagementShifttradesRequest request) throws IOException, ApiException
      Deprecated.
      Gets all of my shift trades Deprecated. Use new route instead (/shifttrading/trades/mine/query/jobs)
      Parameters:
      request - The request object
      Returns:
      ShiftTradeListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttrades

      public ApiResponse<ShiftTradeListResponse> getWorkforcemanagementShifttrades(ApiRequest<Void> request) throws IOException
      Deprecated.
      Gets all of my shift trades Deprecated. Use new route instead (/shifttrading/trades/mine/query/jobs)
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttradingTradeJob

      public ShiftTradeUpdateTradeJobResponse getWorkforcemanagementShifttradingTradeJob(String tradeId, String jobId) throws IOException, ApiException
      View result of update trade operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      tradeId - The ID of the shift trade to update (required)
      jobId - The ID of the job (required)
      Returns:
      ShiftTradeUpdateTradeJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttradingTradeJobWithHttpInfo

      public ApiResponse<ShiftTradeUpdateTradeJobResponse> getWorkforcemanagementShifttradingTradeJobWithHttpInfo(String tradeId, String jobId) throws IOException
      View result of update trade operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      tradeId - The ID of the shift trade to update (required)
      jobId - The ID of the job (required)
      Returns:
      ShiftTradeUpdateTradeJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttradingTradeJob

      public ShiftTradeUpdateTradeJobResponse getWorkforcemanagementShifttradingTradeJob(GetWorkforcemanagementShifttradingTradeJobRequest request) throws IOException, ApiException
      View result of update trade operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      ShiftTradeUpdateTradeJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttradingTradeJob

      public ApiResponse<ShiftTradeUpdateTradeJobResponse> getWorkforcemanagementShifttradingTradeJob(ApiRequest<Void> request) throws IOException
      View result of update trade operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttradingTradeMatchJob

      public ShiftTradeMatchTradeJobResponse getWorkforcemanagementShifttradingTradeMatchJob(String tradeId, String jobId) throws IOException, ApiException
      View result of match shift trade operation. Only the receiving user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      tradeId - The ID of the shift trade to update (required)
      jobId - The ID of the job (required)
      Returns:
      ShiftTradeMatchTradeJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttradingTradeMatchJobWithHttpInfo

      public ApiResponse<ShiftTradeMatchTradeJobResponse> getWorkforcemanagementShifttradingTradeMatchJobWithHttpInfo(String tradeId, String jobId) throws IOException
      View result of match shift trade operation. Only the receiving user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      tradeId - The ID of the shift trade to update (required)
      jobId - The ID of the job (required)
      Returns:
      ShiftTradeMatchTradeJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttradingTradeMatchJob

      public ShiftTradeMatchTradeJobResponse getWorkforcemanagementShifttradingTradeMatchJob(GetWorkforcemanagementShifttradingTradeMatchJobRequest request) throws IOException, ApiException
      View result of match shift trade operation. Only the receiving user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      ShiftTradeMatchTradeJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttradingTradeMatchJob

      public ApiResponse<ShiftTradeMatchTradeJobResponse> getWorkforcemanagementShifttradingTradeMatchJob(ApiRequest<Void> request) throws IOException
      View result of match shift trade operation. Only the receiving user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttradingTradeStateJob

      public ShiftTradeUpdateTradeStateJobResponse getWorkforcemanagementShifttradingTradeStateJob(String tradeId, String jobId) throws IOException, ApiException
      View result of update trade state operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      tradeId - The ID of the shift trade to update (required)
      jobId - The ID of the job (required)
      Returns:
      ShiftTradeUpdateTradeStateJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttradingTradeStateJobWithHttpInfo

      public ApiResponse<ShiftTradeUpdateTradeStateJobResponse> getWorkforcemanagementShifttradingTradeStateJobWithHttpInfo(String tradeId, String jobId) throws IOException
      View result of update trade state operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      tradeId - The ID of the shift trade to update (required)
      jobId - The ID of the job (required)
      Returns:
      ShiftTradeUpdateTradeStateJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttradingTradeStateJob

      public ShiftTradeUpdateTradeStateJobResponse getWorkforcemanagementShifttradingTradeStateJob(GetWorkforcemanagementShifttradingTradeStateJobRequest request) throws IOException, ApiException
      View result of update trade state operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      ShiftTradeUpdateTradeStateJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttradingTradeStateJob

      public ApiResponse<ShiftTradeUpdateTradeStateJobResponse> getWorkforcemanagementShifttradingTradeStateJob(ApiRequest<Void> request) throws IOException
      View result of update trade state operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttradingTradesJob

      public ShiftTradeAddTradeJobResponse getWorkforcemanagementShifttradingTradesJob(String jobId) throws IOException, ApiException
      View result of create trade operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      jobId - The ID of the job (required)
      Returns:
      ShiftTradeAddTradeJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttradingTradesJobWithHttpInfo

      public ApiResponse<ShiftTradeAddTradeJobResponse> getWorkforcemanagementShifttradingTradesJobWithHttpInfo(String jobId) throws IOException
      View result of create trade operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      jobId - The ID of the job (required)
      Returns:
      ShiftTradeAddTradeJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttradingTradesJob

      public ShiftTradeAddTradeJobResponse getWorkforcemanagementShifttradingTradesJob(GetWorkforcemanagementShifttradingTradesJobRequest request) throws IOException, ApiException
      View result of create trade operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      ShiftTradeAddTradeJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttradingTradesJob

      public ApiResponse<ShiftTradeAddTradeJobResponse> getWorkforcemanagementShifttradingTradesJob(ApiRequest<Void> request) throws IOException
      View result of create trade operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttradingTradesMineQueryJob

      public ShiftTradeQueryAgentTradesJobResponse getWorkforcemanagementShifttradingTradesMineQueryJob(String jobId) throws IOException, ApiException
      View results of retrieve all my shift trade operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      jobId - The ID of the job (required)
      Returns:
      ShiftTradeQueryAgentTradesJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttradingTradesMineQueryJobWithHttpInfo

      public ApiResponse<ShiftTradeQueryAgentTradesJobResponse> getWorkforcemanagementShifttradingTradesMineQueryJobWithHttpInfo(String jobId) throws IOException
      View results of retrieve all my shift trade operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      jobId - The ID of the job (required)
      Returns:
      ShiftTradeQueryAgentTradesJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttradingTradesMineQueryJob

      public ShiftTradeQueryAgentTradesJobResponse getWorkforcemanagementShifttradingTradesMineQueryJob(GetWorkforcemanagementShifttradingTradesMineQueryJobRequest request) throws IOException, ApiException
      View results of retrieve all my shift trade operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      ShiftTradeQueryAgentTradesJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementShifttradingTradesMineQueryJob

      public ApiResponse<ShiftTradeQueryAgentTradesJobResponse> getWorkforcemanagementShifttradingTradesMineQueryJob(ApiRequest<Void> request) throws IOException
      View results of retrieve all my shift trade operation. Only the user who started the operation can query the status Job details are only retained if the initial request returned a 202 ACCEPTED response
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementShrinkageJob

      public WfmHistoricalShrinkageResponse getWorkforcemanagementShrinkageJob(String jobId) throws IOException, ApiException
      Request to fetch the status of the historical shrinkage query
      Parameters:
      jobId - jobId (required)
      Returns:
      WfmHistoricalShrinkageResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementShrinkageJobWithHttpInfo

      public ApiResponse<WfmHistoricalShrinkageResponse> getWorkforcemanagementShrinkageJobWithHttpInfo(String jobId) throws IOException
      Request to fetch the status of the historical shrinkage query
      Parameters:
      jobId - jobId (required)
      Returns:
      WfmHistoricalShrinkageResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementShrinkageJob

      public WfmHistoricalShrinkageResponse getWorkforcemanagementShrinkageJob(GetWorkforcemanagementShrinkageJobRequest request) throws IOException, ApiException
      Request to fetch the status of the historical shrinkage query
      Parameters:
      request - The request object
      Returns:
      WfmHistoricalShrinkageResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementShrinkageJob

      public ApiResponse<WfmHistoricalShrinkageResponse> getWorkforcemanagementShrinkageJob(ApiRequest<Void> request) throws IOException
      Request to fetch the status of the historical shrinkage query
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementTeamAdherence

      public UserScheduleAdherenceListing getWorkforcemanagementTeamAdherence(String teamId) throws IOException, ApiException
      Get a list of user schedule adherence records for the requested team
      Parameters:
      teamId - The ID of the team (required)
      Returns:
      UserScheduleAdherenceListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementTeamAdherenceWithHttpInfo

      public ApiResponse<UserScheduleAdherenceListing> getWorkforcemanagementTeamAdherenceWithHttpInfo(String teamId) throws IOException
      Get a list of user schedule adherence records for the requested team
      Parameters:
      teamId - The ID of the team (required)
      Returns:
      UserScheduleAdherenceListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementTeamAdherence

      public UserScheduleAdherenceListing getWorkforcemanagementTeamAdherence(GetWorkforcemanagementTeamAdherenceRequest request) throws IOException, ApiException
      Get a list of user schedule adherence records for the requested team
      Parameters:
      request - The request object
      Returns:
      UserScheduleAdherenceListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementTeamAdherence

      public ApiResponse<UserScheduleAdherenceListing> getWorkforcemanagementTeamAdherence(ApiRequest<Void> request) throws IOException
      Get a list of user schedule adherence records for the requested team
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementTimeoffbalanceJob

      public TimeOffBalanceJobResponse getWorkforcemanagementTimeoffbalanceJob(String jobId) throws IOException, ApiException
      Query the results of time off types job
      Parameters:
      jobId - The ID of the job. (required)
      Returns:
      TimeOffBalanceJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementTimeoffbalanceJobWithHttpInfo

      public ApiResponse<TimeOffBalanceJobResponse> getWorkforcemanagementTimeoffbalanceJobWithHttpInfo(String jobId) throws IOException
      Query the results of time off types job
      Parameters:
      jobId - The ID of the job. (required)
      Returns:
      TimeOffBalanceJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementTimeoffbalanceJob

      public TimeOffBalanceJobResponse getWorkforcemanagementTimeoffbalanceJob(GetWorkforcemanagementTimeoffbalanceJobRequest request) throws IOException, ApiException
      Query the results of time off types job
      Parameters:
      request - The request object
      Returns:
      TimeOffBalanceJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementTimeoffbalanceJob

      public ApiResponse<TimeOffBalanceJobResponse> getWorkforcemanagementTimeoffbalanceJob(ApiRequest<Void> request) throws IOException
      Query the results of time off types job
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementTimeoffrequest

      public TimeOffRequestResponse getWorkforcemanagementTimeoffrequest(String timeOffRequestId) throws IOException, ApiException
      Get a time off request for the current user
      Parameters:
      timeOffRequestId - The ID of the time off request (required)
      Returns:
      TimeOffRequestResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementTimeoffrequestWithHttpInfo

      public ApiResponse<TimeOffRequestResponse> getWorkforcemanagementTimeoffrequestWithHttpInfo(String timeOffRequestId) throws IOException
      Get a time off request for the current user
      Parameters:
      timeOffRequestId - The ID of the time off request (required)
      Returns:
      TimeOffRequestResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementTimeoffrequest

      public TimeOffRequestResponse getWorkforcemanagementTimeoffrequest(GetWorkforcemanagementTimeoffrequestRequest request) throws IOException, ApiException
      Get a time off request for the current user
      Parameters:
      request - The request object
      Returns:
      TimeOffRequestResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementTimeoffrequest

      public ApiResponse<TimeOffRequestResponse> getWorkforcemanagementTimeoffrequest(ApiRequest<Void> request) throws IOException
      Get a time off request for the current user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementTimeoffrequestWaitlistpositions

      public WaitlistPositionListing getWorkforcemanagementTimeoffrequestWaitlistpositions(String timeOffRequestId) throws IOException, ApiException
      Get the daily waitlist positions of a time off request for the current user
      Parameters:
      timeOffRequestId - The ID of the time off request (required)
      Returns:
      WaitlistPositionListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementTimeoffrequestWaitlistpositionsWithHttpInfo

      public ApiResponse<WaitlistPositionListing> getWorkforcemanagementTimeoffrequestWaitlistpositionsWithHttpInfo(String timeOffRequestId) throws IOException
      Get the daily waitlist positions of a time off request for the current user
      Parameters:
      timeOffRequestId - The ID of the time off request (required)
      Returns:
      WaitlistPositionListing
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementTimeoffrequestWaitlistpositions

      public WaitlistPositionListing getWorkforcemanagementTimeoffrequestWaitlistpositions(GetWorkforcemanagementTimeoffrequestWaitlistpositionsRequest request) throws IOException, ApiException
      Get the daily waitlist positions of a time off request for the current user
      Parameters:
      request - The request object
      Returns:
      WaitlistPositionListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementTimeoffrequestWaitlistpositions

      public ApiResponse<WaitlistPositionListing> getWorkforcemanagementTimeoffrequestWaitlistpositions(ApiRequest<Void> request) throws IOException
      Get the daily waitlist positions of a time off request for the current user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementTimeoffrequests

      public TimeOffRequestList getWorkforcemanagementTimeoffrequests() throws IOException, ApiException
      Get a list of time off requests for the current user
      Returns:
      TimeOffRequestList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementTimeoffrequestsWithHttpInfo

      public ApiResponse<TimeOffRequestList> getWorkforcemanagementTimeoffrequestsWithHttpInfo() throws IOException
      Get a list of time off requests for the current user
      Returns:
      TimeOffRequestList
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementTimeoffrequests

      public TimeOffRequestList getWorkforcemanagementTimeoffrequests(GetWorkforcemanagementTimeoffrequestsRequest request) throws IOException, ApiException
      Get a list of time off requests for the current user
      Parameters:
      request - The request object
      Returns:
      TimeOffRequestList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementTimeoffrequests

      public ApiResponse<TimeOffRequestList> getWorkforcemanagementTimeoffrequests(ApiRequest<Void> request) throws IOException
      Get a list of time off requests for the current user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementUnavailabletimesSettings

      public ManagementUnitAvailabilitySettingsResponse getWorkforcemanagementUnavailabletimesSettings() throws IOException, ApiException
      Get availability management unit's settings for agent
      Returns:
      ManagementUnitAvailabilitySettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementUnavailabletimesSettingsWithHttpInfo

      public ApiResponse<ManagementUnitAvailabilitySettingsResponse> getWorkforcemanagementUnavailabletimesSettingsWithHttpInfo() throws IOException
      Get availability management unit's settings for agent
      Returns:
      ManagementUnitAvailabilitySettingsResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementUnavailabletimesSettings

      public ManagementUnitAvailabilitySettingsResponse getWorkforcemanagementUnavailabletimesSettings(GetWorkforcemanagementUnavailabletimesSettingsRequest request) throws IOException, ApiException
      Get availability management unit's settings for agent
      Parameters:
      request - The request object
      Returns:
      ManagementUnitAvailabilitySettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementUnavailabletimesSettings

      public ApiResponse<ManagementUnitAvailabilitySettingsResponse> getWorkforcemanagementUnavailabletimesSettings(ApiRequest<Void> request) throws IOException
      Get availability management unit's settings for agent
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementUnavailabletimesValidationJob

      public QueryAgentUnavailableTimesValidationJobResponse getWorkforcemanagementUnavailabletimesValidationJob(String jobId) throws IOException, ApiException
      Query agent unavailable times validation job
      Parameters:
      jobId - The ID of the job (required)
      Returns:
      QueryAgentUnavailableTimesValidationJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementUnavailabletimesValidationJobWithHttpInfo

      public ApiResponse<QueryAgentUnavailableTimesValidationJobResponse> getWorkforcemanagementUnavailabletimesValidationJobWithHttpInfo(String jobId) throws IOException
      Query agent unavailable times validation job
      Parameters:
      jobId - The ID of the job (required)
      Returns:
      QueryAgentUnavailableTimesValidationJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementUnavailabletimesValidationJob

      public QueryAgentUnavailableTimesValidationJobResponse getWorkforcemanagementUnavailabletimesValidationJob(GetWorkforcemanagementUnavailabletimesValidationJobRequest request) throws IOException, ApiException
      Query agent unavailable times validation job
      Parameters:
      request - The request object
      Returns:
      QueryAgentUnavailableTimesValidationJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementUnavailabletimesValidationJob

      public ApiResponse<QueryAgentUnavailableTimesValidationJobResponse> getWorkforcemanagementUnavailabletimesValidationJob(ApiRequest<Void> request) throws IOException
      Query agent unavailable times validation job
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementUserWorkplanbidranks

      public WorkPlanBidRanks getWorkforcemanagementUserWorkplanbidranks(String userId) throws IOException, ApiException
      Get work plan bid ranks for a user
      Parameters:
      userId - The userId to whom the work plan bid ranks apply. (required)
      Returns:
      WorkPlanBidRanks
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementUserWorkplanbidranksWithHttpInfo

      public ApiResponse<WorkPlanBidRanks> getWorkforcemanagementUserWorkplanbidranksWithHttpInfo(String userId) throws IOException
      Get work plan bid ranks for a user
      Parameters:
      userId - The userId to whom the work plan bid ranks apply. (required)
      Returns:
      WorkPlanBidRanks
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementUserWorkplanbidranks

      public WorkPlanBidRanks getWorkforcemanagementUserWorkplanbidranks(GetWorkforcemanagementUserWorkplanbidranksRequest request) throws IOException, ApiException
      Get work plan bid ranks for a user
      Parameters:
      request - The request object
      Returns:
      WorkPlanBidRanks
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementUserWorkplanbidranks

      public ApiResponse<WorkPlanBidRanks> getWorkforcemanagementUserWorkplanbidranks(ApiRequest<Void> request) throws IOException
      Get work plan bid ranks for a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementWorkplanbidPreferences

      public AgentWorkPlanBiddingPreferenceResponse getWorkforcemanagementWorkplanbidPreferences(String bidId) throws IOException, ApiException
      Gets an agent's work plan bidding preference
      Parameters:
      bidId - The ID of the work plan bid (required)
      Returns:
      AgentWorkPlanBiddingPreferenceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementWorkplanbidPreferencesWithHttpInfo

      public ApiResponse<AgentWorkPlanBiddingPreferenceResponse> getWorkforcemanagementWorkplanbidPreferencesWithHttpInfo(String bidId) throws IOException
      Gets an agent's work plan bidding preference
      Parameters:
      bidId - The ID of the work plan bid (required)
      Returns:
      AgentWorkPlanBiddingPreferenceResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementWorkplanbidPreferences

      public AgentWorkPlanBiddingPreferenceResponse getWorkforcemanagementWorkplanbidPreferences(GetWorkforcemanagementWorkplanbidPreferencesRequest request) throws IOException, ApiException
      Gets an agent's work plan bidding preference
      Parameters:
      request - The request object
      Returns:
      AgentWorkPlanBiddingPreferenceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementWorkplanbidPreferences

      public ApiResponse<AgentWorkPlanBiddingPreferenceResponse> getWorkforcemanagementWorkplanbidPreferences(ApiRequest<Void> request) throws IOException
      Gets an agent's work plan bidding preference
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementWorkplanbidWorkplans

      public AgentWorkPlanListResponse getWorkforcemanagementWorkplanbidWorkplans(String bidId) throws IOException, ApiException
      Gets an agent's work plans for a bid
      Parameters:
      bidId - The ID of the work plan bid (required)
      Returns:
      AgentWorkPlanListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementWorkplanbidWorkplansWithHttpInfo

      public ApiResponse<AgentWorkPlanListResponse> getWorkforcemanagementWorkplanbidWorkplansWithHttpInfo(String bidId) throws IOException
      Gets an agent's work plans for a bid
      Parameters:
      bidId - The ID of the work plan bid (required)
      Returns:
      AgentWorkPlanListResponse
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementWorkplanbidWorkplans

      public AgentWorkPlanListResponse getWorkforcemanagementWorkplanbidWorkplans(GetWorkforcemanagementWorkplanbidWorkplansRequest request) throws IOException, ApiException
      Gets an agent's work plans for a bid
      Parameters:
      request - The request object
      Returns:
      AgentWorkPlanListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementWorkplanbidWorkplans

      public ApiResponse<AgentWorkPlanListResponse> getWorkforcemanagementWorkplanbidWorkplans(ApiRequest<Void> request) throws IOException
      Gets an agent's work plans for a bid
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementWorkplanbids

      public AgentWorkPlanBids getWorkforcemanagementWorkplanbids() throws IOException, ApiException
      Gets the list of work plan bids that belong to an agent
      Returns:
      AgentWorkPlanBids
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementWorkplanbidsWithHttpInfo

      public ApiResponse<AgentWorkPlanBids> getWorkforcemanagementWorkplanbidsWithHttpInfo() throws IOException
      Gets the list of work plan bids that belong to an agent
      Returns:
      AgentWorkPlanBids
      Throws:
      IOException - if the request fails to be processed

    • getWorkforcemanagementWorkplanbids

      public AgentWorkPlanBids getWorkforcemanagementWorkplanbids(GetWorkforcemanagementWorkplanbidsRequest request) throws IOException, ApiException
      Gets the list of work plan bids that belong to an agent
      Parameters:
      request - The request object
      Returns:
      AgentWorkPlanBids
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getWorkforcemanagementWorkplanbids

      public ApiResponse<AgentWorkPlanBids> getWorkforcemanagementWorkplanbids(ApiRequest<Void> request) throws IOException
      Gets the list of work plan bids that belong to an agent
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementAgentAdherenceExplanation

      public AdherenceExplanationAsyncResponse patchWorkforcemanagementAgentAdherenceExplanation(String agentId, String explanationId, UpdateAdherenceExplanationStatusRequest body) throws IOException, ApiException
      Update an adherence explanation
      Parameters:
      agentId - The ID of the agent to query (required)
      explanationId - The ID of the explanation to update (required)
      body - The request body (required)
      Returns:
      AdherenceExplanationAsyncResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementAgentAdherenceExplanationWithHttpInfo

      public ApiResponse<AdherenceExplanationAsyncResponse> patchWorkforcemanagementAgentAdherenceExplanationWithHttpInfo(String agentId, String explanationId, UpdateAdherenceExplanationStatusRequest body) throws IOException
      Update an adherence explanation
      Parameters:
      agentId - The ID of the agent to query (required)
      explanationId - The ID of the explanation to update (required)
      body - The request body (required)
      Returns:
      AdherenceExplanationAsyncResponse
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementAgentAdherenceExplanation

      public AdherenceExplanationAsyncResponse patchWorkforcemanagementAgentAdherenceExplanation(PatchWorkforcemanagementAgentAdherenceExplanationRequest request) throws IOException, ApiException
      Update an adherence explanation
      Parameters:
      request - The request object
      Returns:
      AdherenceExplanationAsyncResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementAgentAdherenceExplanation

      public ApiResponse<AdherenceExplanationAsyncResponse> patchWorkforcemanagementAgentAdherenceExplanation(ApiRequest<UpdateAdherenceExplanationStatusRequest> request) throws IOException
      Update an adherence explanation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementAlternativeshiftsTrade

      public AlternativeShiftTradeResponse patchWorkforcemanagementAlternativeshiftsTrade(String tradeId, AgentUpdateAlternativeShiftTradeRequest body) throws IOException, ApiException
      Update my alternative shifts trade by trade ID
      Parameters:
      tradeId - The ID of the alternative shift trade (required)
      body - body (required)
      Returns:
      AlternativeShiftTradeResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementAlternativeshiftsTradeWithHttpInfo

      public ApiResponse<AlternativeShiftTradeResponse> patchWorkforcemanagementAlternativeshiftsTradeWithHttpInfo(String tradeId, AgentUpdateAlternativeShiftTradeRequest body) throws IOException
      Update my alternative shifts trade by trade ID
      Parameters:
      tradeId - The ID of the alternative shift trade (required)
      body - body (required)
      Returns:
      AlternativeShiftTradeResponse
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementAlternativeshiftsTrade

      public AlternativeShiftTradeResponse patchWorkforcemanagementAlternativeshiftsTrade(PatchWorkforcemanagementAlternativeshiftsTradeRequest request) throws IOException, ApiException
      Update my alternative shifts trade by trade ID
      Parameters:
      request - The request object
      Returns:
      AlternativeShiftTradeResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementAlternativeshiftsTrade

      public ApiResponse<AlternativeShiftTradeResponse> patchWorkforcemanagementAlternativeshiftsTrade(ApiRequest<AgentUpdateAlternativeShiftTradeRequest> request) throws IOException
      Update my alternative shifts trade by trade ID
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementAlternativeshiftsTradesStateJobs

      public AlternativeShiftAsyncResponse patchWorkforcemanagementAlternativeshiftsTradesStateJobs(AdminBulkUpdateAlternativeShiftTradeStateRequest body) throws IOException, ApiException
      Bulk update alternative shift trade states
      Parameters:
      body - The request body (required)
      Returns:
      AlternativeShiftAsyncResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementAlternativeshiftsTradesStateJobsWithHttpInfo

      public ApiResponse<AlternativeShiftAsyncResponse> patchWorkforcemanagementAlternativeshiftsTradesStateJobsWithHttpInfo(AdminBulkUpdateAlternativeShiftTradeStateRequest body) throws IOException
      Bulk update alternative shift trade states
      Parameters:
      body - The request body (required)
      Returns:
      AlternativeShiftAsyncResponse
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementAlternativeshiftsTradesStateJobs

      public AlternativeShiftAsyncResponse patchWorkforcemanagementAlternativeshiftsTradesStateJobs(PatchWorkforcemanagementAlternativeshiftsTradesStateJobsRequest request) throws IOException, ApiException
      Bulk update alternative shift trade states
      Parameters:
      request - The request object
      Returns:
      AlternativeShiftAsyncResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementAlternativeshiftsTradesStateJobs

      public ApiResponse<AlternativeShiftAsyncResponse> patchWorkforcemanagementAlternativeshiftsTradesStateJobs(ApiRequest<AdminBulkUpdateAlternativeShiftTradeStateRequest> request) throws IOException
      Bulk update alternative shift trade states
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunit

      public BusinessUnitResponse patchWorkforcemanagementBusinessunit(String businessUnitId, UpdateBusinessUnitRequest body, Boolean includeSchedulingDefaultMessageSeverities) throws IOException, ApiException
      Update business unit
      Parameters:
      businessUnitId - The ID of the business unit, or 'mine' for the business unit of the logged-in user. (required)
      body - body (required)
      includeSchedulingDefaultMessageSeverities - Whether to include scheduling default message severities (optional)
      Returns:
      BusinessUnitResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitWithHttpInfo

      public ApiResponse<BusinessUnitResponse> patchWorkforcemanagementBusinessunitWithHttpInfo(String businessUnitId, UpdateBusinessUnitRequest body, Boolean includeSchedulingDefaultMessageSeverities) throws IOException
      Update business unit
      Parameters:
      businessUnitId - The ID of the business unit, or 'mine' for the business unit of the logged-in user. (required)
      body - body (required)
      includeSchedulingDefaultMessageSeverities - Whether to include scheduling default message severities (optional)
      Returns:
      BusinessUnitResponse
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunit

      public BusinessUnitResponse patchWorkforcemanagementBusinessunit(PatchWorkforcemanagementBusinessunitRequest request) throws IOException, ApiException
      Update business unit
      Parameters:
      request - The request object
      Returns:
      BusinessUnitResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunit

      public ApiResponse<BusinessUnitResponse> patchWorkforcemanagementBusinessunit(ApiRequest<UpdateBusinessUnitRequest> request) throws IOException
      Update business unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitActivitycode

      public BusinessUnitActivityCode patchWorkforcemanagementBusinessunitActivitycode(String businessUnitId, String activityCodeId, UpdateActivityCodeRequest body) throws IOException, ApiException
      Update an activity code
      Parameters:
      businessUnitId - The ID of the business unit, or 'mine' for the business unit of the logged-in user. (required)
      activityCodeId - The ID of the activity code to update (required)
      body - body (required)
      Returns:
      BusinessUnitActivityCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitActivitycodeWithHttpInfo

      public ApiResponse<BusinessUnitActivityCode> patchWorkforcemanagementBusinessunitActivitycodeWithHttpInfo(String businessUnitId, String activityCodeId, UpdateActivityCodeRequest body) throws IOException
      Update an activity code
      Parameters:
      businessUnitId - The ID of the business unit, or 'mine' for the business unit of the logged-in user. (required)
      activityCodeId - The ID of the activity code to update (required)
      body - body (required)
      Returns:
      BusinessUnitActivityCode
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitActivitycode

      public BusinessUnitActivityCode patchWorkforcemanagementBusinessunitActivitycode(PatchWorkforcemanagementBusinessunitActivitycodeRequest request) throws IOException, ApiException
      Update an activity code
      Parameters:
      request - The request object
      Returns:
      BusinessUnitActivityCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitActivitycode

      public ApiResponse<BusinessUnitActivityCode> patchWorkforcemanagementBusinessunitActivitycode(ApiRequest<UpdateActivityCodeRequest> request) throws IOException
      Update an activity code
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitActivityplan

      public ActivityPlanResponse patchWorkforcemanagementBusinessunitActivityplan(String businessUnitId, String activityPlanId, UpdateActivityPlanRequest body) throws IOException, ApiException
      Update an activity plan If a job associated with the activity plan is in 'Processing' state the activity plan cannot be updated
      Parameters:
      businessUnitId - The ID of the business unit (required)
      activityPlanId - The ID of the activity plan to update (required)
      body - body (required)
      Returns:
      ActivityPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitActivityplanWithHttpInfo

      public ApiResponse<ActivityPlanResponse> patchWorkforcemanagementBusinessunitActivityplanWithHttpInfo(String businessUnitId, String activityPlanId, UpdateActivityPlanRequest body) throws IOException
      Update an activity plan If a job associated with the activity plan is in 'Processing' state the activity plan cannot be updated
      Parameters:
      businessUnitId - The ID of the business unit (required)
      activityPlanId - The ID of the activity plan to update (required)
      body - body (required)
      Returns:
      ActivityPlanResponse
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitActivityplan

      public ActivityPlanResponse patchWorkforcemanagementBusinessunitActivityplan(PatchWorkforcemanagementBusinessunitActivityplanRequest request) throws IOException, ApiException
      Update an activity plan If a job associated with the activity plan is in 'Processing' state the activity plan cannot be updated
      Parameters:
      request - The request object
      Returns:
      ActivityPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitActivityplan

      public ApiResponse<ActivityPlanResponse> patchWorkforcemanagementBusinessunitActivityplan(ApiRequest<UpdateActivityPlanRequest> request) throws IOException
      Update an activity plan If a job associated with the activity plan is in 'Processing' state the activity plan cannot be updated
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitAlternativeshiftsSettings

      public AlternativeShiftBuSettingsResponse patchWorkforcemanagementBusinessunitAlternativeshiftsSettings(String businessUnitId, UpdateAlternativeShiftBuSettingsRequest body) throws IOException, ApiException
      Update alternative shifts settings for a business unit
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      AlternativeShiftBuSettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitAlternativeshiftsSettingsWithHttpInfo

      public ApiResponse<AlternativeShiftBuSettingsResponse> patchWorkforcemanagementBusinessunitAlternativeshiftsSettingsWithHttpInfo(String businessUnitId, UpdateAlternativeShiftBuSettingsRequest body) throws IOException
      Update alternative shifts settings for a business unit
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      AlternativeShiftBuSettingsResponse
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitAlternativeshiftsSettings

      public AlternativeShiftBuSettingsResponse patchWorkforcemanagementBusinessunitAlternativeshiftsSettings(PatchWorkforcemanagementBusinessunitAlternativeshiftsSettingsRequest request) throws IOException, ApiException
      Update alternative shifts settings for a business unit
      Parameters:
      request - The request object
      Returns:
      AlternativeShiftBuSettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitAlternativeshiftsSettings

      public ApiResponse<AlternativeShiftBuSettingsResponse> patchWorkforcemanagementBusinessunitAlternativeshiftsSettings(ApiRequest<UpdateAlternativeShiftBuSettingsRequest> request) throws IOException
      Update alternative shifts settings for a business unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitCapacityplan

      public CapacityPlanResponse patchWorkforcemanagementBusinessunitCapacityplan(String businessUnitId, String capacityPlanId, UpdateCapacityPlanRequest body) throws IOException, ApiException
      Update a capacity plan configuration
      Parameters:
      businessUnitId - The ID of the business unit (required)
      capacityPlanId - The ID of the capacity plan (required)
      body - body (required)
      Returns:
      CapacityPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitCapacityplanWithHttpInfo

      public ApiResponse<CapacityPlanResponse> patchWorkforcemanagementBusinessunitCapacityplanWithHttpInfo(String businessUnitId, String capacityPlanId, UpdateCapacityPlanRequest body) throws IOException
      Update a capacity plan configuration
      Parameters:
      businessUnitId - The ID of the business unit (required)
      capacityPlanId - The ID of the capacity plan (required)
      body - body (required)
      Returns:
      CapacityPlanResponse
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitCapacityplan

      public CapacityPlanResponse patchWorkforcemanagementBusinessunitCapacityplan(PatchWorkforcemanagementBusinessunitCapacityplanRequest request) throws IOException, ApiException
      Update a capacity plan configuration
      Parameters:
      request - The request object
      Returns:
      CapacityPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitCapacityplan

      public ApiResponse<CapacityPlanResponse> patchWorkforcemanagementBusinessunitCapacityplan(ApiRequest<UpdateCapacityPlanRequest> request) throws IOException
      Update a capacity plan configuration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitMinimumstaffingSettings

      public MinimumStaffingResponse patchWorkforcemanagementBusinessunitMinimumstaffingSettings(String businessUnitId, MinimumStaffingRequest body) throws IOException, ApiException
      Update minimum staffing settings for a business unit
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      MinimumStaffingResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitMinimumstaffingSettingsWithHttpInfo

      public ApiResponse<MinimumStaffingResponse> patchWorkforcemanagementBusinessunitMinimumstaffingSettingsWithHttpInfo(String businessUnitId, MinimumStaffingRequest body) throws IOException
      Update minimum staffing settings for a business unit
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      MinimumStaffingResponse
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitMinimumstaffingSettings

      public MinimumStaffingResponse patchWorkforcemanagementBusinessunitMinimumstaffingSettings(PatchWorkforcemanagementBusinessunitMinimumstaffingSettingsRequest request) throws IOException, ApiException
      Update minimum staffing settings for a business unit
      Parameters:
      request - The request object
      Returns:
      MinimumStaffingResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitMinimumstaffingSettings

      public ApiResponse<MinimumStaffingResponse> patchWorkforcemanagementBusinessunitMinimumstaffingSettings(ApiRequest<MinimumStaffingRequest> request) throws IOException
      Update minimum staffing settings for a business unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitOpportunity

      public OpportunityResult patchWorkforcemanagementBusinessunitOpportunity(String businessUnitId, String opportunityId, PatchOpportunityRequest body) throws IOException, ApiException
      Update the opportunity Only opportunities with Draft status can be updated.
      Parameters:
      businessUnitId - The ID of the business unit (required)
      opportunityId - The ID of the opportunity (required)
      body - body (required)
      Returns:
      OpportunityResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitOpportunityWithHttpInfo

      public ApiResponse<OpportunityResult> patchWorkforcemanagementBusinessunitOpportunityWithHttpInfo(String businessUnitId, String opportunityId, PatchOpportunityRequest body) throws IOException
      Update the opportunity Only opportunities with Draft status can be updated.
      Parameters:
      businessUnitId - The ID of the business unit (required)
      opportunityId - The ID of the opportunity (required)
      body - body (required)
      Returns:
      OpportunityResult
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitOpportunity

      public OpportunityResult patchWorkforcemanagementBusinessunitOpportunity(PatchWorkforcemanagementBusinessunitOpportunityRequest request) throws IOException, ApiException
      Update the opportunity Only opportunities with Draft status can be updated.
      Parameters:
      request - The request object
      Returns:
      OpportunityResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitOpportunity

      public ApiResponse<OpportunityResult> patchWorkforcemanagementBusinessunitOpportunity(ApiRequest<PatchOpportunityRequest> request) throws IOException
      Update the opportunity Only opportunities with Draft status can be updated.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitPlanninggroup

      public PlanningGroup patchWorkforcemanagementBusinessunitPlanninggroup(String businessUnitId, String planningGroupId, UpdatePlanningGroupRequest body) throws IOException, ApiException
      Updates the planning group If the request body contains queue references in route paths, routing:queue:view is required in each referenced queue's division.
      Parameters:
      businessUnitId - The ID of the business unit. (required)
      planningGroupId - The ID of a planning group to update (required)
      body - body (required)
      Returns:
      PlanningGroup
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitPlanninggroupWithHttpInfo

      public ApiResponse<PlanningGroup> patchWorkforcemanagementBusinessunitPlanninggroupWithHttpInfo(String businessUnitId, String planningGroupId, UpdatePlanningGroupRequest body) throws IOException
      Updates the planning group If the request body contains queue references in route paths, routing:queue:view is required in each referenced queue's division.
      Parameters:
      businessUnitId - The ID of the business unit. (required)
      planningGroupId - The ID of a planning group to update (required)
      body - body (required)
      Returns:
      PlanningGroup
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitPlanninggroup

      public PlanningGroup patchWorkforcemanagementBusinessunitPlanninggroup(PatchWorkforcemanagementBusinessunitPlanninggroupRequest request) throws IOException, ApiException
      Updates the planning group If the request body contains queue references in route paths, routing:queue:view is required in each referenced queue's division.
      Parameters:
      request - The request object
      Returns:
      PlanningGroup
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitPlanninggroup

      public ApiResponse<PlanningGroup> patchWorkforcemanagementBusinessunitPlanninggroup(ApiRequest<UpdatePlanningGroupRequest> request) throws IOException
      Updates the planning group If the request body contains queue references in route paths, routing:queue:view is required in each referenced queue's division.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitSchedulerSettings

      public BuSchedulerSettingsResponse patchWorkforcemanagementBusinessunitSchedulerSettings(String businessUnitId, BuSchedulerSettingsRequest body) throws IOException, ApiException
      Update scheduler settings for a business unit
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      BuSchedulerSettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitSchedulerSettingsWithHttpInfo

      public ApiResponse<BuSchedulerSettingsResponse> patchWorkforcemanagementBusinessunitSchedulerSettingsWithHttpInfo(String businessUnitId, BuSchedulerSettingsRequest body) throws IOException
      Update scheduler settings for a business unit
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      BuSchedulerSettingsResponse
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitSchedulerSettings

      public BuSchedulerSettingsResponse patchWorkforcemanagementBusinessunitSchedulerSettings(PatchWorkforcemanagementBusinessunitSchedulerSettingsRequest request) throws IOException, ApiException
      Update scheduler settings for a business unit
      Parameters:
      request - The request object
      Returns:
      BuSchedulerSettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitSchedulerSettings

      public ApiResponse<BuSchedulerSettingsResponse> patchWorkforcemanagementBusinessunitSchedulerSettings(ApiRequest<BuSchedulerSettingsRequest> request) throws IOException
      Update scheduler settings for a business unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitSchedulingRun

      public void patchWorkforcemanagementBusinessunitSchedulingRun(String businessUnitId, String runId, PatchBuScheduleRunRequest body) throws IOException, ApiException
      Mark a schedule run as applied
      Parameters:
      businessUnitId - The ID of the business unit (required)
      runId - The ID of the schedule run (required)
      body - body (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitSchedulingRunWithHttpInfo

      public ApiResponse<Void> patchWorkforcemanagementBusinessunitSchedulingRunWithHttpInfo(String businessUnitId, String runId, PatchBuScheduleRunRequest body) throws IOException
      Mark a schedule run as applied
      Parameters:
      businessUnitId - The ID of the business unit (required)
      runId - The ID of the schedule run (required)
      body - body (required)
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitSchedulingRun

      public void patchWorkforcemanagementBusinessunitSchedulingRun(PatchWorkforcemanagementBusinessunitSchedulingRunRequest request) throws IOException, ApiException
      Mark a schedule run as applied
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitSchedulingRun

      public ApiResponse<Void> patchWorkforcemanagementBusinessunitSchedulingRun(ApiRequest<PatchBuScheduleRunRequest> request) throws IOException
      Mark a schedule run as applied
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitServicegoaltemplate

      public ServiceGoalTemplate patchWorkforcemanagementBusinessunitServicegoaltemplate(String businessUnitId, String serviceGoalTemplateId, UpdateServiceGoalTemplate body) throws IOException, ApiException
      Updates a service goal template
      Parameters:
      businessUnitId - The ID of the business unit. (required)
      serviceGoalTemplateId - The ID of a service goal template to update (required)
      body - body (required)
      Returns:
      ServiceGoalTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitServicegoaltemplateWithHttpInfo

      public ApiResponse<ServiceGoalTemplate> patchWorkforcemanagementBusinessunitServicegoaltemplateWithHttpInfo(String businessUnitId, String serviceGoalTemplateId, UpdateServiceGoalTemplate body) throws IOException
      Updates a service goal template
      Parameters:
      businessUnitId - The ID of the business unit. (required)
      serviceGoalTemplateId - The ID of a service goal template to update (required)
      body - body (required)
      Returns:
      ServiceGoalTemplate
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitServicegoaltemplate

      public ServiceGoalTemplate patchWorkforcemanagementBusinessunitServicegoaltemplate(PatchWorkforcemanagementBusinessunitServicegoaltemplateRequest request) throws IOException, ApiException
      Updates a service goal template
      Parameters:
      request - The request object
      Returns:
      ServiceGoalTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitServicegoaltemplate

      public ApiResponse<ServiceGoalTemplate> patchWorkforcemanagementBusinessunitServicegoaltemplate(ApiRequest<UpdateServiceGoalTemplate> request) throws IOException
      Updates a service goal template
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitStaffinggroup

      public StaffingGroupResponse patchWorkforcemanagementBusinessunitStaffinggroup(String businessUnitId, String staffingGroupId, UpdateStaffingGroupRequest body) throws IOException, ApiException
      Updates a staffing group
      Parameters:
      businessUnitId - The ID of the business unit (required)
      staffingGroupId - The ID of the staffing group to update (required)
      body - body (required)
      Returns:
      StaffingGroupResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitStaffinggroupWithHttpInfo

      public ApiResponse<StaffingGroupResponse> patchWorkforcemanagementBusinessunitStaffinggroupWithHttpInfo(String businessUnitId, String staffingGroupId, UpdateStaffingGroupRequest body) throws IOException
      Updates a staffing group
      Parameters:
      businessUnitId - The ID of the business unit (required)
      staffingGroupId - The ID of the staffing group to update (required)
      body - body (required)
      Returns:
      StaffingGroupResponse
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitStaffinggroup

      public StaffingGroupResponse patchWorkforcemanagementBusinessunitStaffinggroup(PatchWorkforcemanagementBusinessunitStaffinggroupRequest request) throws IOException, ApiException
      Updates a staffing group
      Parameters:
      request - The request object
      Returns:
      StaffingGroupResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitStaffinggroup

      public ApiResponse<StaffingGroupResponse> patchWorkforcemanagementBusinessunitStaffinggroup(ApiRequest<UpdateStaffingGroupRequest> request) throws IOException
      Updates a staffing group
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitTimeoffplan

      public BuTimeOffPlanResponse patchWorkforcemanagementBusinessunitTimeoffplan(String businessUnitId, String timeOffPlanId, BuUpdateTimeOffPlanRequest body) throws IOException, ApiException
      Updates a time-off plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      timeOffPlanId - The ID of the time-off plan to update (required)
      body - body (required)
      Returns:
      BuTimeOffPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitTimeoffplanWithHttpInfo

      public ApiResponse<BuTimeOffPlanResponse> patchWorkforcemanagementBusinessunitTimeoffplanWithHttpInfo(String businessUnitId, String timeOffPlanId, BuUpdateTimeOffPlanRequest body) throws IOException
      Updates a time-off plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      timeOffPlanId - The ID of the time-off plan to update (required)
      body - body (required)
      Returns:
      BuTimeOffPlanResponse
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitTimeoffplan

      public BuTimeOffPlanResponse patchWorkforcemanagementBusinessunitTimeoffplan(PatchWorkforcemanagementBusinessunitTimeoffplanRequest request) throws IOException, ApiException
      Updates a time-off plan
      Parameters:
      request - The request object
      Returns:
      BuTimeOffPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitTimeoffplan

      public ApiResponse<BuTimeOffPlanResponse> patchWorkforcemanagementBusinessunitTimeoffplan(ApiRequest<BuUpdateTimeOffPlanRequest> request) throws IOException
      Updates a time-off plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitWorkplanbid

      public WorkPlanBid patchWorkforcemanagementBusinessunitWorkplanbid(String businessUnitId, String bidId, UpdateWorkPlanBid body) throws IOException, ApiException
      Update work plan bid
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The id of the workplanbid (required)
      body - The work plan bid to be updated (required)
      Returns:
      WorkPlanBid
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitWorkplanbidWithHttpInfo

      public ApiResponse<WorkPlanBid> patchWorkforcemanagementBusinessunitWorkplanbidWithHttpInfo(String businessUnitId, String bidId, UpdateWorkPlanBid body) throws IOException
      Update work plan bid
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The id of the workplanbid (required)
      body - The work plan bid to be updated (required)
      Returns:
      WorkPlanBid
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitWorkplanbid

      public WorkPlanBid patchWorkforcemanagementBusinessunitWorkplanbid(PatchWorkforcemanagementBusinessunitWorkplanbidRequest request) throws IOException, ApiException
      Update work plan bid
      Parameters:
      request - The request object
      Returns:
      WorkPlanBid
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitWorkplanbid

      public ApiResponse<WorkPlanBid> patchWorkforcemanagementBusinessunitWorkplanbid(ApiRequest<UpdateWorkPlanBid> request) throws IOException
      Update work plan bid
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitWorkplanbidGroup

      public WorkPlanBidGroupResponse patchWorkforcemanagementBusinessunitWorkplanbidGroup(String businessUnitId, String bidId, String bidGroupId, WorkPlanBidGroupUpdate body) throws IOException, ApiException
      Update a bid group by bid group Id
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The work plan bid id of the bid groups (required)
      bidGroupId - Work Plan Bid Group id (required)
      body - body (required)
      Returns:
      WorkPlanBidGroupResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitWorkplanbidGroupWithHttpInfo

      public ApiResponse<WorkPlanBidGroupResponse> patchWorkforcemanagementBusinessunitWorkplanbidGroupWithHttpInfo(String businessUnitId, String bidId, String bidGroupId, WorkPlanBidGroupUpdate body) throws IOException
      Update a bid group by bid group Id
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The work plan bid id of the bid groups (required)
      bidGroupId - Work Plan Bid Group id (required)
      body - body (required)
      Returns:
      WorkPlanBidGroupResponse
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitWorkplanbidGroup

      public WorkPlanBidGroupResponse patchWorkforcemanagementBusinessunitWorkplanbidGroup(PatchWorkforcemanagementBusinessunitWorkplanbidGroupRequest request) throws IOException, ApiException
      Update a bid group by bid group Id
      Parameters:
      request - The request object
      Returns:
      WorkPlanBidGroupResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitWorkplanbidGroup

      public ApiResponse<WorkPlanBidGroupResponse> patchWorkforcemanagementBusinessunitWorkplanbidGroup(ApiRequest<WorkPlanBidGroupUpdate> request) throws IOException
      Update a bid group by bid group Id
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences

      public AdminAgentWorkPlanPreferenceResponse patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(String businessUnitId, String bidId, String bidGroupId, AgentsBidAssignedWorkPlanOverrideRequest body) throws IOException, ApiException
      Overrides the assigned work plan for the specified agents
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The work plan bid id of the bid groups (required)
      bidGroupId - The ID of the work plan bid group (required)
      body - body (required)
      Returns:
      AdminAgentWorkPlanPreferenceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferencesWithHttpInfo

      public ApiResponse<AdminAgentWorkPlanPreferenceResponse> patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferencesWithHttpInfo(String businessUnitId, String bidId, String bidGroupId, AgentsBidAssignedWorkPlanOverrideRequest body) throws IOException
      Overrides the assigned work plan for the specified agents
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The work plan bid id of the bid groups (required)
      bidGroupId - The ID of the work plan bid group (required)
      body - body (required)
      Returns:
      AdminAgentWorkPlanPreferenceResponse
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences

      public AdminAgentWorkPlanPreferenceResponse patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(PatchWorkforcemanagementBusinessunitWorkplanbidGroupPreferencesRequest request) throws IOException, ApiException
      Overrides the assigned work plan for the specified agents
      Parameters:
      request - The request object
      Returns:
      AdminAgentWorkPlanPreferenceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences

      public ApiResponse<AdminAgentWorkPlanPreferenceResponse> patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(ApiRequest<AgentsBidAssignedWorkPlanOverrideRequest> request) throws IOException
      Overrides the assigned work plan for the specified agents
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunit

      public ManagementUnit patchWorkforcemanagementManagementunit(String managementUnitId, UpdateManagementUnitRequest body) throws IOException, ApiException
      Update the requested management unit
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      Returns:
      ManagementUnit
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitWithHttpInfo

      public ApiResponse<ManagementUnit> patchWorkforcemanagementManagementunitWithHttpInfo(String managementUnitId, UpdateManagementUnitRequest body) throws IOException
      Update the requested management unit
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      Returns:
      ManagementUnit
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunit

      public ManagementUnit patchWorkforcemanagementManagementunit(PatchWorkforcemanagementManagementunitRequest request) throws IOException, ApiException
      Update the requested management unit
      Parameters:
      request - The request object
      Returns:
      ManagementUnit
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunit

      public ApiResponse<ManagementUnit> patchWorkforcemanagementManagementunit(ApiRequest<UpdateManagementUnitRequest> request) throws IOException
      Update the requested management unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitAgents

      public void patchWorkforcemanagementManagementunitAgents(String managementUnitId, UpdateMuAgentsRequest body) throws IOException, ApiException
      Update agent configurations
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitAgentsWithHttpInfo

      public ApiResponse<Void> patchWorkforcemanagementManagementunitAgentsWithHttpInfo(String managementUnitId, UpdateMuAgentsRequest body) throws IOException
      Update agent configurations
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitAgents

      public void patchWorkforcemanagementManagementunitAgents(PatchWorkforcemanagementManagementunitAgentsRequest request) throws IOException, ApiException
      Update agent configurations
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitAgents

      public ApiResponse<Void> patchWorkforcemanagementManagementunitAgents(ApiRequest<UpdateMuAgentsRequest> request) throws IOException
      Update agent configurations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitAgentsWorkplansBulk

      public UpdateMuAgentWorkPlansBatchResponse patchWorkforcemanagementManagementunitAgentsWorkplansBulk(String managementUnitId, UpdateMuAgentWorkPlansBatchRequest body) throws IOException, ApiException
      Updates agent work plan configuration
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      Returns:
      UpdateMuAgentWorkPlansBatchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitAgentsWorkplansBulkWithHttpInfo

      public ApiResponse<UpdateMuAgentWorkPlansBatchResponse> patchWorkforcemanagementManagementunitAgentsWorkplansBulkWithHttpInfo(String managementUnitId, UpdateMuAgentWorkPlansBatchRequest body) throws IOException
      Updates agent work plan configuration
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      Returns:
      UpdateMuAgentWorkPlansBatchResponse
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitAgentsWorkplansBulk

      public UpdateMuAgentWorkPlansBatchResponse patchWorkforcemanagementManagementunitAgentsWorkplansBulk(PatchWorkforcemanagementManagementunitAgentsWorkplansBulkRequest request) throws IOException, ApiException
      Updates agent work plan configuration
      Parameters:
      request - The request object
      Returns:
      UpdateMuAgentWorkPlansBatchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitAgentsWorkplansBulk

      public ApiResponse<UpdateMuAgentWorkPlansBatchResponse> patchWorkforcemanagementManagementunitAgentsWorkplansBulk(ApiRequest<UpdateMuAgentWorkPlansBatchRequest> request) throws IOException
      Updates agent work plan configuration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitTimeofflimit

      public TimeOffLimit patchWorkforcemanagementManagementunitTimeofflimit(String managementUnitId, String timeOffLimitId, UpdateTimeOffLimitRequest body) throws IOException, ApiException
      Updates a time off limit object. Updates time off limit object properties, but not daily values.
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      timeOffLimitId - The id of time off limit object to update (required)
      body - body (required)
      Returns:
      TimeOffLimit
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitTimeofflimitWithHttpInfo

      public ApiResponse<TimeOffLimit> patchWorkforcemanagementManagementunitTimeofflimitWithHttpInfo(String managementUnitId, String timeOffLimitId, UpdateTimeOffLimitRequest body) throws IOException
      Updates a time off limit object. Updates time off limit object properties, but not daily values.
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      timeOffLimitId - The id of time off limit object to update (required)
      body - body (required)
      Returns:
      TimeOffLimit
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitTimeofflimit

      public TimeOffLimit patchWorkforcemanagementManagementunitTimeofflimit(PatchWorkforcemanagementManagementunitTimeofflimitRequest request) throws IOException, ApiException
      Updates a time off limit object. Updates time off limit object properties, but not daily values.
      Parameters:
      request - The request object
      Returns:
      TimeOffLimit
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitTimeofflimit

      public ApiResponse<TimeOffLimit> patchWorkforcemanagementManagementunitTimeofflimit(ApiRequest<UpdateTimeOffLimitRequest> request) throws IOException
      Updates a time off limit object. Updates time off limit object properties, but not daily values.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitTimeoffplan

      public TimeOffPlan patchWorkforcemanagementManagementunitTimeoffplan(String managementUnitId, String timeOffPlanId, UpdateTimeOffPlanRequest body) throws IOException, ApiException
      Updates a time off plan
      Parameters:
      managementUnitId - The ID of the management unit (required)
      timeOffPlanId - The ID of the time off plan to update (required)
      body - body (required)
      Returns:
      TimeOffPlan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitTimeoffplanWithHttpInfo

      public ApiResponse<TimeOffPlan> patchWorkforcemanagementManagementunitTimeoffplanWithHttpInfo(String managementUnitId, String timeOffPlanId, UpdateTimeOffPlanRequest body) throws IOException
      Updates a time off plan
      Parameters:
      managementUnitId - The ID of the management unit (required)
      timeOffPlanId - The ID of the time off plan to update (required)
      body - body (required)
      Returns:
      TimeOffPlan
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitTimeoffplan

      public TimeOffPlan patchWorkforcemanagementManagementunitTimeoffplan(PatchWorkforcemanagementManagementunitTimeoffplanRequest request) throws IOException, ApiException
      Updates a time off plan
      Parameters:
      request - The request object
      Returns:
      TimeOffPlan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitTimeoffplan

      public ApiResponse<TimeOffPlan> patchWorkforcemanagementManagementunitTimeoffplan(ApiRequest<UpdateTimeOffPlanRequest> request) throws IOException
      Updates a time off plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus

      public UserTimeOffIntegrationStatusResponse patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(String managementUnitId, String timeOffRequestId, String userId, SetTimeOffIntegrationStatusRequest body) throws IOException, ApiException
      Set integration status for a time off request.
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      timeOffRequestId - The ID of the time off request. (required)
      userId - The ID of user to whom the time off request belongs. (required)
      body - body (required)
      Returns:
      UserTimeOffIntegrationStatusResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatusWithHttpInfo

      public ApiResponse<UserTimeOffIntegrationStatusResponse> patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatusWithHttpInfo(String managementUnitId, String timeOffRequestId, String userId, SetTimeOffIntegrationStatusRequest body) throws IOException
      Set integration status for a time off request.
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      timeOffRequestId - The ID of the time off request. (required)
      userId - The ID of user to whom the time off request belongs. (required)
      body - body (required)
      Returns:
      UserTimeOffIntegrationStatusResponse
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus

      public UserTimeOffIntegrationStatusResponse patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(PatchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatusRequest request) throws IOException, ApiException
      Set integration status for a time off request.
      Parameters:
      request - The request object
      Returns:
      UserTimeOffIntegrationStatusResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus

      public ApiResponse<UserTimeOffIntegrationStatusResponse> patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(ApiRequest<SetTimeOffIntegrationStatusRequest> request) throws IOException
      Set integration status for a time off request.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitUnavailabletimesSettings

      public ManagementUnitAvailabilitySettingsResponse patchWorkforcemanagementManagementunitUnavailabletimesSettings(String managementUnitId, UpdateManagementUnitsSettingsRequest body) throws IOException, ApiException
      Update management unit availability settings
      Parameters:
      managementUnitId - The ID of the management unit (required)
      body - body (required)
      Returns:
      ManagementUnitAvailabilitySettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitUnavailabletimesSettingsWithHttpInfo

      public ApiResponse<ManagementUnitAvailabilitySettingsResponse> patchWorkforcemanagementManagementunitUnavailabletimesSettingsWithHttpInfo(String managementUnitId, UpdateManagementUnitsSettingsRequest body) throws IOException
      Update management unit availability settings
      Parameters:
      managementUnitId - The ID of the management unit (required)
      body - body (required)
      Returns:
      ManagementUnitAvailabilitySettingsResponse
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitUnavailabletimesSettings

      public ManagementUnitAvailabilitySettingsResponse patchWorkforcemanagementManagementunitUnavailabletimesSettings(PatchWorkforcemanagementManagementunitUnavailabletimesSettingsRequest request) throws IOException, ApiException
      Update management unit availability settings
      Parameters:
      request - The request object
      Returns:
      ManagementUnitAvailabilitySettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitUnavailabletimesSettings

      public ApiResponse<ManagementUnitAvailabilitySettingsResponse> patchWorkforcemanagementManagementunitUnavailabletimesSettings(ApiRequest<UpdateManagementUnitsSettingsRequest> request) throws IOException
      Update management unit availability settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitUserTimeoffrequest

      public TimeOffRequestResponse patchWorkforcemanagementManagementunitUserTimeoffrequest(String managementUnitId, String userId, String timeOffRequestId, AdminTimeOffRequestPatch body) throws IOException, ApiException
      Update a time off request
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      userId - The id of the user the requested time off request belongs to (required)
      timeOffRequestId - The id of the time off request to update (required)
      body - body (required)
      Returns:
      TimeOffRequestResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitUserTimeoffrequestWithHttpInfo

      public ApiResponse<TimeOffRequestResponse> patchWorkforcemanagementManagementunitUserTimeoffrequestWithHttpInfo(String managementUnitId, String userId, String timeOffRequestId, AdminTimeOffRequestPatch body) throws IOException
      Update a time off request
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      userId - The id of the user the requested time off request belongs to (required)
      timeOffRequestId - The id of the time off request to update (required)
      body - body (required)
      Returns:
      TimeOffRequestResponse
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitUserTimeoffrequest

      public TimeOffRequestResponse patchWorkforcemanagementManagementunitUserTimeoffrequest(PatchWorkforcemanagementManagementunitUserTimeoffrequestRequest request) throws IOException, ApiException
      Update a time off request
      Parameters:
      request - The request object
      Returns:
      TimeOffRequestResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitUserTimeoffrequest

      public ApiResponse<TimeOffRequestResponse> patchWorkforcemanagementManagementunitUserTimeoffrequest(ApiRequest<AdminTimeOffRequestPatch> request) throws IOException
      Update a time off request
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitWeekShifttrade

      public ShiftTradeResponse patchWorkforcemanagementManagementunitWeekShifttrade(String managementUnitId, LocalDate weekDateId, String tradeId, PatchShiftTradeRequest body) throws IOException, ApiException
      Deprecated.
      Updates a shift trade. This route can only be called by the initiating agent Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/jobs)
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      weekDateId - The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      tradeId - The ID of the shift trade to update (required)
      body - body (required)
      Returns:
      ShiftTradeResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitWeekShifttradeWithHttpInfo

      public ApiResponse<ShiftTradeResponse> patchWorkforcemanagementManagementunitWeekShifttradeWithHttpInfo(String managementUnitId, LocalDate weekDateId, String tradeId, PatchShiftTradeRequest body) throws IOException
      Deprecated.
      Updates a shift trade. This route can only be called by the initiating agent Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/jobs)
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      weekDateId - The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      tradeId - The ID of the shift trade to update (required)
      body - body (required)
      Returns:
      ShiftTradeResponse
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitWeekShifttrade

      public ShiftTradeResponse patchWorkforcemanagementManagementunitWeekShifttrade(PatchWorkforcemanagementManagementunitWeekShifttradeRequest request) throws IOException, ApiException
      Deprecated.
      Updates a shift trade. This route can only be called by the initiating agent Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/jobs)
      Parameters:
      request - The request object
      Returns:
      ShiftTradeResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitWeekShifttrade

      public ApiResponse<ShiftTradeResponse> patchWorkforcemanagementManagementunitWeekShifttrade(ApiRequest<PatchShiftTradeRequest> request) throws IOException
      Deprecated.
      Updates a shift trade. This route can only be called by the initiating agent Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/jobs)
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitWorkplan

      public WorkPlan patchWorkforcemanagementManagementunitWorkplan(String managementUnitId, String workPlanId, WorkPlan body, String validationMode) throws IOException, ApiException
      Update a work plan
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      workPlanId - The ID of the work plan to update (required)
      body - body (required)
      validationMode - Allows to update work plan even if validation result is invalid (optional)
      Returns:
      WorkPlan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitWorkplanWithHttpInfo

      public ApiResponse<WorkPlan> patchWorkforcemanagementManagementunitWorkplanWithHttpInfo(String managementUnitId, String workPlanId, WorkPlan body, String validationMode) throws IOException
      Update a work plan
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      workPlanId - The ID of the work plan to update (required)
      body - body (required)
      validationMode - Allows to update work plan even if validation result is invalid (optional)
      Returns:
      WorkPlan
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitWorkplan

      public WorkPlan patchWorkforcemanagementManagementunitWorkplan(PatchWorkforcemanagementManagementunitWorkplanRequest request) throws IOException, ApiException
      Update a work plan
      Parameters:
      request - The request object
      Returns:
      WorkPlan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitWorkplan

      public ApiResponse<WorkPlan> patchWorkforcemanagementManagementunitWorkplan(ApiRequest<WorkPlan> request) throws IOException
      Update a work plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitWorkplanrotation

      public WorkPlanRotationResponse patchWorkforcemanagementManagementunitWorkplanrotation(String managementUnitId, String workPlanRotationId, UpdateWorkPlanRotationRequest body) throws IOException, ApiException
      Update a work plan rotation
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      workPlanRotationId - The ID of the work plan rotation to update (required)
      body - body (required)
      Returns:
      WorkPlanRotationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitWorkplanrotationWithHttpInfo

      public ApiResponse<WorkPlanRotationResponse> patchWorkforcemanagementManagementunitWorkplanrotationWithHttpInfo(String managementUnitId, String workPlanRotationId, UpdateWorkPlanRotationRequest body) throws IOException
      Update a work plan rotation
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      workPlanRotationId - The ID of the work plan rotation to update (required)
      body - body (required)
      Returns:
      WorkPlanRotationResponse
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitWorkplanrotation

      public WorkPlanRotationResponse patchWorkforcemanagementManagementunitWorkplanrotation(PatchWorkforcemanagementManagementunitWorkplanrotationRequest request) throws IOException, ApiException
      Update a work plan rotation
      Parameters:
      request - The request object
      Returns:
      WorkPlanRotationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementManagementunitWorkplanrotation

      public ApiResponse<WorkPlanRotationResponse> patchWorkforcemanagementManagementunitWorkplanrotation(ApiRequest<UpdateWorkPlanRotationRequest> request) throws IOException
      Update a work plan rotation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementTimeoffrequest

      public TimeOffRequestResponse patchWorkforcemanagementTimeoffrequest(String timeOffRequestId, AgentTimeOffRequestPatch body) throws IOException, ApiException
      Update a time off request for the current user
      Parameters:
      timeOffRequestId - The ID of the time off request (required)
      body - body (required)
      Returns:
      TimeOffRequestResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementTimeoffrequestWithHttpInfo

      public ApiResponse<TimeOffRequestResponse> patchWorkforcemanagementTimeoffrequestWithHttpInfo(String timeOffRequestId, AgentTimeOffRequestPatch body) throws IOException
      Update a time off request for the current user
      Parameters:
      timeOffRequestId - The ID of the time off request (required)
      body - body (required)
      Returns:
      TimeOffRequestResponse
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementTimeoffrequest

      public TimeOffRequestResponse patchWorkforcemanagementTimeoffrequest(PatchWorkforcemanagementTimeoffrequestRequest request) throws IOException, ApiException
      Update a time off request for the current user
      Parameters:
      request - The request object
      Returns:
      TimeOffRequestResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementTimeoffrequest

      public ApiResponse<TimeOffRequestResponse> patchWorkforcemanagementTimeoffrequest(ApiRequest<AgentTimeOffRequestPatch> request) throws IOException
      Update a time off request for the current user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementUnavailabletimes

      public UnavailableTimeListing patchWorkforcemanagementUnavailabletimes(UpdateUnavailableTimesRequest body) throws IOException, ApiException
      Update agent unavailable times
      Parameters:
      body - body (required)
      Returns:
      UnavailableTimeListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementUnavailabletimesWithHttpInfo

      public ApiResponse<UnavailableTimeListing> patchWorkforcemanagementUnavailabletimesWithHttpInfo(UpdateUnavailableTimesRequest body) throws IOException
      Update agent unavailable times
      Parameters:
      body - body (required)
      Returns:
      UnavailableTimeListing
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementUnavailabletimes

      public UnavailableTimeListing patchWorkforcemanagementUnavailabletimes(PatchWorkforcemanagementUnavailabletimesRequest request) throws IOException, ApiException
      Update agent unavailable times
      Parameters:
      request - The request object
      Returns:
      UnavailableTimeListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementUnavailabletimes

      public ApiResponse<UnavailableTimeListing> patchWorkforcemanagementUnavailabletimes(ApiRequest<UpdateUnavailableTimesRequest> request) throws IOException
      Update agent unavailable times
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementUserWorkplanbidranks

      public WorkPlanBidRanks patchWorkforcemanagementUserWorkplanbidranks(String userId, WorkPlanBidRanks body) throws IOException, ApiException
      Update work plan bid ranks for a user
      Parameters:
      userId - The userId to whom the work plan bid ranks apply. (required)
      body - body (required)
      Returns:
      WorkPlanBidRanks
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementUserWorkplanbidranksWithHttpInfo

      public ApiResponse<WorkPlanBidRanks> patchWorkforcemanagementUserWorkplanbidranksWithHttpInfo(String userId, WorkPlanBidRanks body) throws IOException
      Update work plan bid ranks for a user
      Parameters:
      userId - The userId to whom the work plan bid ranks apply. (required)
      body - body (required)
      Returns:
      WorkPlanBidRanks
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementUserWorkplanbidranks

      public WorkPlanBidRanks patchWorkforcemanagementUserWorkplanbidranks(PatchWorkforcemanagementUserWorkplanbidranksRequest request) throws IOException, ApiException
      Update work plan bid ranks for a user
      Parameters:
      request - The request object
      Returns:
      WorkPlanBidRanks
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementUserWorkplanbidranks

      public ApiResponse<WorkPlanBidRanks> patchWorkforcemanagementUserWorkplanbidranks(ApiRequest<WorkPlanBidRanks> request) throws IOException
      Update work plan bid ranks for a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementUsersWorkplanbidranksBulk

      public EntityListing patchWorkforcemanagementUsersWorkplanbidranksBulk(List<WorkPlanBidRanks> body) throws IOException, ApiException
      Update bulk work plan bid ranks on users. Max 50 users can be updated at a time.
      Parameters:
      body - Users (required)
      Returns:
      EntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementUsersWorkplanbidranksBulkWithHttpInfo

      public ApiResponse<EntityListing> patchWorkforcemanagementUsersWorkplanbidranksBulkWithHttpInfo(List<WorkPlanBidRanks> body) throws IOException
      Update bulk work plan bid ranks on users. Max 50 users can be updated at a time.
      Parameters:
      body - Users (required)
      Returns:
      EntityListing
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementUsersWorkplanbidranksBulk

      public EntityListing patchWorkforcemanagementUsersWorkplanbidranksBulk(PatchWorkforcemanagementUsersWorkplanbidranksBulkRequest request) throws IOException, ApiException
      Update bulk work plan bid ranks on users. Max 50 users can be updated at a time.
      Parameters:
      request - The request object
      Returns:
      EntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementUsersWorkplanbidranksBulk

      public ApiResponse<EntityListing> patchWorkforcemanagementUsersWorkplanbidranksBulk(ApiRequest<List<WorkPlanBidRanks>> request) throws IOException
      Update bulk work plan bid ranks on users. Max 50 users can be updated at a time.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementWorkplanbidPreferences

      public AgentWorkPlanBiddingPreferenceResponse patchWorkforcemanagementWorkplanbidPreferences(String bidId, UpdateAgentWorkPlanBiddingPreference body) throws IOException, ApiException
      Update an agent's work plan bidding preference
      Parameters:
      bidId - The ID of the work plan bid (required)
      body - body (required)
      Returns:
      AgentWorkPlanBiddingPreferenceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementWorkplanbidPreferencesWithHttpInfo

      public ApiResponse<AgentWorkPlanBiddingPreferenceResponse> patchWorkforcemanagementWorkplanbidPreferencesWithHttpInfo(String bidId, UpdateAgentWorkPlanBiddingPreference body) throws IOException
      Update an agent's work plan bidding preference
      Parameters:
      bidId - The ID of the work plan bid (required)
      body - body (required)
      Returns:
      AgentWorkPlanBiddingPreferenceResponse
      Throws:
      IOException - if the request fails to be processed

    • patchWorkforcemanagementWorkplanbidPreferences

      public AgentWorkPlanBiddingPreferenceResponse patchWorkforcemanagementWorkplanbidPreferences(PatchWorkforcemanagementWorkplanbidPreferencesRequest request) throws IOException, ApiException
      Update an agent's work plan bidding preference
      Parameters:
      request - The request object
      Returns:
      AgentWorkPlanBiddingPreferenceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchWorkforcemanagementWorkplanbidPreferences

      public ApiResponse<AgentWorkPlanBiddingPreferenceResponse> patchWorkforcemanagementWorkplanbidPreferences(ApiRequest<UpdateAgentWorkPlanBiddingPreference> request) throws IOException
      Update an agent's work plan bidding preference
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAdherenceExplanations

      public AdherenceExplanationAsyncResponse postWorkforcemanagementAdherenceExplanations(AddAdherenceExplanationAgentRequest body) throws IOException, ApiException
      Submit an adherence explanation for the current user
      Parameters:
      body - The request body (required)
      Returns:
      AdherenceExplanationAsyncResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAdherenceExplanationsWithHttpInfo

      public ApiResponse<AdherenceExplanationAsyncResponse> postWorkforcemanagementAdherenceExplanationsWithHttpInfo(AddAdherenceExplanationAgentRequest body) throws IOException
      Submit an adherence explanation for the current user
      Parameters:
      body - The request body (required)
      Returns:
      AdherenceExplanationAsyncResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAdherenceExplanations

      public AdherenceExplanationAsyncResponse postWorkforcemanagementAdherenceExplanations(PostWorkforcemanagementAdherenceExplanationsRequest request) throws IOException, ApiException
      Submit an adherence explanation for the current user
      Parameters:
      request - The request object
      Returns:
      AdherenceExplanationAsyncResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAdherenceExplanations

      public ApiResponse<AdherenceExplanationAsyncResponse> postWorkforcemanagementAdherenceExplanations(ApiRequest<AddAdherenceExplanationAgentRequest> request) throws IOException
      Submit an adherence explanation for the current user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAdherenceExplanationsQuery

      public QueryAdherenceExplanationsResponse postWorkforcemanagementAdherenceExplanationsQuery(AgentQueryAdherenceExplanationsRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException, ApiException
      Query adherence explanations for the current user
      Parameters:
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      QueryAdherenceExplanationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAdherenceExplanationsQueryWithHttpInfo

      public ApiResponse<QueryAdherenceExplanationsResponse> postWorkforcemanagementAdherenceExplanationsQueryWithHttpInfo(AgentQueryAdherenceExplanationsRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException
      Query adherence explanations for the current user
      Parameters:
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      QueryAdherenceExplanationsResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAdherenceExplanationsQuery

      public QueryAdherenceExplanationsResponse postWorkforcemanagementAdherenceExplanationsQuery(PostWorkforcemanagementAdherenceExplanationsQueryRequest request) throws IOException, ApiException
      Query adherence explanations for the current user
      Parameters:
      request - The request object
      Returns:
      QueryAdherenceExplanationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAdherenceExplanationsQuery

      public ApiResponse<QueryAdherenceExplanationsResponse> postWorkforcemanagementAdherenceExplanationsQuery(ApiRequest<AgentQueryAdherenceExplanationsRequest> request) throws IOException
      Query adherence explanations for the current user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAdherenceHistoricalBulk

      public WfmHistoricalAdherenceBulkResponse postWorkforcemanagementAdherenceHistoricalBulk(WfmHistoricalAdherenceBulkQuery body) throws IOException, ApiException
      Request a historical adherence report in bulk
      Parameters:
      body - body (required)
      Returns:
      WfmHistoricalAdherenceBulkResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAdherenceHistoricalBulkWithHttpInfo

      public ApiResponse<WfmHistoricalAdherenceBulkResponse> postWorkforcemanagementAdherenceHistoricalBulkWithHttpInfo(WfmHistoricalAdherenceBulkQuery body) throws IOException
      Request a historical adherence report in bulk
      Parameters:
      body - body (required)
      Returns:
      WfmHistoricalAdherenceBulkResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAdherenceHistoricalBulk

      public WfmHistoricalAdherenceBulkResponse postWorkforcemanagementAdherenceHistoricalBulk(PostWorkforcemanagementAdherenceHistoricalBulkRequest request) throws IOException, ApiException
      Request a historical adherence report in bulk
      Parameters:
      request - The request object
      Returns:
      WfmHistoricalAdherenceBulkResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAdherenceHistoricalBulk

      public ApiResponse<WfmHistoricalAdherenceBulkResponse> postWorkforcemanagementAdherenceHistoricalBulk(ApiRequest<WfmHistoricalAdherenceBulkQuery> request) throws IOException
      Request a historical adherence report in bulk
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentAdherenceExplanations

      public AdherenceExplanationAsyncResponse postWorkforcemanagementAgentAdherenceExplanations(String agentId, AddAdherenceExplanationAdminRequest body) throws IOException, ApiException
      Add an adherence explanation for the requested user
      Parameters:
      agentId - The ID of the agent to query (required)
      body - The request body (required)
      Returns:
      AdherenceExplanationAsyncResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentAdherenceExplanationsWithHttpInfo

      public ApiResponse<AdherenceExplanationAsyncResponse> postWorkforcemanagementAgentAdherenceExplanationsWithHttpInfo(String agentId, AddAdherenceExplanationAdminRequest body) throws IOException
      Add an adherence explanation for the requested user
      Parameters:
      agentId - The ID of the agent to query (required)
      body - The request body (required)
      Returns:
      AdherenceExplanationAsyncResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentAdherenceExplanations

      public AdherenceExplanationAsyncResponse postWorkforcemanagementAgentAdherenceExplanations(PostWorkforcemanagementAgentAdherenceExplanationsRequest request) throws IOException, ApiException
      Add an adherence explanation for the requested user
      Parameters:
      request - The request object
      Returns:
      AdherenceExplanationAsyncResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentAdherenceExplanations

      public ApiResponse<AdherenceExplanationAsyncResponse> postWorkforcemanagementAgentAdherenceExplanations(ApiRequest<AddAdherenceExplanationAdminRequest> request) throws IOException
      Add an adherence explanation for the requested user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentAdherenceExplanationsQuery

      public AgentQueryAdherenceExplanationsResponse postWorkforcemanagementAgentAdherenceExplanationsQuery(String agentId, AgentQueryAdherenceExplanationsRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException, ApiException
      Query adherence explanations for the given agent across a specified range
      Parameters:
      agentId - The ID of the agent to query (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      AgentQueryAdherenceExplanationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentAdherenceExplanationsQueryWithHttpInfo

      public ApiResponse<AgentQueryAdherenceExplanationsResponse> postWorkforcemanagementAgentAdherenceExplanationsQueryWithHttpInfo(String agentId, AgentQueryAdherenceExplanationsRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException
      Query adherence explanations for the given agent across a specified range
      Parameters:
      agentId - The ID of the agent to query (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      AgentQueryAdherenceExplanationsResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentAdherenceExplanationsQuery

      public AgentQueryAdherenceExplanationsResponse postWorkforcemanagementAgentAdherenceExplanationsQuery(PostWorkforcemanagementAgentAdherenceExplanationsQueryRequest request) throws IOException, ApiException
      Query adherence explanations for the given agent across a specified range
      Parameters:
      request - The request object
      Returns:
      AgentQueryAdherenceExplanationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentAdherenceExplanationsQuery

      public ApiResponse<AgentQueryAdherenceExplanationsResponse> postWorkforcemanagementAgentAdherenceExplanationsQuery(ApiRequest<AgentQueryAdherenceExplanationsRequest> request) throws IOException
      Query adherence explanations for the given agent across a specified range
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentUnavailabletimesQuery

      public UnavailableTimeListing postWorkforcemanagementAgentUnavailabletimesQuery(String agentId, QueryAgentUnavailableTimesRequest body) throws IOException, ApiException
      Get agent unavailable times
      Parameters:
      agentId - The ID of the agent (required)
      body - body (required)
      Returns:
      UnavailableTimeListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentUnavailabletimesQueryWithHttpInfo

      public ApiResponse<UnavailableTimeListing> postWorkforcemanagementAgentUnavailabletimesQueryWithHttpInfo(String agentId, QueryAgentUnavailableTimesRequest body) throws IOException
      Get agent unavailable times
      Parameters:
      agentId - The ID of the agent (required)
      body - body (required)
      Returns:
      UnavailableTimeListing
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentUnavailabletimesQuery

      public UnavailableTimeListing postWorkforcemanagementAgentUnavailabletimesQuery(PostWorkforcemanagementAgentUnavailabletimesQueryRequest request) throws IOException, ApiException
      Get agent unavailable times
      Parameters:
      request - The request object
      Returns:
      UnavailableTimeListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentUnavailabletimesQuery

      public ApiResponse<UnavailableTimeListing> postWorkforcemanagementAgentUnavailabletimesQuery(ApiRequest<QueryAgentUnavailableTimesRequest> request) throws IOException
      Get agent unavailable times
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgents

      public MoveAgentsResponse postWorkforcemanagementAgents(MoveAgentsRequest body) throws IOException, ApiException
      Move agents in and out of management unit
      Parameters:
      body - body (required)
      Returns:
      MoveAgentsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsWithHttpInfo

      public ApiResponse<MoveAgentsResponse> postWorkforcemanagementAgentsWithHttpInfo(MoveAgentsRequest body) throws IOException
      Move agents in and out of management unit
      Parameters:
      body - body (required)
      Returns:
      MoveAgentsResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgents

      public MoveAgentsResponse postWorkforcemanagementAgents(PostWorkforcemanagementAgentsRequest request) throws IOException, ApiException
      Move agents in and out of management unit
      Parameters:
      request - The request object
      Returns:
      MoveAgentsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgents

      public ApiResponse<MoveAgentsResponse> postWorkforcemanagementAgents(ApiRequest<MoveAgentsRequest> request) throws IOException
      Move agents in and out of management unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsIntegrationsHrisQuery

      public AgentsIntegrationsListing postWorkforcemanagementAgentsIntegrationsHrisQuery(QueryAgentsIntegrationsRequest body) throws IOException, ApiException
      Query integrations for agents
      Parameters:
      body - body (required)
      Returns:
      AgentsIntegrationsListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsIntegrationsHrisQueryWithHttpInfo

      public ApiResponse<AgentsIntegrationsListing> postWorkforcemanagementAgentsIntegrationsHrisQueryWithHttpInfo(QueryAgentsIntegrationsRequest body) throws IOException
      Query integrations for agents
      Parameters:
      body - body (required)
      Returns:
      AgentsIntegrationsListing
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsIntegrationsHrisQuery

      public AgentsIntegrationsListing postWorkforcemanagementAgentsIntegrationsHrisQuery(PostWorkforcemanagementAgentsIntegrationsHrisQueryRequest request) throws IOException, ApiException
      Query integrations for agents
      Parameters:
      request - The request object
      Returns:
      AgentsIntegrationsListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsIntegrationsHrisQuery

      public ApiResponse<AgentsIntegrationsListing> postWorkforcemanagementAgentsIntegrationsHrisQuery(ApiRequest<QueryAgentsIntegrationsRequest> request) throws IOException
      Query integrations for agents
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsMeAdherenceHistoricalJobs

      public WfmAgentHistoricalAdherenceResponse postWorkforcemanagementAgentsMeAdherenceHistoricalJobs(List<String> expand, WfmHistoricalAdherenceQueryForAgent body) throws IOException, ApiException
      Request an agent historical adherence report The maximum supported range for historical adherence queries is 31 days, or 7 days when the expand query parameter includes any of the following: exceptionInfo, actuals, scheduledActivities
      Parameters:
      expand - Which fields, if any, to expand with. wfm:AgentHistoricalAdherenceConformance:view permission is required for conformance, and wfm:agentSchedule:view permission is required for scheduledActivities. (optional)
      body - body (optional)
      Returns:
      WfmAgentHistoricalAdherenceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsMeAdherenceHistoricalJobsWithHttpInfo

      public ApiResponse<WfmAgentHistoricalAdherenceResponse> postWorkforcemanagementAgentsMeAdherenceHistoricalJobsWithHttpInfo(List<String> expand, WfmHistoricalAdherenceQueryForAgent body) throws IOException
      Request an agent historical adherence report The maximum supported range for historical adherence queries is 31 days, or 7 days when the expand query parameter includes any of the following: exceptionInfo, actuals, scheduledActivities
      Parameters:
      expand - Which fields, if any, to expand with. wfm:AgentHistoricalAdherenceConformance:view permission is required for conformance, and wfm:agentSchedule:view permission is required for scheduledActivities. (optional)
      body - body (optional)
      Returns:
      WfmAgentHistoricalAdherenceResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsMeAdherenceHistoricalJobs

      public WfmAgentHistoricalAdherenceResponse postWorkforcemanagementAgentsMeAdherenceHistoricalJobs(PostWorkforcemanagementAgentsMeAdherenceHistoricalJobsRequest request) throws IOException, ApiException
      Request an agent historical adherence report The maximum supported range for historical adherence queries is 31 days, or 7 days when the expand query parameter includes any of the following: exceptionInfo, actuals, scheduledActivities
      Parameters:
      request - The request object
      Returns:
      WfmAgentHistoricalAdherenceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsMeAdherenceHistoricalJobs

      public ApiResponse<WfmAgentHistoricalAdherenceResponse> postWorkforcemanagementAgentsMeAdherenceHistoricalJobs(ApiRequest<WfmHistoricalAdherenceQueryForAgent> request) throws IOException
      Request an agent historical adherence report The maximum supported range for historical adherence queries is 31 days, or 7 days when the expand query parameter includes any of the following: exceptionInfo, actuals, scheduledActivities
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsMePossibleworkshifts

      public AgentPossibleWorkShiftsResponse postWorkforcemanagementAgentsMePossibleworkshifts(AgentPossibleWorkShiftsRequest body) throws IOException, ApiException
      Get agent possible work shifts for requested time frame
      Parameters:
      body - body (required)
      Returns:
      AgentPossibleWorkShiftsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsMePossibleworkshiftsWithHttpInfo

      public ApiResponse<AgentPossibleWorkShiftsResponse> postWorkforcemanagementAgentsMePossibleworkshiftsWithHttpInfo(AgentPossibleWorkShiftsRequest body) throws IOException
      Get agent possible work shifts for requested time frame
      Parameters:
      body - body (required)
      Returns:
      AgentPossibleWorkShiftsResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsMePossibleworkshifts

      public AgentPossibleWorkShiftsResponse postWorkforcemanagementAgentsMePossibleworkshifts(PostWorkforcemanagementAgentsMePossibleworkshiftsRequest request) throws IOException, ApiException
      Get agent possible work shifts for requested time frame
      Parameters:
      request - The request object
      Returns:
      AgentPossibleWorkShiftsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsMePossibleworkshifts

      public ApiResponse<AgentPossibleWorkShiftsResponse> postWorkforcemanagementAgentsMePossibleworkshifts(ApiRequest<AgentPossibleWorkShiftsRequest> request) throws IOException
      Get agent possible work shifts for requested time frame
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd

      public AgentBulkAddOpportunityEnrollmentsResponse postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd(AgentBulkAddOpportunityEnrollmentsRequest body) throws IOException, ApiException
      Bulk add enrollments to opportunities for the authenticated agent Allows an agent to enroll in opportunities. This endpoint can return partial success.
      Parameters:
      body - body (required)
      Returns:
      AgentBulkAddOpportunityEnrollmentsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAddWithHttpInfo

      public ApiResponse<AgentBulkAddOpportunityEnrollmentsResponse> postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAddWithHttpInfo(AgentBulkAddOpportunityEnrollmentsRequest body) throws IOException
      Bulk add enrollments to opportunities for the authenticated agent Allows an agent to enroll in opportunities. This endpoint can return partial success.
      Parameters:
      body - body (required)
      Returns:
      AgentBulkAddOpportunityEnrollmentsResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd

      public AgentBulkAddOpportunityEnrollmentsResponse postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd(PostWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAddRequest request) throws IOException, ApiException
      Bulk add enrollments to opportunities for the authenticated agent Allows an agent to enroll in opportunities. This endpoint can return partial success.
      Parameters:
      request - The request object
      Returns:
      AgentBulkAddOpportunityEnrollmentsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd

      public ApiResponse<AgentBulkAddOpportunityEnrollmentsResponse> postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd(ApiRequest<AgentBulkAddOpportunityEnrollmentsRequest> request) throws IOException
      Bulk add enrollments to opportunities for the authenticated agent Allows an agent to enroll in opportunities. This endpoint can return partial success.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate

      public AgentBulkStatusUpdateOpportunityEnrollmentsResponse postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate(AgentBulkStatusUpdateOpportunityEnrollmentsRequest body) throws IOException, ApiException
      Bulk update enrollment status for the authenticated agent Allows an agent to update the status of their enrollments (e.g. withdraw). Returns partial success if some enrollments cannot be updated.
      Parameters:
      body - body (required)
      Returns:
      AgentBulkStatusUpdateOpportunityEnrollmentsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdateWithHttpInfo

      public ApiResponse<AgentBulkStatusUpdateOpportunityEnrollmentsResponse> postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdateWithHttpInfo(AgentBulkStatusUpdateOpportunityEnrollmentsRequest body) throws IOException
      Bulk update enrollment status for the authenticated agent Allows an agent to update the status of their enrollments (e.g. withdraw). Returns partial success if some enrollments cannot be updated.
      Parameters:
      body - body (required)
      Returns:
      AgentBulkStatusUpdateOpportunityEnrollmentsResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate

      public AgentBulkStatusUpdateOpportunityEnrollmentsResponse postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate(PostWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdateRequest request) throws IOException, ApiException
      Bulk update enrollment status for the authenticated agent Allows an agent to update the status of their enrollments (e.g. withdraw). Returns partial success if some enrollments cannot be updated.
      Parameters:
      request - The request object
      Returns:
      AgentBulkStatusUpdateOpportunityEnrollmentsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate

      public ApiResponse<AgentBulkStatusUpdateOpportunityEnrollmentsResponse> postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate(ApiRequest<AgentBulkStatusUpdateOpportunityEnrollmentsRequest> request) throws IOException
      Bulk update enrollment status for the authenticated agent Allows an agent to update the status of their enrollments (e.g. withdraw). Returns partial success if some enrollments cannot be updated.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsOpportunitiesQuery

      public AgentQueryOpportunitiesResponse postWorkforcemanagementAgentsOpportunitiesQuery(QueryOpportunitiesRequest body, String expand, Boolean forceDownloadService) throws IOException, ApiException
      Query opportunities for the authenticated agent Queries within the specified date range. Each opportunity includes the agent's enrollment details if they have enrolled.
      Parameters:
      body - body (required)
      expand - List of resources to expand (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      AgentQueryOpportunitiesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsOpportunitiesQueryWithHttpInfo

      public ApiResponse<AgentQueryOpportunitiesResponse> postWorkforcemanagementAgentsOpportunitiesQueryWithHttpInfo(QueryOpportunitiesRequest body, String expand, Boolean forceDownloadService) throws IOException
      Query opportunities for the authenticated agent Queries within the specified date range. Each opportunity includes the agent's enrollment details if they have enrolled.
      Parameters:
      body - body (required)
      expand - List of resources to expand (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      AgentQueryOpportunitiesResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsOpportunitiesQuery

      public AgentQueryOpportunitiesResponse postWorkforcemanagementAgentsOpportunitiesQuery(PostWorkforcemanagementAgentsOpportunitiesQueryRequest request) throws IOException, ApiException
      Query opportunities for the authenticated agent Queries within the specified date range. Each opportunity includes the agent's enrollment details if they have enrolled.
      Parameters:
      request - The request object
      Returns:
      AgentQueryOpportunitiesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentsOpportunitiesQuery

      public ApiResponse<AgentQueryOpportunitiesResponse> postWorkforcemanagementAgentsOpportunitiesQuery(ApiRequest<QueryOpportunitiesRequest> request) throws IOException
      Query opportunities for the authenticated agent Queries within the specified date range. Each opportunity includes the agent's enrollment details if they have enrolled.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentschedulesManagementunitsMine

      public AgentMuQueryResponse postWorkforcemanagementAgentschedulesManagementunitsMine(AgentMuScheduleQuery body, Boolean forceAsync, Boolean forceDownloadService) throws IOException, ApiException
      Fetch agent schedules for the logged in user's management unit
      Parameters:
      body - body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      AgentMuQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentschedulesManagementunitsMineWithHttpInfo

      public ApiResponse<AgentMuQueryResponse> postWorkforcemanagementAgentschedulesManagementunitsMineWithHttpInfo(AgentMuScheduleQuery body, Boolean forceAsync, Boolean forceDownloadService) throws IOException
      Fetch agent schedules for the logged in user's management unit
      Parameters:
      body - body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      AgentMuQueryResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentschedulesManagementunitsMine

      public AgentMuQueryResponse postWorkforcemanagementAgentschedulesManagementunitsMine(PostWorkforcemanagementAgentschedulesManagementunitsMineRequest request) throws IOException, ApiException
      Fetch agent schedules for the logged in user's management unit
      Parameters:
      request - The request object
      Returns:
      AgentMuQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentschedulesManagementunitsMine

      public ApiResponse<AgentMuQueryResponse> postWorkforcemanagementAgentschedulesManagementunitsMine(ApiRequest<AgentMuScheduleQuery> request) throws IOException
      Fetch agent schedules for the logged in user's management unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentschedulesMine

      public BuCurrentAgentScheduleSearchResponse postWorkforcemanagementAgentschedulesMine(BuGetCurrentAgentScheduleRequest body) throws IOException, ApiException
      Get published schedule for the current user
      Parameters:
      body - body (required)
      Returns:
      BuCurrentAgentScheduleSearchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentschedulesMineWithHttpInfo

      public ApiResponse<BuCurrentAgentScheduleSearchResponse> postWorkforcemanagementAgentschedulesMineWithHttpInfo(BuGetCurrentAgentScheduleRequest body) throws IOException
      Get published schedule for the current user
      Parameters:
      body - body (required)
      Returns:
      BuCurrentAgentScheduleSearchResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentschedulesMine

      public BuCurrentAgentScheduleSearchResponse postWorkforcemanagementAgentschedulesMine(PostWorkforcemanagementAgentschedulesMineRequest request) throws IOException, ApiException
      Get published schedule for the current user
      Parameters:
      request - The request object
      Returns:
      BuCurrentAgentScheduleSearchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAgentschedulesMine

      public ApiResponse<BuCurrentAgentScheduleSearchResponse> postWorkforcemanagementAgentschedulesMine(ApiRequest<BuGetCurrentAgentScheduleRequest> request) throws IOException
      Get published schedule for the current user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAlternativeshiftsOffersJobs

      public AlternativeShiftAsyncResponse postWorkforcemanagementAlternativeshiftsOffersJobs(AlternativeShiftOffersRequest body) throws IOException, ApiException
      Request a list of alternative shift offers for a given schedule
      Parameters:
      body - The request body (required)
      Returns:
      AlternativeShiftAsyncResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAlternativeshiftsOffersJobsWithHttpInfo

      public ApiResponse<AlternativeShiftAsyncResponse> postWorkforcemanagementAlternativeshiftsOffersJobsWithHttpInfo(AlternativeShiftOffersRequest body) throws IOException
      Request a list of alternative shift offers for a given schedule
      Parameters:
      body - The request body (required)
      Returns:
      AlternativeShiftAsyncResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAlternativeshiftsOffersJobs

      public AlternativeShiftAsyncResponse postWorkforcemanagementAlternativeshiftsOffersJobs(PostWorkforcemanagementAlternativeshiftsOffersJobsRequest request) throws IOException, ApiException
      Request a list of alternative shift offers for a given schedule
      Parameters:
      request - The request object
      Returns:
      AlternativeShiftAsyncResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAlternativeshiftsOffersJobs

      public ApiResponse<AlternativeShiftAsyncResponse> postWorkforcemanagementAlternativeshiftsOffersJobs(ApiRequest<AlternativeShiftOffersRequest> request) throws IOException
      Request a list of alternative shift offers for a given schedule
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAlternativeshiftsOffersSearchJobs

      public AlternativeShiftAsyncResponse postWorkforcemanagementAlternativeshiftsOffersSearchJobs(AlternativeShiftSearchOffersRequest body) throws IOException, ApiException
      Request a search of alternative shift offers for a given shift
      Parameters:
      body - The request body (required)
      Returns:
      AlternativeShiftAsyncResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAlternativeshiftsOffersSearchJobsWithHttpInfo

      public ApiResponse<AlternativeShiftAsyncResponse> postWorkforcemanagementAlternativeshiftsOffersSearchJobsWithHttpInfo(AlternativeShiftSearchOffersRequest body) throws IOException
      Request a search of alternative shift offers for a given shift
      Parameters:
      body - The request body (required)
      Returns:
      AlternativeShiftAsyncResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAlternativeshiftsOffersSearchJobs

      public AlternativeShiftAsyncResponse postWorkforcemanagementAlternativeshiftsOffersSearchJobs(PostWorkforcemanagementAlternativeshiftsOffersSearchJobsRequest request) throws IOException, ApiException
      Request a search of alternative shift offers for a given shift
      Parameters:
      request - The request object
      Returns:
      AlternativeShiftAsyncResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAlternativeshiftsOffersSearchJobs

      public ApiResponse<AlternativeShiftAsyncResponse> postWorkforcemanagementAlternativeshiftsOffersSearchJobs(ApiRequest<AlternativeShiftSearchOffersRequest> request) throws IOException
      Request a search of alternative shift offers for a given shift
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAlternativeshiftsTrades

      public AlternativeShiftTradeResponse postWorkforcemanagementAlternativeshiftsTrades(CreateAlternativeShiftTradeRequest body) throws IOException, ApiException
      Create my alternative shift trade using an existing offer's jobId
      Parameters:
      body - The request body (required)
      Returns:
      AlternativeShiftTradeResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAlternativeshiftsTradesWithHttpInfo

      public ApiResponse<AlternativeShiftTradeResponse> postWorkforcemanagementAlternativeshiftsTradesWithHttpInfo(CreateAlternativeShiftTradeRequest body) throws IOException
      Create my alternative shift trade using an existing offer's jobId
      Parameters:
      body - The request body (required)
      Returns:
      AlternativeShiftTradeResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementAlternativeshiftsTrades

      public AlternativeShiftTradeResponse postWorkforcemanagementAlternativeshiftsTrades(PostWorkforcemanagementAlternativeshiftsTradesRequest request) throws IOException, ApiException
      Create my alternative shift trade using an existing offer's jobId
      Parameters:
      request - The request object
      Returns:
      AlternativeShiftTradeResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementAlternativeshiftsTrades

      public ApiResponse<AlternativeShiftTradeResponse> postWorkforcemanagementAlternativeshiftsTrades(ApiRequest<CreateAlternativeShiftTradeRequest> request) throws IOException
      Create my alternative shift trade using an existing offer's jobId
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitActivitycodes

      public BusinessUnitActivityCode postWorkforcemanagementBusinessunitActivitycodes(String businessUnitId, CreateActivityCodeRequest body) throws IOException, ApiException
      Create a new activity code
      Parameters:
      businessUnitId - The ID of the business unit, or 'mine' for the business unit of the logged-in user. (required)
      body - body (required)
      Returns:
      BusinessUnitActivityCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitActivitycodesWithHttpInfo

      public ApiResponse<BusinessUnitActivityCode> postWorkforcemanagementBusinessunitActivitycodesWithHttpInfo(String businessUnitId, CreateActivityCodeRequest body) throws IOException
      Create a new activity code
      Parameters:
      businessUnitId - The ID of the business unit, or 'mine' for the business unit of the logged-in user. (required)
      body - body (required)
      Returns:
      BusinessUnitActivityCode
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitActivitycodes

      public BusinessUnitActivityCode postWorkforcemanagementBusinessunitActivitycodes(PostWorkforcemanagementBusinessunitActivitycodesRequest request) throws IOException, ApiException
      Create a new activity code
      Parameters:
      request - The request object
      Returns:
      BusinessUnitActivityCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitActivitycodes

      public ApiResponse<BusinessUnitActivityCode> postWorkforcemanagementBusinessunitActivitycodes(ApiRequest<CreateActivityCodeRequest> request) throws IOException
      Create a new activity code
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitActivityplanRunsJobs

      public ActivityPlanRunJobResponse postWorkforcemanagementBusinessunitActivityplanRunsJobs(String businessUnitId, String activityPlanId) throws IOException, ApiException
      Run an activity plan manually Triggers a job running the activity plan. The activity plan cannot be updated until the job completes
      Parameters:
      businessUnitId - The ID of the business unit (required)
      activityPlanId - The ID of the activity plan to run (required)
      Returns:
      ActivityPlanRunJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitActivityplanRunsJobsWithHttpInfo

      public ApiResponse<ActivityPlanRunJobResponse> postWorkforcemanagementBusinessunitActivityplanRunsJobsWithHttpInfo(String businessUnitId, String activityPlanId) throws IOException
      Run an activity plan manually Triggers a job running the activity plan. The activity plan cannot be updated until the job completes
      Parameters:
      businessUnitId - The ID of the business unit (required)
      activityPlanId - The ID of the activity plan to run (required)
      Returns:
      ActivityPlanRunJobResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitActivityplanRunsJobs

      public ActivityPlanRunJobResponse postWorkforcemanagementBusinessunitActivityplanRunsJobs(PostWorkforcemanagementBusinessunitActivityplanRunsJobsRequest request) throws IOException, ApiException
      Run an activity plan manually Triggers a job running the activity plan. The activity plan cannot be updated until the job completes
      Parameters:
      request - The request object
      Returns:
      ActivityPlanRunJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitActivityplanRunsJobs

      public ApiResponse<ActivityPlanRunJobResponse> postWorkforcemanagementBusinessunitActivityplanRunsJobs(ApiRequest<Void> request) throws IOException
      Run an activity plan manually Triggers a job running the activity plan. The activity plan cannot be updated until the job completes
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitActivityplans

      public ActivityPlanResponse postWorkforcemanagementBusinessunitActivityplans(String businessUnitId, CreateActivityPlanRequest body) throws IOException, ApiException
      Create an activity plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      ActivityPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitActivityplansWithHttpInfo

      public ApiResponse<ActivityPlanResponse> postWorkforcemanagementBusinessunitActivityplansWithHttpInfo(String businessUnitId, CreateActivityPlanRequest body) throws IOException
      Create an activity plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      ActivityPlanResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitActivityplans

      public ActivityPlanResponse postWorkforcemanagementBusinessunitActivityplans(PostWorkforcemanagementBusinessunitActivityplansRequest request) throws IOException, ApiException
      Create an activity plan
      Parameters:
      request - The request object
      Returns:
      ActivityPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitActivityplans

      public ApiResponse<ActivityPlanResponse> postWorkforcemanagementBusinessunitActivityplans(ApiRequest<CreateActivityPlanRequest> request) throws IOException
      Create an activity plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitAdherenceExplanationsQuery

      public BuQueryAdherenceExplanationsResponse postWorkforcemanagementBusinessunitAdherenceExplanationsQuery(String businessUnitId, BuQueryAdherenceExplanationsRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException, ApiException
      Query adherence explanations across an entire business unit for the requested period
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      BuQueryAdherenceExplanationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitAdherenceExplanationsQueryWithHttpInfo

      public ApiResponse<BuQueryAdherenceExplanationsResponse> postWorkforcemanagementBusinessunitAdherenceExplanationsQueryWithHttpInfo(String businessUnitId, BuQueryAdherenceExplanationsRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException
      Query adherence explanations across an entire business unit for the requested period
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      BuQueryAdherenceExplanationsResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitAdherenceExplanationsQuery

      public BuQueryAdherenceExplanationsResponse postWorkforcemanagementBusinessunitAdherenceExplanationsQuery(PostWorkforcemanagementBusinessunitAdherenceExplanationsQueryRequest request) throws IOException, ApiException
      Query adherence explanations across an entire business unit for the requested period
      Parameters:
      request - The request object
      Returns:
      BuQueryAdherenceExplanationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitAdherenceExplanationsQuery

      public ApiResponse<BuQueryAdherenceExplanationsResponse> postWorkforcemanagementBusinessunitAdherenceExplanationsQuery(ApiRequest<BuQueryAdherenceExplanationsRequest> request) throws IOException
      Query adherence explanations across an entire business unit for the requested period
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitAgentschedulesSearch

      public BuAsyncAgentSchedulesSearchResponse postWorkforcemanagementBusinessunitAgentschedulesSearch(String businessUnitId, BuSearchAgentSchedulesRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException, ApiException
      Search published schedules
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      BuAsyncAgentSchedulesSearchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitAgentschedulesSearchWithHttpInfo

      public ApiResponse<BuAsyncAgentSchedulesSearchResponse> postWorkforcemanagementBusinessunitAgentschedulesSearchWithHttpInfo(String businessUnitId, BuSearchAgentSchedulesRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException
      Search published schedules
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      BuAsyncAgentSchedulesSearchResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitAgentschedulesSearch

      public BuAsyncAgentSchedulesSearchResponse postWorkforcemanagementBusinessunitAgentschedulesSearch(PostWorkforcemanagementBusinessunitAgentschedulesSearchRequest request) throws IOException, ApiException
      Search published schedules
      Parameters:
      request - The request object
      Returns:
      BuAsyncAgentSchedulesSearchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitAgentschedulesSearch

      public ApiResponse<BuAsyncAgentSchedulesSearchResponse> postWorkforcemanagementBusinessunitAgentschedulesSearch(ApiRequest<BuSearchAgentSchedulesRequest> request) throws IOException
      Search published schedules
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch

      public BuListAlternativeShiftTradesResponse postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch(String businessUnitId, SearchAlternativeShiftTradesRequest body, Boolean forceAsync) throws IOException, ApiException
      List alternative shifts trades for a given management unit or agent
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      BuListAlternativeShiftTradesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchWithHttpInfo

      public ApiResponse<BuListAlternativeShiftTradesResponse> postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchWithHttpInfo(String businessUnitId, SearchAlternativeShiftTradesRequest body, Boolean forceAsync) throws IOException
      List alternative shifts trades for a given management unit or agent
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      BuListAlternativeShiftTradesResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch

      public BuListAlternativeShiftTradesResponse postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch(PostWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchRequest request) throws IOException, ApiException
      List alternative shifts trades for a given management unit or agent
      Parameters:
      request - The request object
      Returns:
      BuListAlternativeShiftTradesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch

      public ApiResponse<BuListAlternativeShiftTradesResponse> postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch(ApiRequest<SearchAlternativeShiftTradesRequest> request) throws IOException
      List alternative shifts trades for a given management unit or agent
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplanCopy

      public CapacityPlanResponse postWorkforcemanagementBusinessunitCapacityplanCopy(String businessUnitId, String capacityPlanId, CopyCapacityPlanRequest body) throws IOException, ApiException
      Copy a capacity plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      capacityPlanId - The ID of the capacity plan (required)
      body - body (required)
      Returns:
      CapacityPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplanCopyWithHttpInfo

      public ApiResponse<CapacityPlanResponse> postWorkforcemanagementBusinessunitCapacityplanCopyWithHttpInfo(String businessUnitId, String capacityPlanId, CopyCapacityPlanRequest body) throws IOException
      Copy a capacity plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      capacityPlanId - The ID of the capacity plan (required)
      body - body (required)
      Returns:
      CapacityPlanResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplanCopy

      public CapacityPlanResponse postWorkforcemanagementBusinessunitCapacityplanCopy(PostWorkforcemanagementBusinessunitCapacityplanCopyRequest request) throws IOException, ApiException
      Copy a capacity plan
      Parameters:
      request - The request object
      Returns:
      CapacityPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplanCopy

      public ApiResponse<CapacityPlanResponse> postWorkforcemanagementBusinessunitCapacityplanCopy(ApiRequest<CopyCapacityPlanRequest> request) throws IOException
      Copy a capacity plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplanRequirementGenerate

      public CapacityPlanStaffingRequirementResult postWorkforcemanagementBusinessunitCapacityplanRequirementGenerate(String businessUnitId, String capacityPlanId) throws IOException, ApiException
      Regenerate requirements for capacity plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      capacityPlanId - The ID of the capacity plan (required)
      Returns:
      CapacityPlanStaffingRequirementResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplanRequirementGenerateWithHttpInfo

      public ApiResponse<CapacityPlanStaffingRequirementResult> postWorkforcemanagementBusinessunitCapacityplanRequirementGenerateWithHttpInfo(String businessUnitId, String capacityPlanId) throws IOException
      Regenerate requirements for capacity plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      capacityPlanId - The ID of the capacity plan (required)
      Returns:
      CapacityPlanStaffingRequirementResult
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplanRequirementGenerate

      public CapacityPlanStaffingRequirementResult postWorkforcemanagementBusinessunitCapacityplanRequirementGenerate(PostWorkforcemanagementBusinessunitCapacityplanRequirementGenerateRequest request) throws IOException, ApiException
      Regenerate requirements for capacity plan
      Parameters:
      request - The request object
      Returns:
      CapacityPlanStaffingRequirementResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplanRequirementGenerate

      public ApiResponse<CapacityPlanStaffingRequirementResult> postWorkforcemanagementBusinessunitCapacityplanRequirementGenerate(ApiRequest<Void> request) throws IOException
      Regenerate requirements for capacity plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations

      public CapacityPlanStaffingGroupMetricChangeResponse postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations(String businessUnitId, String capacityPlanId, CreateCapacityPlanStaffingGroupMetricChangeRequest body) throws IOException, ApiException
      Create staffing group allocations for a capacity plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      capacityPlanId - The ID of the capacity plan (required)
      body - (required)
      Returns:
      CapacityPlanStaffingGroupMetricChangeResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationsWithHttpInfo

      public ApiResponse<CapacityPlanStaffingGroupMetricChangeResponse> postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationsWithHttpInfo(String businessUnitId, String capacityPlanId, CreateCapacityPlanStaffingGroupMetricChangeRequest body) throws IOException
      Create staffing group allocations for a capacity plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      capacityPlanId - The ID of the capacity plan (required)
      body - (required)
      Returns:
      CapacityPlanStaffingGroupMetricChangeResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations

      public CapacityPlanStaffingGroupMetricChangeResponse postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations(PostWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationsRequest request) throws IOException, ApiException
      Create staffing group allocations for a capacity plan
      Parameters:
      request - The request object
      Returns:
      CapacityPlanStaffingGroupMetricChangeResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations

      public ApiResponse<CapacityPlanStaffingGroupMetricChangeResponse> postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations(ApiRequest<CreateCapacityPlanStaffingGroupMetricChangeRequest> request) throws IOException
      Create staffing group allocations for a capacity plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQuery

      public CapacityPlanStaffingGroupMetricChangeHistoryListResponse postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQuery(String businessUnitId, String capacityPlanId, QueryCapacityPlanStaffingGroupMetricChangeHistory body) throws IOException, ApiException
      Query staffing groups allocations history for a capacity plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      capacityPlanId - The ID of the capacity plan (required)
      body - (required)
      Returns:
      CapacityPlanStaffingGroupMetricChangeHistoryListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQueryWithHttpInfo

      public ApiResponse<CapacityPlanStaffingGroupMetricChangeHistoryListResponse> postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQueryWithHttpInfo(String businessUnitId, String capacityPlanId, QueryCapacityPlanStaffingGroupMetricChangeHistory body) throws IOException
      Query staffing groups allocations history for a capacity plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      capacityPlanId - The ID of the capacity plan (required)
      body - (required)
      Returns:
      CapacityPlanStaffingGroupMetricChangeHistoryListResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQuery

      public CapacityPlanStaffingGroupMetricChangeHistoryListResponse postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQuery(PostWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQueryRequest request) throws IOException, ApiException
      Query staffing groups allocations history for a capacity plan
      Parameters:
      request - The request object
      Returns:
      CapacityPlanStaffingGroupMetricChangeHistoryListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQuery

      public ApiResponse<CapacityPlanStaffingGroupMetricChangeHistoryListResponse> postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQuery(ApiRequest<QueryCapacityPlanStaffingGroupMetricChangeHistory> request) throws IOException
      Query staffing groups allocations history for a capacity plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerate

      public LongTermRequirementsResponse postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerate(String businessUnitId, LocalDate weekDateId, String forecastId) throws IOException, ApiException
      Force regenerate the latest long term staffing requirements for a business unit
      Parameters:
      businessUnitId - (required)
      weekDateId - weekDateId of forecast, format yyyy-MM-dd. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      forecastId - forecastId of forecast (required)
      Returns:
      LongTermRequirementsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerateWithHttpInfo

      public ApiResponse<LongTermRequirementsResponse> postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerateWithHttpInfo(String businessUnitId, LocalDate weekDateId, String forecastId) throws IOException
      Force regenerate the latest long term staffing requirements for a business unit
      Parameters:
      businessUnitId - (required)
      weekDateId - weekDateId of forecast, format yyyy-MM-dd. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      forecastId - forecastId of forecast (required)
      Returns:
      LongTermRequirementsResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerate

      public LongTermRequirementsResponse postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerate(PostWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerateRequest request) throws IOException, ApiException
      Force regenerate the latest long term staffing requirements for a business unit
      Parameters:
      request - The request object
      Returns:
      LongTermRequirementsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerate

      public ApiResponse<LongTermRequirementsResponse> postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerate(ApiRequest<Void> request) throws IOException
      Force regenerate the latest long term staffing requirements for a business unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplans

      public CapacityPlanResponse postWorkforcemanagementBusinessunitCapacityplans(String businessUnitId, CapacityPlanRequest body) throws IOException, ApiException
      Create a new capacity plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      CapacityPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplansWithHttpInfo

      public ApiResponse<CapacityPlanResponse> postWorkforcemanagementBusinessunitCapacityplansWithHttpInfo(String businessUnitId, CapacityPlanRequest body) throws IOException
      Create a new capacity plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      CapacityPlanResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplans

      public CapacityPlanResponse postWorkforcemanagementBusinessunitCapacityplans(PostWorkforcemanagementBusinessunitCapacityplansRequest request) throws IOException, ApiException
      Create a new capacity plan
      Parameters:
      request - The request object
      Returns:
      CapacityPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplans

      public ApiResponse<CapacityPlanResponse> postWorkforcemanagementBusinessunitCapacityplans(ApiRequest<CapacityPlanRequest> request) throws IOException
      Create a new capacity plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplansBulkRemove

      public void postWorkforcemanagementBusinessunitCapacityplansBulkRemove(String businessUnitId, CapacityPlanDeleteRequest body) throws IOException, ApiException
      Delete capacity plans in a business unit
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplansBulkRemoveWithHttpInfo

      public ApiResponse<Void> postWorkforcemanagementBusinessunitCapacityplansBulkRemoveWithHttpInfo(String businessUnitId, CapacityPlanDeleteRequest body) throws IOException
      Delete capacity plans in a business unit
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplansBulkRemove

      public void postWorkforcemanagementBusinessunitCapacityplansBulkRemove(PostWorkforcemanagementBusinessunitCapacityplansBulkRemoveRequest request) throws IOException, ApiException
      Delete capacity plans in a business unit
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitCapacityplansBulkRemove

      public ApiResponse<Void> postWorkforcemanagementBusinessunitCapacityplansBulkRemove(ApiRequest<CapacityPlanDeleteRequest> request) throws IOException
      Delete capacity plans in a business unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitIntraday

      public AsyncIntradayResponse postWorkforcemanagementBusinessunitIntraday(String businessUnitId, IntradayPlanningGroupRequest body, Boolean forceAsync) throws IOException, ApiException
      Get intraday data for the given date for the requested planningGroupIds
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      AsyncIntradayResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitIntradayWithHttpInfo

      public ApiResponse<AsyncIntradayResponse> postWorkforcemanagementBusinessunitIntradayWithHttpInfo(String businessUnitId, IntradayPlanningGroupRequest body, Boolean forceAsync) throws IOException
      Get intraday data for the given date for the requested planningGroupIds
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      AsyncIntradayResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitIntraday

      public AsyncIntradayResponse postWorkforcemanagementBusinessunitIntraday(PostWorkforcemanagementBusinessunitIntradayRequest request) throws IOException, ApiException
      Get intraday data for the given date for the requested planningGroupIds
      Parameters:
      request - The request object
      Returns:
      AsyncIntradayResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitIntraday

      public ApiResponse<AsyncIntradayResponse> postWorkforcemanagementBusinessunitIntraday(ApiRequest<IntradayPlanningGroupRequest> request) throws IOException
      Get intraday data for the given date for the requested planningGroupIds
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesBulkAdd

      public BulkAddOpportunitiesResponse postWorkforcemanagementBusinessunitOpportunitiesBulkAdd(String businessUnitId, BulkAddOpportunitiesRequest body) throws IOException, ApiException
      Bulk add opportunities
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      BulkAddOpportunitiesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesBulkAddWithHttpInfo

      public ApiResponse<BulkAddOpportunitiesResponse> postWorkforcemanagementBusinessunitOpportunitiesBulkAddWithHttpInfo(String businessUnitId, BulkAddOpportunitiesRequest body) throws IOException
      Bulk add opportunities
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      BulkAddOpportunitiesResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesBulkAdd

      public BulkAddOpportunitiesResponse postWorkforcemanagementBusinessunitOpportunitiesBulkAdd(PostWorkforcemanagementBusinessunitOpportunitiesBulkAddRequest request) throws IOException, ApiException
      Bulk add opportunities
      Parameters:
      request - The request object
      Returns:
      BulkAddOpportunitiesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesBulkAdd

      public ApiResponse<BulkAddOpportunitiesResponse> postWorkforcemanagementBusinessunitOpportunitiesBulkAdd(ApiRequest<BulkAddOpportunitiesRequest> request) throws IOException
      Bulk add opportunities
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesBulkPublish

      public BulkPublishOpportunitiesResponse postWorkforcemanagementBusinessunitOpportunitiesBulkPublish(String businessUnitId, BulkOpportunitiesRequest body) throws IOException, ApiException
      Bulk publish opportunities Published opportunities become available for agent enrollment when they open. Returns partial success if some opportunities cannot be published.
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      BulkPublishOpportunitiesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesBulkPublishWithHttpInfo

      public ApiResponse<BulkPublishOpportunitiesResponse> postWorkforcemanagementBusinessunitOpportunitiesBulkPublishWithHttpInfo(String businessUnitId, BulkOpportunitiesRequest body) throws IOException
      Bulk publish opportunities Published opportunities become available for agent enrollment when they open. Returns partial success if some opportunities cannot be published.
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      BulkPublishOpportunitiesResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesBulkPublish

      public BulkPublishOpportunitiesResponse postWorkforcemanagementBusinessunitOpportunitiesBulkPublish(PostWorkforcemanagementBusinessunitOpportunitiesBulkPublishRequest request) throws IOException, ApiException
      Bulk publish opportunities Published opportunities become available for agent enrollment when they open. Returns partial success if some opportunities cannot be published.
      Parameters:
      request - The request object
      Returns:
      BulkPublishOpportunitiesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesBulkPublish

      public ApiResponse<BulkPublishOpportunitiesResponse> postWorkforcemanagementBusinessunitOpportunitiesBulkPublish(ApiRequest<BulkOpportunitiesRequest> request) throws IOException
      Bulk publish opportunities Published opportunities become available for agent enrollment when they open. Returns partial success if some opportunities cannot be published.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesBulkRemove

      public BulkRemoveOpportunitiesResponse postWorkforcemanagementBusinessunitOpportunitiesBulkRemove(String businessUnitId, BulkOpportunitiesRequest body) throws IOException, ApiException
      Bulk remove opportunities This operation is permanent and cannot be undone. Returns partial success if some opportunities cannot be removed.
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      BulkRemoveOpportunitiesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesBulkRemoveWithHttpInfo

      public ApiResponse<BulkRemoveOpportunitiesResponse> postWorkforcemanagementBusinessunitOpportunitiesBulkRemoveWithHttpInfo(String businessUnitId, BulkOpportunitiesRequest body) throws IOException
      Bulk remove opportunities This operation is permanent and cannot be undone. Returns partial success if some opportunities cannot be removed.
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      BulkRemoveOpportunitiesResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesBulkRemove

      public BulkRemoveOpportunitiesResponse postWorkforcemanagementBusinessunitOpportunitiesBulkRemove(PostWorkforcemanagementBusinessunitOpportunitiesBulkRemoveRequest request) throws IOException, ApiException
      Bulk remove opportunities This operation is permanent and cannot be undone. Returns partial success if some opportunities cannot be removed.
      Parameters:
      request - The request object
      Returns:
      BulkRemoveOpportunitiesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesBulkRemove

      public ApiResponse<BulkRemoveOpportunitiesResponse> postWorkforcemanagementBusinessunitOpportunitiesBulkRemove(ApiRequest<BulkOpportunitiesRequest> request) throws IOException
      Bulk remove opportunities This operation is permanent and cannot be undone. Returns partial success if some opportunities cannot be removed.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate

      public BulkOpportunitiesStatusUpdateResponse postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate(String businessUnitId, BulkOpportunitiesStatusUpdateRequest body) throws IOException, ApiException
      Bulk update opportunities status If status is Closed, pending enrollments are automatically denied; approved enrollments remain in schedules. Returns partial success if some opportunities cannot be updated.
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      BulkOpportunitiesStatusUpdateResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdateWithHttpInfo

      public ApiResponse<BulkOpportunitiesStatusUpdateResponse> postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdateWithHttpInfo(String businessUnitId, BulkOpportunitiesStatusUpdateRequest body) throws IOException
      Bulk update opportunities status If status is Closed, pending enrollments are automatically denied; approved enrollments remain in schedules. Returns partial success if some opportunities cannot be updated.
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      BulkOpportunitiesStatusUpdateResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate

      public BulkOpportunitiesStatusUpdateResponse postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate(PostWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdateRequest request) throws IOException, ApiException
      Bulk update opportunities status If status is Closed, pending enrollments are automatically denied; approved enrollments remain in schedules. Returns partial success if some opportunities cannot be updated.
      Parameters:
      request - The request object
      Returns:
      BulkOpportunitiesStatusUpdateResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate

      public ApiResponse<BulkOpportunitiesStatusUpdateResponse> postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate(ApiRequest<BulkOpportunitiesStatusUpdateRequest> request) throws IOException
      Bulk update opportunities status If status is Closed, pending enrollments are automatically denied; approved enrollments remain in schedules. Returns partial success if some opportunities cannot be updated.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate

      public BulkUpdateOpportunityEnrollmentsStatusResponse postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate(String businessUnitId, BulkOpportunityEnrollmentsStatusUpdateRequest body) throws IOException, ApiException
      Bulk update enrollment status Updates the status of enrollments (approve/deny). Returns partial success if some enrollments cannot be updated.
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      BulkUpdateOpportunityEnrollmentsStatusResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdateWithHttpInfo

      public ApiResponse<BulkUpdateOpportunityEnrollmentsStatusResponse> postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdateWithHttpInfo(String businessUnitId, BulkOpportunityEnrollmentsStatusUpdateRequest body) throws IOException
      Bulk update enrollment status Updates the status of enrollments (approve/deny). Returns partial success if some enrollments cannot be updated.
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      BulkUpdateOpportunityEnrollmentsStatusResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate

      public BulkUpdateOpportunityEnrollmentsStatusResponse postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate(PostWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdateRequest request) throws IOException, ApiException
      Bulk update enrollment status Updates the status of enrollments (approve/deny). Returns partial success if some enrollments cannot be updated.
      Parameters:
      request - The request object
      Returns:
      BulkUpdateOpportunityEnrollmentsStatusResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate

      public ApiResponse<BulkUpdateOpportunityEnrollmentsStatusResponse> postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate(ApiRequest<BulkOpportunityEnrollmentsStatusUpdateRequest> request) throws IOException
      Bulk update enrollment status Updates the status of enrollments (approve/deny). Returns partial success if some enrollments cannot be updated.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery

      public QueryOpportunityEnrollmentsResponse postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery(String businessUnitId, QueryOpportunityEnrollmentsRequest body, String expand, Boolean forceDownloadService) throws IOException, ApiException
      Query enrollments For more information about opportunities, use the expand parameter.
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      expand - List of resources to expand (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      QueryOpportunityEnrollmentsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQueryWithHttpInfo

      public ApiResponse<QueryOpportunityEnrollmentsResponse> postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQueryWithHttpInfo(String businessUnitId, QueryOpportunityEnrollmentsRequest body, String expand, Boolean forceDownloadService) throws IOException
      Query enrollments For more information about opportunities, use the expand parameter.
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      expand - List of resources to expand (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      QueryOpportunityEnrollmentsResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery

      public QueryOpportunityEnrollmentsResponse postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery(PostWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQueryRequest request) throws IOException, ApiException
      Query enrollments For more information about opportunities, use the expand parameter.
      Parameters:
      request - The request object
      Returns:
      QueryOpportunityEnrollmentsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery

      public ApiResponse<QueryOpportunityEnrollmentsResponse> postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery(ApiRequest<QueryOpportunityEnrollmentsRequest> request) throws IOException
      Query enrollments For more information about opportunities, use the expand parameter.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery

      public QueryExternalActivityOpportunitiesResponse postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery(String businessUnitId, BulkOpportunitiesExternalActivitiesRequest body) throws IOException, ApiException
      Query opportunities by external activity IDs
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      QueryExternalActivityOpportunitiesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQueryWithHttpInfo

      public ApiResponse<QueryExternalActivityOpportunitiesResponse> postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQueryWithHttpInfo(String businessUnitId, BulkOpportunitiesExternalActivitiesRequest body) throws IOException
      Query opportunities by external activity IDs
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      QueryExternalActivityOpportunitiesResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery

      public QueryExternalActivityOpportunitiesResponse postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery(PostWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQueryRequest request) throws IOException, ApiException
      Query opportunities by external activity IDs
      Parameters:
      request - The request object
      Returns:
      QueryExternalActivityOpportunitiesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery

      public ApiResponse<QueryExternalActivityOpportunitiesResponse> postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery(ApiRequest<BulkOpportunitiesExternalActivitiesRequest> request) throws IOException
      Query opportunities by external activity IDs
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesQuery

      public QueryOpportunitiesResponse postWorkforcemanagementBusinessunitOpportunitiesQuery(String businessUnitId, QueryOpportunitiesRequest body, Boolean forceDownloadService) throws IOException, ApiException
      Query opportunities within the specified date range
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      QueryOpportunitiesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesQueryWithHttpInfo

      public ApiResponse<QueryOpportunitiesResponse> postWorkforcemanagementBusinessunitOpportunitiesQueryWithHttpInfo(String businessUnitId, QueryOpportunitiesRequest body, Boolean forceDownloadService) throws IOException
      Query opportunities within the specified date range
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      QueryOpportunitiesResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesQuery

      public QueryOpportunitiesResponse postWorkforcemanagementBusinessunitOpportunitiesQuery(PostWorkforcemanagementBusinessunitOpportunitiesQueryRequest request) throws IOException, ApiException
      Query opportunities within the specified date range
      Parameters:
      request - The request object
      Returns:
      QueryOpportunitiesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitOpportunitiesQuery

      public ApiResponse<QueryOpportunitiesResponse> postWorkforcemanagementBusinessunitOpportunitiesQuery(ApiRequest<QueryOpportunitiesRequest> request) throws IOException
      Query opportunities within the specified date range
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitPlanninggroups

      public PlanningGroup postWorkforcemanagementBusinessunitPlanninggroups(String businessUnitId, CreatePlanningGroupRequest body) throws IOException, ApiException
      Adds a new planning group If the request body contains queue references in route paths, routing:queue:view is required in each referenced queue's division.
      Parameters:
      businessUnitId - The ID of the business unit. (required)
      body - body (required)
      Returns:
      PlanningGroup
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitPlanninggroupsWithHttpInfo

      public ApiResponse<PlanningGroup> postWorkforcemanagementBusinessunitPlanninggroupsWithHttpInfo(String businessUnitId, CreatePlanningGroupRequest body) throws IOException
      Adds a new planning group If the request body contains queue references in route paths, routing:queue:view is required in each referenced queue's division.
      Parameters:
      businessUnitId - The ID of the business unit. (required)
      body - body (required)
      Returns:
      PlanningGroup
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitPlanninggroups

      public PlanningGroup postWorkforcemanagementBusinessunitPlanninggroups(PostWorkforcemanagementBusinessunitPlanninggroupsRequest request) throws IOException, ApiException
      Adds a new planning group If the request body contains queue references in route paths, routing:queue:view is required in each referenced queue's division.
      Parameters:
      request - The request object
      Returns:
      PlanningGroup
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitPlanninggroups

      public ApiResponse<PlanningGroup> postWorkforcemanagementBusinessunitPlanninggroups(ApiRequest<CreatePlanningGroupRequest> request) throws IOException
      Adds a new planning group If the request body contains queue references in route paths, routing:queue:view is required in each referenced queue's division.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitServicegoaltemplates

      public ServiceGoalTemplate postWorkforcemanagementBusinessunitServicegoaltemplates(String businessUnitId, CreateServiceGoalTemplate body) throws IOException, ApiException
      Adds a new service goal template
      Parameters:
      businessUnitId - The ID of the business unit. (required)
      body - body (required)
      Returns:
      ServiceGoalTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitServicegoaltemplatesWithHttpInfo

      public ApiResponse<ServiceGoalTemplate> postWorkforcemanagementBusinessunitServicegoaltemplatesWithHttpInfo(String businessUnitId, CreateServiceGoalTemplate body) throws IOException
      Adds a new service goal template
      Parameters:
      businessUnitId - The ID of the business unit. (required)
      body - body (required)
      Returns:
      ServiceGoalTemplate
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitServicegoaltemplates

      public ServiceGoalTemplate postWorkforcemanagementBusinessunitServicegoaltemplates(PostWorkforcemanagementBusinessunitServicegoaltemplatesRequest request) throws IOException, ApiException
      Adds a new service goal template
      Parameters:
      request - The request object
      Returns:
      ServiceGoalTemplate
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitServicegoaltemplates

      public ApiResponse<ServiceGoalTemplate> postWorkforcemanagementBusinessunitServicegoaltemplates(ApiRequest<CreateServiceGoalTemplate> request) throws IOException
      Adds a new service goal template
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitShifttradingTradesEvaluateJobs

      public ShiftTradeEvaluateTradesBuJobResponse postWorkforcemanagementBusinessunitShifttradingTradesEvaluateJobs(String businessUnitId, EvaluateShiftTradeListJobRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException, ApiException
      Queries and evaluates against shift trade configuration shift trades in a management unit per week
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      ShiftTradeEvaluateTradesBuJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitShifttradingTradesEvaluateJobsWithHttpInfo

      public ApiResponse<ShiftTradeEvaluateTradesBuJobResponse> postWorkforcemanagementBusinessunitShifttradingTradesEvaluateJobsWithHttpInfo(String businessUnitId, EvaluateShiftTradeListJobRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException
      Queries and evaluates against shift trade configuration shift trades in a management unit per week
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      ShiftTradeEvaluateTradesBuJobResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitShifttradingTradesEvaluateJobs

      public ShiftTradeEvaluateTradesBuJobResponse postWorkforcemanagementBusinessunitShifttradingTradesEvaluateJobs(PostWorkforcemanagementBusinessunitShifttradingTradesEvaluateJobsRequest request) throws IOException, ApiException
      Queries and evaluates against shift trade configuration shift trades in a management unit per week
      Parameters:
      request - The request object
      Returns:
      ShiftTradeEvaluateTradesBuJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitShifttradingTradesEvaluateJobs

      public ApiResponse<ShiftTradeEvaluateTradesBuJobResponse> postWorkforcemanagementBusinessunitShifttradingTradesEvaluateJobs(ApiRequest<EvaluateShiftTradeListJobRequest> request) throws IOException
      Queries and evaluates against shift trade configuration shift trades in a management unit per week
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitShifttradingTradesQueryJobs

      public ShiftTradeQueryTradesBuJobResponse postWorkforcemanagementBusinessunitShifttradingTradesQueryJobs(String businessUnitId, QueryShiftTradeListJobRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException, ApiException
      Queries shift trades in a management unit per user
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      ShiftTradeQueryTradesBuJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitShifttradingTradesQueryJobsWithHttpInfo

      public ApiResponse<ShiftTradeQueryTradesBuJobResponse> postWorkforcemanagementBusinessunitShifttradingTradesQueryJobsWithHttpInfo(String businessUnitId, QueryShiftTradeListJobRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException
      Queries shift trades in a management unit per user
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      ShiftTradeQueryTradesBuJobResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitShifttradingTradesQueryJobs

      public ShiftTradeQueryTradesBuJobResponse postWorkforcemanagementBusinessunitShifttradingTradesQueryJobs(PostWorkforcemanagementBusinessunitShifttradingTradesQueryJobsRequest request) throws IOException, ApiException
      Queries shift trades in a management unit per user
      Parameters:
      request - The request object
      Returns:
      ShiftTradeQueryTradesBuJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitShifttradingTradesQueryJobs

      public ApiResponse<ShiftTradeQueryTradesBuJobResponse> postWorkforcemanagementBusinessunitShifttradingTradesQueryJobs(ApiRequest<QueryShiftTradeListJobRequest> request) throws IOException
      Queries shift trades in a management unit per user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitShifttradingTradesStateBulkJobs

      public ShiftTradeBulkUpdateTradeStateBuJobResponse postWorkforcemanagementBusinessunitShifttradingTradesStateBulkJobs(String businessUnitId, BulkUpdateShiftTradeListJobRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException, ApiException
      Bulk update multiple trade states. Permits a supervisor to approve or deny multiple trades.
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      ShiftTradeBulkUpdateTradeStateBuJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitShifttradingTradesStateBulkJobsWithHttpInfo

      public ApiResponse<ShiftTradeBulkUpdateTradeStateBuJobResponse> postWorkforcemanagementBusinessunitShifttradingTradesStateBulkJobsWithHttpInfo(String businessUnitId, BulkUpdateShiftTradeListJobRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException
      Bulk update multiple trade states. Permits a supervisor to approve or deny multiple trades.
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      ShiftTradeBulkUpdateTradeStateBuJobResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitShifttradingTradesStateBulkJobs

      public ShiftTradeBulkUpdateTradeStateBuJobResponse postWorkforcemanagementBusinessunitShifttradingTradesStateBulkJobs(PostWorkforcemanagementBusinessunitShifttradingTradesStateBulkJobsRequest request) throws IOException, ApiException
      Bulk update multiple trade states. Permits a supervisor to approve or deny multiple trades.
      Parameters:
      request - The request object
      Returns:
      ShiftTradeBulkUpdateTradeStateBuJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitShifttradingTradesStateBulkJobs

      public ApiResponse<ShiftTradeBulkUpdateTradeStateBuJobResponse> postWorkforcemanagementBusinessunitShifttradingTradesStateBulkJobs(ApiRequest<BulkUpdateShiftTradeListJobRequest> request) throws IOException
      Bulk update multiple trade states. Permits a supervisor to approve or deny multiple trades.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJobs

      public ShiftTradeSearchUnmatchedTradesBuJobResponse postWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJobs(String businessUnitId, SearchUnmatchedShiftTradeListJobRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException, ApiException
      Start an async job to find potential shift trade matches for the current receiving user
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      ShiftTradeSearchUnmatchedTradesBuJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJobsWithHttpInfo

      public ApiResponse<ShiftTradeSearchUnmatchedTradesBuJobResponse> postWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJobsWithHttpInfo(String businessUnitId, SearchUnmatchedShiftTradeListJobRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException
      Start an async job to find potential shift trade matches for the current receiving user
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      ShiftTradeSearchUnmatchedTradesBuJobResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJobs

      public ShiftTradeSearchUnmatchedTradesBuJobResponse postWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJobs(PostWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJobsRequest request) throws IOException, ApiException
      Start an async job to find potential shift trade matches for the current receiving user
      Parameters:
      request - The request object
      Returns:
      ShiftTradeSearchUnmatchedTradesBuJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJobs

      public ApiResponse<ShiftTradeSearchUnmatchedTradesBuJobResponse> postWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJobs(ApiRequest<SearchUnmatchedShiftTradeListJobRequest> request) throws IOException
      Start an async job to find potential shift trade matches for the current receiving user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitShifttradingWeeksSummaryJobs

      public ShiftTradeQueryWeekSummariesBuJobResponse postWorkforcemanagementBusinessunitShifttradingWeeksSummaryJobs(String businessUnitId, QueryWeekSummaryListJobRequest body, Boolean forceAsync) throws IOException, ApiException
      Retrieves the summary of shift trades in a matched state per week
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      ShiftTradeQueryWeekSummariesBuJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitShifttradingWeeksSummaryJobsWithHttpInfo

      public ApiResponse<ShiftTradeQueryWeekSummariesBuJobResponse> postWorkforcemanagementBusinessunitShifttradingWeeksSummaryJobsWithHttpInfo(String businessUnitId, QueryWeekSummaryListJobRequest body, Boolean forceAsync) throws IOException
      Retrieves the summary of shift trades in a matched state per week
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      ShiftTradeQueryWeekSummariesBuJobResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitShifttradingWeeksSummaryJobs

      public ShiftTradeQueryWeekSummariesBuJobResponse postWorkforcemanagementBusinessunitShifttradingWeeksSummaryJobs(PostWorkforcemanagementBusinessunitShifttradingWeeksSummaryJobsRequest request) throws IOException, ApiException
      Retrieves the summary of shift trades in a matched state per week
      Parameters:
      request - The request object
      Returns:
      ShiftTradeQueryWeekSummariesBuJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitShifttradingWeeksSummaryJobs

      public ApiResponse<ShiftTradeQueryWeekSummariesBuJobResponse> postWorkforcemanagementBusinessunitShifttradingWeeksSummaryJobs(ApiRequest<QueryWeekSummaryListJobRequest> request) throws IOException
      Retrieves the summary of shift trades in a matched state per week
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitStaffinggroups

      public StaffingGroupResponse postWorkforcemanagementBusinessunitStaffinggroups(String businessUnitId, CreateStaffingGroupRequest body) throws IOException, ApiException
      Creates a new staffing group
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      StaffingGroupResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitStaffinggroupsWithHttpInfo

      public ApiResponse<StaffingGroupResponse> postWorkforcemanagementBusinessunitStaffinggroupsWithHttpInfo(String businessUnitId, CreateStaffingGroupRequest body) throws IOException
      Creates a new staffing group
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      StaffingGroupResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitStaffinggroups

      public StaffingGroupResponse postWorkforcemanagementBusinessunitStaffinggroups(PostWorkforcemanagementBusinessunitStaffinggroupsRequest request) throws IOException, ApiException
      Creates a new staffing group
      Parameters:
      request - The request object
      Returns:
      StaffingGroupResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitStaffinggroups

      public ApiResponse<StaffingGroupResponse> postWorkforcemanagementBusinessunitStaffinggroups(ApiRequest<CreateStaffingGroupRequest> request) throws IOException
      Creates a new staffing group
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitStaffinggroupsPlanninggroupsQuery

      public PlanningGroupToStaffingGroupsListing postWorkforcemanagementBusinessunitStaffinggroupsPlanninggroupsQuery(String businessUnitId, QueryPlanningGroupToStaffingGroupsRequest body) throws IOException, ApiException
      Gets a list of planning group to staffing groups list association
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      PlanningGroupToStaffingGroupsListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitStaffinggroupsPlanninggroupsQueryWithHttpInfo

      public ApiResponse<PlanningGroupToStaffingGroupsListing> postWorkforcemanagementBusinessunitStaffinggroupsPlanninggroupsQueryWithHttpInfo(String businessUnitId, QueryPlanningGroupToStaffingGroupsRequest body) throws IOException
      Gets a list of planning group to staffing groups list association
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      PlanningGroupToStaffingGroupsListing
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitStaffinggroupsPlanninggroupsQuery

      public PlanningGroupToStaffingGroupsListing postWorkforcemanagementBusinessunitStaffinggroupsPlanninggroupsQuery(PostWorkforcemanagementBusinessunitStaffinggroupsPlanninggroupsQueryRequest request) throws IOException, ApiException
      Gets a list of planning group to staffing groups list association
      Parameters:
      request - The request object
      Returns:
      PlanningGroupToStaffingGroupsListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitStaffinggroupsPlanninggroupsQuery

      public ApiResponse<PlanningGroupToStaffingGroupsListing> postWorkforcemanagementBusinessunitStaffinggroupsPlanninggroupsQuery(ApiRequest<QueryPlanningGroupToStaffingGroupsRequest> request) throws IOException
      Gets a list of planning group to staffing groups list association
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitStaffinggroupsQuery

      public UserStaffingGroupListing postWorkforcemanagementBusinessunitStaffinggroupsQuery(String businessUnitId, QueryUserStaffingGroupListRequest body, Boolean forceDownloadService) throws IOException, ApiException
      Gets staffing group associations for a list of user IDs
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      forceDownloadService - Force the result of this operation to be sent via download service (optional)
      Returns:
      UserStaffingGroupListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitStaffinggroupsQueryWithHttpInfo

      public ApiResponse<UserStaffingGroupListing> postWorkforcemanagementBusinessunitStaffinggroupsQueryWithHttpInfo(String businessUnitId, QueryUserStaffingGroupListRequest body, Boolean forceDownloadService) throws IOException
      Gets staffing group associations for a list of user IDs
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      forceDownloadService - Force the result of this operation to be sent via download service (optional)
      Returns:
      UserStaffingGroupListing
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitStaffinggroupsQuery

      public UserStaffingGroupListing postWorkforcemanagementBusinessunitStaffinggroupsQuery(PostWorkforcemanagementBusinessunitStaffinggroupsQueryRequest request) throws IOException, ApiException
      Gets staffing group associations for a list of user IDs
      Parameters:
      request - The request object
      Returns:
      UserStaffingGroupListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitStaffinggroupsQuery

      public ApiResponse<UserStaffingGroupListing> postWorkforcemanagementBusinessunitStaffinggroupsQuery(ApiRequest<QueryUserStaffingGroupListRequest> request) throws IOException
      Gets staffing group associations for a list of user IDs
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitTimeofflimits

      public BuTimeOffLimitResponse postWorkforcemanagementBusinessunitTimeofflimits(String businessUnitId, BuCreateTimeOffLimitRequest body) throws IOException, ApiException
      Creates a new time-off limit object
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      BuTimeOffLimitResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitTimeofflimitsWithHttpInfo

      public ApiResponse<BuTimeOffLimitResponse> postWorkforcemanagementBusinessunitTimeofflimitsWithHttpInfo(String businessUnitId, BuCreateTimeOffLimitRequest body) throws IOException
      Creates a new time-off limit object
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      BuTimeOffLimitResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitTimeofflimits

      public BuTimeOffLimitResponse postWorkforcemanagementBusinessunitTimeofflimits(PostWorkforcemanagementBusinessunitTimeofflimitsRequest request) throws IOException, ApiException
      Creates a new time-off limit object
      Parameters:
      request - The request object
      Returns:
      BuTimeOffLimitResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitTimeofflimits

      public ApiResponse<BuTimeOffLimitResponse> postWorkforcemanagementBusinessunitTimeofflimits(ApiRequest<BuCreateTimeOffLimitRequest> request) throws IOException
      Creates a new time-off limit object
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery

      public BuTimeOffLimitValuesResponse postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery(String businessUnitId, QueryTimeOffLimitValuesRequest body) throws IOException, ApiException
      Retrieves time-off limit related values based on a given set of filters.
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      BuTimeOffLimitValuesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitTimeofflimitsValuesQueryWithHttpInfo

      public ApiResponse<BuTimeOffLimitValuesResponse> postWorkforcemanagementBusinessunitTimeofflimitsValuesQueryWithHttpInfo(String businessUnitId, QueryTimeOffLimitValuesRequest body) throws IOException
      Retrieves time-off limit related values based on a given set of filters.
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      BuTimeOffLimitValuesResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery

      public BuTimeOffLimitValuesResponse postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery(PostWorkforcemanagementBusinessunitTimeofflimitsValuesQueryRequest request) throws IOException, ApiException
      Retrieves time-off limit related values based on a given set of filters.
      Parameters:
      request - The request object
      Returns:
      BuTimeOffLimitValuesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery

      public ApiResponse<BuTimeOffLimitValuesResponse> postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery(ApiRequest<QueryTimeOffLimitValuesRequest> request) throws IOException
      Retrieves time-off limit related values based on a given set of filters.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitTimeoffplans

      public BuTimeOffPlanResponse postWorkforcemanagementBusinessunitTimeoffplans(String businessUnitId, BuCreateTimeOffPlanRequest body) throws IOException, ApiException
      Creates a new time-off plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      BuTimeOffPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitTimeoffplansWithHttpInfo

      public ApiResponse<BuTimeOffPlanResponse> postWorkforcemanagementBusinessunitTimeoffplansWithHttpInfo(String businessUnitId, BuCreateTimeOffPlanRequest body) throws IOException
      Creates a new time-off plan
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      BuTimeOffPlanResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitTimeoffplans

      public BuTimeOffPlanResponse postWorkforcemanagementBusinessunitTimeoffplans(PostWorkforcemanagementBusinessunitTimeoffplansRequest request) throws IOException, ApiException
      Creates a new time-off plan
      Parameters:
      request - The request object
      Returns:
      BuTimeOffPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitTimeoffplans

      public ApiResponse<BuTimeOffPlanResponse> postWorkforcemanagementBusinessunitTimeoffplans(ApiRequest<BuCreateTimeOffPlanRequest> request) throws IOException
      Creates a new time-off plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitUnavailabletimesSchedulesQuery

      public QueryAgentScheduleUnavailableTimesResponse postWorkforcemanagementBusinessunitUnavailabletimesSchedulesQuery(String businessUnitId, QueryAgentScheduleUnavailableTimesRequest body) throws IOException, ApiException
      Get agent schedule generation unavailable times
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      QueryAgentScheduleUnavailableTimesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitUnavailabletimesSchedulesQueryWithHttpInfo

      public ApiResponse<QueryAgentScheduleUnavailableTimesResponse> postWorkforcemanagementBusinessunitUnavailabletimesSchedulesQueryWithHttpInfo(String businessUnitId, QueryAgentScheduleUnavailableTimesRequest body) throws IOException
      Get agent schedule generation unavailable times
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      QueryAgentScheduleUnavailableTimesResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitUnavailabletimesSchedulesQuery

      public QueryAgentScheduleUnavailableTimesResponse postWorkforcemanagementBusinessunitUnavailabletimesSchedulesQuery(PostWorkforcemanagementBusinessunitUnavailabletimesSchedulesQueryRequest request) throws IOException, ApiException
      Get agent schedule generation unavailable times
      Parameters:
      request - The request object
      Returns:
      QueryAgentScheduleUnavailableTimesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitUnavailabletimesSchedulesQuery

      public ApiResponse<QueryAgentScheduleUnavailableTimesResponse> postWorkforcemanagementBusinessunitUnavailabletimesSchedulesQuery(ApiRequest<QueryAgentScheduleUnavailableTimesRequest> request) throws IOException
      Get agent schedule generation unavailable times
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitUnavailabletimesSettingsQuery

      public QueryAvailabilityManagementUnitsSettingsResponse postWorkforcemanagementBusinessunitUnavailabletimesSettingsQuery(String businessUnitId, QueryAvailabilityManagementUnitsSettingsRequest body) throws IOException, ApiException
      Query availability management units settings
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      QueryAvailabilityManagementUnitsSettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitUnavailabletimesSettingsQueryWithHttpInfo

      public ApiResponse<QueryAvailabilityManagementUnitsSettingsResponse> postWorkforcemanagementBusinessunitUnavailabletimesSettingsQueryWithHttpInfo(String businessUnitId, QueryAvailabilityManagementUnitsSettingsRequest body) throws IOException
      Query availability management units settings
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - body (required)
      Returns:
      QueryAvailabilityManagementUnitsSettingsResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitUnavailabletimesSettingsQuery

      public QueryAvailabilityManagementUnitsSettingsResponse postWorkforcemanagementBusinessunitUnavailabletimesSettingsQuery(PostWorkforcemanagementBusinessunitUnavailabletimesSettingsQueryRequest request) throws IOException, ApiException
      Query availability management units settings
      Parameters:
      request - The request object
      Returns:
      QueryAvailabilityManagementUnitsSettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitUnavailabletimesSettingsQuery

      public ApiResponse<QueryAvailabilityManagementUnitsSettingsResponse> postWorkforcemanagementBusinessunitUnavailabletimesSettingsQuery(ApiRequest<QueryAvailabilityManagementUnitsSettingsRequest> request) throws IOException
      Query availability management units settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery

      public BuAsyncAgentSchedulesQueryResponse postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery(String businessUnitId, LocalDate weekId, String scheduleId, BuQueryAgentSchedulesRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException, ApiException
      Loads agent schedule data from the schedule. Used in combination with the metadata route
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      scheduleId - The ID of the schedule (required)
      body - body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      BuAsyncAgentSchedulesQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQueryWithHttpInfo

      public ApiResponse<BuAsyncAgentSchedulesQueryResponse> postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQueryWithHttpInfo(String businessUnitId, LocalDate weekId, String scheduleId, BuQueryAgentSchedulesRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException
      Loads agent schedule data from the schedule. Used in combination with the metadata route
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      scheduleId - The ID of the schedule (required)
      body - body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      BuAsyncAgentSchedulesQueryResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery

      public BuAsyncAgentSchedulesQueryResponse postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery(PostWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQueryRequest request) throws IOException, ApiException
      Loads agent schedule data from the schedule. Used in combination with the metadata route
      Parameters:
      request - The request object
      Returns:
      BuAsyncAgentSchedulesQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery

      public ApiResponse<BuAsyncAgentSchedulesQueryResponse> postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery(ApiRequest<BuQueryAgentSchedulesRequest> request) throws IOException
      Loads agent schedule data from the schedule. Used in combination with the metadata route
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekScheduleCopy

      public BuAsyncScheduleResponse postWorkforcemanagementBusinessunitWeekScheduleCopy(String businessUnitId, LocalDate weekId, String scheduleId, BuCopyScheduleRequest body) throws IOException, ApiException
      Copy a schedule
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      scheduleId - The ID of the schedule to copy (required)
      body - body (required)
      Returns:
      BuAsyncScheduleResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekScheduleCopyWithHttpInfo

      public ApiResponse<BuAsyncScheduleResponse> postWorkforcemanagementBusinessunitWeekScheduleCopyWithHttpInfo(String businessUnitId, LocalDate weekId, String scheduleId, BuCopyScheduleRequest body) throws IOException
      Copy a schedule
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      scheduleId - The ID of the schedule to copy (required)
      body - body (required)
      Returns:
      BuAsyncScheduleResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekScheduleCopy

      public BuAsyncScheduleResponse postWorkforcemanagementBusinessunitWeekScheduleCopy(PostWorkforcemanagementBusinessunitWeekScheduleCopyRequest request) throws IOException, ApiException
      Copy a schedule
      Parameters:
      request - The request object
      Returns:
      BuAsyncScheduleResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekScheduleCopy

      public ApiResponse<BuAsyncScheduleResponse> postWorkforcemanagementBusinessunitWeekScheduleCopy(ApiRequest<BuCopyScheduleRequest> request) throws IOException
      Copy a schedule
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations

      public PerformancePredictionRecalculationResponse postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations(String businessUnitId, String weekId, String scheduleId, WfmProcessUploadRequest body) throws IOException, ApiException
      Request a daily recalculation of the performance prediction for the associated schedule
      Parameters:
      businessUnitId - The ID of the business unit to which the performance prediction belongs (required)
      weekId - First day of schedule week in yyyy-MM-dd format (required)
      scheduleId - The ID of the schedule the performance prediction belongs to (required)
      body - body (required)
      Returns:
      PerformancePredictionRecalculationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsWithHttpInfo

      public ApiResponse<PerformancePredictionRecalculationResponse> postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsWithHttpInfo(String businessUnitId, String weekId, String scheduleId, WfmProcessUploadRequest body) throws IOException
      Request a daily recalculation of the performance prediction for the associated schedule
      Parameters:
      businessUnitId - The ID of the business unit to which the performance prediction belongs (required)
      weekId - First day of schedule week in yyyy-MM-dd format (required)
      scheduleId - The ID of the schedule the performance prediction belongs to (required)
      body - body (required)
      Returns:
      PerformancePredictionRecalculationResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations

      public PerformancePredictionRecalculationResponse postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations(PostWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsRequest request) throws IOException, ApiException
      Request a daily recalculation of the performance prediction for the associated schedule
      Parameters:
      request - The request object
      Returns:
      PerformancePredictionRecalculationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations

      public ApiResponse<PerformancePredictionRecalculationResponse> postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations(ApiRequest<WfmProcessUploadRequest> request) throws IOException
      Request a daily recalculation of the performance prediction for the associated schedule
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl

      public PerformancePredictionRecalculationUploadResponse postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl(String businessUnitId, String weekId, String scheduleId, UploadUrlRequestBody body) throws IOException, ApiException
      Upload daily activity changes to be able to request a performance prediction recalculation
      Parameters:
      businessUnitId - The ID of the business unit to which the performance prediction belongs (required)
      weekId - First day of schedule week in yyyy-MM-dd format (required)
      scheduleId - The ID of the schedule the performance prediction belongs to (required)
      body - body (required)
      Returns:
      PerformancePredictionRecalculationUploadResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurlWithHttpInfo

      public ApiResponse<PerformancePredictionRecalculationUploadResponse> postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurlWithHttpInfo(String businessUnitId, String weekId, String scheduleId, UploadUrlRequestBody body) throws IOException
      Upload daily activity changes to be able to request a performance prediction recalculation
      Parameters:
      businessUnitId - The ID of the business unit to which the performance prediction belongs (required)
      weekId - First day of schedule week in yyyy-MM-dd format (required)
      scheduleId - The ID of the schedule the performance prediction belongs to (required)
      body - body (required)
      Returns:
      PerformancePredictionRecalculationUploadResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl

      public PerformancePredictionRecalculationUploadResponse postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl(PostWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurlRequest request) throws IOException, ApiException
      Upload daily activity changes to be able to request a performance prediction recalculation
      Parameters:
      request - The request object
      Returns:
      PerformancePredictionRecalculationUploadResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl

      public ApiResponse<PerformancePredictionRecalculationUploadResponse> postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl(ApiRequest<UploadUrlRequestBody> request) throws IOException
      Upload daily activity changes to be able to request a performance prediction recalculation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekScheduleReschedule

      public BuAsyncScheduleRunResponse postWorkforcemanagementBusinessunitWeekScheduleReschedule(String businessUnitId, LocalDate weekId, String scheduleId, BuRescheduleRequest body) throws IOException, ApiException
      Start a rescheduling run
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      scheduleId - The ID of the schedule (required)
      body - body (required)
      Returns:
      BuAsyncScheduleRunResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekScheduleRescheduleWithHttpInfo

      public ApiResponse<BuAsyncScheduleRunResponse> postWorkforcemanagementBusinessunitWeekScheduleRescheduleWithHttpInfo(String businessUnitId, LocalDate weekId, String scheduleId, BuRescheduleRequest body) throws IOException
      Start a rescheduling run
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      scheduleId - The ID of the schedule (required)
      body - body (required)
      Returns:
      BuAsyncScheduleRunResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekScheduleReschedule

      public BuAsyncScheduleRunResponse postWorkforcemanagementBusinessunitWeekScheduleReschedule(PostWorkforcemanagementBusinessunitWeekScheduleRescheduleRequest request) throws IOException, ApiException
      Start a rescheduling run
      Parameters:
      request - The request object
      Returns:
      BuAsyncScheduleRunResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekScheduleReschedule

      public ApiResponse<BuAsyncScheduleRunResponse> postWorkforcemanagementBusinessunitWeekScheduleReschedule(ApiRequest<BuRescheduleRequest> request) throws IOException
      Start a rescheduling run
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekScheduleUpdate

      public BuAsyncScheduleResponse postWorkforcemanagementBusinessunitWeekScheduleUpdate(String businessUnitId, LocalDate weekId, String scheduleId, ProcessScheduleUpdateUploadRequest body) throws IOException, ApiException
      Starts processing a schedule update Call after uploading the schedule data to the url supplied by the /update/uploadurl route
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      scheduleId - The ID of the schedule (required)
      body - body (required)
      Returns:
      BuAsyncScheduleResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekScheduleUpdateWithHttpInfo

      public ApiResponse<BuAsyncScheduleResponse> postWorkforcemanagementBusinessunitWeekScheduleUpdateWithHttpInfo(String businessUnitId, LocalDate weekId, String scheduleId, ProcessScheduleUpdateUploadRequest body) throws IOException
      Starts processing a schedule update Call after uploading the schedule data to the url supplied by the /update/uploadurl route
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      scheduleId - The ID of the schedule (required)
      body - body (required)
      Returns:
      BuAsyncScheduleResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekScheduleUpdate

      public BuAsyncScheduleResponse postWorkforcemanagementBusinessunitWeekScheduleUpdate(PostWorkforcemanagementBusinessunitWeekScheduleUpdateRequest request) throws IOException, ApiException
      Starts processing a schedule update Call after uploading the schedule data to the url supplied by the /update/uploadurl route
      Parameters:
      request - The request object
      Returns:
      BuAsyncScheduleResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekScheduleUpdate

      public ApiResponse<BuAsyncScheduleResponse> postWorkforcemanagementBusinessunitWeekScheduleUpdate(ApiRequest<ProcessScheduleUpdateUploadRequest> request) throws IOException
      Starts processing a schedule update Call after uploading the schedule data to the url supplied by the /update/uploadurl route
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl

      public UpdateScheduleUploadResponse postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl(String businessUnitId, LocalDate weekId, String scheduleId, UploadUrlRequestBody body) throws IOException, ApiException
      Creates a signed upload URL for updating a schedule Once the upload is complete, call the /{scheduleId}/update route to start the schedule update process
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      scheduleId - The ID of the schedule (required)
      body - body (required)
      Returns:
      UpdateScheduleUploadResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurlWithHttpInfo

      public ApiResponse<UpdateScheduleUploadResponse> postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurlWithHttpInfo(String businessUnitId, LocalDate weekId, String scheduleId, UploadUrlRequestBody body) throws IOException
      Creates a signed upload URL for updating a schedule Once the upload is complete, call the /{scheduleId}/update route to start the schedule update process
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      scheduleId - The ID of the schedule (required)
      body - body (required)
      Returns:
      UpdateScheduleUploadResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl

      public UpdateScheduleUploadResponse postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl(PostWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurlRequest request) throws IOException, ApiException
      Creates a signed upload URL for updating a schedule Once the upload is complete, call the /{scheduleId}/update route to start the schedule update process
      Parameters:
      request - The request object
      Returns:
      UpdateScheduleUploadResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl

      public ApiResponse<UpdateScheduleUploadResponse> postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl(ApiRequest<UploadUrlRequestBody> request) throws IOException
      Creates a signed upload URL for updating a schedule Once the upload is complete, call the /{scheduleId}/update route to start the schedule update process
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedules

      public BuScheduleMetadata postWorkforcemanagementBusinessunitWeekSchedules(String businessUnitId, LocalDate weekId, BuCreateBlankScheduleRequest body) throws IOException, ApiException
      Create a blank schedule
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      body - body (required)
      Returns:
      BuScheduleMetadata
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedulesWithHttpInfo

      public ApiResponse<BuScheduleMetadata> postWorkforcemanagementBusinessunitWeekSchedulesWithHttpInfo(String businessUnitId, LocalDate weekId, BuCreateBlankScheduleRequest body) throws IOException
      Create a blank schedule
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      body - body (required)
      Returns:
      BuScheduleMetadata
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedules

      public BuScheduleMetadata postWorkforcemanagementBusinessunitWeekSchedules(PostWorkforcemanagementBusinessunitWeekSchedulesRequest request) throws IOException, ApiException
      Create a blank schedule
      Parameters:
      request - The request object
      Returns:
      BuScheduleMetadata
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedules

      public ApiResponse<BuScheduleMetadata> postWorkforcemanagementBusinessunitWeekSchedules(ApiRequest<BuCreateBlankScheduleRequest> request) throws IOException
      Create a blank schedule
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedulesGenerate

      public BuAsyncScheduleRunResponse postWorkforcemanagementBusinessunitWeekSchedulesGenerate(String businessUnitId, LocalDate weekId, BuGenerateScheduleRequest body) throws IOException, ApiException
      Generate a schedule
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      body - body (required)
      Returns:
      BuAsyncScheduleRunResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedulesGenerateWithHttpInfo

      public ApiResponse<BuAsyncScheduleRunResponse> postWorkforcemanagementBusinessunitWeekSchedulesGenerateWithHttpInfo(String businessUnitId, LocalDate weekId, BuGenerateScheduleRequest body) throws IOException
      Generate a schedule
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      body - body (required)
      Returns:
      BuAsyncScheduleRunResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedulesGenerate

      public BuAsyncScheduleRunResponse postWorkforcemanagementBusinessunitWeekSchedulesGenerate(PostWorkforcemanagementBusinessunitWeekSchedulesGenerateRequest request) throws IOException, ApiException
      Generate a schedule
      Parameters:
      request - The request object
      Returns:
      BuAsyncScheduleRunResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedulesGenerate

      public ApiResponse<BuAsyncScheduleRunResponse> postWorkforcemanagementBusinessunitWeekSchedulesGenerate(ApiRequest<BuGenerateScheduleRequest> request) throws IOException
      Generate a schedule
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedulesImport

      public ScheduleUploadProcessingResponse postWorkforcemanagementBusinessunitWeekSchedulesImport(String businessUnitId, LocalDate weekId, WfmProcessUploadRequest body) throws IOException, ApiException
      Starts processing a schedule import Call after uploading the schedule data to the url supplied by the /import/uploadurl route
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      body - (required)
      Returns:
      ScheduleUploadProcessingResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedulesImportWithHttpInfo

      public ApiResponse<ScheduleUploadProcessingResponse> postWorkforcemanagementBusinessunitWeekSchedulesImportWithHttpInfo(String businessUnitId, LocalDate weekId, WfmProcessUploadRequest body) throws IOException
      Starts processing a schedule import Call after uploading the schedule data to the url supplied by the /import/uploadurl route
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      body - (required)
      Returns:
      ScheduleUploadProcessingResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedulesImport

      public ScheduleUploadProcessingResponse postWorkforcemanagementBusinessunitWeekSchedulesImport(PostWorkforcemanagementBusinessunitWeekSchedulesImportRequest request) throws IOException, ApiException
      Starts processing a schedule import Call after uploading the schedule data to the url supplied by the /import/uploadurl route
      Parameters:
      request - The request object
      Returns:
      ScheduleUploadProcessingResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedulesImport

      public ApiResponse<ScheduleUploadProcessingResponse> postWorkforcemanagementBusinessunitWeekSchedulesImport(ApiRequest<WfmProcessUploadRequest> request) throws IOException
      Starts processing a schedule import Call after uploading the schedule data to the url supplied by the /import/uploadurl route
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl

      public ImportScheduleUploadResponse postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl(String businessUnitId, LocalDate weekId, UploadUrlRequestBody body) throws IOException, ApiException
      Creates a signed upload URL for importing a schedule Once the upload is complete, call the /import route to start the schedule import process
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      body - body (required)
      Returns:
      ImportScheduleUploadResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurlWithHttpInfo

      public ApiResponse<ImportScheduleUploadResponse> postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurlWithHttpInfo(String businessUnitId, LocalDate weekId, UploadUrlRequestBody body) throws IOException
      Creates a signed upload URL for importing a schedule Once the upload is complete, call the /import route to start the schedule import process
      Parameters:
      businessUnitId - The ID of the business unit (required)
      weekId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      body - body (required)
      Returns:
      ImportScheduleUploadResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl

      public ImportScheduleUploadResponse postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl(PostWorkforcemanagementBusinessunitWeekSchedulesImportUploadurlRequest request) throws IOException, ApiException
      Creates a signed upload URL for importing a schedule Once the upload is complete, call the /import route to start the schedule import process
      Parameters:
      request - The request object
      Returns:
      ImportScheduleUploadResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl

      public ApiResponse<ImportScheduleUploadResponse> postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl(ApiRequest<UploadUrlRequestBody> request) throws IOException
      Creates a signed upload URL for importing a schedule Once the upload is complete, call the /import route to start the schedule import process
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekShorttermforecastCopy

      public AsyncForecastOperationResult postWorkforcemanagementBusinessunitWeekShorttermforecastCopy(String businessUnitId, LocalDate weekDateId, String forecastId, CopyBuForecastRequest body, Boolean forceAsync) throws IOException, ApiException
      Copy a short term forecast
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      forecastId - The ID of the forecast to copy (required)
      body - body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      AsyncForecastOperationResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekShorttermforecastCopyWithHttpInfo

      public ApiResponse<AsyncForecastOperationResult> postWorkforcemanagementBusinessunitWeekShorttermforecastCopyWithHttpInfo(String businessUnitId, LocalDate weekDateId, String forecastId, CopyBuForecastRequest body, Boolean forceAsync) throws IOException
      Copy a short term forecast
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      forecastId - The ID of the forecast to copy (required)
      body - body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      AsyncForecastOperationResult
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekShorttermforecastCopy

      public AsyncForecastOperationResult postWorkforcemanagementBusinessunitWeekShorttermforecastCopy(PostWorkforcemanagementBusinessunitWeekShorttermforecastCopyRequest request) throws IOException, ApiException
      Copy a short term forecast
      Parameters:
      request - The request object
      Returns:
      AsyncForecastOperationResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekShorttermforecastCopy

      public ApiResponse<AsyncForecastOperationResult> postWorkforcemanagementBusinessunitWeekShorttermforecastCopy(ApiRequest<CopyBuForecastRequest> request) throws IOException
      Copy a short term forecast
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate

      public AsyncForecastOperationResult postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate(String businessUnitId, LocalDate weekDateId, GenerateBuForecastRequest body, Boolean forceAsync) throws IOException, ApiException
      Generate a short term forecast
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      body - body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      AsyncForecastOperationResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerateWithHttpInfo

      public ApiResponse<AsyncForecastOperationResult> postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerateWithHttpInfo(String businessUnitId, LocalDate weekDateId, GenerateBuForecastRequest body, Boolean forceAsync) throws IOException
      Generate a short term forecast
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      body - body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      AsyncForecastOperationResult
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate

      public AsyncForecastOperationResult postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate(PostWorkforcemanagementBusinessunitWeekShorttermforecastsGenerateRequest request) throws IOException, ApiException
      Generate a short term forecast
      Parameters:
      request - The request object
      Returns:
      AsyncForecastOperationResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate

      public ApiResponse<AsyncForecastOperationResult> postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate(ApiRequest<GenerateBuForecastRequest> request) throws IOException
      Generate a short term forecast
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekShorttermforecastsImport

      public ImportForecastResponse postWorkforcemanagementBusinessunitWeekShorttermforecastsImport(String businessUnitId, LocalDate weekDateId, WfmProcessUploadRequest body) throws IOException, ApiException
      Starts importing the uploaded short term forecast Call after uploading the forecast data to the url supplied by the /import/uploadurl route
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      body - body (required)
      Returns:
      ImportForecastResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekShorttermforecastsImportWithHttpInfo

      public ApiResponse<ImportForecastResponse> postWorkforcemanagementBusinessunitWeekShorttermforecastsImportWithHttpInfo(String businessUnitId, LocalDate weekDateId, WfmProcessUploadRequest body) throws IOException
      Starts importing the uploaded short term forecast Call after uploading the forecast data to the url supplied by the /import/uploadurl route
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      body - body (required)
      Returns:
      ImportForecastResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekShorttermforecastsImport

      public ImportForecastResponse postWorkforcemanagementBusinessunitWeekShorttermforecastsImport(PostWorkforcemanagementBusinessunitWeekShorttermforecastsImportRequest request) throws IOException, ApiException
      Starts importing the uploaded short term forecast Call after uploading the forecast data to the url supplied by the /import/uploadurl route
      Parameters:
      request - The request object
      Returns:
      ImportForecastResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekShorttermforecastsImport

      public ApiResponse<ImportForecastResponse> postWorkforcemanagementBusinessunitWeekShorttermforecastsImport(ApiRequest<WfmProcessUploadRequest> request) throws IOException
      Starts importing the uploaded short term forecast Call after uploading the forecast data to the url supplied by the /import/uploadurl route
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl

      public ImportForecastUploadResponse postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl(String businessUnitId, LocalDate weekDateId, UploadUrlRequestBody body) throws IOException, ApiException
      Creates a signed upload URL for importing a short term forecast Once the upload is complete, call the /import route to start the short term forecast import process
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      body - body (required)
      Returns:
      ImportForecastUploadResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurlWithHttpInfo

      public ApiResponse<ImportForecastUploadResponse> postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurlWithHttpInfo(String businessUnitId, LocalDate weekDateId, UploadUrlRequestBody body) throws IOException
      Creates a signed upload URL for importing a short term forecast Once the upload is complete, call the /import route to start the short term forecast import process
      Parameters:
      businessUnitId - The ID of the business unit to which the forecast belongs (required)
      weekDateId - First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      body - body (required)
      Returns:
      ImportForecastUploadResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl

      public ImportForecastUploadResponse postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl(PostWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurlRequest request) throws IOException, ApiException
      Creates a signed upload URL for importing a short term forecast Once the upload is complete, call the /import route to start the short term forecast import process
      Parameters:
      request - The request object
      Returns:
      ImportForecastUploadResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl

      public ApiResponse<ImportForecastUploadResponse> postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl(ApiRequest<UploadUrlRequestBody> request) throws IOException
      Creates a signed upload URL for importing a short term forecast Once the upload is complete, call the /import route to start the short term forecast import process
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWorkplanbidCopy

      public WorkPlanBid postWorkforcemanagementBusinessunitWorkplanbidCopy(String businessUnitId, String bidId, CopyWorkPlanBid body) throws IOException, ApiException
      Copy a work plan bid
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The ID of the work plan bid to copy (required)
      body - body (required)
      Returns:
      WorkPlanBid
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWorkplanbidCopyWithHttpInfo

      public ApiResponse<WorkPlanBid> postWorkforcemanagementBusinessunitWorkplanbidCopyWithHttpInfo(String businessUnitId, String bidId, CopyWorkPlanBid body) throws IOException
      Copy a work plan bid
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The ID of the work plan bid to copy (required)
      body - body (required)
      Returns:
      WorkPlanBid
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWorkplanbidCopy

      public WorkPlanBid postWorkforcemanagementBusinessunitWorkplanbidCopy(PostWorkforcemanagementBusinessunitWorkplanbidCopyRequest request) throws IOException, ApiException
      Copy a work plan bid
      Parameters:
      request - The request object
      Returns:
      WorkPlanBid
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWorkplanbidCopy

      public ApiResponse<WorkPlanBid> postWorkforcemanagementBusinessunitWorkplanbidCopy(ApiRequest<CopyWorkPlanBid> request) throws IOException
      Copy a work plan bid
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWorkplanbidGroups

      public WorkPlanBidGroupResponse postWorkforcemanagementBusinessunitWorkplanbidGroups(String businessUnitId, String bidId, WorkPlanBidGroupCreate body) throws IOException, ApiException
      Add a bid group in a given work plan bid
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The work plan bid id of the bid groups (required)
      body - body (required)
      Returns:
      WorkPlanBidGroupResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWorkplanbidGroupsWithHttpInfo

      public ApiResponse<WorkPlanBidGroupResponse> postWorkforcemanagementBusinessunitWorkplanbidGroupsWithHttpInfo(String businessUnitId, String bidId, WorkPlanBidGroupCreate body) throws IOException
      Add a bid group in a given work plan bid
      Parameters:
      businessUnitId - The ID of the business unit (required)
      bidId - The work plan bid id of the bid groups (required)
      body - body (required)
      Returns:
      WorkPlanBidGroupResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWorkplanbidGroups

      public WorkPlanBidGroupResponse postWorkforcemanagementBusinessunitWorkplanbidGroups(PostWorkforcemanagementBusinessunitWorkplanbidGroupsRequest request) throws IOException, ApiException
      Add a bid group in a given work plan bid
      Parameters:
      request - The request object
      Returns:
      WorkPlanBidGroupResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWorkplanbidGroups

      public ApiResponse<WorkPlanBidGroupResponse> postWorkforcemanagementBusinessunitWorkplanbidGroups(ApiRequest<WorkPlanBidGroupCreate> request) throws IOException
      Add a bid group in a given work plan bid
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWorkplanbids

      public WorkPlanBid postWorkforcemanagementBusinessunitWorkplanbids(String businessUnitId, CreateWorkPlanBid body) throws IOException, ApiException
      Create a new work plan bid
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - The work plan bid to be created (required)
      Returns:
      WorkPlanBid
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWorkplanbidsWithHttpInfo

      public ApiResponse<WorkPlanBid> postWorkforcemanagementBusinessunitWorkplanbidsWithHttpInfo(String businessUnitId, CreateWorkPlanBid body) throws IOException
      Create a new work plan bid
      Parameters:
      businessUnitId - The ID of the business unit (required)
      body - The work plan bid to be created (required)
      Returns:
      WorkPlanBid
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWorkplanbids

      public WorkPlanBid postWorkforcemanagementBusinessunitWorkplanbids(PostWorkforcemanagementBusinessunitWorkplanbidsRequest request) throws IOException, ApiException
      Create a new work plan bid
      Parameters:
      request - The request object
      Returns:
      WorkPlanBid
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitWorkplanbids

      public ApiResponse<WorkPlanBid> postWorkforcemanagementBusinessunitWorkplanbids(ApiRequest<CreateWorkPlanBid> request) throws IOException
      Create a new work plan bid
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunits

      public BusinessUnitResponse postWorkforcemanagementBusinessunits(CreateBusinessUnitRequest body, Boolean includeSchedulingDefaultMessageSeverities) throws IOException, ApiException
      Add a new business unit It may take a minute or two for a new business unit to be available for api operations
      Parameters:
      body - body (required)
      includeSchedulingDefaultMessageSeverities - Whether to include scheduling default message severities (optional)
      Returns:
      BusinessUnitResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunitsWithHttpInfo

      public ApiResponse<BusinessUnitResponse> postWorkforcemanagementBusinessunitsWithHttpInfo(CreateBusinessUnitRequest body, Boolean includeSchedulingDefaultMessageSeverities) throws IOException
      Add a new business unit It may take a minute or two for a new business unit to be available for api operations
      Parameters:
      body - body (required)
      includeSchedulingDefaultMessageSeverities - Whether to include scheduling default message severities (optional)
      Returns:
      BusinessUnitResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunits

      public BusinessUnitResponse postWorkforcemanagementBusinessunits(PostWorkforcemanagementBusinessunitsRequest request) throws IOException, ApiException
      Add a new business unit It may take a minute or two for a new business unit to be available for api operations
      Parameters:
      request - The request object
      Returns:
      BusinessUnitResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementBusinessunits

      public ApiResponse<BusinessUnitResponse> postWorkforcemanagementBusinessunits(ApiRequest<CreateBusinessUnitRequest> request) throws IOException
      Add a new business unit It may take a minute or two for a new business unit to be available for api operations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementCalendarUrlIcs

      public CalendarUrlResponse postWorkforcemanagementCalendarUrlIcs(String language) throws IOException, ApiException
      Create a newly generated calendar link for the current user; if the current user has previously generated one, the generated link will be returned
      Parameters:
      language - A language tag (which is sometimes referred to as a \"locale identifier\") to use to localize default activity code names in the ics-formatted calendar (optional, default to "en-US")
      Returns:
      CalendarUrlResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementCalendarUrlIcsWithHttpInfo

      public ApiResponse<CalendarUrlResponse> postWorkforcemanagementCalendarUrlIcsWithHttpInfo(String language) throws IOException
      Create a newly generated calendar link for the current user; if the current user has previously generated one, the generated link will be returned
      Parameters:
      language - A language tag (which is sometimes referred to as a \"locale identifier\") to use to localize default activity code names in the ics-formatted calendar (optional, default to "en-US")
      Returns:
      CalendarUrlResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementCalendarUrlIcs

      public CalendarUrlResponse postWorkforcemanagementCalendarUrlIcs(PostWorkforcemanagementCalendarUrlIcsRequest request) throws IOException, ApiException
      Create a newly generated calendar link for the current user; if the current user has previously generated one, the generated link will be returned
      Parameters:
      request - The request object
      Returns:
      CalendarUrlResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementCalendarUrlIcs

      public ApiResponse<CalendarUrlResponse> postWorkforcemanagementCalendarUrlIcs(ApiRequest<Void> request) throws IOException
      Create a newly generated calendar link for the current user; if the current user has previously generated one, the generated link will be returned
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementHistoricaldataBulkRemoveJobs

      public HistoricalImportDeleteFilesJobResponse postWorkforcemanagementHistoricaldataBulkRemoveJobs(HistoricalImportDeleteFilesJobRequest body) throws IOException, ApiException
      Delete the list of the historical data import entries
      Parameters:
      body - body (required)
      Returns:
      HistoricalImportDeleteFilesJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementHistoricaldataBulkRemoveJobsWithHttpInfo

      public ApiResponse<HistoricalImportDeleteFilesJobResponse> postWorkforcemanagementHistoricaldataBulkRemoveJobsWithHttpInfo(HistoricalImportDeleteFilesJobRequest body) throws IOException
      Delete the list of the historical data import entries
      Parameters:
      body - body (required)
      Returns:
      HistoricalImportDeleteFilesJobResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementHistoricaldataBulkRemoveJobs

      public HistoricalImportDeleteFilesJobResponse postWorkforcemanagementHistoricaldataBulkRemoveJobs(PostWorkforcemanagementHistoricaldataBulkRemoveJobsRequest request) throws IOException, ApiException
      Delete the list of the historical data import entries
      Parameters:
      request - The request object
      Returns:
      HistoricalImportDeleteFilesJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementHistoricaldataBulkRemoveJobs

      public ApiResponse<HistoricalImportDeleteFilesJobResponse> postWorkforcemanagementHistoricaldataBulkRemoveJobs(ApiRequest<HistoricalImportDeleteFilesJobRequest> request) throws IOException
      Delete the list of the historical data import entries
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementHistoricaldataValidate

      public ValidationServiceAsyncResponse postWorkforcemanagementHistoricaldataValidate(ValidationServiceRequest body) throws IOException, ApiException
      Trigger validation process for historical import
      Parameters:
      body - body (required)
      Returns:
      ValidationServiceAsyncResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementHistoricaldataValidateWithHttpInfo

      public ApiResponse<ValidationServiceAsyncResponse> postWorkforcemanagementHistoricaldataValidateWithHttpInfo(ValidationServiceRequest body) throws IOException
      Trigger validation process for historical import
      Parameters:
      body - body (required)
      Returns:
      ValidationServiceAsyncResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementHistoricaldataValidate

      public ValidationServiceAsyncResponse postWorkforcemanagementHistoricaldataValidate(PostWorkforcemanagementHistoricaldataValidateRequest request) throws IOException, ApiException
      Trigger validation process for historical import
      Parameters:
      request - The request object
      Returns:
      ValidationServiceAsyncResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementHistoricaldataValidate

      public ApiResponse<ValidationServiceAsyncResponse> postWorkforcemanagementHistoricaldataValidate(ApiRequest<ValidationServiceRequest> request) throws IOException
      Trigger validation process for historical import
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementIntegrationsHriTimeofftypesJobs

      public HrisTimeOffTypesResponse postWorkforcemanagementIntegrationsHriTimeofftypesJobs(String hrisIntegrationId) throws IOException, ApiException
      Get list of time off types configured in integration
      Parameters:
      hrisIntegrationId - The ID of the HRIS integration for which time off types are queried. (required)
      Returns:
      HrisTimeOffTypesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementIntegrationsHriTimeofftypesJobsWithHttpInfo

      public ApiResponse<HrisTimeOffTypesResponse> postWorkforcemanagementIntegrationsHriTimeofftypesJobsWithHttpInfo(String hrisIntegrationId) throws IOException
      Get list of time off types configured in integration
      Parameters:
      hrisIntegrationId - The ID of the HRIS integration for which time off types are queried. (required)
      Returns:
      HrisTimeOffTypesResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementIntegrationsHriTimeofftypesJobs

      public HrisTimeOffTypesResponse postWorkforcemanagementIntegrationsHriTimeofftypesJobs(PostWorkforcemanagementIntegrationsHriTimeofftypesJobsRequest request) throws IOException, ApiException
      Get list of time off types configured in integration
      Parameters:
      request - The request object
      Returns:
      HrisTimeOffTypesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementIntegrationsHriTimeofftypesJobs

      public ApiResponse<HrisTimeOffTypesResponse> postWorkforcemanagementIntegrationsHriTimeofftypesJobs(ApiRequest<Void> request) throws IOException
      Get list of time off types configured in integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitAgentsWorkplansQuery

      public AgentsWorkPlansResponse postWorkforcemanagementManagementunitAgentsWorkplansQuery(String managementUnitId, GetAgentsWorkPlansRequest body, Boolean forceDownloadService) throws IOException, ApiException
      Get agents work plans configuration
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      AgentsWorkPlansResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitAgentsWorkplansQueryWithHttpInfo

      public ApiResponse<AgentsWorkPlansResponse> postWorkforcemanagementManagementunitAgentsWorkplansQueryWithHttpInfo(String managementUnitId, GetAgentsWorkPlansRequest body, Boolean forceDownloadService) throws IOException
      Get agents work plans configuration
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      AgentsWorkPlansResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitAgentsWorkplansQuery

      public AgentsWorkPlansResponse postWorkforcemanagementManagementunitAgentsWorkplansQuery(PostWorkforcemanagementManagementunitAgentsWorkplansQueryRequest request) throws IOException, ApiException
      Get agents work plans configuration
      Parameters:
      request - The request object
      Returns:
      AgentsWorkPlansResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitAgentsWorkplansQuery

      public ApiResponse<AgentsWorkPlansResponse> postWorkforcemanagementManagementunitAgentsWorkplansQuery(ApiRequest<GetAgentsWorkPlansRequest> request) throws IOException
      Get agents work plans configuration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitAgentschedulesSearch

      public BuAsyncAgentSchedulesSearchResponse postWorkforcemanagementManagementunitAgentschedulesSearch(String managementUnitId, BuSearchAgentSchedulesRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException, ApiException
      Query published schedules for given given time range for set of users
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      BuAsyncAgentSchedulesSearchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitAgentschedulesSearchWithHttpInfo

      public ApiResponse<BuAsyncAgentSchedulesSearchResponse> postWorkforcemanagementManagementunitAgentschedulesSearchWithHttpInfo(String managementUnitId, BuSearchAgentSchedulesRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException
      Query published schedules for given given time range for set of users
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      BuAsyncAgentSchedulesSearchResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitAgentschedulesSearch

      public BuAsyncAgentSchedulesSearchResponse postWorkforcemanagementManagementunitAgentschedulesSearch(PostWorkforcemanagementManagementunitAgentschedulesSearchRequest request) throws IOException, ApiException
      Query published schedules for given given time range for set of users
      Parameters:
      request - The request object
      Returns:
      BuAsyncAgentSchedulesSearchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitAgentschedulesSearch

      public ApiResponse<BuAsyncAgentSchedulesSearchResponse> postWorkforcemanagementManagementunitAgentschedulesSearch(ApiRequest<BuSearchAgentSchedulesRequest> request) throws IOException
      Query published schedules for given given time range for set of users
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitHistoricaladherencequery

      public WfmHistoricalAdherenceResponse postWorkforcemanagementManagementunitHistoricaladherencequery(String managementUnitId, WfmHistoricalAdherenceQuery body) throws IOException, ApiException
      Request a historical adherence report The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
      Parameters:
      managementUnitId - The ID of the management unit (required)
      body - body (required)
      Returns:
      WfmHistoricalAdherenceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitHistoricaladherencequeryWithHttpInfo

      public ApiResponse<WfmHistoricalAdherenceResponse> postWorkforcemanagementManagementunitHistoricaladherencequeryWithHttpInfo(String managementUnitId, WfmHistoricalAdherenceQuery body) throws IOException
      Request a historical adherence report The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
      Parameters:
      managementUnitId - The ID of the management unit (required)
      body - body (required)
      Returns:
      WfmHistoricalAdherenceResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitHistoricaladherencequery

      public WfmHistoricalAdherenceResponse postWorkforcemanagementManagementunitHistoricaladherencequery(PostWorkforcemanagementManagementunitHistoricaladherencequeryRequest request) throws IOException, ApiException
      Request a historical adherence report The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
      Parameters:
      request - The request object
      Returns:
      WfmHistoricalAdherenceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitHistoricaladherencequery

      public ApiResponse<WfmHistoricalAdherenceResponse> postWorkforcemanagementManagementunitHistoricaladherencequery(ApiRequest<WfmHistoricalAdherenceQuery> request) throws IOException
      Request a historical adherence report The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitMove

      public MoveManagementUnitResponse postWorkforcemanagementManagementunitMove(String managementUnitId, MoveManagementUnitRequest body) throws IOException, ApiException
      Move the requested management unit to a new business unit Returns status 200 if the management unit is already in the requested business unit
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      Returns:
      MoveManagementUnitResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitMoveWithHttpInfo

      public ApiResponse<MoveManagementUnitResponse> postWorkforcemanagementManagementunitMoveWithHttpInfo(String managementUnitId, MoveManagementUnitRequest body) throws IOException
      Move the requested management unit to a new business unit Returns status 200 if the management unit is already in the requested business unit
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      Returns:
      MoveManagementUnitResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitMove

      public MoveManagementUnitResponse postWorkforcemanagementManagementunitMove(PostWorkforcemanagementManagementunitMoveRequest request) throws IOException, ApiException
      Move the requested management unit to a new business unit Returns status 200 if the management unit is already in the requested business unit
      Parameters:
      request - The request object
      Returns:
      MoveManagementUnitResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitMove

      public ApiResponse<MoveManagementUnitResponse> postWorkforcemanagementManagementunitMove(ApiRequest<MoveManagementUnitRequest> request) throws IOException
      Move the requested management unit to a new business unit Returns status 200 if the management unit is already in the requested business unit
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitSchedulesSearch

      public UserScheduleContainer postWorkforcemanagementManagementunitSchedulesSearch(String managementUnitId, UserListScheduleRequestBody body) throws IOException, ApiException
      Deprecated.
      Query published schedules for given given time range for set of users
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      Returns:
      UserScheduleContainer
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitSchedulesSearchWithHttpInfo

      public ApiResponse<UserScheduleContainer> postWorkforcemanagementManagementunitSchedulesSearchWithHttpInfo(String managementUnitId, UserListScheduleRequestBody body) throws IOException
      Deprecated.
      Query published schedules for given given time range for set of users
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      Returns:
      UserScheduleContainer
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitSchedulesSearch

      public UserScheduleContainer postWorkforcemanagementManagementunitSchedulesSearch(PostWorkforcemanagementManagementunitSchedulesSearchRequest request) throws IOException, ApiException
      Deprecated.
      Query published schedules for given given time range for set of users
      Parameters:
      request - The request object
      Returns:
      UserScheduleContainer
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitSchedulesSearch

      public ApiResponse<UserScheduleContainer> postWorkforcemanagementManagementunitSchedulesSearch(ApiRequest<UserListScheduleRequestBody> request) throws IOException
      Deprecated.
      Query published schedules for given given time range for set of users
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitShrinkageJobs

      public WfmHistoricalShrinkageResponse postWorkforcemanagementManagementunitShrinkageJobs(String managementUnitId, WfmHistoricalShrinkageRequest body) throws IOException, ApiException
      Request a historical shrinkage report The maximum supported range for historical shrinkage queries is up to 32 days. Historical Shrinkage for a given date range can be queried in two modes - granular and aggregated. To see granular shrinkage information, provide granularity in the request body.
      Parameters:
      managementUnitId - The ID of the management unit (required)
      body - body (required)
      Returns:
      WfmHistoricalShrinkageResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitShrinkageJobsWithHttpInfo

      public ApiResponse<WfmHistoricalShrinkageResponse> postWorkforcemanagementManagementunitShrinkageJobsWithHttpInfo(String managementUnitId, WfmHistoricalShrinkageRequest body) throws IOException
      Request a historical shrinkage report The maximum supported range for historical shrinkage queries is up to 32 days. Historical Shrinkage for a given date range can be queried in two modes - granular and aggregated. To see granular shrinkage information, provide granularity in the request body.
      Parameters:
      managementUnitId - The ID of the management unit (required)
      body - body (required)
      Returns:
      WfmHistoricalShrinkageResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitShrinkageJobs

      public WfmHistoricalShrinkageResponse postWorkforcemanagementManagementunitShrinkageJobs(PostWorkforcemanagementManagementunitShrinkageJobsRequest request) throws IOException, ApiException
      Request a historical shrinkage report The maximum supported range for historical shrinkage queries is up to 32 days. Historical Shrinkage for a given date range can be queried in two modes - granular and aggregated. To see granular shrinkage information, provide granularity in the request body.
      Parameters:
      request - The request object
      Returns:
      WfmHistoricalShrinkageResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitShrinkageJobs

      public ApiResponse<WfmHistoricalShrinkageResponse> postWorkforcemanagementManagementunitShrinkageJobs(ApiRequest<WfmHistoricalShrinkageRequest> request) throws IOException
      Request a historical shrinkage report The maximum supported range for historical shrinkage queries is up to 32 days. Historical Shrinkage for a given date range can be queried in two modes - granular and aggregated. To see granular shrinkage information, provide granularity in the request body.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeofflimits

      public TimeOffLimit postWorkforcemanagementManagementunitTimeofflimits(String managementUnitId, CreateTimeOffLimitRequest body) throws IOException, ApiException
      Creates a new time off limit object under management unit. Only one limit object is allowed under management unit, so an attempt to create second object will fail.
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      body - body (required)
      Returns:
      TimeOffLimit
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeofflimitsWithHttpInfo

      public ApiResponse<TimeOffLimit> postWorkforcemanagementManagementunitTimeofflimitsWithHttpInfo(String managementUnitId, CreateTimeOffLimitRequest body) throws IOException
      Creates a new time off limit object under management unit. Only one limit object is allowed under management unit, so an attempt to create second object will fail.
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      body - body (required)
      Returns:
      TimeOffLimit
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeofflimits

      public TimeOffLimit postWorkforcemanagementManagementunitTimeofflimits(PostWorkforcemanagementManagementunitTimeofflimitsRequest request) throws IOException, ApiException
      Creates a new time off limit object under management unit. Only one limit object is allowed under management unit, so an attempt to create second object will fail.
      Parameters:
      request - The request object
      Returns:
      TimeOffLimit
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeofflimits

      public ApiResponse<TimeOffLimit> postWorkforcemanagementManagementunitTimeofflimits(ApiRequest<CreateTimeOffLimitRequest> request) throws IOException
      Creates a new time off limit object under management unit. Only one limit object is allowed under management unit, so an attempt to create second object will fail.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeofflimitsValuesQuery

      public QueryTimeOffLimitValuesResponse postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(String managementUnitId, QueryTimeOffLimitValuesRequest body) throws IOException, ApiException
      Retrieves time off limit related values based on a given set of filters.
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      body - body (required)
      Returns:
      QueryTimeOffLimitValuesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeofflimitsValuesQueryWithHttpInfo

      public ApiResponse<QueryTimeOffLimitValuesResponse> postWorkforcemanagementManagementunitTimeofflimitsValuesQueryWithHttpInfo(String managementUnitId, QueryTimeOffLimitValuesRequest body) throws IOException
      Retrieves time off limit related values based on a given set of filters.
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      body - body (required)
      Returns:
      QueryTimeOffLimitValuesResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeofflimitsValuesQuery

      public QueryTimeOffLimitValuesResponse postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(PostWorkforcemanagementManagementunitTimeofflimitsValuesQueryRequest request) throws IOException, ApiException
      Retrieves time off limit related values based on a given set of filters.
      Parameters:
      request - The request object
      Returns:
      QueryTimeOffLimitValuesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeofflimitsValuesQuery

      public ApiResponse<QueryTimeOffLimitValuesResponse> postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(ApiRequest<QueryTimeOffLimitValuesRequest> request) throws IOException
      Retrieves time off limit related values based on a given set of filters.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeoffplans

      public TimeOffPlan postWorkforcemanagementManagementunitTimeoffplans(String managementUnitId, CreateTimeOffPlanRequest body) throws IOException, ApiException
      Creates a new time off plan
      Parameters:
      managementUnitId - The ID of the management unit (required)
      body - body (required)
      Returns:
      TimeOffPlan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeoffplansWithHttpInfo

      public ApiResponse<TimeOffPlan> postWorkforcemanagementManagementunitTimeoffplansWithHttpInfo(String managementUnitId, CreateTimeOffPlanRequest body) throws IOException
      Creates a new time off plan
      Parameters:
      managementUnitId - The ID of the management unit (required)
      body - body (required)
      Returns:
      TimeOffPlan
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeoffplans

      public TimeOffPlan postWorkforcemanagementManagementunitTimeoffplans(PostWorkforcemanagementManagementunitTimeoffplansRequest request) throws IOException, ApiException
      Creates a new time off plan
      Parameters:
      request - The request object
      Returns:
      TimeOffPlan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeoffplans

      public ApiResponse<TimeOffPlan> postWorkforcemanagementManagementunitTimeoffplans(ApiRequest<CreateTimeOffPlanRequest> request) throws IOException
      Creates a new time off plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeoffrequests

      public TimeOffRequestList postWorkforcemanagementManagementunitTimeoffrequests(String managementUnitId, CreateAdminTimeOffRequest body) throws IOException, ApiException
      Create a new time off request
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      Returns:
      TimeOffRequestList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeoffrequestsWithHttpInfo

      public ApiResponse<TimeOffRequestList> postWorkforcemanagementManagementunitTimeoffrequestsWithHttpInfo(String managementUnitId, CreateAdminTimeOffRequest body) throws IOException
      Create a new time off request
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      Returns:
      TimeOffRequestList
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeoffrequests

      public TimeOffRequestList postWorkforcemanagementManagementunitTimeoffrequests(PostWorkforcemanagementManagementunitTimeoffrequestsRequest request) throws IOException, ApiException
      Create a new time off request
      Parameters:
      request - The request object
      Returns:
      TimeOffRequestList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeoffrequests

      public ApiResponse<TimeOffRequestList> postWorkforcemanagementManagementunitTimeoffrequests(ApiRequest<CreateAdminTimeOffRequest> request) throws IOException
      Create a new time off request
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery

      public UserTimeOffIntegrationStatusResponseListing postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(String managementUnitId, QueryTimeOffIntegrationStatusRequest body) throws IOException, ApiException
      Retrieves integration statuses for a list of time off requests
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      body - body (required)
      Returns:
      UserTimeOffIntegrationStatusResponseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQueryWithHttpInfo

      public ApiResponse<UserTimeOffIntegrationStatusResponseListing> postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQueryWithHttpInfo(String managementUnitId, QueryTimeOffIntegrationStatusRequest body) throws IOException
      Retrieves integration statuses for a list of time off requests
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      body - body (required)
      Returns:
      UserTimeOffIntegrationStatusResponseListing
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery

      public UserTimeOffIntegrationStatusResponseListing postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(PostWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQueryRequest request) throws IOException, ApiException
      Retrieves integration statuses for a list of time off requests
      Parameters:
      request - The request object
      Returns:
      UserTimeOffIntegrationStatusResponseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery

      public ApiResponse<UserTimeOffIntegrationStatusResponseListing> postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(ApiRequest<QueryTimeOffIntegrationStatusRequest> request) throws IOException
      Retrieves integration statuses for a list of time off requests
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeoffrequestsQuery

      public TimeOffRequestListing postWorkforcemanagementManagementunitTimeoffrequestsQuery(String managementUnitId, TimeOffRequestQueryBody body, Boolean forceDownloadService) throws IOException, ApiException
      Fetches time off requests matching the conditions specified in the request body Request body requires one of the following: statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      TimeOffRequestListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeoffrequestsQueryWithHttpInfo

      public ApiResponse<TimeOffRequestListing> postWorkforcemanagementManagementunitTimeoffrequestsQueryWithHttpInfo(String managementUnitId, TimeOffRequestQueryBody body, Boolean forceDownloadService) throws IOException
      Fetches time off requests matching the conditions specified in the request body Request body requires one of the following: statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      TimeOffRequestListing
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeoffrequestsQuery

      public TimeOffRequestListing postWorkforcemanagementManagementunitTimeoffrequestsQuery(PostWorkforcemanagementManagementunitTimeoffrequestsQueryRequest request) throws IOException, ApiException
      Fetches time off requests matching the conditions specified in the request body Request body requires one of the following: statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters
      Parameters:
      request - The request object
      Returns:
      TimeOffRequestListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeoffrequestsQuery

      public ApiResponse<TimeOffRequestListing> postWorkforcemanagementManagementunitTimeoffrequestsQuery(ApiRequest<TimeOffRequestQueryBody> request) throws IOException
      Fetches time off requests matching the conditions specified in the request body Request body requires one of the following: statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery

      public WaitlistPositionListing postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(String managementUnitId, QueryWaitlistPositionsRequest body) throws IOException, ApiException
      Retrieves daily waitlist position for a list of time off requests
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      body - body (required)
      Returns:
      WaitlistPositionListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQueryWithHttpInfo

      public ApiResponse<WaitlistPositionListing> postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQueryWithHttpInfo(String managementUnitId, QueryWaitlistPositionsRequest body) throws IOException
      Retrieves daily waitlist position for a list of time off requests
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      body - body (required)
      Returns:
      WaitlistPositionListing
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery

      public WaitlistPositionListing postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(PostWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQueryRequest request) throws IOException, ApiException
      Retrieves daily waitlist position for a list of time off requests
      Parameters:
      request - The request object
      Returns:
      WaitlistPositionListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery

      public ApiResponse<WaitlistPositionListing> postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(ApiRequest<QueryWaitlistPositionsRequest> request) throws IOException
      Retrieves daily waitlist position for a list of time off requests
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitUserTimeoffbalanceJobs

      public TimeOffBalancesResponse postWorkforcemanagementManagementunitUserTimeoffbalanceJobs(String managementUnitId, String userId, TimeOffBalanceRequest body) throws IOException, ApiException
      Query time off balances for a given user for specified activity code and dates
      Parameters:
      managementUnitId - The ID of the management unit (required)
      userId - The ID of the user (required)
      body - The request body (required)
      Returns:
      TimeOffBalancesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitUserTimeoffbalanceJobsWithHttpInfo

      public ApiResponse<TimeOffBalancesResponse> postWorkforcemanagementManagementunitUserTimeoffbalanceJobsWithHttpInfo(String managementUnitId, String userId, TimeOffBalanceRequest body) throws IOException
      Query time off balances for a given user for specified activity code and dates
      Parameters:
      managementUnitId - The ID of the management unit (required)
      userId - The ID of the user (required)
      body - The request body (required)
      Returns:
      TimeOffBalancesResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitUserTimeoffbalanceJobs

      public TimeOffBalancesResponse postWorkforcemanagementManagementunitUserTimeoffbalanceJobs(PostWorkforcemanagementManagementunitUserTimeoffbalanceJobsRequest request) throws IOException, ApiException
      Query time off balances for a given user for specified activity code and dates
      Parameters:
      request - The request object
      Returns:
      TimeOffBalancesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitUserTimeoffbalanceJobs

      public ApiResponse<TimeOffBalancesResponse> postWorkforcemanagementManagementunitUserTimeoffbalanceJobs(ApiRequest<TimeOffBalanceRequest> request) throws IOException
      Query time off balances for a given user for specified activity code and dates
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs

      public TimeOffBalancesResponse postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs(String managementUnitId, String userId, String timeOffRequestId) throws IOException, ApiException
      Query time off balances for dates spanned by a given time off request
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      userId - The userId to whom the time off request applies. (required)
      timeOffRequestId - The time off request id. (required)
      Returns:
      TimeOffBalancesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobsWithHttpInfo

      public ApiResponse<TimeOffBalancesResponse> postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobsWithHttpInfo(String managementUnitId, String userId, String timeOffRequestId) throws IOException
      Query time off balances for dates spanned by a given time off request
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      userId - The userId to whom the time off request applies. (required)
      timeOffRequestId - The time off request id. (required)
      Returns:
      TimeOffBalancesResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs

      public TimeOffBalancesResponse postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs(PostWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobsRequest request) throws IOException, ApiException
      Query time off balances for dates spanned by a given time off request
      Parameters:
      request - The request object
      Returns:
      TimeOffBalancesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs

      public ApiResponse<TimeOffBalancesResponse> postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs(ApiRequest<Void> request) throws IOException
      Query time off balances for dates spanned by a given time off request
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate

      public EstimateAvailableTimeOffResponse postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(String managementUnitId, String userId, EstimateAvailableTimeOffRequest body, String includeOnly) throws IOException, ApiException
      Estimates available time off for an agent
      Parameters:
      managementUnitId - The ID of the management unit (required)
      userId - The id of the user for whom the time off request estimate is requested (required)
      body - body (required)
      includeOnly - Limit response to the specified field (optional)
      Returns:
      EstimateAvailableTimeOffResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitUserTimeoffrequestsEstimateWithHttpInfo

      public ApiResponse<EstimateAvailableTimeOffResponse> postWorkforcemanagementManagementunitUserTimeoffrequestsEstimateWithHttpInfo(String managementUnitId, String userId, EstimateAvailableTimeOffRequest body, String includeOnly) throws IOException
      Estimates available time off for an agent
      Parameters:
      managementUnitId - The ID of the management unit (required)
      userId - The id of the user for whom the time off request estimate is requested (required)
      body - body (required)
      includeOnly - Limit response to the specified field (optional)
      Returns:
      EstimateAvailableTimeOffResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate

      public EstimateAvailableTimeOffResponse postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(PostWorkforcemanagementManagementunitUserTimeoffrequestsEstimateRequest request) throws IOException, ApiException
      Estimates available time off for an agent
      Parameters:
      request - The request object
      Returns:
      EstimateAvailableTimeOffResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate

      public ApiResponse<EstimateAvailableTimeOffResponse> postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(ApiRequest<EstimateAvailableTimeOffRequest> request) throws IOException
      Estimates available time off for an agent
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWeekShifttradeMatch

      public MatchShiftTradeResponse postWorkforcemanagementManagementunitWeekShifttradeMatch(String managementUnitId, LocalDate weekDateId, String tradeId, MatchShiftTradeRequest body) throws IOException, ApiException
      Deprecated.
      Matches a shift trade. This route can only be called by the receiving agent Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/match/jobs)
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      weekDateId - The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      tradeId - The ID of the shift trade to update (required)
      body - body (required)
      Returns:
      MatchShiftTradeResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWeekShifttradeMatchWithHttpInfo

      public ApiResponse<MatchShiftTradeResponse> postWorkforcemanagementManagementunitWeekShifttradeMatchWithHttpInfo(String managementUnitId, LocalDate weekDateId, String tradeId, MatchShiftTradeRequest body) throws IOException
      Deprecated.
      Matches a shift trade. This route can only be called by the receiving agent Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/match/jobs)
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      weekDateId - The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      tradeId - The ID of the shift trade to update (required)
      body - body (required)
      Returns:
      MatchShiftTradeResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWeekShifttradeMatch

      public MatchShiftTradeResponse postWorkforcemanagementManagementunitWeekShifttradeMatch(PostWorkforcemanagementManagementunitWeekShifttradeMatchRequest request) throws IOException, ApiException
      Deprecated.
      Matches a shift trade. This route can only be called by the receiving agent Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/match/jobs)
      Parameters:
      request - The request object
      Returns:
      MatchShiftTradeResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWeekShifttradeMatch

      public ApiResponse<MatchShiftTradeResponse> postWorkforcemanagementManagementunitWeekShifttradeMatch(ApiRequest<MatchShiftTradeRequest> request) throws IOException
      Deprecated.
      Matches a shift trade. This route can only be called by the receiving agent Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/match/jobs)
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWeekShifttrades

      public ShiftTradeResponse postWorkforcemanagementManagementunitWeekShifttrades(String managementUnitId, LocalDate weekDateId, AddShiftTradeRequest body) throws IOException, ApiException
      Deprecated.
      Adds a shift trade Deprecated. Use new route instead (/shifttrading/trades/jobs)
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      weekDateId - The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      body - body (required)
      Returns:
      ShiftTradeResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWeekShifttradesWithHttpInfo

      public ApiResponse<ShiftTradeResponse> postWorkforcemanagementManagementunitWeekShifttradesWithHttpInfo(String managementUnitId, LocalDate weekDateId, AddShiftTradeRequest body) throws IOException
      Deprecated.
      Adds a shift trade Deprecated. Use new route instead (/shifttrading/trades/jobs)
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      weekDateId - The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      body - body (required)
      Returns:
      ShiftTradeResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWeekShifttrades

      public ShiftTradeResponse postWorkforcemanagementManagementunitWeekShifttrades(PostWorkforcemanagementManagementunitWeekShifttradesRequest request) throws IOException, ApiException
      Deprecated.
      Adds a shift trade Deprecated. Use new route instead (/shifttrading/trades/jobs)
      Parameters:
      request - The request object
      Returns:
      ShiftTradeResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWeekShifttrades

      public ApiResponse<ShiftTradeResponse> postWorkforcemanagementManagementunitWeekShifttrades(ApiRequest<AddShiftTradeRequest> request) throws IOException
      Deprecated.
      Adds a shift trade Deprecated. Use new route instead (/shifttrading/trades/jobs)
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWeekShifttradesSearch

      public SearchShiftTradesResponse postWorkforcemanagementManagementunitWeekShifttradesSearch(String managementUnitId, LocalDate weekDateId, SearchShiftTradesRequest body, Boolean forceDownloadService) throws IOException, ApiException
      Deprecated.
      Searches for potential shift trade matches for the current agent Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs)
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      weekDateId - The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      body - body (required)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      SearchShiftTradesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWeekShifttradesSearchWithHttpInfo

      public ApiResponse<SearchShiftTradesResponse> postWorkforcemanagementManagementunitWeekShifttradesSearchWithHttpInfo(String managementUnitId, LocalDate weekDateId, SearchShiftTradesRequest body, Boolean forceDownloadService) throws IOException
      Deprecated.
      Searches for potential shift trade matches for the current agent Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs)
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      weekDateId - The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      body - body (required)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      SearchShiftTradesResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWeekShifttradesSearch

      public SearchShiftTradesResponse postWorkforcemanagementManagementunitWeekShifttradesSearch(PostWorkforcemanagementManagementunitWeekShifttradesSearchRequest request) throws IOException, ApiException
      Deprecated.
      Searches for potential shift trade matches for the current agent Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs)
      Parameters:
      request - The request object
      Returns:
      SearchShiftTradesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWeekShifttradesSearch

      public ApiResponse<SearchShiftTradesResponse> postWorkforcemanagementManagementunitWeekShifttradesSearch(ApiRequest<SearchShiftTradesRequest> request) throws IOException
      Deprecated.
      Searches for potential shift trade matches for the current agent Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs)
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWeekShifttradesStateBulk

      public BulkUpdateShiftTradeStateResponse postWorkforcemanagementManagementunitWeekShifttradesStateBulk(String managementUnitId, LocalDate weekDateId, BulkShiftTradeStateUpdateRequest body, Boolean forceAsync) throws IOException, ApiException
      Deprecated.
      Updates the state of a batch of shift trades Admin functionality is not supported with \"mine\". Deprecated. Use new route instead (/businessunits/{buId}/shifttrading/trades/state/bulk/jobs)
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      weekDateId - The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      body - body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      BulkUpdateShiftTradeStateResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWeekShifttradesStateBulkWithHttpInfo

      public ApiResponse<BulkUpdateShiftTradeStateResponse> postWorkforcemanagementManagementunitWeekShifttradesStateBulkWithHttpInfo(String managementUnitId, LocalDate weekDateId, BulkShiftTradeStateUpdateRequest body, Boolean forceAsync) throws IOException
      Deprecated.
      Updates the state of a batch of shift trades Admin functionality is not supported with \"mine\". Deprecated. Use new route instead (/businessunits/{buId}/shifttrading/trades/state/bulk/jobs)
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      weekDateId - The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)
      body - body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      BulkUpdateShiftTradeStateResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWeekShifttradesStateBulk

      public BulkUpdateShiftTradeStateResponse postWorkforcemanagementManagementunitWeekShifttradesStateBulk(PostWorkforcemanagementManagementunitWeekShifttradesStateBulkRequest request) throws IOException, ApiException
      Deprecated.
      Updates the state of a batch of shift trades Admin functionality is not supported with \"mine\". Deprecated. Use new route instead (/businessunits/{buId}/shifttrading/trades/state/bulk/jobs)
      Parameters:
      request - The request object
      Returns:
      BulkUpdateShiftTradeStateResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWeekShifttradesStateBulk

      public ApiResponse<BulkUpdateShiftTradeStateResponse> postWorkforcemanagementManagementunitWeekShifttradesStateBulk(ApiRequest<BulkShiftTradeStateUpdateRequest> request) throws IOException
      Deprecated.
      Updates the state of a batch of shift trades Admin functionality is not supported with \"mine\". Deprecated. Use new route instead (/businessunits/{buId}/shifttrading/trades/state/bulk/jobs)
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWorkplanCopy

      public WorkPlan postWorkforcemanagementManagementunitWorkplanCopy(String managementUnitId, String workPlanId, CopyWorkPlan body) throws IOException, ApiException
      Create a copy of work plan
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      workPlanId - The ID of the work plan to create a copy (required)
      body - body (required)
      Returns:
      WorkPlan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWorkplanCopyWithHttpInfo

      public ApiResponse<WorkPlan> postWorkforcemanagementManagementunitWorkplanCopyWithHttpInfo(String managementUnitId, String workPlanId, CopyWorkPlan body) throws IOException
      Create a copy of work plan
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      workPlanId - The ID of the work plan to create a copy (required)
      body - body (required)
      Returns:
      WorkPlan
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWorkplanCopy

      public WorkPlan postWorkforcemanagementManagementunitWorkplanCopy(PostWorkforcemanagementManagementunitWorkplanCopyRequest request) throws IOException, ApiException
      Create a copy of work plan
      Parameters:
      request - The request object
      Returns:
      WorkPlan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWorkplanCopy

      public ApiResponse<WorkPlan> postWorkforcemanagementManagementunitWorkplanCopy(ApiRequest<CopyWorkPlan> request) throws IOException
      Create a copy of work plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWorkplanValidate

      public ValidateWorkPlanResponse postWorkforcemanagementManagementunitWorkplanValidate(String managementUnitId, String workPlanId, WorkPlanValidationRequest body, List<String> expand) throws IOException, ApiException
      Validate Work Plan
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      workPlanId - The ID of the work plan to validate. For new work plan, use the word 'new' for the ID. (required)
      body - body (required)
      expand - (optional)
      Returns:
      ValidateWorkPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWorkplanValidateWithHttpInfo

      public ApiResponse<ValidateWorkPlanResponse> postWorkforcemanagementManagementunitWorkplanValidateWithHttpInfo(String managementUnitId, String workPlanId, WorkPlanValidationRequest body, List<String> expand) throws IOException
      Validate Work Plan
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      workPlanId - The ID of the work plan to validate. For new work plan, use the word 'new' for the ID. (required)
      body - body (required)
      expand - (optional)
      Returns:
      ValidateWorkPlanResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWorkplanValidate

      public ValidateWorkPlanResponse postWorkforcemanagementManagementunitWorkplanValidate(PostWorkforcemanagementManagementunitWorkplanValidateRequest request) throws IOException, ApiException
      Validate Work Plan
      Parameters:
      request - The request object
      Returns:
      ValidateWorkPlanResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWorkplanValidate

      public ApiResponse<ValidateWorkPlanResponse> postWorkforcemanagementManagementunitWorkplanValidate(ApiRequest<WorkPlanValidationRequest> request) throws IOException
      Validate Work Plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWorkplanrotationCopy

      public WorkPlanRotationResponse postWorkforcemanagementManagementunitWorkplanrotationCopy(String managementUnitId, String workPlanRotationId, CopyWorkPlanRotationRequest body) throws IOException, ApiException
      Create a copy of work plan rotation
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      workPlanRotationId - The ID of the work plan rotation to create a copy (required)
      body - body (required)
      Returns:
      WorkPlanRotationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWorkplanrotationCopyWithHttpInfo

      public ApiResponse<WorkPlanRotationResponse> postWorkforcemanagementManagementunitWorkplanrotationCopyWithHttpInfo(String managementUnitId, String workPlanRotationId, CopyWorkPlanRotationRequest body) throws IOException
      Create a copy of work plan rotation
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      workPlanRotationId - The ID of the work plan rotation to create a copy (required)
      body - body (required)
      Returns:
      WorkPlanRotationResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWorkplanrotationCopy

      public WorkPlanRotationResponse postWorkforcemanagementManagementunitWorkplanrotationCopy(PostWorkforcemanagementManagementunitWorkplanrotationCopyRequest request) throws IOException, ApiException
      Create a copy of work plan rotation
      Parameters:
      request - The request object
      Returns:
      WorkPlanRotationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWorkplanrotationCopy

      public ApiResponse<WorkPlanRotationResponse> postWorkforcemanagementManagementunitWorkplanrotationCopy(ApiRequest<CopyWorkPlanRotationRequest> request) throws IOException
      Create a copy of work plan rotation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWorkplanrotations

      public WorkPlanRotationResponse postWorkforcemanagementManagementunitWorkplanrotations(String managementUnitId, AddWorkPlanRotationRequest body) throws IOException, ApiException
      Create a new work plan rotation
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      Returns:
      WorkPlanRotationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWorkplanrotationsWithHttpInfo

      public ApiResponse<WorkPlanRotationResponse> postWorkforcemanagementManagementunitWorkplanrotationsWithHttpInfo(String managementUnitId, AddWorkPlanRotationRequest body) throws IOException
      Create a new work plan rotation
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      Returns:
      WorkPlanRotationResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWorkplanrotations

      public WorkPlanRotationResponse postWorkforcemanagementManagementunitWorkplanrotations(PostWorkforcemanagementManagementunitWorkplanrotationsRequest request) throws IOException, ApiException
      Create a new work plan rotation
      Parameters:
      request - The request object
      Returns:
      WorkPlanRotationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWorkplanrotations

      public ApiResponse<WorkPlanRotationResponse> postWorkforcemanagementManagementunitWorkplanrotations(ApiRequest<AddWorkPlanRotationRequest> request) throws IOException
      Create a new work plan rotation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWorkplans

      public WorkPlan postWorkforcemanagementManagementunitWorkplans(String managementUnitId, CreateWorkPlan body, String validationMode) throws IOException, ApiException
      Create a new work plan
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      validationMode - Allows to create work plan even if the validation result is invalid (optional)
      Returns:
      WorkPlan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWorkplansWithHttpInfo

      public ApiResponse<WorkPlan> postWorkforcemanagementManagementunitWorkplansWithHttpInfo(String managementUnitId, CreateWorkPlan body, String validationMode) throws IOException
      Create a new work plan
      Parameters:
      managementUnitId - The ID of the management unit, or 'mine' for the management unit of the logged-in user. (required)
      body - body (required)
      validationMode - Allows to create work plan even if the validation result is invalid (optional)
      Returns:
      WorkPlan
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWorkplans

      public WorkPlan postWorkforcemanagementManagementunitWorkplans(PostWorkforcemanagementManagementunitWorkplansRequest request) throws IOException, ApiException
      Create a new work plan
      Parameters:
      request - The request object
      Returns:
      WorkPlan
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitWorkplans

      public ApiResponse<WorkPlan> postWorkforcemanagementManagementunitWorkplans(ApiRequest<CreateWorkPlan> request) throws IOException
      Create a new work plan
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunits

      public ManagementUnit postWorkforcemanagementManagementunits(CreateManagementUnitApiRequest body) throws IOException, ApiException
      Add a management unit It may take a minute or two for a new management unit to be available for api operations
      Parameters:
      body - body (required)
      Returns:
      ManagementUnit
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunitsWithHttpInfo

      public ApiResponse<ManagementUnit> postWorkforcemanagementManagementunitsWithHttpInfo(CreateManagementUnitApiRequest body) throws IOException
      Add a management unit It may take a minute or two for a new management unit to be available for api operations
      Parameters:
      body - body (required)
      Returns:
      ManagementUnit
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunits

      public ManagementUnit postWorkforcemanagementManagementunits(PostWorkforcemanagementManagementunitsRequest request) throws IOException, ApiException
      Add a management unit It may take a minute or two for a new management unit to be available for api operations
      Parameters:
      request - The request object
      Returns:
      ManagementUnit
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementManagementunits

      public ApiResponse<ManagementUnit> postWorkforcemanagementManagementunits(ApiRequest<CreateManagementUnitApiRequest> request) throws IOException
      Add a management unit It may take a minute or two for a new management unit to be available for api operations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementNotificationsUpdate

      public UpdateNotificationsResponse postWorkforcemanagementNotificationsUpdate(UpdateNotificationsRequest body) throws IOException, ApiException
      Mark a list of notifications as read or unread
      Parameters:
      body - body (required)
      Returns:
      UpdateNotificationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementNotificationsUpdateWithHttpInfo

      public ApiResponse<UpdateNotificationsResponse> postWorkforcemanagementNotificationsUpdateWithHttpInfo(UpdateNotificationsRequest body) throws IOException
      Mark a list of notifications as read or unread
      Parameters:
      body - body (required)
      Returns:
      UpdateNotificationsResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementNotificationsUpdate

      public UpdateNotificationsResponse postWorkforcemanagementNotificationsUpdate(PostWorkforcemanagementNotificationsUpdateRequest request) throws IOException, ApiException
      Mark a list of notifications as read or unread
      Parameters:
      request - The request object
      Returns:
      UpdateNotificationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementNotificationsUpdate

      public ApiResponse<UpdateNotificationsResponse> postWorkforcemanagementNotificationsUpdate(ApiRequest<UpdateNotificationsRequest> request) throws IOException
      Mark a list of notifications as read or unread
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementSchedules

      public UserScheduleContainer postWorkforcemanagementSchedules(CurrentUserScheduleRequestBody body) throws IOException, ApiException
      Deprecated.
      Get published schedule for the current user
      Parameters:
      body - body (optional)
      Returns:
      UserScheduleContainer
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementSchedulesWithHttpInfo

      public ApiResponse<UserScheduleContainer> postWorkforcemanagementSchedulesWithHttpInfo(CurrentUserScheduleRequestBody body) throws IOException
      Deprecated.
      Get published schedule for the current user
      Parameters:
      body - body (optional)
      Returns:
      UserScheduleContainer
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementSchedules

      public UserScheduleContainer postWorkforcemanagementSchedules(PostWorkforcemanagementSchedulesRequest request) throws IOException, ApiException
      Deprecated.
      Get published schedule for the current user
      Parameters:
      request - The request object
      Returns:
      UserScheduleContainer
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementSchedules

      public ApiResponse<UserScheduleContainer> postWorkforcemanagementSchedules(ApiRequest<CurrentUserScheduleRequestBody> request) throws IOException
      Deprecated.
      Get published schedule for the current user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementShifttradingTradeJobs

      public ShiftTradeUpdateTradeJobResponse postWorkforcemanagementShifttradingTradeJobs(String tradeId, UpdateShiftTradeJobRequest body, Boolean forceAsync) throws IOException, ApiException
      Updates a shift trade. This route can only be called by the initiating user
      Parameters:
      tradeId - The ID of the shift trade to update (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      ShiftTradeUpdateTradeJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementShifttradingTradeJobsWithHttpInfo

      public ApiResponse<ShiftTradeUpdateTradeJobResponse> postWorkforcemanagementShifttradingTradeJobsWithHttpInfo(String tradeId, UpdateShiftTradeJobRequest body, Boolean forceAsync) throws IOException
      Updates a shift trade. This route can only be called by the initiating user
      Parameters:
      tradeId - The ID of the shift trade to update (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      ShiftTradeUpdateTradeJobResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementShifttradingTradeJobs

      public ShiftTradeUpdateTradeJobResponse postWorkforcemanagementShifttradingTradeJobs(PostWorkforcemanagementShifttradingTradeJobsRequest request) throws IOException, ApiException
      Updates a shift trade. This route can only be called by the initiating user
      Parameters:
      request - The request object
      Returns:
      ShiftTradeUpdateTradeJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementShifttradingTradeJobs

      public ApiResponse<ShiftTradeUpdateTradeJobResponse> postWorkforcemanagementShifttradingTradeJobs(ApiRequest<UpdateShiftTradeJobRequest> request) throws IOException
      Updates a shift trade. This route can only be called by the initiating user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementShifttradingTradeMatchJobs

      public ShiftTradeMatchTradeJobResponse postWorkforcemanagementShifttradingTradeMatchJobs(String tradeId, MatchShiftTradeJobRequest body, Boolean forceAsync) throws IOException, ApiException
      Matches a shift trade. This route can only be called by the receiving user
      Parameters:
      tradeId - The ID of the shift trade to match (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      ShiftTradeMatchTradeJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementShifttradingTradeMatchJobsWithHttpInfo

      public ApiResponse<ShiftTradeMatchTradeJobResponse> postWorkforcemanagementShifttradingTradeMatchJobsWithHttpInfo(String tradeId, MatchShiftTradeJobRequest body, Boolean forceAsync) throws IOException
      Matches a shift trade. This route can only be called by the receiving user
      Parameters:
      tradeId - The ID of the shift trade to match (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      ShiftTradeMatchTradeJobResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementShifttradingTradeMatchJobs

      public ShiftTradeMatchTradeJobResponse postWorkforcemanagementShifttradingTradeMatchJobs(PostWorkforcemanagementShifttradingTradeMatchJobsRequest request) throws IOException, ApiException
      Matches a shift trade. This route can only be called by the receiving user
      Parameters:
      request - The request object
      Returns:
      ShiftTradeMatchTradeJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementShifttradingTradeMatchJobs

      public ApiResponse<ShiftTradeMatchTradeJobResponse> postWorkforcemanagementShifttradingTradeMatchJobs(ApiRequest<MatchShiftTradeJobRequest> request) throws IOException
      Matches a shift trade. This route can only be called by the receiving user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementShifttradingTradeStateJobs

      public ShiftTradeUpdateTradeStateJobResponse postWorkforcemanagementShifttradingTradeStateJobs(String tradeId, UpdateShiftTradeStateJobRequest body, Boolean forceAsync) throws IOException, ApiException
      Update trade state by a user
      Parameters:
      tradeId - The ID of the shift trade to update state (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      ShiftTradeUpdateTradeStateJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementShifttradingTradeStateJobsWithHttpInfo

      public ApiResponse<ShiftTradeUpdateTradeStateJobResponse> postWorkforcemanagementShifttradingTradeStateJobsWithHttpInfo(String tradeId, UpdateShiftTradeStateJobRequest body, Boolean forceAsync) throws IOException
      Update trade state by a user
      Parameters:
      tradeId - The ID of the shift trade to update state (required)
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      ShiftTradeUpdateTradeStateJobResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementShifttradingTradeStateJobs

      public ShiftTradeUpdateTradeStateJobResponse postWorkforcemanagementShifttradingTradeStateJobs(PostWorkforcemanagementShifttradingTradeStateJobsRequest request) throws IOException, ApiException
      Update trade state by a user
      Parameters:
      request - The request object
      Returns:
      ShiftTradeUpdateTradeStateJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementShifttradingTradeStateJobs

      public ApiResponse<ShiftTradeUpdateTradeStateJobResponse> postWorkforcemanagementShifttradingTradeStateJobs(ApiRequest<UpdateShiftTradeStateJobRequest> request) throws IOException
      Update trade state by a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementShifttradingTradesJobs

      public ShiftTradeAddTradeJobResponse postWorkforcemanagementShifttradingTradesJobs(AddShiftTradeJobRequest body, Boolean forceAsync) throws IOException, ApiException
      Add a shift trade job
      Parameters:
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      ShiftTradeAddTradeJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementShifttradingTradesJobsWithHttpInfo

      public ApiResponse<ShiftTradeAddTradeJobResponse> postWorkforcemanagementShifttradingTradesJobsWithHttpInfo(AddShiftTradeJobRequest body, Boolean forceAsync) throws IOException
      Add a shift trade job
      Parameters:
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      Returns:
      ShiftTradeAddTradeJobResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementShifttradingTradesJobs

      public ShiftTradeAddTradeJobResponse postWorkforcemanagementShifttradingTradesJobs(PostWorkforcemanagementShifttradingTradesJobsRequest request) throws IOException, ApiException
      Add a shift trade job
      Parameters:
      request - The request object
      Returns:
      ShiftTradeAddTradeJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementShifttradingTradesJobs

      public ApiResponse<ShiftTradeAddTradeJobResponse> postWorkforcemanagementShifttradingTradesJobs(ApiRequest<AddShiftTradeJobRequest> request) throws IOException
      Add a shift trade job
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementShifttradingTradesMineQueryJobs

      public ShiftTradeQueryAgentTradesJobResponse postWorkforcemanagementShifttradingTradesMineQueryJobs(QueryAgentShiftTradeListJobRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException, ApiException
      Retrieve all my shift trades where I am either the initiating or receiving user
      Parameters:
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      ShiftTradeQueryAgentTradesJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementShifttradingTradesMineQueryJobsWithHttpInfo

      public ApiResponse<ShiftTradeQueryAgentTradesJobResponse> postWorkforcemanagementShifttradingTradesMineQueryJobsWithHttpInfo(QueryAgentShiftTradeListJobRequest body, Boolean forceAsync, Boolean forceDownloadService) throws IOException
      Retrieve all my shift trades where I am either the initiating or receiving user
      Parameters:
      body - The request body (required)
      forceAsync - Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional)
      forceDownloadService - Force the result of this operation to be sent via download service. For testing/app development purposes (optional)
      Returns:
      ShiftTradeQueryAgentTradesJobResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementShifttradingTradesMineQueryJobs

      public ShiftTradeQueryAgentTradesJobResponse postWorkforcemanagementShifttradingTradesMineQueryJobs(PostWorkforcemanagementShifttradingTradesMineQueryJobsRequest request) throws IOException, ApiException
      Retrieve all my shift trades where I am either the initiating or receiving user
      Parameters:
      request - The request object
      Returns:
      ShiftTradeQueryAgentTradesJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementShifttradingTradesMineQueryJobs

      public ApiResponse<ShiftTradeQueryAgentTradesJobResponse> postWorkforcemanagementShifttradingTradesMineQueryJobs(ApiRequest<QueryAgentShiftTradeListJobRequest> request) throws IOException
      Retrieve all my shift trades where I am either the initiating or receiving user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementTeamAdherenceHistorical

      public WfmHistoricalAdherenceResponse postWorkforcemanagementTeamAdherenceHistorical(String teamId, WfmHistoricalAdherenceQueryForTeams body) throws IOException, ApiException
      Request a teams historical adherence report The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
      Parameters:
      teamId - The ID of the team (required)
      body - body (required)
      Returns:
      WfmHistoricalAdherenceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementTeamAdherenceHistoricalWithHttpInfo

      public ApiResponse<WfmHistoricalAdherenceResponse> postWorkforcemanagementTeamAdherenceHistoricalWithHttpInfo(String teamId, WfmHistoricalAdherenceQueryForTeams body) throws IOException
      Request a teams historical adherence report The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
      Parameters:
      teamId - The ID of the team (required)
      body - body (required)
      Returns:
      WfmHistoricalAdherenceResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementTeamAdherenceHistorical

      public WfmHistoricalAdherenceResponse postWorkforcemanagementTeamAdherenceHistorical(PostWorkforcemanagementTeamAdherenceHistoricalRequest request) throws IOException, ApiException
      Request a teams historical adherence report The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
      Parameters:
      request - The request object
      Returns:
      WfmHistoricalAdherenceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementTeamAdherenceHistorical

      public ApiResponse<WfmHistoricalAdherenceResponse> postWorkforcemanagementTeamAdherenceHistorical(ApiRequest<WfmHistoricalAdherenceQueryForTeams> request) throws IOException
      Request a teams historical adherence report The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementTeamShrinkageJobs

      public WfmHistoricalShrinkageResponse postWorkforcemanagementTeamShrinkageJobs(String teamId, WfmHistoricalShrinkageTeamsRequest body) throws IOException, ApiException
      Request a historical shrinkage report The maximum supported range for historical shrinkage queries is up to 32 days
      Parameters:
      teamId - The ID of the team (required)
      body - body (required)
      Returns:
      WfmHistoricalShrinkageResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementTeamShrinkageJobsWithHttpInfo

      public ApiResponse<WfmHistoricalShrinkageResponse> postWorkforcemanagementTeamShrinkageJobsWithHttpInfo(String teamId, WfmHistoricalShrinkageTeamsRequest body) throws IOException
      Request a historical shrinkage report The maximum supported range for historical shrinkage queries is up to 32 days
      Parameters:
      teamId - The ID of the team (required)
      body - body (required)
      Returns:
      WfmHistoricalShrinkageResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementTeamShrinkageJobs

      public WfmHistoricalShrinkageResponse postWorkforcemanagementTeamShrinkageJobs(PostWorkforcemanagementTeamShrinkageJobsRequest request) throws IOException, ApiException
      Request a historical shrinkage report The maximum supported range for historical shrinkage queries is up to 32 days
      Parameters:
      request - The request object
      Returns:
      WfmHistoricalShrinkageResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementTeamShrinkageJobs

      public ApiResponse<WfmHistoricalShrinkageResponse> postWorkforcemanagementTeamShrinkageJobs(ApiRequest<WfmHistoricalShrinkageTeamsRequest> request) throws IOException
      Request a historical shrinkage report The maximum supported range for historical shrinkage queries is up to 32 days
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementTimeoffbalanceJobs

      public TimeOffBalancesResponse postWorkforcemanagementTimeoffbalanceJobs(TimeOffBalanceRequest body) throws IOException, ApiException
      Query time off balances for the current user for specified activity code and dates
      Parameters:
      body - The request body (required)
      Returns:
      TimeOffBalancesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementTimeoffbalanceJobsWithHttpInfo

      public ApiResponse<TimeOffBalancesResponse> postWorkforcemanagementTimeoffbalanceJobsWithHttpInfo(TimeOffBalanceRequest body) throws IOException
      Query time off balances for the current user for specified activity code and dates
      Parameters:
      body - The request body (required)
      Returns:
      TimeOffBalancesResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementTimeoffbalanceJobs

      public TimeOffBalancesResponse postWorkforcemanagementTimeoffbalanceJobs(PostWorkforcemanagementTimeoffbalanceJobsRequest request) throws IOException, ApiException
      Query time off balances for the current user for specified activity code and dates
      Parameters:
      request - The request object
      Returns:
      TimeOffBalancesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementTimeoffbalanceJobs

      public ApiResponse<TimeOffBalancesResponse> postWorkforcemanagementTimeoffbalanceJobs(ApiRequest<TimeOffBalanceRequest> request) throws IOException
      Query time off balances for the current user for specified activity code and dates
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementTimeofflimitsAvailableQuery

      public AvailableTimeOffResponse postWorkforcemanagementTimeofflimitsAvailableQuery(AvailableTimeOffRequest body) throws IOException, ApiException
      Queries available time off for the current user
      Parameters:
      body - body (required)
      Returns:
      AvailableTimeOffResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementTimeofflimitsAvailableQueryWithHttpInfo

      public ApiResponse<AvailableTimeOffResponse> postWorkforcemanagementTimeofflimitsAvailableQueryWithHttpInfo(AvailableTimeOffRequest body) throws IOException
      Queries available time off for the current user
      Parameters:
      body - body (required)
      Returns:
      AvailableTimeOffResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementTimeofflimitsAvailableQuery

      public AvailableTimeOffResponse postWorkforcemanagementTimeofflimitsAvailableQuery(PostWorkforcemanagementTimeofflimitsAvailableQueryRequest request) throws IOException, ApiException
      Queries available time off for the current user
      Parameters:
      request - The request object
      Returns:
      AvailableTimeOffResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementTimeofflimitsAvailableQuery

      public ApiResponse<AvailableTimeOffResponse> postWorkforcemanagementTimeofflimitsAvailableQuery(ApiRequest<AvailableTimeOffRequest> request) throws IOException
      Queries available time off for the current user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementTimeoffrequests

      public TimeOffRequestResponse postWorkforcemanagementTimeoffrequests(CreateAgentTimeOffRequest body) throws IOException, ApiException
      Create a time off request for the current user
      Parameters:
      body - body (required)
      Returns:
      TimeOffRequestResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementTimeoffrequestsWithHttpInfo

      public ApiResponse<TimeOffRequestResponse> postWorkforcemanagementTimeoffrequestsWithHttpInfo(CreateAgentTimeOffRequest body) throws IOException
      Create a time off request for the current user
      Parameters:
      body - body (required)
      Returns:
      TimeOffRequestResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementTimeoffrequests

      public TimeOffRequestResponse postWorkforcemanagementTimeoffrequests(PostWorkforcemanagementTimeoffrequestsRequest request) throws IOException, ApiException
      Create a time off request for the current user
      Parameters:
      request - The request object
      Returns:
      TimeOffRequestResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementTimeoffrequests

      public ApiResponse<TimeOffRequestResponse> postWorkforcemanagementTimeoffrequests(ApiRequest<CreateAgentTimeOffRequest> request) throws IOException
      Create a time off request for the current user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementTimeoffrequestsEstimate

      public EstimateAvailableTimeOffResponse postWorkforcemanagementTimeoffrequestsEstimate(EstimateAvailableTimeOffRequest body, String includeOnly) throws IOException, ApiException
      Estimates available time off for current user
      Parameters:
      body - body (required)
      includeOnly - Limit response to the specified field (optional)
      Returns:
      EstimateAvailableTimeOffResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementTimeoffrequestsEstimateWithHttpInfo

      public ApiResponse<EstimateAvailableTimeOffResponse> postWorkforcemanagementTimeoffrequestsEstimateWithHttpInfo(EstimateAvailableTimeOffRequest body, String includeOnly) throws IOException
      Estimates available time off for current user
      Parameters:
      body - body (required)
      includeOnly - Limit response to the specified field (optional)
      Returns:
      EstimateAvailableTimeOffResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementTimeoffrequestsEstimate

      public EstimateAvailableTimeOffResponse postWorkforcemanagementTimeoffrequestsEstimate(PostWorkforcemanagementTimeoffrequestsEstimateRequest request) throws IOException, ApiException
      Estimates available time off for current user
      Parameters:
      request - The request object
      Returns:
      EstimateAvailableTimeOffResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementTimeoffrequestsEstimate

      public ApiResponse<EstimateAvailableTimeOffResponse> postWorkforcemanagementTimeoffrequestsEstimate(ApiRequest<EstimateAvailableTimeOffRequest> request) throws IOException
      Estimates available time off for current user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery

      public TimeOffIntegrationStatusResponseListing postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(CurrentUserTimeOffIntegrationStatusRequest body) throws IOException, ApiException
      Retrieves integration statuses for a list of current user time off requests
      Parameters:
      body - body (required)
      Returns:
      TimeOffIntegrationStatusResponseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementTimeoffrequestsIntegrationstatusQueryWithHttpInfo

      public ApiResponse<TimeOffIntegrationStatusResponseListing> postWorkforcemanagementTimeoffrequestsIntegrationstatusQueryWithHttpInfo(CurrentUserTimeOffIntegrationStatusRequest body) throws IOException
      Retrieves integration statuses for a list of current user time off requests
      Parameters:
      body - body (required)
      Returns:
      TimeOffIntegrationStatusResponseListing
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery

      public TimeOffIntegrationStatusResponseListing postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(PostWorkforcemanagementTimeoffrequestsIntegrationstatusQueryRequest request) throws IOException, ApiException
      Retrieves integration statuses for a list of current user time off requests
      Parameters:
      request - The request object
      Returns:
      TimeOffIntegrationStatusResponseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery

      public ApiResponse<TimeOffIntegrationStatusResponseListing> postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(ApiRequest<CurrentUserTimeOffIntegrationStatusRequest> request) throws IOException
      Retrieves integration statuses for a list of current user time off requests
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementUnavailabletimesQuery

      public UnavailableTimeListing postWorkforcemanagementUnavailabletimesQuery(QueryAgentUnavailableTimesRequest body) throws IOException, ApiException
      Get agent unavailable times
      Parameters:
      body - body (required)
      Returns:
      UnavailableTimeListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementUnavailabletimesQueryWithHttpInfo

      public ApiResponse<UnavailableTimeListing> postWorkforcemanagementUnavailabletimesQueryWithHttpInfo(QueryAgentUnavailableTimesRequest body) throws IOException
      Get agent unavailable times
      Parameters:
      body - body (required)
      Returns:
      UnavailableTimeListing
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementUnavailabletimesQuery

      public UnavailableTimeListing postWorkforcemanagementUnavailabletimesQuery(PostWorkforcemanagementUnavailabletimesQueryRequest request) throws IOException, ApiException
      Get agent unavailable times
      Parameters:
      request - The request object
      Returns:
      UnavailableTimeListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementUnavailabletimesQuery

      public ApiResponse<UnavailableTimeListing> postWorkforcemanagementUnavailabletimesQuery(ApiRequest<QueryAgentUnavailableTimesRequest> request) throws IOException
      Get agent unavailable times
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementUnavailabletimesValidationJobs

      public ValidateAgentUnavailableTimesResponse postWorkforcemanagementUnavailabletimesValidationJobs(ValidateAgentUnavailableTimesRequest body) throws IOException, ApiException
      Validates proposed changes to an agent's unavailable time spans against scheduling rules and constraints for a specific week
      Parameters:
      body - body (required)
      Returns:
      ValidateAgentUnavailableTimesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementUnavailabletimesValidationJobsWithHttpInfo

      public ApiResponse<ValidateAgentUnavailableTimesResponse> postWorkforcemanagementUnavailabletimesValidationJobsWithHttpInfo(ValidateAgentUnavailableTimesRequest body) throws IOException
      Validates proposed changes to an agent's unavailable time spans against scheduling rules and constraints for a specific week
      Parameters:
      body - body (required)
      Returns:
      ValidateAgentUnavailableTimesResponse
      Throws:
      IOException - if the request fails to be processed

    • postWorkforcemanagementUnavailabletimesValidationJobs

      public ValidateAgentUnavailableTimesResponse postWorkforcemanagementUnavailabletimesValidationJobs(PostWorkforcemanagementUnavailabletimesValidationJobsRequest request) throws IOException, ApiException
      Validates proposed changes to an agent's unavailable time spans against scheduling rules and constraints for a specific week
      Parameters:
      request - The request object
      Returns:
      ValidateAgentUnavailableTimesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postWorkforcemanagementUnavailabletimesValidationJobs

      public ApiResponse<ValidateAgentUnavailableTimesResponse> postWorkforcemanagementUnavailabletimesValidationJobs(ApiRequest<ValidateAgentUnavailableTimesRequest> request) throws IOException
      Validates proposed changes to an agent's unavailable time spans against scheduling rules and constraints for a specific week
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putWorkforcemanagementAgentIntegrationsHris

      public AgentIntegrationsResponse putWorkforcemanagementAgentIntegrationsHris(String agentId, AgentIntegrationsRequest body) throws IOException, ApiException
      Update integrations for agent
      Parameters:
      agentId - The ID of the agent (required)
      body - body (required)
      Returns:
      AgentIntegrationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putWorkforcemanagementAgentIntegrationsHrisWithHttpInfo

      public ApiResponse<AgentIntegrationsResponse> putWorkforcemanagementAgentIntegrationsHrisWithHttpInfo(String agentId, AgentIntegrationsRequest body) throws IOException
      Update integrations for agent
      Parameters:
      agentId - The ID of the agent (required)
      body - body (required)
      Returns:
      AgentIntegrationsResponse
      Throws:
      IOException - if the request fails to be processed

    • putWorkforcemanagementAgentIntegrationsHris

      public AgentIntegrationsResponse putWorkforcemanagementAgentIntegrationsHris(PutWorkforcemanagementAgentIntegrationsHrisRequest request) throws IOException, ApiException
      Update integrations for agent
      Parameters:
      request - The request object
      Returns:
      AgentIntegrationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putWorkforcemanagementAgentIntegrationsHris

      public ApiResponse<AgentIntegrationsResponse> putWorkforcemanagementAgentIntegrationsHris(ApiRequest<AgentIntegrationsRequest> request) throws IOException
      Update integrations for agent
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putWorkforcemanagementBusinessunitTimeofflimitValues

      public BuTimeOffLimitResponse putWorkforcemanagementBusinessunitTimeofflimitValues(String businessUnitId, String timeOffLimitId, BuSetTimeOffLimitValuesRequest body) throws IOException, ApiException
      Sets daily values for a date range of time-off limit object Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time-off limit API
      Parameters:
      businessUnitId - The ID of the business unit (required)
      timeOffLimitId - The ID of the time-off limit object to set values for (required)
      body - body (required)
      Returns:
      BuTimeOffLimitResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putWorkforcemanagementBusinessunitTimeofflimitValuesWithHttpInfo

      public ApiResponse<BuTimeOffLimitResponse> putWorkforcemanagementBusinessunitTimeofflimitValuesWithHttpInfo(String businessUnitId, String timeOffLimitId, BuSetTimeOffLimitValuesRequest body) throws IOException
      Sets daily values for a date range of time-off limit object Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time-off limit API
      Parameters:
      businessUnitId - The ID of the business unit (required)
      timeOffLimitId - The ID of the time-off limit object to set values for (required)
      body - body (required)
      Returns:
      BuTimeOffLimitResponse
      Throws:
      IOException - if the request fails to be processed

    • putWorkforcemanagementBusinessunitTimeofflimitValues

      public BuTimeOffLimitResponse putWorkforcemanagementBusinessunitTimeofflimitValues(PutWorkforcemanagementBusinessunitTimeofflimitValuesRequest request) throws IOException, ApiException
      Sets daily values for a date range of time-off limit object Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time-off limit API
      Parameters:
      request - The request object
      Returns:
      BuTimeOffLimitResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putWorkforcemanagementBusinessunitTimeofflimitValues

      public ApiResponse<BuTimeOffLimitResponse> putWorkforcemanagementBusinessunitTimeofflimitValues(ApiRequest<BuSetTimeOffLimitValuesRequest> request) throws IOException
      Sets daily values for a date range of time-off limit object Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time-off limit API
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putWorkforcemanagementManagementunitTimeofflimitValues

      public TimeOffLimit putWorkforcemanagementManagementunitTimeofflimitValues(String managementUnitId, String timeOffLimitId, SetTimeOffLimitValuesRequest body) throws IOException, ApiException
      Sets daily values for a date range of time off limit object Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      timeOffLimitId - The ID of the time off limit object to set values for (required)
      body - body (required)
      Returns:
      TimeOffLimit
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putWorkforcemanagementManagementunitTimeofflimitValuesWithHttpInfo

      public ApiResponse<TimeOffLimit> putWorkforcemanagementManagementunitTimeofflimitValuesWithHttpInfo(String managementUnitId, String timeOffLimitId, SetTimeOffLimitValuesRequest body) throws IOException
      Sets daily values for a date range of time off limit object Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
      Parameters:
      managementUnitId - The ID of the management unit. (required)
      timeOffLimitId - The ID of the time off limit object to set values for (required)
      body - body (required)
      Returns:
      TimeOffLimit
      Throws:
      IOException - if the request fails to be processed

    • putWorkforcemanagementManagementunitTimeofflimitValues

      public TimeOffLimit putWorkforcemanagementManagementunitTimeofflimitValues(PutWorkforcemanagementManagementunitTimeofflimitValuesRequest request) throws IOException, ApiException
      Sets daily values for a date range of time off limit object Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
      Parameters:
      request - The request object
      Returns:
      TimeOffLimit
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putWorkforcemanagementManagementunitTimeofflimitValues

      public ApiResponse<TimeOffLimit> putWorkforcemanagementManagementunitTimeofflimitValues(ApiRequest<SetTimeOffLimitValuesRequest> request) throws IOException
      Sets daily values for a date range of time off limit object Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed