purecloudplatformclientv2 66.0.0 → 71.0.0

data/lib/purecloudplatformclientv2/api/authorization_api.rb

@@ -2188,6 +2188,163 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Bulk-grant roles and divisions to a subject.
+    # 
+    # @param subject_id Subject ID (user or group)
+    # @param body Pairs of role and division IDs
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :subject_type what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) (default to PC_USER)
+    # @return [nil]
+    def post_authorization_subject_bulkadd(subject_id, body, opts = {})
+      post_authorization_subject_bulkadd_with_http_info(subject_id, body, opts)
+      return nil
+    end
+
+    # Bulk-grant roles and divisions to a subject.
+    # 
+    # @param subject_id Subject ID (user or group)
+    # @param body Pairs of role and division IDs
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :subject_type what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT)
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def post_authorization_subject_bulkadd_with_http_info(subject_id, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AuthorizationApi.post_authorization_subject_bulkadd ..."
+      end
+      
+      
+      # verify the required parameter 'subject_id' is set
+      fail ArgumentError, "Missing the required parameter 'subject_id' when calling AuthorizationApi.post_authorization_subject_bulkadd" if subject_id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.post_authorization_subject_bulkadd" if body.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/authorization/subjects/{subjectId}/bulkadd".sub('{format}','json').sub('{' + 'subjectId' + '}', subject_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'subjectType'] = opts[:'subject_type'] if opts[:'subject_type']
+
+      # 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)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuthorizationApi#post_authorization_subject_bulkadd\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Bulk-remove grants from a subject.
+    # 
+    # @param subject_id Subject ID (user or group)
+    # @param body Pairs of role and division IDs
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def post_authorization_subject_bulkremove(subject_id, body, opts = {})
+      post_authorization_subject_bulkremove_with_http_info(subject_id, body, opts)
+      return nil
+    end
+
+    # Bulk-remove grants from a subject.
+    # 
+    # @param subject_id Subject ID (user or group)
+    # @param body Pairs of role and division IDs
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def post_authorization_subject_bulkremove_with_http_info(subject_id, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AuthorizationApi.post_authorization_subject_bulkremove ..."
+      end
+      
+      
+      # verify the required parameter 'subject_id' is set
+      fail ArgumentError, "Missing the required parameter 'subject_id' when calling AuthorizationApi.post_authorization_subject_bulkremove" if subject_id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.post_authorization_subject_bulkremove" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/authorization/subjects/{subjectId}/bulkremove".sub('{format}','json').sub('{' + 'subjectId' + '}', subject_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)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuthorizationApi#post_authorization_subject_bulkremove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Make a grant of a role in a division
     # 
     # @param subject_id Subject ID (user or group)

data/lib/purecloudplatformclientv2/api/conversations_api.rb

@@ -586,6 +586,71 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Delete a WhatsApp messaging integration
+    # 
+    # @param integration_id Integration ID
+    # @param [Hash] opts the optional parameters
+    # @return [WhatsAppIntegration]
+    def delete_conversations_messaging_integrations_whatsapp_integration_id(integration_id, opts = {})
+      data, _status_code, _headers = delete_conversations_messaging_integrations_whatsapp_integration_id_with_http_info(integration_id, opts)
+      return data
+    end
+
+    # Delete a WhatsApp messaging integration
+    # 
+    # @param integration_id Integration ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WhatsAppIntegration, Fixnum, Hash)>] WhatsAppIntegration data, response status code and response headers
+    def delete_conversations_messaging_integrations_whatsapp_integration_id_with_http_info(integration_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ConversationsApi.delete_conversations_messaging_integrations_whatsapp_integration_id ..."
+      end
+      
+      
+      # verify the required parameter 'integration_id' is set
+      fail ArgumentError, "Missing the required parameter 'integration_id' when calling ConversationsApi.delete_conversations_messaging_integrations_whatsapp_integration_id" if integration_id.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/conversations/messaging/integrations/whatsapp/{integrationId}".sub('{format}','json').sub('{' + 'integrationId' + '}', integration_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 => 'WhatsAppIntegration')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationsApi#delete_conversations_messaging_integrations_whatsapp_integration_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get a conversation by id
     # 
     # @param conversation_id conversationId
@@ -9133,6 +9198,71 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Send an agentless outbound message
+    # Send an agentlesss (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will generate a new Conversation, if there is an existing active Conversation between the fromAddress and toAddress already, then this POST will fail.
+    # @param body Create agentless outbound messaging request
+    # @param [Hash] opts the optional parameters
+    # @return [SendAgentlessOutboundMessageResponse]
+    def post_conversations_messages_agentless(body, opts = {})
+      data, _status_code, _headers = post_conversations_messages_agentless_with_http_info(body, opts)
+      return data
+    end
+
+    # Send an agentless outbound message
+    # Send an agentlesss (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will generate a new Conversation, if there is an existing active Conversation between the fromAddress and toAddress already, then this POST will fail.
+    # @param body Create agentless outbound messaging request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SendAgentlessOutboundMessageResponse, Fixnum, Hash)>] SendAgentlessOutboundMessageResponse data, response status code and response headers
+    def post_conversations_messages_agentless_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ConversationsApi.post_conversations_messages_agentless ..."
+      end
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.post_conversations_messages_agentless" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/conversations/messages/agentless".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(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 => 'SendAgentlessOutboundMessageResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationsApi#post_conversations_messages_agentless\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create a Facebook Integration
     # 
     # @param body FacebookIntegrationRequest
@@ -9328,6 +9458,71 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Create a WhatsApp Integration
+    # 
+    # @param body WhatsAppIntegrationRequest
+    # @param [Hash] opts the optional parameters
+    # @return [WhatsAppIntegration]
+    def post_conversations_messaging_integrations_whatsapp(body, opts = {})
+      data, _status_code, _headers = post_conversations_messaging_integrations_whatsapp_with_http_info(body, opts)
+      return data
+    end
+
+    # Create a WhatsApp Integration
+    # 
+    # @param body WhatsAppIntegrationRequest
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WhatsAppIntegration, Fixnum, Hash)>] WhatsAppIntegration data, response status code and response headers
+    def post_conversations_messaging_integrations_whatsapp_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ConversationsApi.post_conversations_messaging_integrations_whatsapp ..."
+      end
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.post_conversations_messaging_integrations_whatsapp" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/conversations/messaging/integrations/whatsapp".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(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 => 'WhatsAppIntegration')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationsApi#post_conversations_messaging_integrations_whatsapp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Set flagged reason on conversation participant to indicate bad conversation quality.
     # 
     # @param conversation_id conversation ID

data/lib/purecloudplatformclientv2/api/notifications_api.rb

@@ -361,7 +361,7 @@ module PureCloud
     end
 
     # Create a new channel
-    # There is a limit of 5 channels per user/app combination. Creating a 6th channel will remove the channel with oldest last used date.
+    # There is a limit of 20 channels per user/app combination. Creating a 21st channel will remove the channel with oldest last used date.
     # @param [Hash] opts the optional parameters
     # @return [Channel]
     def post_notifications_channels(opts = {})
@@ -370,7 +370,7 @@ module PureCloud
     end
 
     # Create a new channel
-    # There is a limit of 5 channels per user/app combination. Creating a 6th channel will remove the channel with oldest last used date.
+    # There is a limit of 20 channels per user/app combination. Creating a 21st channel will remove the channel with oldest last used date.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Channel, Fixnum, Hash)>] Channel data, response status code and response headers
     def post_notifications_channels_with_http_info(opts = {})

data/lib/purecloudplatformclientv2/api/quality_api.rb

@@ -899,7 +899,7 @@ module PureCloud
     end
 
     # Get audits for conversation or recording
-    # 
+    # Different permissions are required for viewing different resource audit entries.  The quality:evaluation:viewAudit permission is required to view evaluation audits, the recording:recording:viewAudit permission is required to view recording audits, and so on.
     # @param conversation_id Conversation ID
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size The total page size requested (default to 25)
@@ -917,7 +917,7 @@ module PureCloud
     end
 
     # Get audits for conversation or recording
-    # 
+    # Different permissions are required for viewing different resource audit entries.  The quality:evaluation:viewAudit permission is required to view evaluation audits, the recording:recording:viewAudit permission is required to view recording audits, and so on.
     # @param conversation_id Conversation ID
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size The total page size requested
@@ -4428,7 +4428,7 @@ module PureCloud
     end
 
     # Update an evaluation
-    # 
+    # The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation.
     # @param conversation_id conversationId
     # @param evaluation_id evaluationId
     # @param body evaluation
@@ -4441,7 +4441,7 @@ module PureCloud
     end
 
     # Update an evaluation
-    # 
+    # The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation.
     # @param conversation_id conversationId
     # @param evaluation_id evaluationId
     # @param body evaluation

data/lib/purecloudplatformclientv2/api/recording_api.rb

@@ -2609,8 +2609,73 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get a list of conversations with protected recordings
+    # 
+    # @param body conversationIds
+    # @param [Hash] opts the optional parameters
+    # @return [Array<AddressableEntityRef>]
+    def post_recordings_deletionprotection(body, opts = {})
+      data, _status_code, _headers = post_recordings_deletionprotection_with_http_info(body, opts)
+      return data
+    end
+
+    # Get a list of conversations with protected recordings
+    # 
+    # @param body conversationIds
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<AddressableEntityRef>, Fixnum, Hash)>] Array<AddressableEntityRef> data, response status code and response headers
+    def post_recordings_deletionprotection_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: RecordingApi.post_recordings_deletionprotection ..."
+      end
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling RecordingApi.post_recordings_deletionprotection" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/recordings/deletionprotection".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(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 => 'Array<AddressableEntityRef>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RecordingApi#post_recordings_deletionprotection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Updates the retention records on a recording.
-    # Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. 
+    # Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. The recording:recording:view permission is required for the recording, as well as either the recording:recording:editRetention or recording:screenRecording:editRetention permissions depending on the type of recording.
     # @param conversation_id Conversation ID
     # @param recording_id Recording ID
     # @param body recording
@@ -2622,7 +2687,7 @@ module PureCloud
     end
 
     # Updates the retention records on a recording.
-    # Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. 
+    # Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. The recording:recording:view permission is required for the recording, as well as either the recording:recording:editRetention or recording:screenRecording:editRetention permissions depending on the type of recording.
     # @param conversation_id Conversation ID
     # @param recording_id Recording ID
     # @param body recording
@@ -3216,5 +3281,76 @@ module PureCloud
       end
       return data, status_code, headers
     end
+
+    # Apply or revoke recording protection for conversations
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :protect Check for apply, uncheck for revoke (each action requires the respective permission) (default to true)
+    # @option opts [ConversationDeletionProtectionQuery] :body 
+    # @return [nil]
+    def put_recordings_deletionprotection(opts = {})
+      put_recordings_deletionprotection_with_http_info(opts)
+      return nil
+    end
+
+    # Apply or revoke recording protection for conversations
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :protect Check for apply, uncheck for revoke (each action requires the respective permission)
+    # @option opts [ConversationDeletionProtectionQuery] :body 
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def put_recordings_deletionprotection_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: RecordingApi.put_recordings_deletionprotection ..."
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/recordings/deletionprotection".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'protect'] = opts[:'protect'] if opts[:'protect']
+
+      # 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(:PUT, 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: RecordingApi#put_recordings_deletionprotection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end