class PureCloud::WorkforceManagementApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 23
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

delete_workforcemanagement_businessunit(business_unit_id, opts = {}) click to toggle source

Delete business unit A business unit cannot be deleted if it contains one or more management units @param business_unit_id The ID of the business unit, or 'mine' for the business unit of the logged-in user. @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 32
def delete_workforcemanagement_businessunit(business_unit_id, opts = {})
  delete_workforcemanagement_businessunit_with_http_info(business_unit_id, opts)
  return nil
end
delete_workforcemanagement_businessunit_activitycode(bu_id, ac_id, opts = {}) click to toggle source

Deletes an activity code

@param bu_id The ID of the business unit, or 'mine' for the business unit of the logged-in user. @param ac_id The ID of the activity code to delete @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 97
def delete_workforcemanagement_businessunit_activitycode(bu_id, ac_id, opts = {})
  delete_workforcemanagement_businessunit_activitycode_with_http_info(bu_id, ac_id, opts)
  return nil
end
delete_workforcemanagement_businessunit_activitycode_with_http_info(bu_id, ac_id, opts = {}) click to toggle source

Deletes an activity code

@param bu_id The ID of the business unit, or &#39;mine&#39; for the business unit of the logged-in user. @param ac_id The ID of the activity code to delete @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 108
def delete_workforcemanagement_businessunit_activitycode_with_http_info(bu_id, ac_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.delete_workforcemanagement_businessunit_activitycode ..."
  end
  
  
  # verify the required parameter 'bu_id' is set
  fail ArgumentError, "Missing the required parameter 'bu_id' when calling WorkforceManagementApi.delete_workforcemanagement_businessunit_activitycode" if bu_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'ac_id' is set
  fail ArgumentError, "Missing the required parameter 'ac_id' when calling WorkforceManagementApi.delete_workforcemanagement_businessunit_activitycode" if ac_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{buId}/activitycodes/{acId}".sub('{format}','json').sub('{' + 'buId' + '}', bu_id.to_s).sub('{' + 'acId' + '}', ac_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#delete_workforcemanagement_businessunit_activitycode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_workforcemanagement_businessunit_planninggroup(business_unit_id, planning_group_id, opts = {}) click to toggle source

Deletes the planning group

@param business_unit_id The ID of the business unit. @param planning_group_id The ID of a planning group to delete @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 171
def delete_workforcemanagement_businessunit_planninggroup(business_unit_id, planning_group_id, opts = {})
  delete_workforcemanagement_businessunit_planninggroup_with_http_info(business_unit_id, planning_group_id, opts)
  return nil
end
delete_workforcemanagement_businessunit_planninggroup_with_http_info(business_unit_id, planning_group_id, opts = {}) click to toggle source

Deletes the planning group

@param business_unit_id The ID of the business unit. @param planning_group_id The ID of a planning group to delete @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 182
def delete_workforcemanagement_businessunit_planninggroup_with_http_info(business_unit_id, planning_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.delete_workforcemanagement_businessunit_planninggroup ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.delete_workforcemanagement_businessunit_planninggroup" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'planning_group_id' is set
  fail ArgumentError, "Missing the required parameter 'planning_group_id' when calling WorkforceManagementApi.delete_workforcemanagement_businessunit_planninggroup" if planning_group_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'planningGroupId' + '}', planning_group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#delete_workforcemanagement_businessunit_planninggroup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_workforcemanagement_businessunit_scheduling_run(business_unit_id, run_id, opts = {}) click to toggle source

Cancel a scheduling run

@param business_unit_id The ID of the business unit @param run_id The ID of the schedule run @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 245
def delete_workforcemanagement_businessunit_scheduling_run(business_unit_id, run_id, opts = {})
  delete_workforcemanagement_businessunit_scheduling_run_with_http_info(business_unit_id, run_id, opts)
  return nil
end
delete_workforcemanagement_businessunit_scheduling_run_with_http_info(business_unit_id, run_id, opts = {}) click to toggle source

Cancel a scheduling run

@param business_unit_id The ID of the business unit @param run_id The ID of the schedule run @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 256
def delete_workforcemanagement_businessunit_scheduling_run_with_http_info(business_unit_id, run_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.delete_workforcemanagement_businessunit_scheduling_run ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.delete_workforcemanagement_businessunit_scheduling_run" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'run_id' is set
  fail ArgumentError, "Missing the required parameter 'run_id' when calling WorkforceManagementApi.delete_workforcemanagement_businessunit_scheduling_run" if run_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'runId' + '}', run_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#delete_workforcemanagement_businessunit_scheduling_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_workforcemanagement_businessunit_servicegoaltemplate(business_unit_id, service_goal_template_id, opts = {}) click to toggle source

Delete a service goal template

@param business_unit_id The ID of the business unit. @param service_goal_template_id The ID of the service goal template to delete @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 319
def delete_workforcemanagement_businessunit_servicegoaltemplate(business_unit_id, service_goal_template_id, opts = {})
  delete_workforcemanagement_businessunit_servicegoaltemplate_with_http_info(business_unit_id, service_goal_template_id, opts)
  return nil
end
delete_workforcemanagement_businessunit_servicegoaltemplate_with_http_info(business_unit_id, service_goal_template_id, opts = {}) click to toggle source

Delete a service goal template

@param business_unit_id The ID of the business unit. @param service_goal_template_id The ID of the service goal template to delete @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 330
def delete_workforcemanagement_businessunit_servicegoaltemplate_with_http_info(business_unit_id, service_goal_template_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.delete_workforcemanagement_businessunit_servicegoaltemplate ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.delete_workforcemanagement_businessunit_servicegoaltemplate" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'service_goal_template_id' is set
  fail ArgumentError, "Missing the required parameter 'service_goal_template_id' when calling WorkforceManagementApi.delete_workforcemanagement_businessunit_servicegoaltemplate" if service_goal_template_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'serviceGoalTemplateId' + '}', service_goal_template_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#delete_workforcemanagement_businessunit_servicegoaltemplate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_workforcemanagement_businessunit_week_schedule(business_unit_id, week_id, schedule_id, opts = {}) click to toggle source

Delete a schedule

@param business_unit_id The ID of the business unit @param week_id First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param schedule_id The ID of the schedule @param [Hash] opts the optional parameters @return [BuAsyncScheduleResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 394
def delete_workforcemanagement_businessunit_week_schedule(business_unit_id, week_id, schedule_id, opts = {})
  data, _status_code, _headers = delete_workforcemanagement_businessunit_week_schedule_with_http_info(business_unit_id, week_id, schedule_id, opts)
  return data
end
delete_workforcemanagement_businessunit_week_schedule_with_http_info(business_unit_id, week_id, schedule_id, opts = {}) click to toggle source

Delete a schedule

@param business_unit_id The ID of the business unit @param week_id First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param schedule_id The ID of the schedule @param [Hash] opts the optional parameters @return [Array<(BuAsyncScheduleResponse, Fixnum, Hash)>] BuAsyncScheduleResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 406
def delete_workforcemanagement_businessunit_week_schedule_with_http_info(business_unit_id, week_id, schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.delete_workforcemanagement_businessunit_week_schedule ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.delete_workforcemanagement_businessunit_week_schedule" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.delete_workforcemanagement_businessunit_week_schedule" if week_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'schedule_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_id' when calling WorkforceManagementApi.delete_workforcemanagement_businessunit_week_schedule" if schedule_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BuAsyncScheduleResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#delete_workforcemanagement_businessunit_week_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_workforcemanagement_businessunit_week_shorttermforecast(business_unit_id, week_date_id, forecast_id, opts = {}) click to toggle source

Delete a short term forecast Must not be tied to any schedules @param business_unit_id The business unit ID of the business unit to which the forecast belongs @param week_date_id 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 @param forecast_id The ID of the forecast @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 479
def delete_workforcemanagement_businessunit_week_shorttermforecast(business_unit_id, week_date_id, forecast_id, opts = {})
  delete_workforcemanagement_businessunit_week_shorttermforecast_with_http_info(business_unit_id, week_date_id, forecast_id, opts)
  return nil
end
delete_workforcemanagement_businessunit_week_shorttermforecast_with_http_info(business_unit_id, week_date_id, forecast_id, opts = {}) click to toggle source

Delete a short term forecast Must not be tied to any schedules @param business_unit_id The business unit ID of the business unit to which the forecast belongs @param week_date_id 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 @param forecast_id The ID of the forecast @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 491
def delete_workforcemanagement_businessunit_week_shorttermforecast_with_http_info(business_unit_id, week_date_id, forecast_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.delete_workforcemanagement_businessunit_week_shorttermforecast ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.delete_workforcemanagement_businessunit_week_shorttermforecast" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.delete_workforcemanagement_businessunit_week_shorttermforecast" if week_date_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'forecast_id' is set
  fail ArgumentError, "Missing the required parameter 'forecast_id' when calling WorkforceManagementApi.delete_workforcemanagement_businessunit_week_shorttermforecast" if forecast_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s).sub('{' + 'forecastId' + '}', forecast_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#delete_workforcemanagement_businessunit_week_shorttermforecast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_workforcemanagement_businessunit_with_http_info(business_unit_id, opts = {}) click to toggle source

Delete business unit A business unit cannot be deleted if it contains one or more management units @param business_unit_id The ID of the business unit, or &#39;mine&#39; for the business unit of the logged-in user. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 42
def delete_workforcemanagement_businessunit_with_http_info(business_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.delete_workforcemanagement_businessunit ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.delete_workforcemanagement_businessunit" if business_unit_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#delete_workforcemanagement_businessunit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_workforcemanagement_managementunit(mu_id, opts = {}) click to toggle source

Delete management unit

@param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 561
def delete_workforcemanagement_managementunit(mu_id, opts = {})
  delete_workforcemanagement_managementunit_with_http_info(mu_id, opts)
  return nil
end
delete_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts = {}) click to toggle source

Deprecated/Gone: Use the new business unit activity code resources

@param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param ac_id The ID of the activity code to delete @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 626
def delete_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts = {})
  delete_workforcemanagement_managementunit_activitycode_with_http_info(mu_id, ac_id, opts)
  return nil
end
delete_workforcemanagement_managementunit_activitycode_with_http_info(mu_id, ac_id, opts = {}) click to toggle source

Deprecated/Gone: Use the new business unit activity code resources

@param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param ac_id The ID of the activity code to delete @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 637
def delete_workforcemanagement_managementunit_activitycode_with_http_info(mu_id, ac_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.delete_workforcemanagement_managementunit_activitycode ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_activitycode" if mu_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'ac_id' is set
  fail ArgumentError, "Missing the required parameter 'ac_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_activitycode" if ac_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s).sub('{' + 'acId' + '}', ac_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#delete_workforcemanagement_managementunit_activitycode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id (Deprecated/gone): The ID of the management unit. @param run_id The ID of the schedule run @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 700
def delete_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id, opts = {})
  delete_workforcemanagement_managementunit_scheduling_run_with_http_info(management_unit_id, run_id, opts)
  return nil
end
delete_workforcemanagement_managementunit_scheduling_run_with_http_info(management_unit_id, run_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id (Deprecated/gone): The ID of the management unit. @param run_id The ID of the schedule run @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 711
def delete_workforcemanagement_managementunit_scheduling_run_with_http_info(management_unit_id, run_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.delete_workforcemanagement_managementunit_scheduling_run ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_scheduling_run" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'run_id' is set
  fail ArgumentError, "Missing the required parameter 'run_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_scheduling_run" if run_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'runId' + '}', run_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#delete_workforcemanagement_managementunit_scheduling_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts = {}) click to toggle source

Gone. Replaced with service goal templates and planning groups under business units

@param management_unit_id (Deprecated/gone): The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param service_goal_group_id Gone. The ID of the service goal group to delete @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 774
def delete_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts = {})
  delete_workforcemanagement_managementunit_servicegoalgroup_with_http_info(management_unit_id, service_goal_group_id, opts)
  return nil
end
delete_workforcemanagement_managementunit_servicegoalgroup_with_http_info(management_unit_id, service_goal_group_id, opts = {}) click to toggle source

Gone. Replaced with service goal templates and planning groups under business units

@param management_unit_id (Deprecated/gone): The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param service_goal_group_id Gone. The ID of the service goal group to delete @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 785
def delete_workforcemanagement_managementunit_servicegoalgroup_with_http_info(management_unit_id, service_goal_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.delete_workforcemanagement_managementunit_servicegoalgroup ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_servicegoalgroup" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'service_goal_group_id' is set
  fail ArgumentError, "Missing the required parameter 'service_goal_group_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_servicegoalgroup" if service_goal_group_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'serviceGoalGroupId' + '}', service_goal_group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#delete_workforcemanagement_managementunit_servicegoalgroup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_id First day of schedule week in yyyy-MM-dd format. @param schedule_id Gone/deprecated. The ID of the schedule to delete @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 849
def delete_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts = {})
  delete_workforcemanagement_managementunit_week_schedule_with_http_info(management_unit_id, week_id, schedule_id, opts)
  return nil
end
delete_workforcemanagement_managementunit_week_schedule_with_http_info(management_unit_id, week_id, schedule_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_id First day of schedule week in yyyy-MM-dd format. @param schedule_id Gone/deprecated. The ID of the schedule to delete @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 861
def delete_workforcemanagement_managementunit_week_schedule_with_http_info(management_unit_id, week_id, schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.delete_workforcemanagement_managementunit_week_schedule ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_week_schedule" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_week_schedule" if week_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'schedule_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_week_schedule" if schedule_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#delete_workforcemanagement_managementunit_week_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_workforcemanagement_managementunit_week_shorttermforecast(management_unit_id, week_date_id, forecast_id, opts = {}) click to toggle source

Gone. Use equivalent business unit resource instead

@param management_unit_id (Deprecated/gone): The id of the management unit. @param week_date_id (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format @param forecast_id (Gone/Deprecated): The ID of the forecast @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 933
def delete_workforcemanagement_managementunit_week_shorttermforecast(management_unit_id, week_date_id, forecast_id, opts = {})
  delete_workforcemanagement_managementunit_week_shorttermforecast_with_http_info(management_unit_id, week_date_id, forecast_id, opts)
  return nil
end
delete_workforcemanagement_managementunit_week_shorttermforecast_with_http_info(management_unit_id, week_date_id, forecast_id, opts = {}) click to toggle source

Gone. Use equivalent business unit resource instead

@param management_unit_id (Deprecated/gone): The id of the management unit. @param week_date_id (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format @param forecast_id (Gone/Deprecated): The ID of the forecast @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 945
def delete_workforcemanagement_managementunit_week_shorttermforecast_with_http_info(management_unit_id, week_date_id, forecast_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.delete_workforcemanagement_managementunit_week_shorttermforecast ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_week_shorttermforecast" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_week_shorttermforecast" if week_date_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'forecast_id' is set
  fail ArgumentError, "Missing the required parameter 'forecast_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_week_shorttermforecast" if forecast_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s).sub('{' + 'forecastId' + '}', forecast_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#delete_workforcemanagement_managementunit_week_shorttermforecast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_workforcemanagement_managementunit_with_http_info(mu_id, opts = {}) click to toggle source

Delete management unit

@param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 571
def delete_workforcemanagement_managementunit_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.delete_workforcemanagement_managementunit ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit" if mu_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#delete_workforcemanagement_managementunit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts = {}) click to toggle source

Delete a work plan

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param work_plan_id The ID of the work plan to delete @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1016
def delete_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts = {})
  delete_workforcemanagement_managementunit_workplan_with_http_info(management_unit_id, work_plan_id, opts)
  return nil
end
delete_workforcemanagement_managementunit_workplan_with_http_info(management_unit_id, work_plan_id, opts = {}) click to toggle source

Delete a work plan

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param work_plan_id The ID of the work plan to delete @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1027
def delete_workforcemanagement_managementunit_workplan_with_http_info(management_unit_id, work_plan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.delete_workforcemanagement_managementunit_workplan ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_workplan" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'work_plan_id' is set
  fail ArgumentError, "Missing the required parameter 'work_plan_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_workplan" if work_plan_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'workPlanId' + '}', work_plan_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#delete_workforcemanagement_managementunit_workplan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_adherence(user_id, opts = {}) click to toggle source

Get a list of UserScheduleAdherence records for the requested users

@param user_id User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request @param [Hash] opts the optional parameters @return [Array<UserScheduleAdherence>]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1089
def get_workforcemanagement_adherence(user_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_adherence_with_http_info(user_id, opts)
  return data
end
get_workforcemanagement_adherence_with_http_info(user_id, opts = {}) click to toggle source

Get a list of UserScheduleAdherence records for the requested users

@param user_id User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request @param [Hash] opts the optional parameters @return [Array<(Array<UserScheduleAdherence>, Fixnum, Hash)>] Array<UserScheduleAdherence> data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1099
def get_workforcemanagement_adherence_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_adherence ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling WorkforceManagementApi.get_workforcemanagement_adherence" if user_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/adherence".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'userId'] = @api_client.build_collection_param(user_id, :multi)

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<UserScheduleAdherence>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_adherence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_adhocmodelingjob(job_id, opts = {}) click to toggle source

Get status of the modeling job

@param job_id The id of the modeling job @param [Hash] opts the optional parameters @return [ModelingStatusResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1155
def get_workforcemanagement_adhocmodelingjob(job_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_adhocmodelingjob_with_http_info(job_id, opts)
  return data
end
get_workforcemanagement_adhocmodelingjob_with_http_info(job_id, opts = {}) click to toggle source

Get status of the modeling job

@param job_id The id of the modeling job @param [Hash] opts the optional parameters @return [Array<(ModelingStatusResponse, Fixnum, Hash)>] ModelingStatusResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1165
def get_workforcemanagement_adhocmodelingjob_with_http_info(job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_adhocmodelingjob ..."
  end
  
  
  # verify the required parameter 'job_id' is set
  fail ArgumentError, "Missing the required parameter 'job_id' when calling WorkforceManagementApi.get_workforcemanagement_adhocmodelingjob" if job_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/adhocmodelingjobs/{jobId}".sub('{format}','json').sub('{' + 'jobId' + '}', job_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ModelingStatusResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_adhocmodelingjob\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunit(business_unit_id, opts = {}) click to toggle source

Get business unit Expanding "settings" will retrieve all settings. All other expands will retrieve only the requested settings field(s). @param business_unit_id The ID of the business unit, or &#39;mine&#39; for the business unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [Array<String>] :expand @return [BusinessUnit]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1221
def get_workforcemanagement_businessunit(business_unit_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunit_with_http_info(business_unit_id, opts)
  return data
end
get_workforcemanagement_businessunit_activitycode(bu_id, ac_id, opts = {}) click to toggle source

Get an activity code

@param bu_id The ID of the business unit, or &#39;mine&#39; for the business unit of the logged-in user. @param ac_id The ID of the activity code to fetch @param [Hash] opts the optional parameters @return [BusinessUnitActivityCode]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1295
def get_workforcemanagement_businessunit_activitycode(bu_id, ac_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunit_activitycode_with_http_info(bu_id, ac_id, opts)
  return data
end
get_workforcemanagement_businessunit_activitycode_with_http_info(bu_id, ac_id, opts = {}) click to toggle source

Get an activity code

@param bu_id The ID of the business unit, or &#39;mine&#39; for the business unit of the logged-in user. @param ac_id The ID of the activity code to fetch @param [Hash] opts the optional parameters @return [Array<(BusinessUnitActivityCode, Fixnum, Hash)>] BusinessUnitActivityCode data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1306
def get_workforcemanagement_businessunit_activitycode_with_http_info(bu_id, ac_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunit_activitycode ..."
  end
  
  
  # verify the required parameter 'bu_id' is set
  fail ArgumentError, "Missing the required parameter 'bu_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_activitycode" if bu_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'ac_id' is set
  fail ArgumentError, "Missing the required parameter 'ac_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_activitycode" if ac_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{buId}/activitycodes/{acId}".sub('{format}','json').sub('{' + 'buId' + '}', bu_id.to_s).sub('{' + 'acId' + '}', ac_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BusinessUnitActivityCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunit_activitycode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunit_activitycodes(bu_id, opts = {}) click to toggle source

Get activity codes

@param bu_id The ID of the business unit, or &#39;mine&#39; for the business unit of the logged-in user. @param [Hash] opts the optional parameters @return [BusinessUnitActivityCodeListing]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1369
def get_workforcemanagement_businessunit_activitycodes(bu_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunit_activitycodes_with_http_info(bu_id, opts)
  return data
end
get_workforcemanagement_businessunit_activitycodes_with_http_info(bu_id, opts = {}) click to toggle source

Get activity codes

@param bu_id The ID of the business unit, or &#39;mine&#39; for the business unit of the logged-in user. @param [Hash] opts the optional parameters @return [Array<(BusinessUnitActivityCodeListing, Fixnum, Hash)>] BusinessUnitActivityCodeListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1379
def get_workforcemanagement_businessunit_activitycodes_with_http_info(bu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunit_activitycodes ..."
  end
  
  
  # verify the required parameter 'bu_id' is set
  fail ArgumentError, "Missing the required parameter 'bu_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_activitycodes" if bu_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{buId}/activitycodes".sub('{format}','json').sub('{' + 'buId' + '}', bu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BusinessUnitActivityCodeListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunit_activitycodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunit_intraday_planninggroups(business_unit_id, date, opts = {}) click to toggle source

Get intraday planning groups for the given date

@param business_unit_id The business unit ID of the business unit @param 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 @param [Hash] opts the optional parameters @return [WfmIntradayPlanningGroupListing]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1435
def get_workforcemanagement_businessunit_intraday_planninggroups(business_unit_id, date, opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunit_intraday_planninggroups_with_http_info(business_unit_id, date, opts)
  return data
end
get_workforcemanagement_businessunit_intraday_planninggroups_with_http_info(business_unit_id, date, opts = {}) click to toggle source

Get intraday planning groups for the given date

@param business_unit_id The business unit ID of the business unit @param 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 @param [Hash] opts the optional parameters @return [Array<(WfmIntradayPlanningGroupListing, Fixnum, Hash)>] WfmIntradayPlanningGroupListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1446
def get_workforcemanagement_businessunit_intraday_planninggroups_with_http_info(business_unit_id, date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunit_intraday_planninggroups ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_intraday_planninggroups" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'date' is set
  fail ArgumentError, "Missing the required parameter 'date' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_intraday_planninggroups" if date.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday/planninggroups".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'date'] = date

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WfmIntradayPlanningGroupListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunit_intraday_planninggroups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunit_managementunits(business_unit_id, opts = {}) click to toggle source

Get all authorized management units in the business unit

@param business_unit_id The ID of the business unit, or &#39;mine&#39; for the business unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [String] :feature @option opts [String] :division_id @return [ManagementUnitListing]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1512
def get_workforcemanagement_businessunit_managementunits(business_unit_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunit_managementunits_with_http_info(business_unit_id, opts)
  return data
end
get_workforcemanagement_businessunit_managementunits_with_http_info(business_unit_id, opts = {}) click to toggle source

Get all authorized management units in the business unit

@param business_unit_id The ID of the business unit, or &#39;mine&#39; for the business unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [String] :feature @option opts [String] :division_id @return [Array<(ManagementUnitListing, Fixnum, Hash)>] ManagementUnitListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1524
def get_workforcemanagement_businessunit_managementunits_with_http_info(business_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunit_managementunits ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_managementunits" if business_unit_id.nil?
  
  
  
  
  
  
  
  
  if opts[:'feature'] && !['AgentSchedule', 'AgentTimeOffRequest', 'Coaching', 'ActivityCodes', 'Agents', 'BuActivityCodes', 'BusinessUnits', 'HistoricalAdherence', 'IntradayMonitoring', 'BuIntradayMonitoring', 'ManagementUnits', 'RealTimeAdherence', 'Schedules', 'BuSchedules', 'ServiceGoalGroups', 'ServiceGoalTemplates', 'PlanningGroups', 'ShiftTrading', 'ShortTermForecasts', 'BuShortTermForecasts', 'TimeOffRequests', 'WorkPlanRotations', 'WorkPlans'].include?(opts[:'feature'])
    fail ArgumentError, 'invalid value for "feature", must be one of AgentSchedule, AgentTimeOffRequest, Coaching, ActivityCodes, Agents, BuActivityCodes, BusinessUnits, HistoricalAdherence, IntradayMonitoring, BuIntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, BuSchedules, ServiceGoalGroups, ServiceGoalTemplates, PlanningGroups, ShiftTrading, ShortTermForecasts, BuShortTermForecasts, TimeOffRequests, WorkPlanRotations, WorkPlans'
  end
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/managementunits".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'feature'] = opts[:'feature'] if opts[:'feature']
  query_params[:'divisionId'] = opts[:'division_id'] if opts[:'division_id']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ManagementUnitListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunit_managementunits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunit_planninggroup(business_unit_id, planning_group_id, opts = {}) click to toggle source

Get a planning group

@param business_unit_id The ID of the business unit. @param planning_group_id The ID of a planning group to fetch @param [Hash] opts the optional parameters @return [PlanningGroup]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1598
def get_workforcemanagement_businessunit_planninggroup(business_unit_id, planning_group_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunit_planninggroup_with_http_info(business_unit_id, planning_group_id, opts)
  return data
end
get_workforcemanagement_businessunit_planninggroup_with_http_info(business_unit_id, planning_group_id, opts = {}) click to toggle source

Get a planning group

@param business_unit_id The ID of the business unit. @param planning_group_id The ID of a planning group to fetch @param [Hash] opts the optional parameters @return [Array<(PlanningGroup, Fixnum, Hash)>] PlanningGroup data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1609
def get_workforcemanagement_businessunit_planninggroup_with_http_info(business_unit_id, planning_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunit_planninggroup ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_planninggroup" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'planning_group_id' is set
  fail ArgumentError, "Missing the required parameter 'planning_group_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_planninggroup" if planning_group_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'planningGroupId' + '}', planning_group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PlanningGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunit_planninggroup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunit_planninggroups(business_unit_id, opts = {}) click to toggle source

Gets list of planning groups

@param business_unit_id The ID of the business unit. @param [Hash] opts the optional parameters @return [PlanningGroupList]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1672
def get_workforcemanagement_businessunit_planninggroups(business_unit_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunit_planninggroups_with_http_info(business_unit_id, opts)
  return data
end
get_workforcemanagement_businessunit_planninggroups_with_http_info(business_unit_id, opts = {}) click to toggle source

Gets list of planning groups

@param business_unit_id The ID of the business unit. @param [Hash] opts the optional parameters @return [Array<(PlanningGroupList, Fixnum, Hash)>] PlanningGroupList data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1682
def get_workforcemanagement_businessunit_planninggroups_with_http_info(business_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunit_planninggroups ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_planninggroups" if business_unit_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PlanningGroupList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunit_planninggroups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunit_scheduling_run(business_unit_id, run_id, opts = {}) click to toggle source

Get a scheduling run

@param business_unit_id The ID of the business unit @param run_id The ID of the schedule run @param [Hash] opts the optional parameters @return [BuScheduleRun]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1738
def get_workforcemanagement_businessunit_scheduling_run(business_unit_id, run_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunit_scheduling_run_with_http_info(business_unit_id, run_id, opts)
  return data
end
get_workforcemanagement_businessunit_scheduling_run_result(business_unit_id, run_id, management_unit_ids, expand, opts = {}) click to toggle source

Get the result of a rescheduling operation

@param business_unit_id The ID of the business unit @param run_id The ID of the schedule run @param management_unit_ids The IDs of the management units for which to fetch the reschedule results @param expand The fields to expand. Omitting will return an empty response @param [Hash] opts the optional parameters @return [BuRescheduleResult]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1815
def get_workforcemanagement_businessunit_scheduling_run_result(business_unit_id, run_id, management_unit_ids, expand, opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunit_scheduling_run_result_with_http_info(business_unit_id, run_id, management_unit_ids, expand, opts)
  return data
end
get_workforcemanagement_businessunit_scheduling_run_result_with_http_info(business_unit_id, run_id, management_unit_ids, expand, opts = {}) click to toggle source

Get the result of a rescheduling operation

@param business_unit_id The ID of the business unit @param run_id The ID of the schedule run @param management_unit_ids The IDs of the management units for which to fetch the reschedule results @param expand The fields to expand. Omitting will return an empty response @param [Hash] opts the optional parameters @return [Array<(BuRescheduleResult, Fixnum, Hash)>] BuRescheduleResult data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1828
def get_workforcemanagement_businessunit_scheduling_run_result_with_http_info(business_unit_id, run_id, management_unit_ids, expand, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunit_scheduling_run_result ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_scheduling_run_result" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'run_id' is set
  fail ArgumentError, "Missing the required parameter 'run_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_scheduling_run_result" if run_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'management_unit_ids' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_ids' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_scheduling_run_result" if management_unit_ids.nil?
  
  
  
  
  
  
  # verify the required parameter 'expand' is set
  fail ArgumentError, "Missing the required parameter 'expand' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_scheduling_run_result" if expand.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}/result".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'runId' + '}', run_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'managementUnitIds'] = @api_client.build_collection_param(management_unit_ids, :multi)
  query_params[:'expand'] = @api_client.build_collection_param(expand, :multi)

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BuRescheduleResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunit_scheduling_run_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunit_scheduling_run_with_http_info(business_unit_id, run_id, opts = {}) click to toggle source

Get a scheduling run

@param business_unit_id The ID of the business unit @param run_id The ID of the schedule run @param [Hash] opts the optional parameters @return [Array<(BuScheduleRun, Fixnum, Hash)>] BuScheduleRun data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1749
def get_workforcemanagement_businessunit_scheduling_run_with_http_info(business_unit_id, run_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunit_scheduling_run ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_scheduling_run" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'run_id' is set
  fail ArgumentError, "Missing the required parameter 'run_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_scheduling_run" if run_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'runId' + '}', run_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BuScheduleRun')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunit_scheduling_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunit_scheduling_runs(business_unit_id, opts = {}) click to toggle source

Get the list of scheduling runs

@param business_unit_id The ID of the business unit @param [Hash] opts the optional parameters @return [BuScheduleRunListing]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1909
def get_workforcemanagement_businessunit_scheduling_runs(business_unit_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunit_scheduling_runs_with_http_info(business_unit_id, opts)
  return data
end
get_workforcemanagement_businessunit_scheduling_runs_with_http_info(business_unit_id, opts = {}) click to toggle source

Get the list of scheduling runs

@param business_unit_id The ID of the business unit @param [Hash] opts the optional parameters @return [Array<(BuScheduleRunListing, Fixnum, Hash)>] BuScheduleRunListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1919
def get_workforcemanagement_businessunit_scheduling_runs_with_http_info(business_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunit_scheduling_runs ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_scheduling_runs" if business_unit_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BuScheduleRunListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunit_scheduling_runs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunit_servicegoaltemplate(business_unit_id, service_goal_template_id, opts = {}) click to toggle source

Get a service goal template

@param business_unit_id The ID of the business unit. @param service_goal_template_id The ID of a service goal template to fetch @param [Hash] opts the optional parameters @return [ServiceGoalTemplate]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1975
def get_workforcemanagement_businessunit_servicegoaltemplate(business_unit_id, service_goal_template_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunit_servicegoaltemplate_with_http_info(business_unit_id, service_goal_template_id, opts)
  return data
end
get_workforcemanagement_businessunit_servicegoaltemplate_with_http_info(business_unit_id, service_goal_template_id, opts = {}) click to toggle source

Get a service goal template

@param business_unit_id The ID of the business unit. @param service_goal_template_id The ID of a service goal template to fetch @param [Hash] opts the optional parameters @return [Array<(ServiceGoalTemplate, Fixnum, Hash)>] ServiceGoalTemplate data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1986
def get_workforcemanagement_businessunit_servicegoaltemplate_with_http_info(business_unit_id, service_goal_template_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunit_servicegoaltemplate ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_servicegoaltemplate" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'service_goal_template_id' is set
  fail ArgumentError, "Missing the required parameter 'service_goal_template_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_servicegoaltemplate" if service_goal_template_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'serviceGoalTemplateId' + '}', service_goal_template_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ServiceGoalTemplate')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunit_servicegoaltemplate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunit_servicegoaltemplates(business_unit_id, opts = {}) click to toggle source

Gets list of service goal templates

@param business_unit_id The ID of the business unit. @param [Hash] opts the optional parameters @return [ServiceGoalTemplateList]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2049
def get_workforcemanagement_businessunit_servicegoaltemplates(business_unit_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunit_servicegoaltemplates_with_http_info(business_unit_id, opts)
  return data
end
get_workforcemanagement_businessunit_servicegoaltemplates_with_http_info(business_unit_id, opts = {}) click to toggle source

Gets list of service goal templates

@param business_unit_id The ID of the business unit. @param [Hash] opts the optional parameters @return [Array<(ServiceGoalTemplateList, Fixnum, Hash)>] ServiceGoalTemplateList data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2059
def get_workforcemanagement_businessunit_servicegoaltemplates_with_http_info(business_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunit_servicegoaltemplates ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_servicegoaltemplates" if business_unit_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ServiceGoalTemplateList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunit_servicegoaltemplates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunit_week_schedule(business_unit_id, week_id, schedule_id, opts = {}) click to toggle source

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

@param business_unit_id The ID of the business unit @param week_id First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param schedule_id The ID of the schedule @param [Hash] opts the optional parameters @return [BuScheduleMetadata]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2116
def get_workforcemanagement_businessunit_week_schedule(business_unit_id, week_id, schedule_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunit_week_schedule_with_http_info(business_unit_id, week_id, schedule_id, opts)
  return data
end
get_workforcemanagement_businessunit_week_schedule_generationresults(business_unit_id, week_id, schedule_id, opts = {}) click to toggle source

Get the generation results for a generated schedule

@param business_unit_id The ID of the business unit @param week_id First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param schedule_id The ID of the schedule @param [Hash] opts the optional parameters @return [ScheduleGenerationResult]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2201
def get_workforcemanagement_businessunit_week_schedule_generationresults(business_unit_id, week_id, schedule_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunit_week_schedule_generationresults_with_http_info(business_unit_id, week_id, schedule_id, opts)
  return data
end
get_workforcemanagement_businessunit_week_schedule_generationresults_with_http_info(business_unit_id, week_id, schedule_id, opts = {}) click to toggle source

Get the generation results for a generated schedule

@param business_unit_id The ID of the business unit @param week_id First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param schedule_id The ID of the schedule @param [Hash] opts the optional parameters @return [Array<(ScheduleGenerationResult, Fixnum, Hash)>] ScheduleGenerationResult data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2213
def get_workforcemanagement_businessunit_week_schedule_generationresults_with_http_info(business_unit_id, week_id, schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunit_week_schedule_generationresults ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_schedule_generationresults" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_schedule_generationresults" if week_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'schedule_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_schedule_generationresults" if schedule_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScheduleGenerationResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunit_week_schedule_generationresults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunit_week_schedule_headcountforecast(business_unit_id, week_id, schedule_id, opts = {}) click to toggle source

Get the headcount forecast by planning group for the schedule

@param business_unit_id The ID of the business unit @param week_id First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param schedule_id The ID of the schedule @param [Hash] opts the optional parameters @option opts [BOOLEAN] :force_download Whether to force the result to come via download url. For testing purposes only @return [BuHeadcountForecastResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2287
def get_workforcemanagement_businessunit_week_schedule_headcountforecast(business_unit_id, week_id, schedule_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunit_week_schedule_headcountforecast_with_http_info(business_unit_id, week_id, schedule_id, opts)
  return data
end
get_workforcemanagement_businessunit_week_schedule_headcountforecast_with_http_info(business_unit_id, week_id, schedule_id, opts = {}) click to toggle source

Get the headcount forecast by planning group for the schedule

@param business_unit_id The ID of the business unit @param week_id First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param schedule_id The ID of the schedule @param [Hash] opts the optional parameters @option opts [BOOLEAN] :force_download Whether to force the result to come via download url. For testing purposes only @return [Array<(BuHeadcountForecastResponse, Fixnum, Hash)>] BuHeadcountForecastResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2300
def get_workforcemanagement_businessunit_week_schedule_headcountforecast_with_http_info(business_unit_id, week_id, schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunit_week_schedule_headcountforecast ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_schedule_headcountforecast" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_schedule_headcountforecast" if week_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'schedule_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_schedule_headcountforecast" if schedule_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/headcountforecast".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'forceDownload'] = opts[:'force_download'] if opts[:'force_download']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BuHeadcountForecastResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunit_week_schedule_headcountforecast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunit_week_schedule_with_http_info(business_unit_id, week_id, schedule_id, opts = {}) click to toggle source

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

@param business_unit_id The ID of the business unit @param week_id First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param schedule_id The ID of the schedule @param [Hash] opts the optional parameters @return [Array<(BuScheduleMetadata, Fixnum, Hash)>] BuScheduleMetadata data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2128
def get_workforcemanagement_businessunit_week_schedule_with_http_info(business_unit_id, week_id, schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunit_week_schedule ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_schedule" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_schedule" if week_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'schedule_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_schedule" if schedule_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BuScheduleMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunit_week_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunit_week_schedules(business_unit_id, week_id, opts = {}) click to toggle source

Get the list of week schedules for the specified week Use "recent" for the `weekId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any schedule which spans the specified week @param business_unit_id The ID of the business unit @param week_id First day of schedule week in yyyy-MM-dd format, or &#39;recent&#39; to get recent schedules @param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_only_published includeOnlyPublished @option opts [String] :expand expand @return [BuScheduleListing]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2381
def get_workforcemanagement_businessunit_week_schedules(business_unit_id, week_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunit_week_schedules_with_http_info(business_unit_id, week_id, opts)
  return data
end
get_workforcemanagement_businessunit_week_schedules_with_http_info(business_unit_id, week_id, opts = {}) click to toggle source

Get the list of week schedules for the specified week Use "recent&quot; for the `weekId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any schedule which spans the specified week @param business_unit_id The ID of the business unit @param week_id First day of schedule week in yyyy-MM-dd format, or &#39;recent&#39; to get recent schedules @param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_only_published includeOnlyPublished @option opts [String] :expand expand @return [Array<(BuScheduleListing, Fixnum, Hash)>] BuScheduleListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2394
def get_workforcemanagement_businessunit_week_schedules_with_http_info(business_unit_id, week_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunit_week_schedules ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_schedules" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_schedules" if week_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'expand'] && !['forecast.description'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of forecast.description'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeOnlyPublished'] = opts[:'include_only_published'] if opts[:'include_only_published']
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BuScheduleListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunit_week_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunit_week_shorttermforecast(business_unit_id, week_date_id, forecast_id, opts = {}) click to toggle source

Get a short term forecast

@param business_unit_id The business unit ID of the business unit to which the forecast belongs @param week_date_id 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 @param forecast_id The ID of the forecast @param [Hash] opts the optional parameters @option opts [Array<String>] :expand @return [BuShortTermForecast]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2478
def get_workforcemanagement_businessunit_week_shorttermforecast(business_unit_id, week_date_id, forecast_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunit_week_shorttermforecast_with_http_info(business_unit_id, week_date_id, forecast_id, opts)
  return data
end
get_workforcemanagement_businessunit_week_shorttermforecast_data(business_unit_id, week_date_id, forecast_id, opts = {}) click to toggle source

Get the result of a short term forecast calculation Includes modifications unless you pass the doNotApplyModifications query parameter @param business_unit_id The business unit ID of the business unit to which the forecast belongs @param week_date_id 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 @param forecast_id The ID of the forecast @param [Hash] opts the optional parameters @option opts [Integer] :week_number The week number to fetch (for multi-week forecasts) @option opts [BOOLEAN] :force_download_service Force the result of this operation to be sent via download service. For testing/app development purposes @return [BuForecastResultResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2573
def get_workforcemanagement_businessunit_week_shorttermforecast_data(business_unit_id, week_date_id, forecast_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunit_week_shorttermforecast_data_with_http_info(business_unit_id, week_date_id, forecast_id, opts)
  return data
end
get_workforcemanagement_businessunit_week_shorttermforecast_data_with_http_info(business_unit_id, week_date_id, forecast_id, opts = {}) click to toggle source

Get the result of a short term forecast calculation Includes modifications unless you pass the doNotApplyModifications query parameter @param business_unit_id The business unit ID of the business unit to which the forecast belongs @param week_date_id 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 @param forecast_id The ID of the forecast @param [Hash] opts the optional parameters @option opts [Integer] :week_number The week number to fetch (for multi-week forecasts) @option opts [BOOLEAN] :force_download_service Force the result of this operation to be sent via download service. For testing/app development purposes @return [Array<(BuForecastResultResponse, Fixnum, Hash)>] BuForecastResultResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2587
def get_workforcemanagement_businessunit_week_shorttermforecast_data_with_http_info(business_unit_id, week_date_id, forecast_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunit_week_shorttermforecast_data ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_shorttermforecast_data" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_shorttermforecast_data" if week_date_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'forecast_id' is set
  fail ArgumentError, "Missing the required parameter 'forecast_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_shorttermforecast_data" if forecast_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/data".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s).sub('{' + 'forecastId' + '}', forecast_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'weekNumber'] = opts[:'week_number'] if opts[:'week_number']
  query_params[:'forceDownloadService'] = opts[:'force_download_service'] if opts[:'force_download_service']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BuForecastResultResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunit_week_shorttermforecast_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunit_week_shorttermforecast_generationresults(business_unit_id, week_date_id, forecast_id, opts = {}) click to toggle source

Gets the forecast generation results

@param business_unit_id The business unit ID of the business unit to which the forecast belongs @param week_date_id 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 @param forecast_id The ID of the forecast @param [Hash] opts the optional parameters @return [BuForecastGenerationResult]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2674
def get_workforcemanagement_businessunit_week_shorttermforecast_generationresults(business_unit_id, week_date_id, forecast_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunit_week_shorttermforecast_generationresults_with_http_info(business_unit_id, week_date_id, forecast_id, opts)
  return data
end
get_workforcemanagement_businessunit_week_shorttermforecast_generationresults_with_http_info(business_unit_id, week_date_id, forecast_id, opts = {}) click to toggle source

Gets the forecast generation results

@param business_unit_id The business unit ID of the business unit to which the forecast belongs @param week_date_id 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 @param forecast_id The ID of the forecast @param [Hash] opts the optional parameters @return [Array<(BuForecastGenerationResult, Fixnum, Hash)>] BuForecastGenerationResult data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2686
def get_workforcemanagement_businessunit_week_shorttermforecast_generationresults_with_http_info(business_unit_id, week_date_id, forecast_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunit_week_shorttermforecast_generationresults ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_shorttermforecast_generationresults" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_shorttermforecast_generationresults" if week_date_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'forecast_id' is set
  fail ArgumentError, "Missing the required parameter 'forecast_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_shorttermforecast_generationresults" if forecast_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/generationresults".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s).sub('{' + 'forecastId' + '}', forecast_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BuForecastGenerationResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunit_week_shorttermforecast_generationresults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunit_week_shorttermforecast_planninggroups(business_unit_id, week_date_id, forecast_id, opts = {}) click to toggle source

Gets the forecast planning group snapshot

@param business_unit_id The business unit ID of the business unit to which the forecast belongs @param week_date_id 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 @param forecast_id The ID of the forecast @param [Hash] opts the optional parameters @return [ForecastPlanningGroupsResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2759
def get_workforcemanagement_businessunit_week_shorttermforecast_planninggroups(business_unit_id, week_date_id, forecast_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunit_week_shorttermforecast_planninggroups_with_http_info(business_unit_id, week_date_id, forecast_id, opts)
  return data
end
get_workforcemanagement_businessunit_week_shorttermforecast_planninggroups_with_http_info(business_unit_id, week_date_id, forecast_id, opts = {}) click to toggle source

Gets the forecast planning group snapshot

@param business_unit_id The business unit ID of the business unit to which the forecast belongs @param week_date_id 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 @param forecast_id The ID of the forecast @param [Hash] opts the optional parameters @return [Array<(ForecastPlanningGroupsResponse, Fixnum, Hash)>] ForecastPlanningGroupsResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2771
def get_workforcemanagement_businessunit_week_shorttermforecast_planninggroups_with_http_info(business_unit_id, week_date_id, forecast_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunit_week_shorttermforecast_planninggroups ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_shorttermforecast_planninggroups" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_shorttermforecast_planninggroups" if week_date_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'forecast_id' is set
  fail ArgumentError, "Missing the required parameter 'forecast_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_shorttermforecast_planninggroups" if forecast_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/planninggroups".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s).sub('{' + 'forecastId' + '}', forecast_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ForecastPlanningGroupsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunit_week_shorttermforecast_planninggroups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunit_week_shorttermforecast_with_http_info(business_unit_id, week_date_id, forecast_id, opts = {}) click to toggle source

Get a short term forecast

@param business_unit_id The business unit ID of the business unit to which the forecast belongs @param week_date_id 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 @param forecast_id The ID of the forecast @param [Hash] opts the optional parameters @option opts [Array<String>] :expand @return [Array<(BuShortTermForecast, Fixnum, Hash)>] BuShortTermForecast data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2491
def get_workforcemanagement_businessunit_week_shorttermforecast_with_http_info(business_unit_id, week_date_id, forecast_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunit_week_shorttermforecast ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_shorttermforecast" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_shorttermforecast" if week_date_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'forecast_id' is set
  fail ArgumentError, "Missing the required parameter 'forecast_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_shorttermforecast" if forecast_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s).sub('{' + 'forecastId' + '}', forecast_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BuShortTermForecast')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunit_week_shorttermforecast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunit_week_shorttermforecasts(business_unit_id, week_date_id, opts = {}) click to toggle source

Get short term forecasts Use "recent" for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week @param business_unit_id The business unit ID of the business unit to which the forecast belongs @param week_date_id The week start date of the forecast in yyyy-MM-dd format or &#39;recent&#39; to fetch recent forecasts @param [Hash] opts the optional parameters @return [BuShortTermForecastListing]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2843
def get_workforcemanagement_businessunit_week_shorttermforecasts(business_unit_id, week_date_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunit_week_shorttermforecasts_with_http_info(business_unit_id, week_date_id, opts)
  return data
end
get_workforcemanagement_businessunit_week_shorttermforecasts_with_http_info(business_unit_id, week_date_id, opts = {}) click to toggle source

Get short term forecasts Use "recent&quot; for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week @param business_unit_id The business unit ID of the business unit to which the forecast belongs @param week_date_id The week start date of the forecast in yyyy-MM-dd format or &#39;recent&#39; to fetch recent forecasts @param [Hash] opts the optional parameters @return [Array<(BuShortTermForecastListing, Fixnum, Hash)>] BuShortTermForecastListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2854
def get_workforcemanagement_businessunit_week_shorttermforecasts_with_http_info(business_unit_id, week_date_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunit_week_shorttermforecasts ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_shorttermforecasts" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit_week_shorttermforecasts" if week_date_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BuShortTermForecastListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunit_week_shorttermforecasts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunit_with_http_info(business_unit_id, opts = {}) click to toggle source

Get business unit Expanding "settings&quot; will retrieve all settings. All other expands will retrieve only the requested settings field(s). @param business_unit_id The ID of the business unit, or &#39;mine&#39; for the business unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [Array<String>] :expand @return [Array<(BusinessUnit, Fixnum, Hash)>] BusinessUnit data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 1232
def get_workforcemanagement_businessunit_with_http_info(business_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunit ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_businessunit" if business_unit_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BusinessUnit')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunits(opts = {}) click to toggle source

Get business units

@param [Hash] opts the optional parameters @option opts [String] :feature @option opts [String] :division_id @return [BusinessUnitListing]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2918
def get_workforcemanagement_businessunits(opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunits_with_http_info(opts)
  return data
end
get_workforcemanagement_businessunits_divisionviews(opts = {}) click to toggle source

Get business units across divisions

@param [Hash] opts the optional parameters @option opts [Array<String>] :division_id The divisionIds to filter by. If omitted, will return business units in all divisions @return [BusinessUnitListing]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2994
def get_workforcemanagement_businessunits_divisionviews(opts = {})
  data, _status_code, _headers = get_workforcemanagement_businessunits_divisionviews_with_http_info(opts)
  return data
end
get_workforcemanagement_businessunits_divisionviews_with_http_info(opts = {}) click to toggle source

Get business units across divisions

@param [Hash] opts the optional parameters @option opts [Array<String>] :division_id The divisionIds to filter by. If omitted, will return business units in all divisions @return [Array<(BusinessUnitListing, Fixnum, Hash)>] BusinessUnitListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3004
def get_workforcemanagement_businessunits_divisionviews_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunits_divisionviews ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/divisionviews".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BusinessUnitListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunits_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_businessunits_with_http_info(opts = {}) click to toggle source

Get business units

@param [Hash] opts the optional parameters @option opts [String] :feature @option opts [String] :division_id @return [Array<(BusinessUnitListing, Fixnum, Hash)>] BusinessUnitListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 2929
def get_workforcemanagement_businessunits_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_businessunits ..."
  end
  
  
  
  
  if opts[:'feature'] && !['AgentSchedule', 'AgentTimeOffRequest', 'Coaching', 'ActivityCodes', 'Agents', 'BuActivityCodes', 'BusinessUnits', 'HistoricalAdherence', 'IntradayMonitoring', 'BuIntradayMonitoring', 'ManagementUnits', 'RealTimeAdherence', 'Schedules', 'BuSchedules', 'ServiceGoalGroups', 'ServiceGoalTemplates', 'PlanningGroups', 'ShiftTrading', 'ShortTermForecasts', 'BuShortTermForecasts', 'TimeOffRequests', 'WorkPlanRotations', 'WorkPlans'].include?(opts[:'feature'])
    fail ArgumentError, 'invalid value for "feature", must be one of AgentSchedule, AgentTimeOffRequest, Coaching, ActivityCodes, Agents, BuActivityCodes, BusinessUnits, HistoricalAdherence, IntradayMonitoring, BuIntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, BuSchedules, ServiceGoalGroups, ServiceGoalTemplates, PlanningGroups, ShiftTrading, ShortTermForecasts, BuShortTermForecasts, TimeOffRequests, WorkPlanRotations, WorkPlans'
  end
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'feature'] = opts[:'feature'] if opts[:'feature']
  query_params[:'divisionId'] = opts[:'division_id'] if opts[:'division_id']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BusinessUnitListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_businessunits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit(mu_id, opts = {}) click to toggle source

Get management unit

@param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [Array<String>] :expand @return [ManagementUnit]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3059
def get_workforcemanagement_managementunit(mu_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_with_http_info(mu_id, opts)
  return data
end
get_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts = {}) click to toggle source

Get an activity code

@param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param ac_id The ID of the activity code to fetch @param [Hash] opts the optional parameters @return [ActivityCode]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3133
def get_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_activitycode_with_http_info(mu_id, ac_id, opts)
  return data
end
get_workforcemanagement_managementunit_activitycode_with_http_info(mu_id, ac_id, opts = {}) click to toggle source

Get an activity code

@param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param ac_id The ID of the activity code to fetch @param [Hash] opts the optional parameters @return [Array<(ActivityCode, Fixnum, Hash)>] ActivityCode data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3144
def get_workforcemanagement_managementunit_activitycode_with_http_info(mu_id, ac_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_activitycode ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_activitycode" if mu_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'ac_id' is set
  fail ArgumentError, "Missing the required parameter 'ac_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_activitycode" if ac_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s).sub('{' + 'acId' + '}', ac_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ActivityCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_activitycode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_activitycodes(mu_id, opts = {}) click to toggle source

Get activity codes

@param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @return [ActivityCodeContainer]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3207
def get_workforcemanagement_managementunit_activitycodes(mu_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_activitycodes_with_http_info(mu_id, opts)
  return data
end
get_workforcemanagement_managementunit_activitycodes_with_http_info(mu_id, opts = {}) click to toggle source

Get activity codes

@param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @return [Array<(ActivityCodeContainer, Fixnum, Hash)>] ActivityCodeContainer data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3217
def get_workforcemanagement_managementunit_activitycodes_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_activitycodes ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_activitycodes" if mu_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/activitycodes".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ActivityCodeContainer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_activitycodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_adherence(management_unit_id, opts = {}) click to toggle source

Get a list of user schedule adherence records for the requested management unit

@param management_unit_id The management unit ID of the management unit. @param [Hash] opts the optional parameters @option opts [BOOLEAN] :force_download_service Force the result of this operation to be sent via download service. For testing/app development purposes @return [UserScheduleAdherenceListing]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3273
def get_workforcemanagement_managementunit_adherence(management_unit_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_adherence_with_http_info(management_unit_id, opts)
  return data
end
get_workforcemanagement_managementunit_adherence_with_http_info(management_unit_id, opts = {}) click to toggle source

Get a list of user schedule adherence records for the requested management unit

@param management_unit_id The management unit ID of the management unit. @param [Hash] opts the optional parameters @option opts [BOOLEAN] :force_download_service Force the result of this operation to be sent via download service. For testing/app development purposes @return [Array<(UserScheduleAdherenceListing, Fixnum, Hash)>] UserScheduleAdherenceListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3284
def get_workforcemanagement_managementunit_adherence_with_http_info(management_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_adherence ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_adherence" if management_unit_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/adherence".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'forceDownloadService'] = opts[:'force_download_service'] if opts[:'force_download_service']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserScheduleAdherenceListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_adherence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_agent(management_unit_id, agent_id, opts = {}) click to toggle source

Get data for agent in the management unit

@param management_unit_id The id of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param agent_id The agent id @param [Hash] opts the optional parameters @option opts [BOOLEAN] :exclude_capabilities Excludes all capabilities of the agent such as queues, languages, and skills @return [WfmAgent]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3348
def get_workforcemanagement_managementunit_agent(management_unit_id, agent_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_agent_with_http_info(management_unit_id, agent_id, opts)
  return data
end
get_workforcemanagement_managementunit_agent_shifttrades(management_unit_id, agent_id, opts = {}) click to toggle source

Gets all the shift trades for a given agent

@param management_unit_id The id of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param agent_id The agent id @param [Hash] opts the optional parameters @return [ShiftTradeListResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3431
def get_workforcemanagement_managementunit_agent_shifttrades(management_unit_id, agent_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_agent_shifttrades_with_http_info(management_unit_id, agent_id, opts)
  return data
end
get_workforcemanagement_managementunit_agent_shifttrades_with_http_info(management_unit_id, agent_id, opts = {}) click to toggle source

Gets all the shift trades for a given agent

@param management_unit_id The id of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param agent_id The agent id @param [Hash] opts the optional parameters @return [Array<(ShiftTradeListResponse, Fixnum, Hash)>] ShiftTradeListResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3442
def get_workforcemanagement_managementunit_agent_shifttrades_with_http_info(management_unit_id, agent_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_agent_shifttrades ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_agent_shifttrades" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'agent_id' is set
  fail ArgumentError, "Missing the required parameter 'agent_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_agent_shifttrades" if agent_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}/shifttrades".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'agentId' + '}', agent_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ShiftTradeListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_agent_shifttrades\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_agent_with_http_info(management_unit_id, agent_id, opts = {}) click to toggle source

Get data for agent in the management unit

@param management_unit_id The id of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param agent_id The agent id @param [Hash] opts the optional parameters @option opts [BOOLEAN] :exclude_capabilities Excludes all capabilities of the agent such as queues, languages, and skills @return [Array<(WfmAgent, Fixnum, Hash)>] WfmAgent data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3360
def get_workforcemanagement_managementunit_agent_with_http_info(management_unit_id, agent_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_agent ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_agent" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'agent_id' is set
  fail ArgumentError, "Missing the required parameter 'agent_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_agent" if agent_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'agentId' + '}', agent_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'excludeCapabilities'] = opts[:'exclude_capabilities'] if opts[:'exclude_capabilities']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WfmAgent')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_agent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_intraday_queues(mu_id, opts = {}) click to toggle source

Gone. Moved under business units

@param mu_id The management unit ID of the management unit @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3505
def get_workforcemanagement_managementunit_intraday_queues(mu_id, opts = {})
  get_workforcemanagement_managementunit_intraday_queues_with_http_info(mu_id, opts)
  return nil
end
get_workforcemanagement_managementunit_intraday_queues_with_http_info(mu_id, opts = {}) click to toggle source

Gone. Moved under business units

@param mu_id The management unit ID of the management unit @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3515
def get_workforcemanagement_managementunit_intraday_queues_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_intraday_queues ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_intraday_queues" if mu_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/intraday/queues".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_intraday_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id (Deprecated/gone): The ID of the management unit. @param run_id The ID of the schedule run @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3570
def get_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id, opts = {})
  get_workforcemanagement_managementunit_scheduling_run_with_http_info(management_unit_id, run_id, opts)
  return nil
end
get_workforcemanagement_managementunit_scheduling_run_result(management_unit_id, run_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id (Deprecated/gone): The ID of the management unit. @param run_id The ID of the schedule run @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3644
def get_workforcemanagement_managementunit_scheduling_run_result(management_unit_id, run_id, opts = {})
  get_workforcemanagement_managementunit_scheduling_run_result_with_http_info(management_unit_id, run_id, opts)
  return nil
end
get_workforcemanagement_managementunit_scheduling_run_result_with_http_info(management_unit_id, run_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id (Deprecated/gone): The ID of the management unit. @param run_id The ID of the schedule run @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3655
def get_workforcemanagement_managementunit_scheduling_run_result_with_http_info(management_unit_id, run_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_scheduling_run_result ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_scheduling_run_result" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'run_id' is set
  fail ArgumentError, "Missing the required parameter 'run_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_scheduling_run_result" if run_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}/result".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'runId' + '}', run_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_scheduling_run_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_scheduling_run_with_http_info(management_unit_id, run_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id (Deprecated/gone): The ID of the management unit. @param run_id The ID of the schedule run @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3581
def get_workforcemanagement_managementunit_scheduling_run_with_http_info(management_unit_id, run_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_scheduling_run ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_scheduling_run" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'run_id' is set
  fail ArgumentError, "Missing the required parameter 'run_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_scheduling_run" if run_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'runId' + '}', run_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_scheduling_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_scheduling_runs(management_unit_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id (Deprecated/gone): The ID of the management unit. @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3717
def get_workforcemanagement_managementunit_scheduling_runs(management_unit_id, opts = {})
  get_workforcemanagement_managementunit_scheduling_runs_with_http_info(management_unit_id, opts)
  return nil
end
get_workforcemanagement_managementunit_scheduling_runs_with_http_info(management_unit_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id (Deprecated/gone): The ID of the management unit. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3727
def get_workforcemanagement_managementunit_scheduling_runs_with_http_info(management_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_scheduling_runs ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_scheduling_runs" if management_unit_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_scheduling_runs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts = {}) click to toggle source

Gone. Replaced with service goal templates and planning groups under business units

@param management_unit_id (Deprecated/gone): The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param service_goal_group_id Gone. The ID of the service goal group to fetch @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3782
def get_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts = {})
  get_workforcemanagement_managementunit_servicegoalgroup_with_http_info(management_unit_id, service_goal_group_id, opts)
  return nil
end
get_workforcemanagement_managementunit_servicegoalgroup_with_http_info(management_unit_id, service_goal_group_id, opts = {}) click to toggle source

Gone. Replaced with service goal templates and planning groups under business units

@param management_unit_id (Deprecated/gone): The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param service_goal_group_id Gone. The ID of the service goal group to fetch @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3793
def get_workforcemanagement_managementunit_servicegoalgroup_with_http_info(management_unit_id, service_goal_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_servicegoalgroup ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_servicegoalgroup" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'service_goal_group_id' is set
  fail ArgumentError, "Missing the required parameter 'service_goal_group_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_servicegoalgroup" if service_goal_group_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'serviceGoalGroupId' + '}', service_goal_group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_servicegoalgroup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_servicegoalgroups(management_unit_id, opts = {}) click to toggle source

Gone. Replaced with service goal templates and planning groups under business units

@param management_unit_id (Deprecated/gone): The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3855
def get_workforcemanagement_managementunit_servicegoalgroups(management_unit_id, opts = {})
  get_workforcemanagement_managementunit_servicegoalgroups_with_http_info(management_unit_id, opts)
  return nil
end
get_workforcemanagement_managementunit_servicegoalgroups_with_http_info(management_unit_id, opts = {}) click to toggle source

Gone. Replaced with service goal templates and planning groups under business units

@param management_unit_id (Deprecated/gone): The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3865
def get_workforcemanagement_managementunit_servicegoalgroups_with_http_info(management_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_servicegoalgroups ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_servicegoalgroups" if management_unit_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_servicegoalgroups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_settings(mu_id, opts = {}) click to toggle source

Gone. Get management unit settings via expand parameters on the GET management unit

@param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3919
def get_workforcemanagement_managementunit_settings(mu_id, opts = {})
  get_workforcemanagement_managementunit_settings_with_http_info(mu_id, opts)
  return nil
end
get_workforcemanagement_managementunit_settings_with_http_info(mu_id, opts = {}) click to toggle source

Gone. Get management unit settings via expand parameters on the GET management unit

@param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3929
def get_workforcemanagement_managementunit_settings_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_settings ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_settings" if mu_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/settings".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_shifttrades_matched(mu_id, opts = {}) click to toggle source

Gets a summary of all shift trades in the matched state

@param mu_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @return [ShiftTradeMatchesSummaryResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3983
def get_workforcemanagement_managementunit_shifttrades_matched(mu_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_shifttrades_matched_with_http_info(mu_id, opts)
  return data
end
get_workforcemanagement_managementunit_shifttrades_matched_with_http_info(mu_id, opts = {}) click to toggle source

Gets a summary of all shift trades in the matched state

@param mu_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @return [Array<(ShiftTradeMatchesSummaryResponse, Fixnum, Hash)>] ShiftTradeMatchesSummaryResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3993
def get_workforcemanagement_managementunit_shifttrades_matched_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_shifttrades_matched ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_shifttrades_matched" if mu_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/shifttrades/matched".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ShiftTradeMatchesSummaryResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_shifttrades_matched\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_shifttrades_users(mu_id, opts = {}) click to toggle source

Gets list of users available for whom you can send direct shift trade requests

@param mu_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @return [WfmUserEntityListing]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4048
def get_workforcemanagement_managementunit_shifttrades_users(mu_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_shifttrades_users_with_http_info(mu_id, opts)
  return data
end
get_workforcemanagement_managementunit_shifttrades_users_with_http_info(mu_id, opts = {}) click to toggle source

Gets list of users available for whom you can send direct shift trade requests

@param mu_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @return [Array<(WfmUserEntityListing, Fixnum, Hash)>] WfmUserEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4058
def get_workforcemanagement_managementunit_shifttrades_users_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_shifttrades_users ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_shifttrades_users" if mu_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/shifttrades/users".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WfmUserEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_shifttrades_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts = {}) click to toggle source

Get a time off request

@param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param user_id The userId to whom the Time Off Request applies. @param time_off_request_id Time Off Request Id @param [Hash] opts the optional parameters @return [TimeOffRequestResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4115
def get_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_user_timeoffrequest_with_http_info(mu_id, user_id, time_off_request_id, opts)
  return data
end
get_workforcemanagement_managementunit_user_timeoffrequest_with_http_info(mu_id, user_id, time_off_request_id, opts = {}) click to toggle source

Get a time off request

@param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param user_id The userId to whom the Time Off Request applies. @param time_off_request_id Time Off Request Id @param [Hash] opts the optional parameters @return [Array<(TimeOffRequestResponse, Fixnum, Hash)>] TimeOffRequestResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4127
def get_workforcemanagement_managementunit_user_timeoffrequest_with_http_info(mu_id, user_id, time_off_request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_user_timeoffrequest ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_user_timeoffrequest" if mu_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_user_timeoffrequest" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'time_off_request_id' is set
  fail ArgumentError, "Missing the required parameter 'time_off_request_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_user_timeoffrequest" if time_off_request_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId}".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s).sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'timeOffRequestId' + '}', time_off_request_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeOffRequestResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_user_timeoffrequest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_user_timeoffrequests(mu_id, user_id, opts = {}) click to toggle source

Get a list of time off requests for a given user

@param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param user_id The userId to whom the Time Off Request applies. @param [Hash] opts the optional parameters @option opts [BOOLEAN] :recently_reviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false) @return [TimeOffRequestList]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4200
def get_workforcemanagement_managementunit_user_timeoffrequests(mu_id, user_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_user_timeoffrequests_with_http_info(mu_id, user_id, opts)
  return data
end
get_workforcemanagement_managementunit_user_timeoffrequests_with_http_info(mu_id, user_id, opts = {}) click to toggle source

Get a list of time off requests for a given user

@param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param user_id The userId to whom the Time Off Request applies. @param [Hash] opts the optional parameters @option opts [BOOLEAN] :recently_reviewed Limit results to requests that have been reviewed within the preceding 30 days @return [Array<(TimeOffRequestList, Fixnum, Hash)>] TimeOffRequestList data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4212
def get_workforcemanagement_managementunit_user_timeoffrequests_with_http_info(mu_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_user_timeoffrequests ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_user_timeoffrequests" if mu_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_user_timeoffrequests" if user_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'recentlyReviewed'] = opts[:'recently_reviewed'] if opts[:'recently_reviewed']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeOffRequestList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_user_timeoffrequests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_users(mu_id, opts = {}) click to toggle source

Get users in the management unit

@param mu_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @return [WfmUserEntityListing]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4282
def get_workforcemanagement_managementunit_users(mu_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_users_with_http_info(mu_id, opts)
  return data
end
get_workforcemanagement_managementunit_users_with_http_info(mu_id, opts = {}) click to toggle source

Get users in the management unit

@param mu_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @return [Array<(WfmUserEntityListing, Fixnum, Hash)>] WfmUserEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4292
def get_workforcemanagement_managementunit_users_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_users ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_users" if mu_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/users".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WfmUserEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts = {}) click to toggle source

Deprecated. Use the equivalent business unit resource instead. Get a week schedule

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_id First day of schedule week in yyyy-MM-dd format. @param schedule_id The ID of the schedule to fetch @param [Hash] opts the optional parameters @option opts [String] :expand Which fields, if any, to expand @option opts [BOOLEAN] :force_download_service Force the result of this operation to be sent via download service. For testing/app development purposes @return [WeekScheduleResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4351
def get_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_week_schedule_with_http_info(management_unit_id, week_id, schedule_id, opts)
  return data
end
get_workforcemanagement_managementunit_week_schedule_generationresults(management_unit_id, week_id, schedule_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_id First day of schedule week in yyyy-MM-dd format. @param schedule_id Gone/deprecated. The ID of the schedule to fetch generation results @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4456
def get_workforcemanagement_managementunit_week_schedule_generationresults(management_unit_id, week_id, schedule_id, opts = {})
  get_workforcemanagement_managementunit_week_schedule_generationresults_with_http_info(management_unit_id, week_id, schedule_id, opts)
  return nil
end
get_workforcemanagement_managementunit_week_schedule_generationresults_with_http_info(management_unit_id, week_id, schedule_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_id First day of schedule week in yyyy-MM-dd format. @param schedule_id Gone/deprecated. The ID of the schedule to fetch generation results @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4468
def get_workforcemanagement_managementunit_week_schedule_generationresults_with_http_info(management_unit_id, week_id, schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedule_generationresults ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedule_generationresults" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedule_generationresults" if week_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'schedule_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedule_generationresults" if schedule_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_week_schedule_generationresults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_week_schedule_with_http_info(management_unit_id, week_id, schedule_id, opts = {}) click to toggle source

Deprecated. Use the equivalent business unit resource instead. Get a week schedule

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_id First day of schedule week in yyyy-MM-dd format. @param schedule_id The ID of the schedule to fetch @param [Hash] opts the optional parameters @option opts [String] :expand Which fields, if any, to expand @option opts [BOOLEAN] :force_download_service Force the result of this operation to be sent via download service. For testing/app development purposes @return [Array<(WeekScheduleResponse, Fixnum, Hash)>] WeekScheduleResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4365
def get_workforcemanagement_managementunit_week_schedule_with_http_info(management_unit_id, week_id, schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedule ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedule" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedule" if week_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'schedule_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedule" if schedule_id.nil?
  
  
  
  
  
  
  
  
  if opts[:'expand'] && !['generationResults', 'headcountForecast'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of generationResults, headcountForecast'
  end
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
  query_params[:'forceDownloadService'] = opts[:'force_download_service'] if opts[:'force_download_service']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WeekScheduleResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_week_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id, opts = {}) click to toggle source

Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_id First day of schedule week in yyyy-MM-dd format. @param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_only_published Return only published schedules @option opts [String] :earliest_week_date The start date of the earliest week to query in yyyy-MM-dd format @option opts [String] :latest_week_date The start date of the latest week to query in yyyy-MM-dd format @return [WeekScheduleListResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4542
def get_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_week_schedules_with_http_info(management_unit_id, week_id, opts)
  return data
end
get_workforcemanagement_managementunit_week_schedules_with_http_info(management_unit_id, week_id, opts = {}) click to toggle source

Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_id First day of schedule week in yyyy-MM-dd format. @param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_only_published Return only published schedules @option opts [String] :earliest_week_date The start date of the earliest week to query in yyyy-MM-dd format @option opts [String] :latest_week_date The start date of the latest week to query in yyyy-MM-dd format @return [Array<(WeekScheduleListResponse, Fixnum, Hash)>] WeekScheduleListResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4556
def get_workforcemanagement_managementunit_week_schedules_with_http_info(management_unit_id, week_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedules ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedules" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedules" if week_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeOnlyPublished'] = opts[:'include_only_published'] if opts[:'include_only_published']
  query_params[:'earliestWeekDate'] = opts[:'earliest_week_date'] if opts[:'earliest_week_date']
  query_params[:'latestWeekDate'] = opts[:'latest_week_date'] if opts[:'latest_week_date']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WeekScheduleListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_week_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_week_shifttrades(management_unit_id, week_date_id, opts = {}) click to toggle source

Gets all the shift trades for a given week

@param management_unit_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_date_id The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param [Hash] opts the optional parameters @option opts [BOOLEAN] :evaluate_matches Whether to evaluate the matches for violations (default to true) @return [WeekShiftTradeListResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4642
def get_workforcemanagement_managementunit_week_shifttrades(management_unit_id, week_date_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_week_shifttrades_with_http_info(management_unit_id, week_date_id, opts)
  return data
end
get_workforcemanagement_managementunit_week_shifttrades_with_http_info(management_unit_id, week_date_id, opts = {}) click to toggle source

Gets all the shift trades for a given week

@param management_unit_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_date_id The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param [Hash] opts the optional parameters @option opts [BOOLEAN] :evaluate_matches Whether to evaluate the matches for violations @return [Array<(WeekShiftTradeListResponse, Fixnum, Hash)>] WeekShiftTradeListResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4654
def get_workforcemanagement_managementunit_week_shifttrades_with_http_info(management_unit_id, week_date_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_week_shifttrades ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_shifttrades" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_shifttrades" if week_date_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'evaluateMatches'] = opts[:'evaluate_matches'] if opts[:'evaluate_matches']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WeekShiftTradeListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_week_shifttrades\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_week_shorttermforecast_final(management_unit_id, week_date_id, forecast_id, opts = {}) click to toggle source

Gone. Use equivalent business unit resource instead

@param management_unit_id (Deprecated/gone): The id of the management unit. @param week_date_id (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format @param forecast_id (Gone/Deprecated): The ID of the forecast @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4726
def get_workforcemanagement_managementunit_week_shorttermforecast_final(management_unit_id, week_date_id, forecast_id, opts = {})
  get_workforcemanagement_managementunit_week_shorttermforecast_final_with_http_info(management_unit_id, week_date_id, forecast_id, opts)
  return nil
end
get_workforcemanagement_managementunit_week_shorttermforecast_final_with_http_info(management_unit_id, week_date_id, forecast_id, opts = {}) click to toggle source

Gone. Use equivalent business unit resource instead

@param management_unit_id (Deprecated/gone): The id of the management unit. @param week_date_id (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format @param forecast_id (Gone/Deprecated): The ID of the forecast @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4738
def get_workforcemanagement_managementunit_week_shorttermforecast_final_with_http_info(management_unit_id, week_date_id, forecast_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_week_shorttermforecast_final ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_shorttermforecast_final" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_shorttermforecast_final" if week_date_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'forecast_id' is set
  fail ArgumentError, "Missing the required parameter 'forecast_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_shorttermforecast_final" if forecast_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/final".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s).sub('{' + 'forecastId' + '}', forecast_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_week_shorttermforecast_final\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id, opts = {}) click to toggle source

Gone. Use equivalent business unit resource instead

@param management_unit_id (Deprecated/gone): The id of the management unit. @param week_date_id (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4809
def get_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id, opts = {})
  get_workforcemanagement_managementunit_week_shorttermforecasts_with_http_info(management_unit_id, week_date_id, opts)
  return nil
end
get_workforcemanagement_managementunit_week_shorttermforecasts_with_http_info(management_unit_id, week_date_id, opts = {}) click to toggle source

Gone. Use equivalent business unit resource instead

@param management_unit_id (Deprecated/gone): The id of the management unit. @param week_date_id (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4820
def get_workforcemanagement_managementunit_week_shorttermforecasts_with_http_info(management_unit_id, week_date_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_week_shorttermforecasts ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_shorttermforecasts" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_shorttermforecasts" if week_date_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_week_shorttermforecasts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_with_http_info(mu_id, opts = {}) click to toggle source

Get management unit

@param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [Array<String>] :expand @return [Array<(ManagementUnit, Fixnum, Hash)>] ManagementUnit data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 3070
def get_workforcemanagement_managementunit_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit" if mu_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ManagementUnit')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts = {}) click to toggle source

Get a work plan

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param work_plan_id The ID of the work plan to fetch @param [Hash] opts the optional parameters @return [WorkPlan]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4883
def get_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_workplan_with_http_info(management_unit_id, work_plan_id, opts)
  return data
end
get_workforcemanagement_managementunit_workplan_with_http_info(management_unit_id, work_plan_id, opts = {}) click to toggle source

Get a work plan

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param work_plan_id The ID of the work plan to fetch @param [Hash] opts the optional parameters @return [Array<(WorkPlan, Fixnum, Hash)>] WorkPlan data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4894
def get_workforcemanagement_managementunit_workplan_with_http_info(management_unit_id, work_plan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_workplan ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_workplan" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'work_plan_id' is set
  fail ArgumentError, "Missing the required parameter 'work_plan_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_workplan" if work_plan_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'workPlanId' + '}', work_plan_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkPlan')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_workplan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunit_workplans(management_unit_id, opts = {}) click to toggle source

Get work plans

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [Array<String>] :expand @return [WorkPlanListResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4958
def get_workforcemanagement_managementunit_workplans(management_unit_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_workplans_with_http_info(management_unit_id, opts)
  return data
end
get_workforcemanagement_managementunit_workplans_with_http_info(management_unit_id, opts = {}) click to toggle source

Get work plans

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [Array<String>] :expand @return [Array<(WorkPlanListResponse, Fixnum, Hash)>] WorkPlanListResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 4969
def get_workforcemanagement_managementunit_workplans_with_http_info(management_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_workplans ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_workplans" if management_unit_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkPlanListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_workplans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunits(opts = {}) click to toggle source

Get management units

@param [Hash] opts the optional parameters @option opts [Integer] :page_size @option opts [Integer] :page_number @option opts [String] :expand @option opts [String] :feature @option opts [String] :division_id @return [ManagementUnitListing]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5035
def get_workforcemanagement_managementunits(opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunits_with_http_info(opts)
  return data
end
get_workforcemanagement_managementunits_divisionviews(opts = {}) click to toggle source

Get management units across divisions

@param [Hash] opts the optional parameters @option opts [Array<String>] :division_id The divisionIds to filter by. If omitted, will return all divisions @return [ManagementUnitListing]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5139
def get_workforcemanagement_managementunits_divisionviews(opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunits_divisionviews_with_http_info(opts)
  return data
end
get_workforcemanagement_managementunits_divisionviews_with_http_info(opts = {}) click to toggle source

Get management units across divisions

@param [Hash] opts the optional parameters @option opts [Array<String>] :division_id The divisionIds to filter by. If omitted, will return all divisions @return [Array<(ManagementUnitListing, Fixnum, Hash)>] ManagementUnitListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5149
def get_workforcemanagement_managementunits_divisionviews_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunits_divisionviews ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/divisionviews".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ManagementUnitListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunits_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_managementunits_with_http_info(opts = {}) click to toggle source

Get management units

@param [Hash] opts the optional parameters @option opts [Integer] :page_size @option opts [Integer] :page_number @option opts [String] :expand @option opts [String] :feature @option opts [String] :division_id @return [Array<(ManagementUnitListing, Fixnum, Hash)>] ManagementUnitListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5049
def get_workforcemanagement_managementunits_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunits ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'expand'] && !['details'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of details'
  end
  
  
  
  
  
  
  
  if opts[:'feature'] && !['AgentSchedule', 'AgentTimeOffRequest', 'Coaching', 'ActivityCodes', 'Agents', 'BuActivityCodes', 'BusinessUnits', 'HistoricalAdherence', 'IntradayMonitoring', 'BuIntradayMonitoring', 'ManagementUnits', 'RealTimeAdherence', 'Schedules', 'BuSchedules', 'ServiceGoalGroups', 'ServiceGoalTemplates', 'PlanningGroups', 'ShiftTrading', 'ShortTermForecasts', 'BuShortTermForecasts', 'TimeOffRequests', 'WorkPlanRotations', 'WorkPlans'].include?(opts[:'feature'])
    fail ArgumentError, 'invalid value for "feature", must be one of AgentSchedule, AgentTimeOffRequest, Coaching, ActivityCodes, Agents, BuActivityCodes, BusinessUnits, HistoricalAdherence, IntradayMonitoring, BuIntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, BuSchedules, ServiceGoalGroups, ServiceGoalTemplates, PlanningGroups, ShiftTrading, ShortTermForecasts, BuShortTermForecasts, TimeOffRequests, WorkPlanRotations, WorkPlans'
  end
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
  query_params[:'feature'] = opts[:'feature'] if opts[:'feature']
  query_params[:'divisionId'] = opts[:'division_id'] if opts[:'division_id']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ManagementUnitListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_notifications(opts = {}) click to toggle source

Get a list of notifications for the current user

@param [Hash] opts the optional parameters @return [NotificationsResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5202
def get_workforcemanagement_notifications(opts = {})
  data, _status_code, _headers = get_workforcemanagement_notifications_with_http_info(opts)
  return data
end
get_workforcemanagement_notifications_with_http_info(opts = {}) click to toggle source

Get a list of notifications for the current user

@param [Hash] opts the optional parameters @return [Array<(NotificationsResponse, Fixnum, Hash)>] NotificationsResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5211
def get_workforcemanagement_notifications_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_notifications ..."
  end
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/notifications".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NotificationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_notifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_schedulingjob(job_id, opts = {}) click to toggle source

Get status of the scheduling job

@param job_id The id of the scheduling job @param [Hash] opts the optional parameters @return [SchedulingStatusResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5258
def get_workforcemanagement_schedulingjob(job_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_schedulingjob_with_http_info(job_id, opts)
  return data
end
get_workforcemanagement_schedulingjob_with_http_info(job_id, opts = {}) click to toggle source

Get status of the scheduling job

@param job_id The id of the scheduling job @param [Hash] opts the optional parameters @return [Array<(SchedulingStatusResponse, Fixnum, Hash)>] SchedulingStatusResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5268
def get_workforcemanagement_schedulingjob_with_http_info(job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_schedulingjob ..."
  end
  
  
  # verify the required parameter 'job_id' is set
  fail ArgumentError, "Missing the required parameter 'job_id' when calling WorkforceManagementApi.get_workforcemanagement_schedulingjob" if job_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/schedulingjobs/{jobId}".sub('{format}','json').sub('{' + 'jobId' + '}', job_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SchedulingStatusResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_schedulingjob\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_shifttrades(opts = {}) click to toggle source

Gets all of my shift trades

@param [Hash] opts the optional parameters @return [ShiftTradeListResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5322
def get_workforcemanagement_shifttrades(opts = {})
  data, _status_code, _headers = get_workforcemanagement_shifttrades_with_http_info(opts)
  return data
end
get_workforcemanagement_shifttrades_with_http_info(opts = {}) click to toggle source

Gets all of my shift trades

@param [Hash] opts the optional parameters @return [Array<(ShiftTradeListResponse, Fixnum, Hash)>] ShiftTradeListResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5331
def get_workforcemanagement_shifttrades_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_shifttrades ..."
  end
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/shifttrades".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ShiftTradeListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_shifttrades\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_timeoffrequest(time_off_request_id, opts = {}) click to toggle source

Get a time off request for the current user

@param time_off_request_id Time Off Request Id @param [Hash] opts the optional parameters @return [TimeOffRequestResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5378
def get_workforcemanagement_timeoffrequest(time_off_request_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_timeoffrequest_with_http_info(time_off_request_id, opts)
  return data
end
get_workforcemanagement_timeoffrequest_with_http_info(time_off_request_id, opts = {}) click to toggle source

Get a time off request for the current user

@param time_off_request_id Time Off Request Id @param [Hash] opts the optional parameters @return [Array<(TimeOffRequestResponse, Fixnum, Hash)>] TimeOffRequestResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5388
def get_workforcemanagement_timeoffrequest_with_http_info(time_off_request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_timeoffrequest ..."
  end
  
  
  # verify the required parameter 'time_off_request_id' is set
  fail ArgumentError, "Missing the required parameter 'time_off_request_id' when calling WorkforceManagementApi.get_workforcemanagement_timeoffrequest" if time_off_request_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}".sub('{format}','json').sub('{' + 'timeOffRequestId' + '}', time_off_request_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeOffRequestResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_timeoffrequest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_workforcemanagement_timeoffrequests(opts = {}) click to toggle source

Get a list of time off requests for the current user

@param [Hash] opts the optional parameters @option opts [BOOLEAN] :recently_reviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false) @return [TimeOffRequestList]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5443
def get_workforcemanagement_timeoffrequests(opts = {})
  data, _status_code, _headers = get_workforcemanagement_timeoffrequests_with_http_info(opts)
  return data
end
get_workforcemanagement_timeoffrequests_with_http_info(opts = {}) click to toggle source

Get a list of time off requests for the current user

@param [Hash] opts the optional parameters @option opts [BOOLEAN] :recently_reviewed Limit results to requests that have been reviewed within the preceding 30 days @return [Array<(TimeOffRequestList, Fixnum, Hash)>] TimeOffRequestList data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5453
def get_workforcemanagement_timeoffrequests_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_timeoffrequests ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/timeoffrequests".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'recentlyReviewed'] = opts[:'recently_reviewed'] if opts[:'recently_reviewed']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeOffRequestList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_timeoffrequests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_workforcemanagement_businessunit(business_unit_id, opts = {}) click to toggle source

Update business unit

@param business_unit_id The ID of the business unit, or &#39;mine&#39; for the business unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [UpdateBusinessUnitRequest] :body body @return [BusinessUnit]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5508
def patch_workforcemanagement_businessunit(business_unit_id, opts = {})
  data, _status_code, _headers = patch_workforcemanagement_businessunit_with_http_info(business_unit_id, opts)
  return data
end
patch_workforcemanagement_businessunit_activitycode(bu_id, ac_id, opts = {}) click to toggle source

Update an activity code

@param bu_id The ID of the business unit, or &#39;mine&#39; for the business unit of the logged-in user. @param ac_id The ID of the activity code to update @param [Hash] opts the optional parameters @option opts [UpdateActivityCodeRequest] :body body @return [BusinessUnitActivityCode]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5582
def patch_workforcemanagement_businessunit_activitycode(bu_id, ac_id, opts = {})
  data, _status_code, _headers = patch_workforcemanagement_businessunit_activitycode_with_http_info(bu_id, ac_id, opts)
  return data
end
patch_workforcemanagement_businessunit_activitycode_with_http_info(bu_id, ac_id, opts = {}) click to toggle source

Update an activity code

@param bu_id The ID of the business unit, or &#39;mine&#39; for the business unit of the logged-in user. @param ac_id The ID of the activity code to update @param [Hash] opts the optional parameters @option opts [UpdateActivityCodeRequest] :body body @return [Array<(BusinessUnitActivityCode, Fixnum, Hash)>] BusinessUnitActivityCode data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5594
def patch_workforcemanagement_businessunit_activitycode_with_http_info(bu_id, ac_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_businessunit_activitycode ..."
  end
  
  
  # verify the required parameter 'bu_id' is set
  fail ArgumentError, "Missing the required parameter 'bu_id' when calling WorkforceManagementApi.patch_workforcemanagement_businessunit_activitycode" if bu_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'ac_id' is set
  fail ArgumentError, "Missing the required parameter 'ac_id' when calling WorkforceManagementApi.patch_workforcemanagement_businessunit_activitycode" if ac_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{buId}/activitycodes/{acId}".sub('{format}','json').sub('{' + 'buId' + '}', bu_id.to_s).sub('{' + 'acId' + '}', ac_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BusinessUnitActivityCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_businessunit_activitycode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_workforcemanagement_businessunit_planninggroup(business_unit_id, planning_group_id, opts = {}) click to toggle source

Updates the planning group

@param business_unit_id The ID of the business unit. @param planning_group_id The ID of a planning group to update @param [Hash] opts the optional parameters @option opts [UpdatePlanningGroupRequest] :body body @return [PlanningGroup]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5665
def patch_workforcemanagement_businessunit_planninggroup(business_unit_id, planning_group_id, opts = {})
  data, _status_code, _headers = patch_workforcemanagement_businessunit_planninggroup_with_http_info(business_unit_id, planning_group_id, opts)
  return data
end
patch_workforcemanagement_businessunit_planninggroup_with_http_info(business_unit_id, planning_group_id, opts = {}) click to toggle source

Updates the planning group

@param business_unit_id The ID of the business unit. @param planning_group_id The ID of a planning group to update @param [Hash] opts the optional parameters @option opts [UpdatePlanningGroupRequest] :body body @return [Array<(PlanningGroup, Fixnum, Hash)>] PlanningGroup data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5677
def patch_workforcemanagement_businessunit_planninggroup_with_http_info(business_unit_id, planning_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_businessunit_planninggroup ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.patch_workforcemanagement_businessunit_planninggroup" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'planning_group_id' is set
  fail ArgumentError, "Missing the required parameter 'planning_group_id' when calling WorkforceManagementApi.patch_workforcemanagement_businessunit_planninggroup" if planning_group_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'planningGroupId' + '}', planning_group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PlanningGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_businessunit_planninggroup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_workforcemanagement_businessunit_scheduling_run(business_unit_id, run_id, opts = {}) click to toggle source

Mark a schedule run as applied

@param business_unit_id The ID of the business unit @param run_id The ID of the schedule run @param [Hash] opts the optional parameters @option opts [PatchBuScheduleRunRequest] :body body @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5748
def patch_workforcemanagement_businessunit_scheduling_run(business_unit_id, run_id, opts = {})
  patch_workforcemanagement_businessunit_scheduling_run_with_http_info(business_unit_id, run_id, opts)
  return nil
end
patch_workforcemanagement_businessunit_scheduling_run_with_http_info(business_unit_id, run_id, opts = {}) click to toggle source

Mark a schedule run as applied

@param business_unit_id The ID of the business unit @param run_id The ID of the schedule run @param [Hash] opts the optional parameters @option opts [PatchBuScheduleRunRequest] :body body @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5760
def patch_workforcemanagement_businessunit_scheduling_run_with_http_info(business_unit_id, run_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_businessunit_scheduling_run ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.patch_workforcemanagement_businessunit_scheduling_run" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'run_id' is set
  fail ArgumentError, "Missing the required parameter 'run_id' when calling WorkforceManagementApi.patch_workforcemanagement_businessunit_scheduling_run" if run_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'runId' + '}', run_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_businessunit_scheduling_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_workforcemanagement_businessunit_servicegoaltemplate(business_unit_id, service_goal_template_id, opts = {}) click to toggle source

Updates a service goal template

@param business_unit_id The ID of the business unit. @param service_goal_template_id The ID of a service goal template to update @param [Hash] opts the optional parameters @option opts [UpdateServiceGoalTemplate] :body body @return [ServiceGoalTemplate]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5830
def patch_workforcemanagement_businessunit_servicegoaltemplate(business_unit_id, service_goal_template_id, opts = {})
  data, _status_code, _headers = patch_workforcemanagement_businessunit_servicegoaltemplate_with_http_info(business_unit_id, service_goal_template_id, opts)
  return data
end
patch_workforcemanagement_businessunit_servicegoaltemplate_with_http_info(business_unit_id, service_goal_template_id, opts = {}) click to toggle source

Updates a service goal template

@param business_unit_id The ID of the business unit. @param service_goal_template_id The ID of a service goal template to update @param [Hash] opts the optional parameters @option opts [UpdateServiceGoalTemplate] :body body @return [Array<(ServiceGoalTemplate, Fixnum, Hash)>] ServiceGoalTemplate data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5842
def patch_workforcemanagement_businessunit_servicegoaltemplate_with_http_info(business_unit_id, service_goal_template_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_businessunit_servicegoaltemplate ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.patch_workforcemanagement_businessunit_servicegoaltemplate" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'service_goal_template_id' is set
  fail ArgumentError, "Missing the required parameter 'service_goal_template_id' when calling WorkforceManagementApi.patch_workforcemanagement_businessunit_servicegoaltemplate" if service_goal_template_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'serviceGoalTemplateId' + '}', service_goal_template_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ServiceGoalTemplate')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_businessunit_servicegoaltemplate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_workforcemanagement_businessunit_with_http_info(business_unit_id, opts = {}) click to toggle source

Update business unit

@param business_unit_id The ID of the business unit, or &#39;mine&#39; for the business unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [UpdateBusinessUnitRequest] :body body @return [Array<(BusinessUnit, Fixnum, Hash)>] BusinessUnit data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5519
def patch_workforcemanagement_businessunit_with_http_info(business_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_businessunit ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.patch_workforcemanagement_businessunit" if business_unit_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BusinessUnit')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_businessunit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_workforcemanagement_managementunit(mu_id, opts = {}) click to toggle source

Update the requested management unit

@param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [UpdateManagementUnitRequest] :body body @return [ManagementUnit]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5912
def patch_workforcemanagement_managementunit(mu_id, opts = {})
  data, _status_code, _headers = patch_workforcemanagement_managementunit_with_http_info(mu_id, opts)
  return data
end
patch_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts = {}) click to toggle source

Deprecated/Gone: Use the new business unit activity code resources

@param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param ac_id The ID of the activity code to update @param [Hash] opts the optional parameters @option opts [UpdateActivityCodeRequest] :body body @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5986
def patch_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts = {})
  patch_workforcemanagement_managementunit_activitycode_with_http_info(mu_id, ac_id, opts)
  return nil
end
patch_workforcemanagement_managementunit_activitycode_with_http_info(mu_id, ac_id, opts = {}) click to toggle source

Deprecated/Gone: Use the new business unit activity code resources

@param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param ac_id The ID of the activity code to update @param [Hash] opts the optional parameters @option opts [UpdateActivityCodeRequest] :body body @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5998
def patch_workforcemanagement_managementunit_activitycode_with_http_info(mu_id, ac_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_managementunit_activitycode ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_activitycode" if mu_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'ac_id' is set
  fail ArgumentError, "Missing the required parameter 'ac_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_activitycode" if ac_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s).sub('{' + 'acId' + '}', ac_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_managementunit_activitycode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id (Deprecated/gone): The ID of the management unit. @param run_id The ID of the schedule run @param [Hash] opts the optional parameters @option opts [UpdateSchedulingRunRequest] :body body @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6068
def patch_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id, opts = {})
  patch_workforcemanagement_managementunit_scheduling_run_with_http_info(management_unit_id, run_id, opts)
  return nil
end
patch_workforcemanagement_managementunit_scheduling_run_with_http_info(management_unit_id, run_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id (Deprecated/gone): The ID of the management unit. @param run_id The ID of the schedule run @param [Hash] opts the optional parameters @option opts [UpdateSchedulingRunRequest] :body body @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6080
def patch_workforcemanagement_managementunit_scheduling_run_with_http_info(management_unit_id, run_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_managementunit_scheduling_run ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_scheduling_run" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'run_id' is set
  fail ArgumentError, "Missing the required parameter 'run_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_scheduling_run" if run_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'runId' + '}', run_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_managementunit_scheduling_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts = {}) click to toggle source

Gone. Replaced with service goal templates and planning groups under business units

@param management_unit_id (Deprecated/gone): The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param service_goal_group_id Gone. The ID of the service goal group to update @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6149
def patch_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts = {})
  patch_workforcemanagement_managementunit_servicegoalgroup_with_http_info(management_unit_id, service_goal_group_id, opts)
  return nil
end
patch_workforcemanagement_managementunit_servicegoalgroup_with_http_info(management_unit_id, service_goal_group_id, opts = {}) click to toggle source

Gone. Replaced with service goal templates and planning groups under business units

@param management_unit_id (Deprecated/gone): The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param service_goal_group_id Gone. The ID of the service goal group to update @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6160
def patch_workforcemanagement_managementunit_servicegoalgroup_with_http_info(management_unit_id, service_goal_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_managementunit_servicegoalgroup ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_servicegoalgroup" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'service_goal_group_id' is set
  fail ArgumentError, "Missing the required parameter 'service_goal_group_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_servicegoalgroup" if service_goal_group_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'serviceGoalGroupId' + '}', service_goal_group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_managementunit_servicegoalgroup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_workforcemanagement_managementunit_settings(mu_id, opts = {}) click to toggle source

Gone. Update settings by PATCHing the management unit

@param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6222
def patch_workforcemanagement_managementunit_settings(mu_id, opts = {})
  patch_workforcemanagement_managementunit_settings_with_http_info(mu_id, opts)
  return nil
end
patch_workforcemanagement_managementunit_settings_with_http_info(mu_id, opts = {}) click to toggle source

Gone. Update settings by PATCHing the management unit

@param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6232
def patch_workforcemanagement_managementunit_settings_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_managementunit_settings ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_settings" if mu_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/settings".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_managementunit_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts = {}) click to toggle source

Update a time off request

@param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param user_id The id of the user the requested time off request belongs to @param time_off_request_id The id of the time off request to update @param [Hash] opts the optional parameters @option opts [AdminTimeOffRequestPatch] :body body @return [TimeOffRequestResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6289
def patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts = {})
  data, _status_code, _headers = patch_workforcemanagement_managementunit_user_timeoffrequest_with_http_info(mu_id, user_id, time_off_request_id, opts)
  return data
end
patch_workforcemanagement_managementunit_user_timeoffrequest_with_http_info(mu_id, user_id, time_off_request_id, opts = {}) click to toggle source

Update a time off request

@param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param user_id The id of the user the requested time off request belongs to @param time_off_request_id The id of the time off request to update @param [Hash] opts the optional parameters @option opts [AdminTimeOffRequestPatch] :body body @return [Array<(TimeOffRequestResponse, Fixnum, Hash)>] TimeOffRequestResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6302
def patch_workforcemanagement_managementunit_user_timeoffrequest_with_http_info(mu_id, user_id, time_off_request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_managementunit_user_timeoffrequest ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_user_timeoffrequest" if mu_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_user_timeoffrequest" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'time_off_request_id' is set
  fail ArgumentError, "Missing the required parameter 'time_off_request_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_user_timeoffrequest" if time_off_request_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId}".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s).sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'timeOffRequestId' + '}', time_off_request_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeOffRequestResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_managementunit_user_timeoffrequest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_id First day of schedule week in yyyy-MM-dd format. @param schedule_id Gone/deprecated. The ID of the schedule to update. Use partial uploads of user schedules if activity count in schedule is greater than 17500 @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6381
def patch_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts = {})
  patch_workforcemanagement_managementunit_week_schedule_with_http_info(management_unit_id, week_id, schedule_id, opts)
  return nil
end
patch_workforcemanagement_managementunit_week_schedule_with_http_info(management_unit_id, week_id, schedule_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_id First day of schedule week in yyyy-MM-dd format. @param schedule_id Gone/deprecated. The ID of the schedule to update. Use partial uploads of user schedules if activity count in schedule is greater than 17500 @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6393
def patch_workforcemanagement_managementunit_week_schedule_with_http_info(management_unit_id, week_id, schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_managementunit_week_schedule ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_week_schedule" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_week_schedule" if week_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'schedule_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_week_schedule" if schedule_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_managementunit_week_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_workforcemanagement_managementunit_week_shifttrade(management_unit_id, week_date_id, body, trade_id, opts = {}) click to toggle source

Updates a shift trade. This route can only be called by the initiating agent

@param management_unit_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_date_id The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param body body @param trade_id The ID of the shift trade to update @param [Hash] opts the optional parameters @return [ShiftTradeResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6466
def patch_workforcemanagement_managementunit_week_shifttrade(management_unit_id, week_date_id, body, trade_id, opts = {})
  data, _status_code, _headers = patch_workforcemanagement_managementunit_week_shifttrade_with_http_info(management_unit_id, week_date_id, body, trade_id, opts)
  return data
end
patch_workforcemanagement_managementunit_week_shifttrade_with_http_info(management_unit_id, week_date_id, body, trade_id, opts = {}) click to toggle source

Updates a shift trade. This route can only be called by the initiating agent

@param management_unit_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_date_id The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param body body @param trade_id The ID of the shift trade to update @param [Hash] opts the optional parameters @return [Array<(ShiftTradeResponse, Fixnum, Hash)>] ShiftTradeResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6479
def patch_workforcemanagement_managementunit_week_shifttrade_with_http_info(management_unit_id, week_date_id, body, trade_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_managementunit_week_shifttrade ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_week_shifttrade" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_week_shifttrade" if week_date_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_week_shifttrade" if body.nil?
  
  
  
  
  
  
  # verify the required parameter 'trade_id' is set
  fail ArgumentError, "Missing the required parameter 'trade_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_week_shifttrade" if trade_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s).sub('{' + 'tradeId' + '}', trade_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ShiftTradeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_managementunit_week_shifttrade\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_workforcemanagement_managementunit_with_http_info(mu_id, opts = {}) click to toggle source

Update the requested management unit

@param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [UpdateManagementUnitRequest] :body body @return [Array<(ManagementUnit, Fixnum, Hash)>] ManagementUnit data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 5923
def patch_workforcemanagement_managementunit_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_managementunit ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit" if mu_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ManagementUnit')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_managementunit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts = {}) click to toggle source

Update a work plan

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param work_plan_id The ID of the work plan to update @param [Hash] opts the optional parameters @option opts [WorkPlan] :body body @return [WorkPlan]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6560
def patch_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts = {})
  data, _status_code, _headers = patch_workforcemanagement_managementunit_workplan_with_http_info(management_unit_id, work_plan_id, opts)
  return data
end
patch_workforcemanagement_managementunit_workplan_with_http_info(management_unit_id, work_plan_id, opts = {}) click to toggle source

Update a work plan

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param work_plan_id The ID of the work plan to update @param [Hash] opts the optional parameters @option opts [WorkPlan] :body body @return [Array<(WorkPlan, Fixnum, Hash)>] WorkPlan data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6572
def patch_workforcemanagement_managementunit_workplan_with_http_info(management_unit_id, work_plan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_managementunit_workplan ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_workplan" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'work_plan_id' is set
  fail ArgumentError, "Missing the required parameter 'work_plan_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_workplan" if work_plan_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'workPlanId' + '}', work_plan_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkPlan')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_managementunit_workplan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_workforcemanagement_timeoffrequest(time_off_request_id, opts = {}) click to toggle source

Update a time off request for the current user

@param time_off_request_id Time Off Request Id @param [Hash] opts the optional parameters @option opts [AgentTimeOffRequestPatch] :body body @return [TimeOffRequestResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6642
def patch_workforcemanagement_timeoffrequest(time_off_request_id, opts = {})
  data, _status_code, _headers = patch_workforcemanagement_timeoffrequest_with_http_info(time_off_request_id, opts)
  return data
end
patch_workforcemanagement_timeoffrequest_with_http_info(time_off_request_id, opts = {}) click to toggle source

Update a time off request for the current user

@param time_off_request_id Time Off Request Id @param [Hash] opts the optional parameters @option opts [AgentTimeOffRequestPatch] :body body @return [Array<(TimeOffRequestResponse, Fixnum, Hash)>] TimeOffRequestResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6653
def patch_workforcemanagement_timeoffrequest_with_http_info(time_off_request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_timeoffrequest ..."
  end
  
  
  # verify the required parameter 'time_off_request_id' is set
  fail ArgumentError, "Missing the required parameter 'time_off_request_id' when calling WorkforceManagementApi.patch_workforcemanagement_timeoffrequest" if time_off_request_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}".sub('{format}','json').sub('{' + 'timeOffRequestId' + '}', time_off_request_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeOffRequestResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_timeoffrequest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_adherence_historical(opts = {}) click to toggle source

Request a historical adherence report for users across management units

@param [Hash] opts the optional parameters @option opts [WfmHistoricalAdherenceQueryForUsers] :body body @return [WfmHistoricalAdherenceResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6714
def post_workforcemanagement_adherence_historical(opts = {})
  data, _status_code, _headers = post_workforcemanagement_adherence_historical_with_http_info(opts)
  return data
end
post_workforcemanagement_adherence_historical_with_http_info(opts = {}) click to toggle source

Request a historical adherence report for users across management units

@param [Hash] opts the optional parameters @option opts [WfmHistoricalAdherenceQueryForUsers] :body body @return [Array<(WfmHistoricalAdherenceResponse, Fixnum, Hash)>] WfmHistoricalAdherenceResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6724
def post_workforcemanagement_adherence_historical_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_adherence_historical ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/adherence/historical".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WfmHistoricalAdherenceResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_adherence_historical\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_agentschedules_mine(opts = {}) click to toggle source

Get published schedule for the current user

@param [Hash] opts the optional parameters @option opts [BuGetCurrentAgentScheduleRequest] :body body @return [BuCurrentAgentScheduleSearchResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6777
def post_workforcemanagement_agentschedules_mine(opts = {})
  data, _status_code, _headers = post_workforcemanagement_agentschedules_mine_with_http_info(opts)
  return data
end
post_workforcemanagement_agentschedules_mine_with_http_info(opts = {}) click to toggle source

Get published schedule for the current user

@param [Hash] opts the optional parameters @option opts [BuGetCurrentAgentScheduleRequest] :body body @return [Array<(BuCurrentAgentScheduleSearchResponse, Fixnum, Hash)>] BuCurrentAgentScheduleSearchResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6787
def post_workforcemanagement_agentschedules_mine_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_agentschedules_mine ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/agentschedules/mine".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BuCurrentAgentScheduleSearchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_agentschedules_mine\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_businessunit_activitycodes(bu_id, opts = {}) click to toggle source

Create a new activity code

@param bu_id The ID of the business unit, or &#39;mine&#39; for the business unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [CreateActivityCodeRequest] :body body @return [BusinessUnitActivityCode]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6841
def post_workforcemanagement_businessunit_activitycodes(bu_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_businessunit_activitycodes_with_http_info(bu_id, opts)
  return data
end
post_workforcemanagement_businessunit_activitycodes_with_http_info(bu_id, opts = {}) click to toggle source

Create a new activity code

@param bu_id The ID of the business unit, or &#39;mine&#39; for the business unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [CreateActivityCodeRequest] :body body @return [Array<(BusinessUnitActivityCode, Fixnum, Hash)>] BusinessUnitActivityCode data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6852
def post_workforcemanagement_businessunit_activitycodes_with_http_info(bu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_businessunit_activitycodes ..."
  end
  
  
  # verify the required parameter 'bu_id' is set
  fail ArgumentError, "Missing the required parameter 'bu_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_activitycodes" if bu_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{buId}/activitycodes".sub('{format}','json').sub('{' + 'buId' + '}', bu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BusinessUnitActivityCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_businessunit_activitycodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_businessunit_agentschedules_search(business_unit_id, opts = {}) click to toggle source

Search published schedules

@param business_unit_id The ID of the business unit @param [Hash] opts the optional parameters @option opts [BuSearchAgentSchedulesRequest] :body body @option opts [BOOLEAN] :force_async Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes @option opts [BOOLEAN] :force_download_service Force the result of this operation to be sent via download service. For testing/app development purposes @return [BuAsyncAgentSchedulesSearchResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6916
def post_workforcemanagement_businessunit_agentschedules_search(business_unit_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_businessunit_agentschedules_search_with_http_info(business_unit_id, opts)
  return data
end
post_workforcemanagement_businessunit_agentschedules_search_with_http_info(business_unit_id, opts = {}) click to toggle source

Search published schedules

@param business_unit_id The ID of the business unit @param [Hash] opts the optional parameters @option opts [BuSearchAgentSchedulesRequest] :body body @option opts [BOOLEAN] :force_async Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes @option opts [BOOLEAN] :force_download_service Force the result of this operation to be sent via download service. For testing/app development purposes @return [Array<(BuAsyncAgentSchedulesSearchResponse, Fixnum, Hash)>] BuAsyncAgentSchedulesSearchResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 6929
def post_workforcemanagement_businessunit_agentschedules_search_with_http_info(business_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_businessunit_agentschedules_search ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_agentschedules_search" if business_unit_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/agentschedules/search".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'forceAsync'] = opts[:'force_async'] if opts[:'force_async']
  query_params[:'forceDownloadService'] = opts[:'force_download_service'] if opts[:'force_download_service']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BuAsyncAgentSchedulesSearchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_businessunit_agentschedules_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_businessunit_intraday(business_unit_id, opts = {}) click to toggle source

Get intraday data for the given date for the requested planningGroupIds

@param business_unit_id The business unit ID of the business unit @param [Hash] opts the optional parameters @option opts [BOOLEAN] :force_async Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes @option opts [IntradayPlanningGroupRequest] :body body @return [AsyncIntradayResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7006
def post_workforcemanagement_businessunit_intraday(business_unit_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_businessunit_intraday_with_http_info(business_unit_id, opts)
  return data
end
post_workforcemanagement_businessunit_intraday_with_http_info(business_unit_id, opts = {}) click to toggle source

Get intraday data for the given date for the requested planningGroupIds

@param business_unit_id The business unit ID of the business unit @param [Hash] opts the optional parameters @option opts [BOOLEAN] :force_async Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes @option opts [IntradayPlanningGroupRequest] :body body @return [Array<(AsyncIntradayResponse, Fixnum, Hash)>] AsyncIntradayResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7018
def post_workforcemanagement_businessunit_intraday_with_http_info(business_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_businessunit_intraday ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_intraday" if business_unit_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'forceAsync'] = opts[:'force_async'] if opts[:'force_async']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsyncIntradayResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_businessunit_intraday\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_businessunit_planninggroups(business_unit_id, opts = {}) click to toggle source

Adds a new planning group

@param business_unit_id The ID of the business unit. @param [Hash] opts the optional parameters @option opts [CreatePlanningGroupRequest] :body body @return [PlanningGroup]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7087
def post_workforcemanagement_businessunit_planninggroups(business_unit_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_businessunit_planninggroups_with_http_info(business_unit_id, opts)
  return data
end
post_workforcemanagement_businessunit_planninggroups_with_http_info(business_unit_id, opts = {}) click to toggle source

Adds a new planning group

@param business_unit_id The ID of the business unit. @param [Hash] opts the optional parameters @option opts [CreatePlanningGroupRequest] :body body @return [Array<(PlanningGroup, Fixnum, Hash)>] PlanningGroup data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7098
def post_workforcemanagement_businessunit_planninggroups_with_http_info(business_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_businessunit_planninggroups ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_planninggroups" if business_unit_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PlanningGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_businessunit_planninggroups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_businessunit_servicegoaltemplates(business_unit_id, opts = {}) click to toggle source

Adds a new service goal template

@param business_unit_id The ID of the business unit. @param [Hash] opts the optional parameters @option opts [CreateServiceGoalTemplate] :body body @return [ServiceGoalTemplate]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7160
def post_workforcemanagement_businessunit_servicegoaltemplates(business_unit_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_businessunit_servicegoaltemplates_with_http_info(business_unit_id, opts)
  return data
end
post_workforcemanagement_businessunit_servicegoaltemplates_with_http_info(business_unit_id, opts = {}) click to toggle source

Adds a new service goal template

@param business_unit_id The ID of the business unit. @param [Hash] opts the optional parameters @option opts [CreateServiceGoalTemplate] :body body @return [Array<(ServiceGoalTemplate, Fixnum, Hash)>] ServiceGoalTemplate data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7171
def post_workforcemanagement_businessunit_servicegoaltemplates_with_http_info(business_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_businessunit_servicegoaltemplates ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_servicegoaltemplates" if business_unit_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ServiceGoalTemplate')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_businessunit_servicegoaltemplates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_businessunit_week_schedule_agentschedules_query(business_unit_id, week_id, schedule_id, body, opts = {}) click to toggle source

Loads agent schedule data from the schedule. Used in combination with the metadata route

@param business_unit_id The ID of the business unit @param week_id First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param schedule_id The ID of the schedule @param body body @param [Hash] opts the optional parameters @option opts [BOOLEAN] :force_async Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes @option opts [BOOLEAN] :force_download_service Force the result of this operation to be sent via download service. For testing/app development purposes @return [BuAsyncAgentSchedulesQueryResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7237
def post_workforcemanagement_businessunit_week_schedule_agentschedules_query(business_unit_id, week_id, schedule_id, body, opts = {})
  data, _status_code, _headers = post_workforcemanagement_businessunit_week_schedule_agentschedules_query_with_http_info(business_unit_id, week_id, schedule_id, body, opts)
  return data
end
post_workforcemanagement_businessunit_week_schedule_agentschedules_query_with_http_info(business_unit_id, week_id, schedule_id, body, opts = {}) click to toggle source

Loads agent schedule data from the schedule. Used in combination with the metadata route

@param business_unit_id The ID of the business unit @param week_id First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param schedule_id The ID of the schedule @param body body @param [Hash] opts the optional parameters @option opts [BOOLEAN] :force_async Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes @option opts [BOOLEAN] :force_download_service Force the result of this operation to be sent via download service. For testing/app development purposes @return [Array<(BuAsyncAgentSchedulesQueryResponse, Fixnum, Hash)>] BuAsyncAgentSchedulesQueryResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7252
def post_workforcemanagement_businessunit_week_schedule_agentschedules_query_with_http_info(business_unit_id, week_id, schedule_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedule_agentschedules_query ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedule_agentschedules_query" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedule_agentschedules_query" if week_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'schedule_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedule_agentschedules_query" if schedule_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedule_agentschedules_query" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/agentschedules/query".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'forceAsync'] = opts[:'force_async'] if opts[:'force_async']
  query_params[:'forceDownloadService'] = opts[:'force_download_service'] if opts[:'force_download_service']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BuAsyncAgentSchedulesQueryResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_businessunit_week_schedule_agentschedules_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_businessunit_week_schedule_copy(business_unit_id, week_id, schedule_id, body, opts = {}) click to toggle source

Copy a schedule

@param business_unit_id The ID of the business unit @param week_id First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param schedule_id The ID of the schedule to copy @param body body @param [Hash] opts the optional parameters @return [BuAsyncScheduleResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7348
def post_workforcemanagement_businessunit_week_schedule_copy(business_unit_id, week_id, schedule_id, body, opts = {})
  data, _status_code, _headers = post_workforcemanagement_businessunit_week_schedule_copy_with_http_info(business_unit_id, week_id, schedule_id, body, opts)
  return data
end
post_workforcemanagement_businessunit_week_schedule_copy_with_http_info(business_unit_id, week_id, schedule_id, body, opts = {}) click to toggle source

Copy a schedule

@param business_unit_id The ID of the business unit @param week_id First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param schedule_id The ID of the schedule to copy @param body body @param [Hash] opts the optional parameters @return [Array<(BuAsyncScheduleResponse, Fixnum, Hash)>] BuAsyncScheduleResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7361
def post_workforcemanagement_businessunit_week_schedule_copy_with_http_info(business_unit_id, week_id, schedule_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedule_copy ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedule_copy" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedule_copy" if week_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'schedule_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedule_copy" if schedule_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedule_copy" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BuAsyncScheduleResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_businessunit_week_schedule_copy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_businessunit_week_schedule_reschedule(business_unit_id, week_id, schedule_id, body, opts = {}) click to toggle source

Start a rescheduling run

@param business_unit_id The ID of the business unit @param week_id First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param schedule_id The ID of the schedule @param body body @param [Hash] opts the optional parameters @return [BuAsyncScheduleRunResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7443
def post_workforcemanagement_businessunit_week_schedule_reschedule(business_unit_id, week_id, schedule_id, body, opts = {})
  data, _status_code, _headers = post_workforcemanagement_businessunit_week_schedule_reschedule_with_http_info(business_unit_id, week_id, schedule_id, body, opts)
  return data
end
post_workforcemanagement_businessunit_week_schedule_reschedule_with_http_info(business_unit_id, week_id, schedule_id, body, opts = {}) click to toggle source

Start a rescheduling run

@param business_unit_id The ID of the business unit @param week_id First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param schedule_id The ID of the schedule @param body body @param [Hash] opts the optional parameters @return [Array<(BuAsyncScheduleRunResponse, Fixnum, Hash)>] BuAsyncScheduleRunResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7456
def post_workforcemanagement_businessunit_week_schedule_reschedule_with_http_info(business_unit_id, week_id, schedule_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedule_reschedule ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedule_reschedule" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedule_reschedule" if week_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'schedule_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedule_reschedule" if schedule_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedule_reschedule" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BuAsyncScheduleRunResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_businessunit_week_schedule_reschedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_businessunit_week_schedules(business_unit_id, week_id, body, opts = {}) click to toggle source

Create a blank schedule

@param business_unit_id The ID of the business unit @param week_id First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param body body @param [Hash] opts the optional parameters @return [BuScheduleMetadata]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7537
def post_workforcemanagement_businessunit_week_schedules(business_unit_id, week_id, body, opts = {})
  data, _status_code, _headers = post_workforcemanagement_businessunit_week_schedules_with_http_info(business_unit_id, week_id, body, opts)
  return data
end
post_workforcemanagement_businessunit_week_schedules_generate(business_unit_id, week_id, body, opts = {}) click to toggle source

Generate a schedule

@param business_unit_id The ID of the business unit @param week_id First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param body body @param [Hash] opts the optional parameters @return [BuAsyncScheduleRunResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7622
def post_workforcemanagement_businessunit_week_schedules_generate(business_unit_id, week_id, body, opts = {})
  data, _status_code, _headers = post_workforcemanagement_businessunit_week_schedules_generate_with_http_info(business_unit_id, week_id, body, opts)
  return data
end
post_workforcemanagement_businessunit_week_schedules_generate_with_http_info(business_unit_id, week_id, body, opts = {}) click to toggle source

Generate a schedule

@param business_unit_id The ID of the business unit @param week_id First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param body body @param [Hash] opts the optional parameters @return [Array<(BuAsyncScheduleRunResponse, Fixnum, Hash)>] BuAsyncScheduleRunResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7634
def post_workforcemanagement_businessunit_week_schedules_generate_with_http_info(business_unit_id, week_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedules_generate ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedules_generate" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedules_generate" if week_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedules_generate" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/generate".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BuAsyncScheduleRunResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_businessunit_week_schedules_generate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_businessunit_week_schedules_with_http_info(business_unit_id, week_id, body, opts = {}) click to toggle source

Create a blank schedule

@param business_unit_id The ID of the business unit @param week_id First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param body body @param [Hash] opts the optional parameters @return [Array<(BuScheduleMetadata, Fixnum, Hash)>] BuScheduleMetadata data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7549
def post_workforcemanagement_businessunit_week_schedules_with_http_info(business_unit_id, week_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedules ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedules" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedules" if week_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_schedules" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BuScheduleMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_businessunit_week_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_businessunit_week_shorttermforecast_copy(business_unit_id, week_date_id, forecast_id, body, opts = {}) click to toggle source

Copy a short term forecast

@param business_unit_id The business unit ID of the business unit to which the forecast belongs @param week_date_id 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 @param forecast_id The ID of the forecast to copy @param body body @param [Hash] opts the optional parameters @option opts [BOOLEAN] :force_async Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes @return [AsyncForecastOperationResult]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7709
def post_workforcemanagement_businessunit_week_shorttermforecast_copy(business_unit_id, week_date_id, forecast_id, body, opts = {})
  data, _status_code, _headers = post_workforcemanagement_businessunit_week_shorttermforecast_copy_with_http_info(business_unit_id, week_date_id, forecast_id, body, opts)
  return data
end
post_workforcemanagement_businessunit_week_shorttermforecast_copy_with_http_info(business_unit_id, week_date_id, forecast_id, body, opts = {}) click to toggle source

Copy a short term forecast

@param business_unit_id The business unit ID of the business unit to which the forecast belongs @param week_date_id 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 @param forecast_id The ID of the forecast to copy @param body body @param [Hash] opts the optional parameters @option opts [BOOLEAN] :force_async Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes @return [Array<(AsyncForecastOperationResult, Fixnum, Hash)>] AsyncForecastOperationResult data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7723
def post_workforcemanagement_businessunit_week_shorttermforecast_copy_with_http_info(business_unit_id, week_date_id, forecast_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_businessunit_week_shorttermforecast_copy ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_shorttermforecast_copy" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_shorttermforecast_copy" if week_date_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'forecast_id' is set
  fail ArgumentError, "Missing the required parameter 'forecast_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_shorttermforecast_copy" if forecast_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_shorttermforecast_copy" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s).sub('{' + 'forecastId' + '}', forecast_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'forceAsync'] = opts[:'force_async'] if opts[:'force_async']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsyncForecastOperationResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_businessunit_week_shorttermforecast_copy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_businessunit_week_shorttermforecasts_generate(business_unit_id, week_date_id, body, opts = {}) click to toggle source

Generate a short term forecast

@param business_unit_id The business unit ID of the business unit to which the forecast belongs @param week_date_id 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 @param body @param [Hash] opts the optional parameters @option opts [BOOLEAN] :force_async Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes @return [AsyncForecastOperationResult]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7812
def post_workforcemanagement_businessunit_week_shorttermforecasts_generate(business_unit_id, week_date_id, body, opts = {})
  data, _status_code, _headers = post_workforcemanagement_businessunit_week_shorttermforecasts_generate_with_http_info(business_unit_id, week_date_id, body, opts)
  return data
end
post_workforcemanagement_businessunit_week_shorttermforecasts_generate_with_http_info(business_unit_id, week_date_id, body, opts = {}) click to toggle source

Generate a short term forecast

@param business_unit_id The business unit ID of the business unit to which the forecast belongs @param week_date_id 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 @param body @param [Hash] opts the optional parameters @option opts [BOOLEAN] :force_async Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes @return [Array<(AsyncForecastOperationResult, Fixnum, Hash)>] AsyncForecastOperationResult data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7825
def post_workforcemanagement_businessunit_week_shorttermforecasts_generate_with_http_info(business_unit_id, week_date_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_businessunit_week_shorttermforecasts_generate ..."
  end
  
  
  # verify the required parameter 'business_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'business_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_shorttermforecasts_generate" if business_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_shorttermforecasts_generate" if week_date_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling WorkforceManagementApi.post_workforcemanagement_businessunit_week_shorttermforecasts_generate" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/generate".sub('{format}','json').sub('{' + 'businessUnitId' + '}', business_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'forceAsync'] = opts[:'force_async'] if opts[:'force_async']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsyncForecastOperationResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_businessunit_week_shorttermforecasts_generate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_businessunits(opts = {}) click to toggle source

Add a new business unit It may take a minute or two for a new business unit to be available for api operations @param [Hash] opts the optional parameters @option opts [CreateBusinessUnitRequest] :body body @return [BusinessUnit]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7903
def post_workforcemanagement_businessunits(opts = {})
  data, _status_code, _headers = post_workforcemanagement_businessunits_with_http_info(opts)
  return data
end
post_workforcemanagement_businessunits_with_http_info(opts = {}) click to toggle source

Add a new business unit It may take a minute or two for a new business unit to be available for api operations @param [Hash] opts the optional parameters @option opts [CreateBusinessUnitRequest] :body body @return [Array<(BusinessUnit, Fixnum, Hash)>] BusinessUnit data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7913
def post_workforcemanagement_businessunits_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_businessunits ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/businessunits".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BusinessUnit')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_businessunits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_activitycodes(mu_id, opts = {}) click to toggle source

Deprecated/Gone: Use the new business unit activity code resources

@param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7966
def post_workforcemanagement_managementunit_activitycodes(mu_id, opts = {})
  post_workforcemanagement_managementunit_activitycodes_with_http_info(mu_id, opts)
  return nil
end
post_workforcemanagement_managementunit_activitycodes_with_http_info(mu_id, opts = {}) click to toggle source

Deprecated/Gone: Use the new business unit activity code resources

@param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 7976
def post_workforcemanagement_managementunit_activitycodes_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_activitycodes ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_activitycodes" if mu_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/activitycodes".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_activitycodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_agentschedules_search(mu_id, opts = {}) click to toggle source

Query published schedules for given given time range for set of users

@param mu_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [BuSearchAgentSchedulesRequest] :body body @option opts [BOOLEAN] :force_async Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes @option opts [BOOLEAN] :force_download_service Force the result of this operation to be sent via download service. For testing/app development purposes @return [BuAsyncAgentSchedulesSearchResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8033
def post_workforcemanagement_managementunit_agentschedules_search(mu_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_agentschedules_search_with_http_info(mu_id, opts)
  return data
end
post_workforcemanagement_managementunit_agentschedules_search_with_http_info(mu_id, opts = {}) click to toggle source

Query published schedules for given given time range for set of users

@param mu_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [BuSearchAgentSchedulesRequest] :body body @option opts [BOOLEAN] :force_async Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes @option opts [BOOLEAN] :force_download_service Force the result of this operation to be sent via download service. For testing/app development purposes @return [Array<(BuAsyncAgentSchedulesSearchResponse, Fixnum, Hash)>] BuAsyncAgentSchedulesSearchResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8046
def post_workforcemanagement_managementunit_agentschedules_search_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_agentschedules_search ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_agentschedules_search" if mu_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/agentschedules/search".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'forceAsync'] = opts[:'force_async'] if opts[:'force_async']
  query_params[:'forceDownloadService'] = opts[:'force_download_service'] if opts[:'force_download_service']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BuAsyncAgentSchedulesSearchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_agentschedules_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts = {}) click to toggle source

Request a historical adherence report The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true @param mu_id The management unit ID of the management unit @param [Hash] opts the optional parameters @option opts [WfmHistoricalAdherenceQuery] :body body @return [WfmHistoricalAdherenceResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8122
def post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_historicaladherencequery_with_http_info(mu_id, opts)
  return data
end
post_workforcemanagement_managementunit_historicaladherencequery_with_http_info(mu_id, opts = {}) click to toggle source

Request a historical adherence report The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true @param mu_id The management unit ID of the management unit @param [Hash] opts the optional parameters @option opts [WfmHistoricalAdherenceQuery] :body body @return [Array<(WfmHistoricalAdherenceResponse, Fixnum, Hash)>] WfmHistoricalAdherenceResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8133
def post_workforcemanagement_managementunit_historicaladherencequery_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_historicaladherencequery ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_historicaladherencequery" if mu_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/historicaladherencequery".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WfmHistoricalAdherenceResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_historicaladherencequery\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_intraday(mu_id, opts = {}) click to toggle source

Gone. Moved under business units

@param mu_id The management unit ID of the management unit @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8194
def post_workforcemanagement_managementunit_intraday(mu_id, opts = {})
  post_workforcemanagement_managementunit_intraday_with_http_info(mu_id, opts)
  return nil
end
post_workforcemanagement_managementunit_intraday_with_http_info(mu_id, opts = {}) click to toggle source

Gone. Moved under business units

@param mu_id The management unit ID of the management unit @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8204
def post_workforcemanagement_managementunit_intraday_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_intraday ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_intraday" if mu_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/intraday".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_intraday\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_move(mu_id, opts = {}) click to toggle source

Move the requested management unit to a new business unit Returns status 200 if the management unit is already in the requested business unit @param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [MoveManagementUnitRequest] :body body @return [MoveManagementUnitResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8259
def post_workforcemanagement_managementunit_move(mu_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_move_with_http_info(mu_id, opts)
  return data
end
post_workforcemanagement_managementunit_move_with_http_info(mu_id, opts = {}) click to toggle source

Move the requested management unit to a new business unit Returns status 200 if the management unit is already in the requested business unit @param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [MoveManagementUnitRequest] :body body @return [Array<(MoveManagementUnitResponse, Fixnum, Hash)>] MoveManagementUnitResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8270
def post_workforcemanagement_managementunit_move_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_move ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_move" if mu_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/move".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MoveManagementUnitResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_move\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_schedules_search(mu_id, opts = {}) click to toggle source

Query published schedules for given given time range for set of users

@param mu_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [UserListScheduleRequestBody] :body body @return [UserScheduleContainer]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8332
def post_workforcemanagement_managementunit_schedules_search(mu_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_schedules_search_with_http_info(mu_id, opts)
  return data
end
post_workforcemanagement_managementunit_schedules_search_with_http_info(mu_id, opts = {}) click to toggle source

Query published schedules for given given time range for set of users

@param mu_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [UserListScheduleRequestBody] :body body @return [Array<(UserScheduleContainer, Fixnum, Hash)>] UserScheduleContainer data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8343
def post_workforcemanagement_managementunit_schedules_search_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_schedules_search ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_schedules_search" if mu_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/schedules/search".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserScheduleContainer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_schedules_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_servicegoalgroups(management_unit_id, opts = {}) click to toggle source

Gone. Replaced with service goal templates and planning groups under business units

@param management_unit_id (Deprecated/gone): The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8404
def post_workforcemanagement_managementunit_servicegoalgroups(management_unit_id, opts = {})
  post_workforcemanagement_managementunit_servicegoalgroups_with_http_info(management_unit_id, opts)
  return nil
end
post_workforcemanagement_managementunit_servicegoalgroups_with_http_info(management_unit_id, opts = {}) click to toggle source

Gone. Replaced with service goal templates and planning groups under business units

@param management_unit_id (Deprecated/gone): The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8414
def post_workforcemanagement_managementunit_servicegoalgroups_with_http_info(management_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_servicegoalgroups ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_servicegoalgroups" if management_unit_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_servicegoalgroups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_timeoffrequests(mu_id, opts = {}) click to toggle source

Create a new time off request

@param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [CreateAdminTimeOffRequest] :body body @return [TimeOffRequestList]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8469
def post_workforcemanagement_managementunit_timeoffrequests(mu_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_timeoffrequests_with_http_info(mu_id, opts)
  return data
end
post_workforcemanagement_managementunit_timeoffrequests_fetchdetails(mu_id, opts = {}) click to toggle source

Gone. All data is now returned in the query route

@param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [TimeOffRequestListing] :body body @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8542
def post_workforcemanagement_managementunit_timeoffrequests_fetchdetails(mu_id, opts = {})
  post_workforcemanagement_managementunit_timeoffrequests_fetchdetails_with_http_info(mu_id, opts)
  return nil
end
post_workforcemanagement_managementunit_timeoffrequests_fetchdetails_with_http_info(mu_id, opts = {}) click to toggle source

Gone. All data is now returned in the query route

@param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [TimeOffRequestListing] :body body @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8553
def post_workforcemanagement_managementunit_timeoffrequests_fetchdetails_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_timeoffrequests_fetchdetails ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_timeoffrequests_fetchdetails" if mu_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/fetchdetails".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_timeoffrequests_fetchdetails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_timeoffrequests_query(mu_id, opts = {}) click to toggle source

Gets the lookup ids to fetch the specified set of requests

@param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [TimeOffRequestQueryBody] :body body @return [TimeOffRequestListing]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8614
def post_workforcemanagement_managementunit_timeoffrequests_query(mu_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_timeoffrequests_query_with_http_info(mu_id, opts)
  return data
end
post_workforcemanagement_managementunit_timeoffrequests_query_with_http_info(mu_id, opts = {}) click to toggle source

Gets the lookup ids to fetch the specified set of requests

@param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [TimeOffRequestQueryBody] :body body @return [Array<(TimeOffRequestListing, Fixnum, Hash)>] TimeOffRequestListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8625
def post_workforcemanagement_managementunit_timeoffrequests_query_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_timeoffrequests_query ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_timeoffrequests_query" if mu_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/query".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeOffRequestListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_timeoffrequests_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_timeoffrequests_with_http_info(mu_id, opts = {}) click to toggle source

Create a new time off request

@param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [CreateAdminTimeOffRequest] :body body @return [Array<(TimeOffRequestList, Fixnum, Hash)>] TimeOffRequestList data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8480
def post_workforcemanagement_managementunit_timeoffrequests_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_timeoffrequests ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_timeoffrequests" if mu_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeOffRequestList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_timeoffrequests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_week_schedule_copy(management_unit_id, week_id, schedule_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_id First day of schedule week in yyyy-MM-dd format. @param schedule_id Gone/deprecated. The ID of the schedule to copy from @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8688
def post_workforcemanagement_managementunit_week_schedule_copy(management_unit_id, week_id, schedule_id, opts = {})
  post_workforcemanagement_managementunit_week_schedule_copy_with_http_info(management_unit_id, week_id, schedule_id, opts)
  return nil
end
post_workforcemanagement_managementunit_week_schedule_copy_with_http_info(management_unit_id, week_id, schedule_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_id First day of schedule week in yyyy-MM-dd format. @param schedule_id Gone/deprecated. The ID of the schedule to copy from @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8700
def post_workforcemanagement_managementunit_week_schedule_copy_with_http_info(management_unit_id, week_id, schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedule_copy ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedule_copy" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedule_copy" if week_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'schedule_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedule_copy" if schedule_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_week_schedule_copy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_week_schedule_reschedule(management_unit_id, week_id, schedule_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_id First day of schedule week in yyyy-MM-dd format. @param schedule_id Gone/deprecated. The ID of the schedule to re-optimize @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8772
def post_workforcemanagement_managementunit_week_schedule_reschedule(management_unit_id, week_id, schedule_id, opts = {})
  post_workforcemanagement_managementunit_week_schedule_reschedule_with_http_info(management_unit_id, week_id, schedule_id, opts)
  return nil
end
post_workforcemanagement_managementunit_week_schedule_reschedule_with_http_info(management_unit_id, week_id, schedule_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_id First day of schedule week in yyyy-MM-dd format. @param schedule_id Gone/deprecated. The ID of the schedule to re-optimize @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8784
def post_workforcemanagement_managementunit_week_schedule_reschedule_with_http_info(management_unit_id, week_id, schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedule_reschedule ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedule_reschedule" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedule_reschedule" if week_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'schedule_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedule_reschedule" if schedule_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_week_schedule_reschedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_id First day of schedule week in yyyy-MM-dd format. @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8855
def post_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id, opts = {})
  post_workforcemanagement_managementunit_week_schedules_with_http_info(management_unit_id, week_id, opts)
  return nil
end
post_workforcemanagement_managementunit_week_schedules_generate(management_unit_id, week_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_id First day of schedule week in yyyy-MM-dd format. @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8929
def post_workforcemanagement_managementunit_week_schedules_generate(management_unit_id, week_id, opts = {})
  post_workforcemanagement_managementunit_week_schedules_generate_with_http_info(management_unit_id, week_id, opts)
  return nil
end
post_workforcemanagement_managementunit_week_schedules_generate_with_http_info(management_unit_id, week_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_id First day of schedule week in yyyy-MM-dd format. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8940
def post_workforcemanagement_managementunit_week_schedules_generate_with_http_info(management_unit_id, week_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedules_generate ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedules_generate" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedules_generate" if week_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/generate".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_week_schedules_generate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_week_schedules_partialupload(management_unit_id, week_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_id First day of schedule week in yyyy-MM-dd format. @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9003
def post_workforcemanagement_managementunit_week_schedules_partialupload(management_unit_id, week_id, opts = {})
  post_workforcemanagement_managementunit_week_schedules_partialupload_with_http_info(management_unit_id, week_id, opts)
  return nil
end
post_workforcemanagement_managementunit_week_schedules_partialupload_with_http_info(management_unit_id, week_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_id First day of schedule week in yyyy-MM-dd format. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9014
def post_workforcemanagement_managementunit_week_schedules_partialupload_with_http_info(management_unit_id, week_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedules_partialupload ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedules_partialupload" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedules_partialupload" if week_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/partialupload".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_week_schedules_partialupload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_week_schedules_with_http_info(management_unit_id, week_id, opts = {}) click to toggle source

Gone. Scheduling has moved under business units

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_id First day of schedule week in yyyy-MM-dd format. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 8866
def post_workforcemanagement_managementunit_week_schedules_with_http_info(management_unit_id, week_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedules ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedules" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedules" if week_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_week_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_week_shifttrade_match(management_unit_id, week_date_id, body, trade_id, opts = {}) click to toggle source

Matches a shift trade. This route can only be called by the receiving agent

@param management_unit_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_date_id The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param body body @param trade_id The ID of the shift trade to update @param [Hash] opts the optional parameters @return [MatchShiftTradeResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9079
def post_workforcemanagement_managementunit_week_shifttrade_match(management_unit_id, week_date_id, body, trade_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_week_shifttrade_match_with_http_info(management_unit_id, week_date_id, body, trade_id, opts)
  return data
end
post_workforcemanagement_managementunit_week_shifttrade_match_with_http_info(management_unit_id, week_date_id, body, trade_id, opts = {}) click to toggle source

Matches a shift trade. This route can only be called by the receiving agent

@param management_unit_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_date_id The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param body body @param trade_id The ID of the shift trade to update @param [Hash] opts the optional parameters @return [Array<(MatchShiftTradeResponse, Fixnum, Hash)>] MatchShiftTradeResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9092
def post_workforcemanagement_managementunit_week_shifttrade_match_with_http_info(management_unit_id, week_date_id, body, trade_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_week_shifttrade_match ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shifttrade_match" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shifttrade_match" if week_date_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shifttrade_match" if body.nil?
  
  
  
  
  
  
  # verify the required parameter 'trade_id' is set
  fail ArgumentError, "Missing the required parameter 'trade_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shifttrade_match" if trade_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/match".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s).sub('{' + 'tradeId' + '}', trade_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MatchShiftTradeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_week_shifttrade_match\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_week_shifttrades(management_unit_id, week_date_id, body, opts = {}) click to toggle source

Adds a shift trade

@param management_unit_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_date_id The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param body body @param [Hash] opts the optional parameters @return [ShiftTradeResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9173
def post_workforcemanagement_managementunit_week_shifttrades(management_unit_id, week_date_id, body, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_week_shifttrades_with_http_info(management_unit_id, week_date_id, body, opts)
  return data
end
post_workforcemanagement_managementunit_week_shifttrades_search(management_unit_id, week_date_id, body, opts = {}) click to toggle source

Searches for potential shift trade matches for the current agent

@param management_unit_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_date_id The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param body body @param [Hash] opts the optional parameters @return [SearchShiftTradesResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9258
def post_workforcemanagement_managementunit_week_shifttrades_search(management_unit_id, week_date_id, body, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_week_shifttrades_search_with_http_info(management_unit_id, week_date_id, body, opts)
  return data
end
post_workforcemanagement_managementunit_week_shifttrades_search_with_http_info(management_unit_id, week_date_id, body, opts = {}) click to toggle source

Searches for potential shift trade matches for the current agent

@param management_unit_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_date_id The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param body body @param [Hash] opts the optional parameters @return [Array<(SearchShiftTradesResponse, Fixnum, Hash)>] SearchShiftTradesResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9270
def post_workforcemanagement_managementunit_week_shifttrades_search_with_http_info(management_unit_id, week_date_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_week_shifttrades_search ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shifttrades_search" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shifttrades_search" if week_date_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shifttrades_search" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SearchShiftTradesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_week_shifttrades_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_week_shifttrades_state_bulk(management_unit_id, week_date_id, body, opts = {}) click to toggle source

Updates the state of a batch of shift trades Admin functionality is not supported with "mine". @param management_unit_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_date_id The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param body body @param [Hash] opts the optional parameters @option opts [BOOLEAN] :force_async Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes @return [BulkUpdateShiftTradeStateResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9344
def post_workforcemanagement_managementunit_week_shifttrades_state_bulk(management_unit_id, week_date_id, body, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_week_shifttrades_state_bulk_with_http_info(management_unit_id, week_date_id, body, opts)
  return data
end
post_workforcemanagement_managementunit_week_shifttrades_state_bulk_with_http_info(management_unit_id, week_date_id, body, opts = {}) click to toggle source

Updates the state of a batch of shift trades Admin functionality is not supported with "mine&quot;. @param management_unit_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_date_id The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param body body @param [Hash] opts the optional parameters @option opts [BOOLEAN] :force_async Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes @return [Array<(BulkUpdateShiftTradeStateResponse, Fixnum, Hash)>] BulkUpdateShiftTradeStateResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9357
def post_workforcemanagement_managementunit_week_shifttrades_state_bulk_with_http_info(management_unit_id, week_date_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_week_shifttrades_state_bulk ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shifttrades_state_bulk" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shifttrades_state_bulk" if week_date_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shifttrades_state_bulk" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/state/bulk".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'forceAsync'] = opts[:'force_async'] if opts[:'force_async']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BulkUpdateShiftTradeStateResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_week_shifttrades_state_bulk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_week_shifttrades_with_http_info(management_unit_id, week_date_id, body, opts = {}) click to toggle source

Adds a shift trade

@param management_unit_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param week_date_id The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd @param body body @param [Hash] opts the optional parameters @return [Array<(ShiftTradeResponse, Fixnum, Hash)>] ShiftTradeResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9185
def post_workforcemanagement_managementunit_week_shifttrades_with_http_info(management_unit_id, week_date_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_week_shifttrades ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shifttrades" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shifttrades" if week_date_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shifttrades" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ShiftTradeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_week_shifttrades\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_week_shorttermforecast_copy(management_unit_id, week_date_id, forecast_id, opts = {}) click to toggle source

Gone. Use equivalent business unit resource instead

@param management_unit_id (Deprecated/gone): The id of the management unit. @param week_date_id (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format @param forecast_id (Gone/Deprecated): The ID of the forecast @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9437
def post_workforcemanagement_managementunit_week_shorttermforecast_copy(management_unit_id, week_date_id, forecast_id, opts = {})
  post_workforcemanagement_managementunit_week_shorttermforecast_copy_with_http_info(management_unit_id, week_date_id, forecast_id, opts)
  return nil
end
post_workforcemanagement_managementunit_week_shorttermforecast_copy_with_http_info(management_unit_id, week_date_id, forecast_id, opts = {}) click to toggle source

Gone. Use equivalent business unit resource instead

@param management_unit_id (Deprecated/gone): The id of the management unit. @param week_date_id (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format @param forecast_id (Gone/Deprecated): The ID of the forecast @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9449
def post_workforcemanagement_managementunit_week_shorttermforecast_copy_with_http_info(management_unit_id, week_date_id, forecast_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecast_copy ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecast_copy" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecast_copy" if week_date_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'forecast_id' is set
  fail ArgumentError, "Missing the required parameter 'forecast_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecast_copy" if forecast_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s).sub('{' + 'forecastId' + '}', forecast_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_week_shorttermforecast_copy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id, opts = {}) click to toggle source

Gone. Use equivalent business unit resource instead

@param management_unit_id (Deprecated/gone): The id of the management unit. @param week_date_id (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9520
def post_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id, opts = {})
  post_workforcemanagement_managementunit_week_shorttermforecasts_with_http_info(management_unit_id, week_date_id, opts)
  return nil
end
post_workforcemanagement_managementunit_week_shorttermforecasts_generate(management_unit_id, week_date_id, opts = {}) click to toggle source

Gone. Use equivalent business unit resource instead

@param management_unit_id (Deprecated/gone): The id of the management unit. @param week_date_id (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9594
def post_workforcemanagement_managementunit_week_shorttermforecasts_generate(management_unit_id, week_date_id, opts = {})
  post_workforcemanagement_managementunit_week_shorttermforecasts_generate_with_http_info(management_unit_id, week_date_id, opts)
  return nil
end
post_workforcemanagement_managementunit_week_shorttermforecasts_generate_with_http_info(management_unit_id, week_date_id, opts = {}) click to toggle source

Gone. Use equivalent business unit resource instead

@param management_unit_id (Deprecated/gone): The id of the management unit. @param week_date_id (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9605
def post_workforcemanagement_managementunit_week_shorttermforecasts_generate_with_http_info(management_unit_id, week_date_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecasts_generate ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecasts_generate" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecasts_generate" if week_date_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/generate".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_week_shorttermforecasts_generate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload(management_unit_id, week_date_id, opts = {}) click to toggle source

Gone. Use equivalent business unit resource instead

@param management_unit_id (Deprecated/gone): The id of the management unit. @param week_date_id (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9668
def post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload(management_unit_id, week_date_id, opts = {})
  post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload_with_http_info(management_unit_id, week_date_id, opts)
  return nil
end
post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload_with_http_info(management_unit_id, week_date_id, opts = {}) click to toggle source

Gone. Use equivalent business unit resource instead

@param management_unit_id (Deprecated/gone): The id of the management unit. @param week_date_id (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9679
def post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload_with_http_info(management_unit_id, week_date_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload" if week_date_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/partialupload".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_week_shorttermforecasts_with_http_info(management_unit_id, week_date_id, opts = {}) click to toggle source

Gone. Use equivalent business unit resource instead

@param management_unit_id (Deprecated/gone): The id of the management unit. @param week_date_id (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9531
def post_workforcemanagement_managementunit_week_shorttermforecasts_with_http_info(management_unit_id, week_date_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecasts ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecasts" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecasts" if week_date_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_week_shorttermforecasts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_workplan_copy(management_unit_id, work_plan_id, opts = {}) click to toggle source

Create a copy of work plan

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param work_plan_id The ID of the work plan to create a copy @param [Hash] opts the optional parameters @option opts [CopyWorkPlan] :body body @return [WorkPlan]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9743
def post_workforcemanagement_managementunit_workplan_copy(management_unit_id, work_plan_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_workplan_copy_with_http_info(management_unit_id, work_plan_id, opts)
  return data
end
post_workforcemanagement_managementunit_workplan_copy_with_http_info(management_unit_id, work_plan_id, opts = {}) click to toggle source

Create a copy of work plan

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param work_plan_id The ID of the work plan to create a copy @param [Hash] opts the optional parameters @option opts [CopyWorkPlan] :body body @return [Array<(WorkPlan, Fixnum, Hash)>] WorkPlan data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9755
def post_workforcemanagement_managementunit_workplan_copy_with_http_info(management_unit_id, work_plan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_workplan_copy ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_workplan_copy" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'work_plan_id' is set
  fail ArgumentError, "Missing the required parameter 'work_plan_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_workplan_copy" if work_plan_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'workPlanId' + '}', work_plan_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkPlan')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_workplan_copy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunit_workplans(management_unit_id, opts = {}) click to toggle source

Create a new work plan

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [CreateWorkPlan] :body body @return [WorkPlan]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9825
def post_workforcemanagement_managementunit_workplans(management_unit_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_workplans_with_http_info(management_unit_id, opts)
  return data
end
post_workforcemanagement_managementunit_workplans_with_http_info(management_unit_id, opts = {}) click to toggle source

Create a new work plan

@param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. @param [Hash] opts the optional parameters @option opts [CreateWorkPlan] :body body @return [Array<(WorkPlan, Fixnum, Hash)>] WorkPlan data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9836
def post_workforcemanagement_managementunit_workplans_with_http_info(management_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_workplans ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_workplans" if management_unit_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkPlan')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_workplans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_managementunits(opts = {}) click to toggle source

Add a management unit It may take a minute or two for a new management unit to be available for api operations @param [Hash] opts the optional parameters @option opts [CreateManagementUnitApiRequest] :body body @return [ManagementUnit]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9897
def post_workforcemanagement_managementunits(opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunits_with_http_info(opts)
  return data
end
post_workforcemanagement_managementunits_with_http_info(opts = {}) click to toggle source

Add a management unit It may take a minute or two for a new management unit to be available for api operations @param [Hash] opts the optional parameters @option opts [CreateManagementUnitApiRequest] :body body @return [Array<(ManagementUnit, Fixnum, Hash)>] ManagementUnit data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9907
def post_workforcemanagement_managementunits_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunits ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ManagementUnit')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_notifications_update(opts = {}) click to toggle source

Mark a list of notifications as read or unread

@param [Hash] opts the optional parameters @option opts [UpdateNotificationsRequest] :body body @return [UpdateNotificationsResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9960
def post_workforcemanagement_notifications_update(opts = {})
  data, _status_code, _headers = post_workforcemanagement_notifications_update_with_http_info(opts)
  return data
end
post_workforcemanagement_notifications_update_with_http_info(opts = {}) click to toggle source

Mark a list of notifications as read or unread

@param [Hash] opts the optional parameters @option opts [UpdateNotificationsRequest] :body body @return [Array<(UpdateNotificationsResponse, Fixnum, Hash)>] UpdateNotificationsResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 9970
def post_workforcemanagement_notifications_update_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_notifications_update ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/notifications/update".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UpdateNotificationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_notifications_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_schedules(opts = {}) click to toggle source

Get published schedule for the current user

@param [Hash] opts the optional parameters @option opts [CurrentUserScheduleRequestBody] :body body @return [UserScheduleContainer]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 10023
def post_workforcemanagement_schedules(opts = {})
  data, _status_code, _headers = post_workforcemanagement_schedules_with_http_info(opts)
  return data
end
post_workforcemanagement_schedules_with_http_info(opts = {}) click to toggle source

Get published schedule for the current user

@param [Hash] opts the optional parameters @option opts [CurrentUserScheduleRequestBody] :body body @return [Array<(UserScheduleContainer, Fixnum, Hash)>] UserScheduleContainer data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 10033
def post_workforcemanagement_schedules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_schedules ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/schedules".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserScheduleContainer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_workforcemanagement_timeoffrequests(opts = {}) click to toggle source

Create a time off request for the current user

@param [Hash] opts the optional parameters @option opts [CreateAgentTimeOffRequest] :body body @return [TimeOffRequestResponse]

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 10086
def post_workforcemanagement_timeoffrequests(opts = {})
  data, _status_code, _headers = post_workforcemanagement_timeoffrequests_with_http_info(opts)
  return data
end
post_workforcemanagement_timeoffrequests_with_http_info(opts = {}) click to toggle source

Create a time off request for the current user

@param [Hash] opts the optional parameters @option opts [CreateAgentTimeOffRequest] :body body @return [Array<(TimeOffRequestResponse, Fixnum, Hash)>] TimeOffRequestResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/workforce_management_api.rb, line 10096
def post_workforcemanagement_timeoffrequests_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_timeoffrequests ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/timeoffrequests".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeOffRequestResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_timeoffrequests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end