purecloudplatformclientv2 22.0.0 → 23.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActivityCode.md +8 -5
- data/docs/ActivityCodeContainer.md +1 -0
- data/docs/AdherenceSettings.md +1 -1
- data/docs/ArchitectApi.md +14 -14
- data/docs/AuthorizationApi.md +3 -1
- data/docs/BatchDownloadJobResult.md +20 -0
- data/docs/BatchDownloadJobStatusResult.md +20 -0
- data/docs/BatchDownloadJobSubmission.md +13 -0
- data/docs/BatchDownloadJobSubmissionResult.md +15 -0
- data/docs/BatchDownloadRequest.md +14 -0
- data/docs/Call.md +2 -0
- data/docs/CallBasic.md +2 -0
- data/docs/CallForwardingNotification.md +17 -0
- data/docs/CallForwardingNotificationCall.md +13 -0
- data/docs/CallForwardingNotificationCalls.md +13 -0
- data/docs/CallForwardingNotificationTarget.md +14 -0
- data/docs/CallForwardingNotificationTargets.md +14 -0
- data/docs/CallForwardingNotificationUser.md +13 -0
- data/docs/CallRoute.md +0 -1
- data/docs/{SignedData.md → ContactColumnTimeZone.md} +2 -3
- data/docs/CreateActivityCodeRequest.md +18 -0
- data/docs/CreateQueueRequest.md +12 -11
- data/docs/ExternalContact.md +1 -0
- data/docs/IgnoredActivityCategories.md +13 -0
- data/docs/ManagementUnit.md +4 -3
- data/docs/ManagementUnitSettings.md +1 -3
- data/docs/MessageDetails.md +1 -0
- data/docs/MessageMedia.md +14 -0
- data/docs/MoveAgentResponse.md +14 -0
- data/docs/MoveAgentsRequest.md +14 -0
- data/docs/MoveAgentsResponse.md +15 -0
- data/docs/NTPSettings.md +13 -0
- data/docs/OrganizationAuthorizationApi.md +2 -2
- data/docs/OutOfOfficeNotification.md +1 -0
- data/docs/OutboundApi.md +63 -0
- data/docs/Queue.md +12 -11
- data/docs/Recording.md +1 -0
- data/docs/RecordingApi.md +120 -0
- data/docs/RecordingMessagingMessage.md +18 -0
- data/docs/RoutingApi.md +2 -2
- data/docs/SchedulingSettings.md +1 -0
- data/docs/ShrinkageOverride.md +14 -0
- data/docs/ShrinkageOverrides.md +14 -0
- data/docs/Site.md +1 -0
- data/docs/TrustCreate.md +2 -1
- data/docs/TrustGroup.md +26 -0
- data/docs/{TrustUserCreate.md → TrustMemberCreate.md} +4 -4
- data/docs/TrustRequest.md +2 -1
- data/docs/TrustRequestCreate.md +2 -1
- data/docs/UserQueue.md +12 -11
- data/docs/WfmVersionedEntityMetadata.md +15 -0
- data/docs/WorkforceManagementApi.md +128 -3
- data/docs/{Entity.md → WrapUpCodeReference.md} +2 -2
- data/lib/purecloudplatformclientv2.rb +26 -4
- data/lib/purecloudplatformclientv2/api/architect_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +75 -0
- data/lib/purecloudplatformclientv2/api/recording_api.rb +130 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +138 -2
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/activity_code.rb +95 -12
- data/lib/purecloudplatformclientv2/models/activity_code_container.rb +35 -4
- data/lib/purecloudplatformclientv2/models/adherence_settings.rb +2 -4
- data/lib/purecloudplatformclientv2/models/batch_download_job_result.rb +383 -0
- data/lib/purecloudplatformclientv2/models/batch_download_job_status_result.rb +385 -0
- data/lib/purecloudplatformclientv2/models/batch_download_job_submission.rb +209 -0
- data/lib/purecloudplatformclientv2/models/batch_download_job_submission_result.rb +253 -0
- data/lib/purecloudplatformclientv2/models/batch_download_request.rb +228 -0
- data/lib/purecloudplatformclientv2/models/call.rb +56 -4
- data/lib/purecloudplatformclientv2/models/call_basic.rb +56 -4
- data/lib/purecloudplatformclientv2/models/call_forwarding_notification.rb +303 -0
- data/lib/purecloudplatformclientv2/models/call_forwarding_notification_call.rb +203 -0
- data/lib/purecloudplatformclientv2/models/call_forwarding_notification_calls.rb +203 -0
- data/lib/purecloudplatformclientv2/models/call_forwarding_notification_target.rb +226 -0
- data/lib/purecloudplatformclientv2/models/call_forwarding_notification_targets.rb +226 -0
- data/lib/purecloudplatformclientv2/models/{signed_data.rb → call_forwarding_notification_user.rb} +8 -8
- data/lib/purecloudplatformclientv2/models/call_route.rb +4 -30
- data/lib/purecloudplatformclientv2/models/contact_column_time_zone.rb +176 -0
- data/lib/purecloudplatformclientv2/models/create_activity_code_request.rb +358 -0
- data/lib/purecloudplatformclientv2/models/create_queue_request.rb +38 -12
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/external_contact.rb +26 -1
- data/lib/purecloudplatformclientv2/models/ignored_activity_categories.rb +204 -0
- data/lib/purecloudplatformclientv2/models/management_unit.rb +36 -5
- data/lib/purecloudplatformclientv2/models/management_unit_settings.rb +9 -61
- data/lib/purecloudplatformclientv2/models/message_details.rb +32 -4
- data/lib/purecloudplatformclientv2/models/message_media.rb +228 -0
- data/lib/purecloudplatformclientv2/models/move_agent_response.rb +243 -0
- data/lib/purecloudplatformclientv2/models/move_agents_request.rb +236 -0
- data/lib/purecloudplatformclientv2/models/move_agents_response.rb +257 -0
- data/lib/purecloudplatformclientv2/models/ntp_settings.rb +204 -0
- data/lib/purecloudplatformclientv2/models/out_of_office_notification.rb +26 -1
- data/lib/purecloudplatformclientv2/models/prediction_results.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue.rb +38 -12
- data/lib/purecloudplatformclientv2/models/recording.rb +29 -1
- data/lib/purecloudplatformclientv2/models/recording_messaging_message.rb +327 -0
- data/lib/purecloudplatformclientv2/models/scheduling_settings.rb +30 -4
- data/lib/purecloudplatformclientv2/models/shrinkage_override.rb +233 -0
- data/lib/purecloudplatformclientv2/models/shrinkage_overrides.rb +230 -0
- data/lib/purecloudplatformclientv2/models/site.rb +27 -1
- data/lib/purecloudplatformclientv2/models/trust_create.rb +32 -9
- data/lib/purecloudplatformclientv2/models/trust_group.rb +603 -0
- data/lib/purecloudplatformclientv2/models/{trust_user_create.rb → trust_member_create.rb} +3 -3
- data/lib/purecloudplatformclientv2/models/trust_request.rb +28 -5
- data/lib/purecloudplatformclientv2/models/trust_request_create.rb +32 -9
- data/lib/purecloudplatformclientv2/models/user_queue.rb +38 -12
- data/lib/purecloudplatformclientv2/models/wfm_versioned_entity_metadata.rb +260 -0
- data/lib/purecloudplatformclientv2/models/{entity.rb → wrap_up_code_reference.rb} +1 -1
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +54 -10
- data/docs/SignedDataApi.md +0 -73
- data/lib/purecloudplatformclientv2/api/signed_data_api.rb +0 -90
@@ -864,8 +864,8 @@ module PureCloud
|
|
864
864
|
fail ArgumentError, "Missing the required parameter 'object_type' when calling ArchitectApi.get_architect_dependencytracking_consumedresources" if object_type.nil?
|
865
865
|
|
866
866
|
# verify enum value
|
867
|
-
unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
|
868
|
-
fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW"
|
867
|
+
unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'EMERGENCYGROUP', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
|
868
|
+
fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW"
|
869
869
|
end
|
870
870
|
|
871
871
|
|
@@ -956,8 +956,8 @@ module PureCloud
|
|
956
956
|
fail ArgumentError, "Missing the required parameter 'object_type' when calling ArchitectApi.get_architect_dependencytracking_consumingresources" if object_type.nil?
|
957
957
|
|
958
958
|
# verify enum value
|
959
|
-
unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
|
960
|
-
fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW"
|
959
|
+
unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'EMERGENCYGROUP', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
|
960
|
+
fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW"
|
961
961
|
end
|
962
962
|
|
963
963
|
|
@@ -1181,8 +1181,8 @@ module PureCloud
|
|
1181
1181
|
|
1182
1182
|
|
1183
1183
|
|
1184
|
-
if opts[:'object_type'] && !['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(opts[:'object_type'])
|
1185
|
-
fail ArgumentError, 'invalid value for "object_type", must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW'
|
1184
|
+
if opts[:'object_type'] && !['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'EMERGENCYGROUP', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(opts[:'object_type'])
|
1185
|
+
fail ArgumentError, 'invalid value for "object_type", must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW'
|
1186
1186
|
end
|
1187
1187
|
|
1188
1188
|
|
@@ -433,6 +433,7 @@ module PureCloud
|
|
433
433
|
# @option opts [Array<Object>] :permission
|
434
434
|
# @option opts [Array<Object>] :default_role_id
|
435
435
|
# @option opts [BOOLEAN] :user_count (default to true)
|
436
|
+
# @option opts [Array<String>] :id id
|
436
437
|
# @return [OrganizationRoleEntityListing]
|
437
438
|
def get_authorization_roles(opts = {})
|
438
439
|
data, _status_code, _headers = get_authorization_roles_with_http_info(opts)
|
@@ -452,6 +453,7 @@ module PureCloud
|
|
452
453
|
# @option opts [Array<Object>] :permission
|
453
454
|
# @option opts [Array<Object>] :default_role_id
|
454
455
|
# @option opts [BOOLEAN] :user_count
|
456
|
+
# @option opts [Array<String>] :id id
|
455
457
|
# @return [Array<(OrganizationRoleEntityListing, Fixnum, Hash)>] OrganizationRoleEntityListing data, response status code and response headers
|
456
458
|
def get_authorization_roles_with_http_info(opts = {})
|
457
459
|
if @api_client.config.debugging
|
@@ -511,6 +513,12 @@ module PureCloud
|
|
511
513
|
|
512
514
|
|
513
515
|
|
516
|
+
|
517
|
+
|
518
|
+
|
519
|
+
|
520
|
+
|
521
|
+
|
514
522
|
|
515
523
|
|
516
524
|
|
@@ -533,6 +541,7 @@ module PureCloud
|
|
533
541
|
query_params[:'permission'] = @api_client.build_collection_param(opts[:'permission'], :multi) if opts[:'permission']
|
534
542
|
query_params[:'defaultRoleId'] = @api_client.build_collection_param(opts[:'default_role_id'], :multi) if opts[:'default_role_id']
|
535
543
|
query_params[:'userCount'] = opts[:'user_count'] if opts[:'user_count']
|
544
|
+
query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
|
536
545
|
|
537
546
|
# header parameters
|
538
547
|
header_params = {}
|
@@ -4903,6 +4903,81 @@ module PureCloud
|
|
4903
4903
|
return data, status_code, headers
|
4904
4904
|
end
|
4905
4905
|
|
4906
|
+
# Get contacts from a contact list.
|
4907
|
+
#
|
4908
|
+
# @param contact_list_id Contact List ID
|
4909
|
+
# @param body ContactIds to get.
|
4910
|
+
# @param [Hash] opts the optional parameters
|
4911
|
+
# @return [Array<DialerContact>]
|
4912
|
+
def post_outbound_contactlist_contacts_bulk(contact_list_id, body, opts = {})
|
4913
|
+
data, _status_code, _headers = post_outbound_contactlist_contacts_bulk_with_http_info(contact_list_id, body, opts)
|
4914
|
+
return data
|
4915
|
+
end
|
4916
|
+
|
4917
|
+
# Get contacts from a contact list.
|
4918
|
+
#
|
4919
|
+
# @param contact_list_id Contact List ID
|
4920
|
+
# @param body ContactIds to get.
|
4921
|
+
# @param [Hash] opts the optional parameters
|
4922
|
+
# @return [Array<(Array<DialerContact>, Fixnum, Hash)>] Array<DialerContact> data, response status code and response headers
|
4923
|
+
def post_outbound_contactlist_contacts_bulk_with_http_info(contact_list_id, body, opts = {})
|
4924
|
+
if @api_client.config.debugging
|
4925
|
+
@api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_contactlist_contacts_bulk ..."
|
4926
|
+
end
|
4927
|
+
|
4928
|
+
|
4929
|
+
# verify the required parameter 'contact_list_id' is set
|
4930
|
+
fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.post_outbound_contactlist_contacts_bulk" if contact_list_id.nil?
|
4931
|
+
|
4932
|
+
|
4933
|
+
|
4934
|
+
|
4935
|
+
|
4936
|
+
|
4937
|
+
# verify the required parameter 'body' is set
|
4938
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_contactlist_contacts_bulk" if body.nil?
|
4939
|
+
|
4940
|
+
|
4941
|
+
|
4942
|
+
|
4943
|
+
|
4944
|
+
# resource path
|
4945
|
+
local_var_path = "/api/v2/outbound/contactlists/{contactListId}/contacts/bulk".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)
|
4946
|
+
|
4947
|
+
# query parameters
|
4948
|
+
query_params = {}
|
4949
|
+
|
4950
|
+
# header parameters
|
4951
|
+
header_params = {}
|
4952
|
+
|
4953
|
+
# HTTP header 'Accept' (if needed)
|
4954
|
+
local_header_accept = ['application/json']
|
4955
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
4956
|
+
|
4957
|
+
# HTTP header 'Content-Type'
|
4958
|
+
local_header_content_type = ['application/json']
|
4959
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
4960
|
+
|
4961
|
+
# form parameters
|
4962
|
+
form_params = {}
|
4963
|
+
|
4964
|
+
# http body (model)
|
4965
|
+
post_body = @api_client.object_to_http_body(body)
|
4966
|
+
|
4967
|
+
auth_names = ['PureCloud Auth']
|
4968
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
4969
|
+
:header_params => header_params,
|
4970
|
+
:query_params => query_params,
|
4971
|
+
:form_params => form_params,
|
4972
|
+
:body => post_body,
|
4973
|
+
:auth_names => auth_names,
|
4974
|
+
:return_type => 'Array<DialerContact>')
|
4975
|
+
if @api_client.config.debugging
|
4976
|
+
@api_client.config.logger.debug "API called: OutboundApi#post_outbound_contactlist_contacts_bulk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4977
|
+
end
|
4978
|
+
return data, status_code, headers
|
4979
|
+
end
|
4980
|
+
|
4906
4981
|
# Initiate the export of a contact list.
|
4907
4982
|
# Returns 200 if received OK.
|
4908
4983
|
# @param contact_list_id ContactList ID
|
@@ -1087,6 +1087,71 @@ module PureCloud
|
|
1087
1087
|
return data, status_code, headers
|
1088
1088
|
end
|
1089
1089
|
|
1090
|
+
# Get the status and results for a batch request job, only the user that submitted the job may retrieve results
|
1091
|
+
#
|
1092
|
+
# @param job_id jobId
|
1093
|
+
# @param [Hash] opts the optional parameters
|
1094
|
+
# @return [BatchDownloadJobStatusResult]
|
1095
|
+
def get_recording_batchrequest(job_id, opts = {})
|
1096
|
+
data, _status_code, _headers = get_recording_batchrequest_with_http_info(job_id, opts)
|
1097
|
+
return data
|
1098
|
+
end
|
1099
|
+
|
1100
|
+
# Get the status and results for a batch request job, only the user that submitted the job may retrieve results
|
1101
|
+
#
|
1102
|
+
# @param job_id jobId
|
1103
|
+
# @param [Hash] opts the optional parameters
|
1104
|
+
# @return [Array<(BatchDownloadJobStatusResult, Fixnum, Hash)>] BatchDownloadJobStatusResult data, response status code and response headers
|
1105
|
+
def get_recording_batchrequest_with_http_info(job_id, opts = {})
|
1106
|
+
if @api_client.config.debugging
|
1107
|
+
@api_client.config.logger.debug "Calling API: RecordingApi.get_recording_batchrequest ..."
|
1108
|
+
end
|
1109
|
+
|
1110
|
+
|
1111
|
+
# verify the required parameter 'job_id' is set
|
1112
|
+
fail ArgumentError, "Missing the required parameter 'job_id' when calling RecordingApi.get_recording_batchrequest" if job_id.nil?
|
1113
|
+
|
1114
|
+
|
1115
|
+
|
1116
|
+
|
1117
|
+
|
1118
|
+
# resource path
|
1119
|
+
local_var_path = "/api/v2/recording/batchrequests/{jobId}".sub('{format}','json').sub('{' + 'jobId' + '}', job_id.to_s)
|
1120
|
+
|
1121
|
+
# query parameters
|
1122
|
+
query_params = {}
|
1123
|
+
|
1124
|
+
# header parameters
|
1125
|
+
header_params = {}
|
1126
|
+
|
1127
|
+
# HTTP header 'Accept' (if needed)
|
1128
|
+
local_header_accept = ['application/json']
|
1129
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1130
|
+
|
1131
|
+
# HTTP header 'Content-Type'
|
1132
|
+
local_header_content_type = ['application/json']
|
1133
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1134
|
+
|
1135
|
+
# form parameters
|
1136
|
+
form_params = {}
|
1137
|
+
|
1138
|
+
# http body (model)
|
1139
|
+
post_body = nil
|
1140
|
+
|
1141
|
+
auth_names = ['PureCloud Auth']
|
1142
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1143
|
+
:header_params => header_params,
|
1144
|
+
:query_params => query_params,
|
1145
|
+
:form_params => form_params,
|
1146
|
+
:body => post_body,
|
1147
|
+
:auth_names => auth_names,
|
1148
|
+
:return_type => 'BatchDownloadJobStatusResult')
|
1149
|
+
if @api_client.config.debugging
|
1150
|
+
@api_client.config.logger.debug "API called: RecordingApi#get_recording_batchrequest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1151
|
+
end
|
1152
|
+
return data, status_code, headers
|
1153
|
+
end
|
1154
|
+
|
1090
1155
|
# Get the local encryption settings
|
1091
1156
|
#
|
1092
1157
|
# @param settings_id Settings Id
|
@@ -1914,6 +1979,71 @@ module PureCloud
|
|
1914
1979
|
return data, status_code, headers
|
1915
1980
|
end
|
1916
1981
|
|
1982
|
+
# Submit a batch download request
|
1983
|
+
#
|
1984
|
+
# @param body Job submission criteria
|
1985
|
+
# @param [Hash] opts the optional parameters
|
1986
|
+
# @return [BatchDownloadJobSubmissionResult]
|
1987
|
+
def post_recording_batchrequests(body, opts = {})
|
1988
|
+
data, _status_code, _headers = post_recording_batchrequests_with_http_info(body, opts)
|
1989
|
+
return data
|
1990
|
+
end
|
1991
|
+
|
1992
|
+
# Submit a batch download request
|
1993
|
+
#
|
1994
|
+
# @param body Job submission criteria
|
1995
|
+
# @param [Hash] opts the optional parameters
|
1996
|
+
# @return [Array<(BatchDownloadJobSubmissionResult, Fixnum, Hash)>] BatchDownloadJobSubmissionResult data, response status code and response headers
|
1997
|
+
def post_recording_batchrequests_with_http_info(body, opts = {})
|
1998
|
+
if @api_client.config.debugging
|
1999
|
+
@api_client.config.logger.debug "Calling API: RecordingApi.post_recording_batchrequests ..."
|
2000
|
+
end
|
2001
|
+
|
2002
|
+
|
2003
|
+
# verify the required parameter 'body' is set
|
2004
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling RecordingApi.post_recording_batchrequests" if body.nil?
|
2005
|
+
|
2006
|
+
|
2007
|
+
|
2008
|
+
|
2009
|
+
|
2010
|
+
# resource path
|
2011
|
+
local_var_path = "/api/v2/recording/batchrequests".sub('{format}','json')
|
2012
|
+
|
2013
|
+
# query parameters
|
2014
|
+
query_params = {}
|
2015
|
+
|
2016
|
+
# header parameters
|
2017
|
+
header_params = {}
|
2018
|
+
|
2019
|
+
# HTTP header 'Accept' (if needed)
|
2020
|
+
local_header_accept = ['application/json']
|
2021
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
2022
|
+
|
2023
|
+
# HTTP header 'Content-Type'
|
2024
|
+
local_header_content_type = ['application/json']
|
2025
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
2026
|
+
|
2027
|
+
# form parameters
|
2028
|
+
form_params = {}
|
2029
|
+
|
2030
|
+
# http body (model)
|
2031
|
+
post_body = @api_client.object_to_http_body(body)
|
2032
|
+
|
2033
|
+
auth_names = ['PureCloud Auth']
|
2034
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
2035
|
+
:header_params => header_params,
|
2036
|
+
:query_params => query_params,
|
2037
|
+
:form_params => form_params,
|
2038
|
+
:body => post_body,
|
2039
|
+
:auth_names => auth_names,
|
2040
|
+
:return_type => 'BatchDownloadJobSubmissionResult')
|
2041
|
+
if @api_client.config.debugging
|
2042
|
+
@api_client.config.logger.debug "API called: RecordingApi#post_recording_batchrequests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2043
|
+
end
|
2044
|
+
return data, status_code, headers
|
2045
|
+
end
|
2046
|
+
|
1917
2047
|
# create a local recording key
|
1918
2048
|
#
|
1919
2049
|
# @param body Local Encryption body
|
@@ -90,7 +90,7 @@ module PureCloud
|
|
90
90
|
return data, status_code, headers
|
91
91
|
end
|
92
92
|
|
93
|
-
# Get activity codes
|
93
|
+
# Get activity codes
|
94
94
|
#
|
95
95
|
# @param mu_id The muId of the management unit, or 'mine' for the management unit of the logged-in user.
|
96
96
|
# @param [Hash] opts the optional parameters
|
@@ -100,7 +100,7 @@ module PureCloud
|
|
100
100
|
return data
|
101
101
|
end
|
102
102
|
|
103
|
-
# Get activity codes
|
103
|
+
# Get activity codes
|
104
104
|
#
|
105
105
|
# @param mu_id The muId of the management unit, or 'mine' for the management unit of the logged-in user.
|
106
106
|
# @param [Hash] opts the optional parameters
|
@@ -752,6 +752,69 @@ module PureCloud
|
|
752
752
|
return data, status_code, headers
|
753
753
|
end
|
754
754
|
|
755
|
+
# Move agents in and out of management unit
|
756
|
+
#
|
757
|
+
# @param [Hash] opts the optional parameters
|
758
|
+
# @option opts [MoveAgentsRequest] :body body
|
759
|
+
# @return [MoveAgentsResponse]
|
760
|
+
def post_workforcemanagement_agents(opts = {})
|
761
|
+
data, _status_code, _headers = post_workforcemanagement_agents_with_http_info(opts)
|
762
|
+
return data
|
763
|
+
end
|
764
|
+
|
765
|
+
# Move agents in and out of management unit
|
766
|
+
#
|
767
|
+
# @param [Hash] opts the optional parameters
|
768
|
+
# @option opts [MoveAgentsRequest] :body body
|
769
|
+
# @return [Array<(MoveAgentsResponse, Fixnum, Hash)>] MoveAgentsResponse data, response status code and response headers
|
770
|
+
def post_workforcemanagement_agents_with_http_info(opts = {})
|
771
|
+
if @api_client.config.debugging
|
772
|
+
@api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_agents ..."
|
773
|
+
end
|
774
|
+
|
775
|
+
|
776
|
+
|
777
|
+
|
778
|
+
|
779
|
+
|
780
|
+
|
781
|
+
# resource path
|
782
|
+
local_var_path = "/api/v2/workforcemanagement/agents".sub('{format}','json')
|
783
|
+
|
784
|
+
# query parameters
|
785
|
+
query_params = {}
|
786
|
+
|
787
|
+
# header parameters
|
788
|
+
header_params = {}
|
789
|
+
|
790
|
+
# HTTP header 'Accept' (if needed)
|
791
|
+
local_header_accept = ['application/json']
|
792
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
793
|
+
|
794
|
+
# HTTP header 'Content-Type'
|
795
|
+
local_header_content_type = ['application/json']
|
796
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
797
|
+
|
798
|
+
# form parameters
|
799
|
+
form_params = {}
|
800
|
+
|
801
|
+
# http body (model)
|
802
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
803
|
+
|
804
|
+
auth_names = ['PureCloud Auth']
|
805
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
806
|
+
:header_params => header_params,
|
807
|
+
:query_params => query_params,
|
808
|
+
:form_params => form_params,
|
809
|
+
:body => post_body,
|
810
|
+
:auth_names => auth_names,
|
811
|
+
:return_type => 'MoveAgentsResponse')
|
812
|
+
if @api_client.config.debugging
|
813
|
+
@api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_agents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
814
|
+
end
|
815
|
+
return data, status_code, headers
|
816
|
+
end
|
817
|
+
|
755
818
|
# Get the management units to which the agents belong
|
756
819
|
#
|
757
820
|
# @param [Hash] opts the optional parameters
|
@@ -815,6 +878,79 @@ module PureCloud
|
|
815
878
|
return data, status_code, headers
|
816
879
|
end
|
817
880
|
|
881
|
+
# Create a new activity code
|
882
|
+
#
|
883
|
+
# @param mu_id The muId of the management unit, or 'mine' for the management unit of the logged-in user.
|
884
|
+
# @param [Hash] opts the optional parameters
|
885
|
+
# @option opts [CreateActivityCodeRequest] :body body
|
886
|
+
# @return [ActivityCode]
|
887
|
+
def post_workforcemanagement_managementunit_activitycodes(mu_id, opts = {})
|
888
|
+
data, _status_code, _headers = post_workforcemanagement_managementunit_activitycodes_with_http_info(mu_id, opts)
|
889
|
+
return data
|
890
|
+
end
|
891
|
+
|
892
|
+
# Create a new activity code
|
893
|
+
#
|
894
|
+
# @param mu_id The muId of the management unit, or 'mine' for the management unit of the logged-in user.
|
895
|
+
# @param [Hash] opts the optional parameters
|
896
|
+
# @option opts [CreateActivityCodeRequest] :body body
|
897
|
+
# @return [Array<(ActivityCode, Fixnum, Hash)>] ActivityCode data, response status code and response headers
|
898
|
+
def post_workforcemanagement_managementunit_activitycodes_with_http_info(mu_id, opts = {})
|
899
|
+
if @api_client.config.debugging
|
900
|
+
@api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_activitycodes ..."
|
901
|
+
end
|
902
|
+
|
903
|
+
|
904
|
+
# verify the required parameter 'mu_id' is set
|
905
|
+
fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_activitycodes" if mu_id.nil?
|
906
|
+
|
907
|
+
|
908
|
+
|
909
|
+
|
910
|
+
|
911
|
+
|
912
|
+
|
913
|
+
|
914
|
+
|
915
|
+
|
916
|
+
|
917
|
+
# resource path
|
918
|
+
local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/activitycodes".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)
|
919
|
+
|
920
|
+
# query parameters
|
921
|
+
query_params = {}
|
922
|
+
|
923
|
+
# header parameters
|
924
|
+
header_params = {}
|
925
|
+
|
926
|
+
# HTTP header 'Accept' (if needed)
|
927
|
+
local_header_accept = ['application/json']
|
928
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
929
|
+
|
930
|
+
# HTTP header 'Content-Type'
|
931
|
+
local_header_content_type = ['application/json']
|
932
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
933
|
+
|
934
|
+
# form parameters
|
935
|
+
form_params = {}
|
936
|
+
|
937
|
+
# http body (model)
|
938
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
939
|
+
|
940
|
+
auth_names = ['PureCloud Auth']
|
941
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
942
|
+
:header_params => header_params,
|
943
|
+
:query_params => query_params,
|
944
|
+
:form_params => form_params,
|
945
|
+
:body => post_body,
|
946
|
+
:auth_names => auth_names,
|
947
|
+
:return_type => 'ActivityCode')
|
948
|
+
if @api_client.config.debugging
|
949
|
+
@api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_activitycodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
950
|
+
end
|
951
|
+
return data, status_code, headers
|
952
|
+
end
|
953
|
+
|
818
954
|
# Request a historical adherence report
|
819
955
|
#
|
820
956
|
# @param mu_id The muId of the management unit, or 'mine' for the management unit of the logged-in user.
|