purecloudplatformclientv2 75.1.0 → 79.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActivityCode.md +1 -1
- data/docs/AnalyticsApi.md +66 -2
- data/docs/AnalyticsConversationAsyncQueryResponse.md +1 -1
- data/docs/AnalyticsConversationQueryResponse.md +1 -1
- data/docs/AnalyticsParticipant.md +1 -0
- data/docs/AnalyticsParticipantWithoutAttributes.md +1 -0
- data/docs/ArchitectApi.md +345 -0
- data/docs/AuditApi.md +3 -1
- data/docs/AuditLogMessage.md +1 -1
- data/docs/AuthorizationApi.md +154 -9
- data/docs/AvailableTopic.md +3 -1
- data/docs/BuAgentScheduleActivity.md +18 -0
- data/docs/BuAgentSchedulePublishedScheduleReference.md +16 -0
- data/docs/BuAgentScheduleSearchResponse.md +15 -0
- data/docs/BuAgentScheduleShift.md +18 -0
- data/docs/BuAgentSchedulesSearchResponse.md +15 -0
- data/docs/BuAsyncAgentSchedulesSearchResponse.md +17 -0
- data/docs/BuFullDayTimeOffMarker.md +18 -0
- data/docs/BuScheduleReference.md +15 -0
- data/docs/Call.md +1 -1
- data/docs/CallBasic.md +1 -1
- data/docs/CallMediaParticipant.md +1 -1
- data/docs/CallbackMediaParticipant.md +1 -1
- data/docs/CampaignProgress.md +2 -1
- data/docs/ChatMediaParticipant.md +1 -1
- data/docs/CobrowseMediaParticipant.md +1 -1
- data/docs/ConversationsApi.md +71 -1
- data/docs/CopyAttachmentsRequest.md +14 -0
- data/docs/CreateManagementUnitApiRequest.md +3 -2
- data/docs/CreateManagementUnitSettingsRequest.md +1 -1
- data/docs/CreateWorkPlanShift.md +1 -1
- data/docs/DataTableExportJob.md +22 -0
- data/docs/DataTableImportJob.md +25 -0
- data/docs/DivsPermittedEntityListing.md +23 -0
- data/docs/EmailMediaParticipant.md +1 -1
- data/docs/EntityListing.md +17 -0
- data/docs/ErrorBody.md +2 -2
- data/docs/ErrorInfo.md +14 -0
- data/docs/Evaluation.md +1 -0
- data/docs/EvaluationQuestionGroupScore.md +4 -0
- data/docs/EvaluationScoringSet.md +1 -0
- data/docs/FacebookIntegrationRequest.md +2 -2
- data/docs/GDPRJourneyCustomer.md +2 -2
- data/docs/InboundDomain.md +2 -0
- data/docs/Library.md +4 -3
- data/docs/LicenseApi.md +66 -0
- data/docs/MailFromResult.md +15 -0
- data/docs/ManagementUnit.md +2 -2
- data/docs/ManagementUnitSettingsRequest.md +1 -1
- data/docs/MessageMediaParticipant.md +1 -1
- data/docs/MessagingApi.md +0 -936
- data/docs/MessagingTemplate.md +15 -0
- data/docs/Organization.md +1 -0
- data/docs/QualityApi.md +5 -6
- data/docs/Record.md +15 -0
- data/docs/ReportingExportMetadataJobListing.md +22 -0
- data/docs/ReportingExportMetadataJobResponse.md +22 -0
- data/docs/Response.md +2 -0
- data/docs/RoutingApi.md +385 -0
- data/docs/RoutingSettings.md +13 -0
- data/docs/SCIMApi.md +397 -23
- data/docs/ScimUserExtensions.md +14 -0
- data/docs/ScimUserRole.md +13 -0
- data/docs/ScimUserRoutingLanguage.md +14 -0
- data/docs/ScimUserRoutingSkill.md +14 -0
- data/docs/ScimV2CreateUser.md +2 -1
- data/docs/ScimV2SchemaAttribute.md +24 -0
- data/docs/ScimV2SchemaDefinition.md +17 -0
- data/docs/ScimV2SchemaListResponse.md +17 -0
- data/docs/ScimV2User.md +2 -1
- data/docs/ShortTermForecast.md +2 -2
- data/docs/ShortTermForecastListItemResponse.md +2 -2
- data/docs/ShortTermForecastReference.md +2 -2
- data/docs/TimeOffRequestLookup.md +3 -3
- data/docs/TimeOffRequestResponse.md +3 -3
- data/docs/UserScheduleAdherence.md +1 -1
- data/docs/UsersApi.md +358 -10
- data/docs/ViewFilter.md +4 -10
- data/docs/WeekSchedule.md +1 -1
- data/docs/WeekScheduleListItemResponse.md +1 -1
- data/docs/WeekScheduleReference.md +1 -1
- data/docs/WorkPlanShift.md +1 -1
- data/docs/WorkforceManagementApi.md +40 -41
- data/lib/purecloudplatformclientv2.rb +27 -0
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +73 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +373 -0
- data/lib/purecloudplatformclientv2/api/audit_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +185 -7
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +84 -0
- data/lib/purecloudplatformclientv2/api/license_api.rb +63 -0
- data/lib/purecloudplatformclientv2/api/messaging_api.rb +0 -949
- data/lib/purecloudplatformclientv2/api/quality_api.rb +8 -6
- data/lib/purecloudplatformclientv2/api/routing_api.rb +378 -0
- data/lib/purecloudplatformclientv2/api/scim_api.rb +366 -26
- data/lib/purecloudplatformclientv2/api/users_api.rb +398 -7
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +3 -3
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/activity_code.rb +30 -30
- data/lib/purecloudplatformclientv2/models/analytics_conversation_async_query_response.rb +15 -15
- data/lib/purecloudplatformclientv2/models/analytics_conversation_query_response.rb +15 -15
- data/lib/purecloudplatformclientv2/models/analytics_participant.rb +27 -1
- data/lib/purecloudplatformclientv2/models/analytics_participant_without_attributes.rb +27 -1
- data/lib/purecloudplatformclientv2/models/audit_log_message.rb +5 -5
- data/lib/purecloudplatformclientv2/models/available_topic.rb +57 -4
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_activity.rb +332 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_published_schedule_reference.rb +280 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_search_response.rb +258 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_shift.rb +334 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedules_search_response.rb +258 -0
- data/lib/purecloudplatformclientv2/models/bu_async_agent_schedules_search_response.rb +320 -0
- data/lib/purecloudplatformclientv2/models/bu_full_day_time_off_marker.rb +332 -0
- data/lib/purecloudplatformclientv2/models/bu_schedule_reference.rb +254 -0
- data/lib/purecloudplatformclientv2/models/call.rb +1 -1
- data/lib/purecloudplatformclientv2/models/call_basic.rb +1 -1
- data/lib/purecloudplatformclientv2/models/call_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/campaign_progress.rb +28 -2
- data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/copy_attachments_request.rb +240 -0
- data/lib/purecloudplatformclientv2/models/create_management_unit_api_request.rb +37 -16
- data/lib/purecloudplatformclientv2/models/create_management_unit_settings_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/create_work_plan_shift.rb +1 -1
- data/lib/purecloudplatformclientv2/models/data_table_export_job.rb +455 -0
- data/lib/purecloudplatformclientv2/models/data_table_import_job.rb +547 -0
- data/lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb +453 -0
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/entity_listing.rb +303 -0
- data/lib/purecloudplatformclientv2/models/error_body.rb +20 -20
- data/lib/purecloudplatformclientv2/models/error_info.rb +226 -0
- data/lib/purecloudplatformclientv2/models/evaluation.rb +27 -1
- data/lib/purecloudplatformclientv2/models/evaluation_question_group_score.rb +101 -1
- data/lib/purecloudplatformclientv2/models/evaluation_scoring_set.rb +26 -1
- data/lib/purecloudplatformclientv2/models/facebook_integration_request.rb +2 -7
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/gdpr_journey_customer.rb +2 -12
- data/lib/purecloudplatformclientv2/models/inbound_domain.rb +53 -1
- data/lib/purecloudplatformclientv2/models/library.rb +44 -2
- data/lib/purecloudplatformclientv2/models/mail_from_result.rb +275 -0
- data/lib/purecloudplatformclientv2/models/management_unit.rb +2 -2
- data/lib/purecloudplatformclientv2/models/management_unit_settings_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/messaging_template.rb +270 -0
- data/lib/purecloudplatformclientv2/models/organization.rb +41 -1
- data/lib/purecloudplatformclientv2/models/record.rb +269 -0
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_response.rb +459 -0
- data/lib/purecloudplatformclientv2/models/response.rb +67 -1
- data/lib/purecloudplatformclientv2/models/routing_settings.rb +202 -0
- data/lib/purecloudplatformclientv2/models/scim_metadata.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_user_extensions.rb +233 -0
- data/lib/purecloudplatformclientv2/models/scim_user_role.rb +203 -0
- data/lib/purecloudplatformclientv2/models/scim_user_routing_language.rb +234 -0
- data/lib/purecloudplatformclientv2/models/scim_user_routing_skill.rb +234 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +30 -5
- data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_attribute.rb +551 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb +309 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_list_response.rb +311 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +27 -2
- data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/short_term_forecast.rb +30 -35
- data/lib/purecloudplatformclientv2/models/short_term_forecast_list_item_response.rb +30 -35
- data/lib/purecloudplatformclientv2/models/short_term_forecast_reference.rb +22 -27
- data/lib/purecloudplatformclientv2/models/time_off_request_lookup.rb +3 -3
- data/lib/purecloudplatformclientv2/models/time_off_request_response.rb +3 -3
- data/lib/purecloudplatformclientv2/models/user_schedule_adherence.rb +1 -1
- data/lib/purecloudplatformclientv2/models/view_filter.rb +53 -255
- data/lib/purecloudplatformclientv2/models/week_schedule.rb +21 -21
- data/lib/purecloudplatformclientv2/models/week_schedule_list_item_response.rb +21 -21
- data/lib/purecloudplatformclientv2/models/week_schedule_reference.rb +14 -14
- data/lib/purecloudplatformclientv2/models/work_plan_shift.rb +1 -1
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +56 -2
@@ -3270,25 +3270,27 @@ module PureCloud
|
|
3270
3270
|
|
3271
3271
|
# Get a survey as an end-customer, for the purposes of scoring it.
|
3272
3272
|
#
|
3273
|
+
# @param customer_survey_url customerSurveyUrl
|
3273
3274
|
# @param [Hash] opts the optional parameters
|
3274
|
-
# @option opts [String] :customer_survey_url customerSurveyUrl
|
3275
3275
|
# @return [ScorableSurvey]
|
3276
|
-
def get_quality_surveys_scorable(opts = {})
|
3277
|
-
data, _status_code, _headers = get_quality_surveys_scorable_with_http_info(opts)
|
3276
|
+
def get_quality_surveys_scorable(customer_survey_url, opts = {})
|
3277
|
+
data, _status_code, _headers = get_quality_surveys_scorable_with_http_info(customer_survey_url, opts)
|
3278
3278
|
return data
|
3279
3279
|
end
|
3280
3280
|
|
3281
3281
|
# Get a survey as an end-customer, for the purposes of scoring it.
|
3282
3282
|
#
|
3283
|
+
# @param customer_survey_url customerSurveyUrl
|
3283
3284
|
# @param [Hash] opts the optional parameters
|
3284
|
-
# @option opts [String] :customer_survey_url customerSurveyUrl
|
3285
3285
|
# @return [Array<(ScorableSurvey, Fixnum, Hash)>] ScorableSurvey data, response status code and response headers
|
3286
|
-
def get_quality_surveys_scorable_with_http_info(opts = {})
|
3286
|
+
def get_quality_surveys_scorable_with_http_info(customer_survey_url, opts = {})
|
3287
3287
|
if @api_client.config.debugging
|
3288
3288
|
@api_client.config.logger.debug "Calling API: QualityApi.get_quality_surveys_scorable ..."
|
3289
3289
|
end
|
3290
3290
|
|
3291
3291
|
|
3292
|
+
# verify the required parameter 'customer_survey_url' is set
|
3293
|
+
fail ArgumentError, "Missing the required parameter 'customer_survey_url' when calling QualityApi.get_quality_surveys_scorable" if customer_survey_url.nil?
|
3292
3294
|
|
3293
3295
|
|
3294
3296
|
|
@@ -3299,7 +3301,7 @@ module PureCloud
|
|
3299
3301
|
|
3300
3302
|
# query parameters
|
3301
3303
|
query_params = {}
|
3302
|
-
query_params[:'customerSurveyUrl'] =
|
3304
|
+
query_params[:'customerSurveyUrl'] = customer_survey_url
|
3303
3305
|
|
3304
3306
|
# header parameters
|
3305
3307
|
header_params = {}
|
@@ -383,6 +383,60 @@ module PureCloud
|
|
383
383
|
return data, status_code, headers
|
384
384
|
end
|
385
385
|
|
386
|
+
# Delete an organization's routing settings
|
387
|
+
#
|
388
|
+
# @param [Hash] opts the optional parameters
|
389
|
+
# @return [nil]
|
390
|
+
def delete_routing_settings(opts = {})
|
391
|
+
delete_routing_settings_with_http_info(opts)
|
392
|
+
return nil
|
393
|
+
end
|
394
|
+
|
395
|
+
# Delete an organization's routing settings
|
396
|
+
#
|
397
|
+
# @param [Hash] opts the optional parameters
|
398
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
399
|
+
def delete_routing_settings_with_http_info(opts = {})
|
400
|
+
if @api_client.config.debugging
|
401
|
+
@api_client.config.logger.debug "Calling API: RoutingApi.delete_routing_settings ..."
|
402
|
+
end
|
403
|
+
|
404
|
+
# resource path
|
405
|
+
local_var_path = "/api/v2/routing/settings".sub('{format}','json')
|
406
|
+
|
407
|
+
# query parameters
|
408
|
+
query_params = {}
|
409
|
+
|
410
|
+
# header parameters
|
411
|
+
header_params = {}
|
412
|
+
|
413
|
+
# HTTP header 'Accept' (if needed)
|
414
|
+
local_header_accept = ['application/json']
|
415
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
416
|
+
|
417
|
+
# HTTP header 'Content-Type'
|
418
|
+
local_header_content_type = ['application/json']
|
419
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
420
|
+
|
421
|
+
# form parameters
|
422
|
+
form_params = {}
|
423
|
+
|
424
|
+
# http body (model)
|
425
|
+
post_body = nil
|
426
|
+
|
427
|
+
auth_names = ['PureCloud OAuth']
|
428
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
429
|
+
:header_params => header_params,
|
430
|
+
:query_params => query_params,
|
431
|
+
:form_params => form_params,
|
432
|
+
:body => post_body,
|
433
|
+
:auth_names => auth_names)
|
434
|
+
if @api_client.config.debugging
|
435
|
+
@api_client.config.logger.debug "API called: RoutingApi#delete_routing_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
436
|
+
end
|
437
|
+
return data, status_code, headers
|
438
|
+
end
|
439
|
+
|
386
440
|
# Delete Routing Skill
|
387
441
|
#
|
388
442
|
# @param skill_id Skill ID
|
@@ -511,6 +565,70 @@ module PureCloud
|
|
511
565
|
return data, status_code, headers
|
512
566
|
end
|
513
567
|
|
568
|
+
# Delete the user's max utilization settings and revert to the organization-wide default.
|
569
|
+
#
|
570
|
+
# @param user_id User ID
|
571
|
+
# @param [Hash] opts the optional parameters
|
572
|
+
# @return [nil]
|
573
|
+
def delete_routing_user_utilization(user_id, opts = {})
|
574
|
+
delete_routing_user_utilization_with_http_info(user_id, opts)
|
575
|
+
return nil
|
576
|
+
end
|
577
|
+
|
578
|
+
# Delete the user's max utilization settings and revert to the organization-wide default.
|
579
|
+
#
|
580
|
+
# @param user_id User ID
|
581
|
+
# @param [Hash] opts the optional parameters
|
582
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
583
|
+
def delete_routing_user_utilization_with_http_info(user_id, opts = {})
|
584
|
+
if @api_client.config.debugging
|
585
|
+
@api_client.config.logger.debug "Calling API: RoutingApi.delete_routing_user_utilization ..."
|
586
|
+
end
|
587
|
+
|
588
|
+
|
589
|
+
# verify the required parameter 'user_id' is set
|
590
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.delete_routing_user_utilization" if user_id.nil?
|
591
|
+
|
592
|
+
|
593
|
+
|
594
|
+
|
595
|
+
|
596
|
+
# resource path
|
597
|
+
local_var_path = "/api/v2/routing/users/{userId}/utilization".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
598
|
+
|
599
|
+
# query parameters
|
600
|
+
query_params = {}
|
601
|
+
|
602
|
+
# header parameters
|
603
|
+
header_params = {}
|
604
|
+
|
605
|
+
# HTTP header 'Accept' (if needed)
|
606
|
+
local_header_accept = ['application/json']
|
607
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
608
|
+
|
609
|
+
# HTTP header 'Content-Type'
|
610
|
+
local_header_content_type = ['application/json']
|
611
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
612
|
+
|
613
|
+
# form parameters
|
614
|
+
form_params = {}
|
615
|
+
|
616
|
+
# http body (model)
|
617
|
+
post_body = nil
|
618
|
+
|
619
|
+
auth_names = ['PureCloud OAuth']
|
620
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
621
|
+
:header_params => header_params,
|
622
|
+
:query_params => query_params,
|
623
|
+
:form_params => form_params,
|
624
|
+
:body => post_body,
|
625
|
+
:auth_names => auth_names)
|
626
|
+
if @api_client.config.debugging
|
627
|
+
@api_client.config.logger.debug "API called: RoutingApi#delete_routing_user_utilization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
628
|
+
end
|
629
|
+
return data, status_code, headers
|
630
|
+
end
|
631
|
+
|
514
632
|
# Delete the organization-wide max utilization settings and revert to the system default.
|
515
633
|
#
|
516
634
|
# @param [Hash] opts the optional parameters
|
@@ -2269,6 +2387,61 @@ module PureCloud
|
|
2269
2387
|
return data, status_code, headers
|
2270
2388
|
end
|
2271
2389
|
|
2390
|
+
# Get an organization's routing settings
|
2391
|
+
#
|
2392
|
+
# @param [Hash] opts the optional parameters
|
2393
|
+
# @return [RoutingSettings]
|
2394
|
+
def get_routing_settings(opts = {})
|
2395
|
+
data, _status_code, _headers = get_routing_settings_with_http_info(opts)
|
2396
|
+
return data
|
2397
|
+
end
|
2398
|
+
|
2399
|
+
# Get an organization's routing settings
|
2400
|
+
#
|
2401
|
+
# @param [Hash] opts the optional parameters
|
2402
|
+
# @return [Array<(RoutingSettings, Fixnum, Hash)>] RoutingSettings data, response status code and response headers
|
2403
|
+
def get_routing_settings_with_http_info(opts = {})
|
2404
|
+
if @api_client.config.debugging
|
2405
|
+
@api_client.config.logger.debug "Calling API: RoutingApi.get_routing_settings ..."
|
2406
|
+
end
|
2407
|
+
|
2408
|
+
# resource path
|
2409
|
+
local_var_path = "/api/v2/routing/settings".sub('{format}','json')
|
2410
|
+
|
2411
|
+
# query parameters
|
2412
|
+
query_params = {}
|
2413
|
+
|
2414
|
+
# header parameters
|
2415
|
+
header_params = {}
|
2416
|
+
|
2417
|
+
# HTTP header 'Accept' (if needed)
|
2418
|
+
local_header_accept = ['application/json']
|
2419
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
2420
|
+
|
2421
|
+
# HTTP header 'Content-Type'
|
2422
|
+
local_header_content_type = ['application/json']
|
2423
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
2424
|
+
|
2425
|
+
# form parameters
|
2426
|
+
form_params = {}
|
2427
|
+
|
2428
|
+
# http body (model)
|
2429
|
+
post_body = nil
|
2430
|
+
|
2431
|
+
auth_names = ['PureCloud OAuth']
|
2432
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
2433
|
+
:header_params => header_params,
|
2434
|
+
:query_params => query_params,
|
2435
|
+
:form_params => form_params,
|
2436
|
+
:body => post_body,
|
2437
|
+
:auth_names => auth_names,
|
2438
|
+
:return_type => 'RoutingSettings')
|
2439
|
+
if @api_client.config.debugging
|
2440
|
+
@api_client.config.logger.debug "API called: RoutingApi#get_routing_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2441
|
+
end
|
2442
|
+
return data, status_code, headers
|
2443
|
+
end
|
2444
|
+
|
2272
2445
|
# Get Contact Center Settings
|
2273
2446
|
#
|
2274
2447
|
# @param [Hash] opts the optional parameters
|
@@ -2977,6 +3150,71 @@ module PureCloud
|
|
2977
3150
|
return data, status_code, headers
|
2978
3151
|
end
|
2979
3152
|
|
3153
|
+
# Get the user's max utilization settings. If not configured, the organization-wide default is returned.
|
3154
|
+
#
|
3155
|
+
# @param user_id User ID
|
3156
|
+
# @param [Hash] opts the optional parameters
|
3157
|
+
# @return [Utilization]
|
3158
|
+
def get_routing_user_utilization(user_id, opts = {})
|
3159
|
+
data, _status_code, _headers = get_routing_user_utilization_with_http_info(user_id, opts)
|
3160
|
+
return data
|
3161
|
+
end
|
3162
|
+
|
3163
|
+
# Get the user's max utilization settings. If not configured, the organization-wide default is returned.
|
3164
|
+
#
|
3165
|
+
# @param user_id User ID
|
3166
|
+
# @param [Hash] opts the optional parameters
|
3167
|
+
# @return [Array<(Utilization, Fixnum, Hash)>] Utilization data, response status code and response headers
|
3168
|
+
def get_routing_user_utilization_with_http_info(user_id, opts = {})
|
3169
|
+
if @api_client.config.debugging
|
3170
|
+
@api_client.config.logger.debug "Calling API: RoutingApi.get_routing_user_utilization ..."
|
3171
|
+
end
|
3172
|
+
|
3173
|
+
|
3174
|
+
# verify the required parameter 'user_id' is set
|
3175
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.get_routing_user_utilization" if user_id.nil?
|
3176
|
+
|
3177
|
+
|
3178
|
+
|
3179
|
+
|
3180
|
+
|
3181
|
+
# resource path
|
3182
|
+
local_var_path = "/api/v2/routing/users/{userId}/utilization".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
3183
|
+
|
3184
|
+
# query parameters
|
3185
|
+
query_params = {}
|
3186
|
+
|
3187
|
+
# header parameters
|
3188
|
+
header_params = {}
|
3189
|
+
|
3190
|
+
# HTTP header 'Accept' (if needed)
|
3191
|
+
local_header_accept = ['application/json']
|
3192
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
3193
|
+
|
3194
|
+
# HTTP header 'Content-Type'
|
3195
|
+
local_header_content_type = ['application/json']
|
3196
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
3197
|
+
|
3198
|
+
# form parameters
|
3199
|
+
form_params = {}
|
3200
|
+
|
3201
|
+
# http body (model)
|
3202
|
+
post_body = nil
|
3203
|
+
|
3204
|
+
auth_names = ['PureCloud OAuth']
|
3205
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
3206
|
+
:header_params => header_params,
|
3207
|
+
:query_params => query_params,
|
3208
|
+
:form_params => form_params,
|
3209
|
+
:body => post_body,
|
3210
|
+
:auth_names => auth_names,
|
3211
|
+
:return_type => 'Utilization')
|
3212
|
+
if @api_client.config.debugging
|
3213
|
+
@api_client.config.logger.debug "API called: RoutingApi#get_routing_user_utilization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3214
|
+
end
|
3215
|
+
return data, status_code, headers
|
3216
|
+
end
|
3217
|
+
|
2980
3218
|
# Get the organization-wide max utilization settings.
|
2981
3219
|
#
|
2982
3220
|
# @param [Hash] opts the optional parameters
|
@@ -5252,6 +5490,71 @@ module PureCloud
|
|
5252
5490
|
return data, status_code, headers
|
5253
5491
|
end
|
5254
5492
|
|
5493
|
+
# Update an organization's routing settings
|
5494
|
+
#
|
5495
|
+
# @param body Organization Settings
|
5496
|
+
# @param [Hash] opts the optional parameters
|
5497
|
+
# @return [RoutingSettings]
|
5498
|
+
def put_routing_settings(body, opts = {})
|
5499
|
+
data, _status_code, _headers = put_routing_settings_with_http_info(body, opts)
|
5500
|
+
return data
|
5501
|
+
end
|
5502
|
+
|
5503
|
+
# Update an organization's routing settings
|
5504
|
+
#
|
5505
|
+
# @param body Organization Settings
|
5506
|
+
# @param [Hash] opts the optional parameters
|
5507
|
+
# @return [Array<(RoutingSettings, Fixnum, Hash)>] RoutingSettings data, response status code and response headers
|
5508
|
+
def put_routing_settings_with_http_info(body, opts = {})
|
5509
|
+
if @api_client.config.debugging
|
5510
|
+
@api_client.config.logger.debug "Calling API: RoutingApi.put_routing_settings ..."
|
5511
|
+
end
|
5512
|
+
|
5513
|
+
|
5514
|
+
# verify the required parameter 'body' is set
|
5515
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.put_routing_settings" if body.nil?
|
5516
|
+
|
5517
|
+
|
5518
|
+
|
5519
|
+
|
5520
|
+
|
5521
|
+
# resource path
|
5522
|
+
local_var_path = "/api/v2/routing/settings".sub('{format}','json')
|
5523
|
+
|
5524
|
+
# query parameters
|
5525
|
+
query_params = {}
|
5526
|
+
|
5527
|
+
# header parameters
|
5528
|
+
header_params = {}
|
5529
|
+
|
5530
|
+
# HTTP header 'Accept' (if needed)
|
5531
|
+
local_header_accept = ['application/json']
|
5532
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
5533
|
+
|
5534
|
+
# HTTP header 'Content-Type'
|
5535
|
+
local_header_content_type = ['application/json']
|
5536
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
5537
|
+
|
5538
|
+
# form parameters
|
5539
|
+
form_params = {}
|
5540
|
+
|
5541
|
+
# http body (model)
|
5542
|
+
post_body = @api_client.object_to_http_body(body)
|
5543
|
+
|
5544
|
+
auth_names = ['PureCloud OAuth']
|
5545
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
5546
|
+
:header_params => header_params,
|
5547
|
+
:query_params => query_params,
|
5548
|
+
:form_params => form_params,
|
5549
|
+
:body => post_body,
|
5550
|
+
:auth_names => auth_names,
|
5551
|
+
:return_type => 'RoutingSettings')
|
5552
|
+
if @api_client.config.debugging
|
5553
|
+
@api_client.config.logger.debug "API called: RoutingApi#put_routing_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5554
|
+
end
|
5555
|
+
return data, status_code, headers
|
5556
|
+
end
|
5557
|
+
|
5255
5558
|
# Update Transcription Settings
|
5256
5559
|
#
|
5257
5560
|
# @param body Organization Settings
|
@@ -5392,6 +5695,81 @@ module PureCloud
|
|
5392
5695
|
return data, status_code, headers
|
5393
5696
|
end
|
5394
5697
|
|
5698
|
+
# Update the user's max utilization settings. Include only those media types requiring custom configuration.
|
5699
|
+
#
|
5700
|
+
# @param user_id User ID
|
5701
|
+
# @param body utilization
|
5702
|
+
# @param [Hash] opts the optional parameters
|
5703
|
+
# @return [Utilization]
|
5704
|
+
def put_routing_user_utilization(user_id, body, opts = {})
|
5705
|
+
data, _status_code, _headers = put_routing_user_utilization_with_http_info(user_id, body, opts)
|
5706
|
+
return data
|
5707
|
+
end
|
5708
|
+
|
5709
|
+
# Update the user's max utilization settings. Include only those media types requiring custom configuration.
|
5710
|
+
#
|
5711
|
+
# @param user_id User ID
|
5712
|
+
# @param body utilization
|
5713
|
+
# @param [Hash] opts the optional parameters
|
5714
|
+
# @return [Array<(Utilization, Fixnum, Hash)>] Utilization data, response status code and response headers
|
5715
|
+
def put_routing_user_utilization_with_http_info(user_id, body, opts = {})
|
5716
|
+
if @api_client.config.debugging
|
5717
|
+
@api_client.config.logger.debug "Calling API: RoutingApi.put_routing_user_utilization ..."
|
5718
|
+
end
|
5719
|
+
|
5720
|
+
|
5721
|
+
# verify the required parameter 'user_id' is set
|
5722
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.put_routing_user_utilization" if user_id.nil?
|
5723
|
+
|
5724
|
+
|
5725
|
+
|
5726
|
+
|
5727
|
+
|
5728
|
+
|
5729
|
+
# verify the required parameter 'body' is set
|
5730
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.put_routing_user_utilization" if body.nil?
|
5731
|
+
|
5732
|
+
|
5733
|
+
|
5734
|
+
|
5735
|
+
|
5736
|
+
# resource path
|
5737
|
+
local_var_path = "/api/v2/routing/users/{userId}/utilization".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
5738
|
+
|
5739
|
+
# query parameters
|
5740
|
+
query_params = {}
|
5741
|
+
|
5742
|
+
# header parameters
|
5743
|
+
header_params = {}
|
5744
|
+
|
5745
|
+
# HTTP header 'Accept' (if needed)
|
5746
|
+
local_header_accept = ['application/json']
|
5747
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
5748
|
+
|
5749
|
+
# HTTP header 'Content-Type'
|
5750
|
+
local_header_content_type = ['application/json']
|
5751
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
5752
|
+
|
5753
|
+
# form parameters
|
5754
|
+
form_params = {}
|
5755
|
+
|
5756
|
+
# http body (model)
|
5757
|
+
post_body = @api_client.object_to_http_body(body)
|
5758
|
+
|
5759
|
+
auth_names = ['PureCloud OAuth']
|
5760
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
5761
|
+
:header_params => header_params,
|
5762
|
+
:query_params => query_params,
|
5763
|
+
:form_params => form_params,
|
5764
|
+
:body => post_body,
|
5765
|
+
:auth_names => auth_names,
|
5766
|
+
:return_type => 'Utilization')
|
5767
|
+
if @api_client.config.debugging
|
5768
|
+
@api_client.config.logger.debug "API called: RoutingApi#put_routing_user_utilization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5769
|
+
end
|
5770
|
+
return data, status_code, headers
|
5771
|
+
end
|
5772
|
+
|
5395
5773
|
# Update the organization-wide max utilization settings. Include only those media types requiring custom configuration.
|
5396
5774
|
#
|
5397
5775
|
# @param body utilization
|