purecloudplatformclientv2 91.0.0 → 96.0.0

data/lib/purecloudplatformclientv2/api/conversations_api.rb

@@ -6777,6 +6777,81 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Update Facebook messaging integration
+    # 
+    # @param integration_id Integration ID
+    # @param body FacebookIntegrationUpdateRequest
+    # @param [Hash] opts the optional parameters
+    # @return [FacebookIntegration]
+    def patch_conversations_messaging_integrations_facebook_integration_id(integration_id, body, opts = {})
+      data, _status_code, _headers = patch_conversations_messaging_integrations_facebook_integration_id_with_http_info(integration_id, body, opts)
+      return data
+    end
+
+    # Update Facebook messaging integration
+    # 
+    # @param integration_id Integration ID
+    # @param body FacebookIntegrationUpdateRequest
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FacebookIntegration, Fixnum, Hash)>] FacebookIntegration data, response status code and response headers
+    def patch_conversations_messaging_integrations_facebook_integration_id_with_http_info(integration_id, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ConversationsApi.patch_conversations_messaging_integrations_facebook_integration_id ..."
+      end
+      
+      
+      # verify the required parameter 'integration_id' is set
+      fail ArgumentError, "Missing the required parameter 'integration_id' when calling ConversationsApi.patch_conversations_messaging_integrations_facebook_integration_id" if integration_id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.patch_conversations_messaging_integrations_facebook_integration_id" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/conversations/messaging/integrations/facebook/{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 = @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 => 'FacebookIntegration')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationsApi#patch_conversations_messaging_integrations_facebook_integration_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Activate a WhatsApp messaging integration.
     # The following steps are required in order to fully activate a Whatsapp Integration: Initially, you will need to get an activation code by sending: an action set to Activate, and an authenticationMethod choosing from Sms or Voice. Finally, once you have been informed of an activation code on selected authenticationMethod, you will need to confirm the code by sending: an action set to Confirm, and the confirmationCode you have received from Whatsapp.
     # @param integration_id Integration ID
@@ -7122,7 +7197,7 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resyncronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
+    # Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
     # 
     # @param conversation_id conversation ID
     # @param [Hash] opts the optional parameters
@@ -7132,7 +7207,7 @@ module PureCloud
       return data
     end
 
-    # Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resyncronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
+    # Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
     # 
     # @param conversation_id conversation ID
     # @param [Hash] opts the optional parameters
@@ -9598,7 +9673,7 @@ module PureCloud
     end
 
     # Create a WhatsApp Integration
-    # 
+    # You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
     # @param body WhatsAppIntegrationRequest
     # @param [Hash] opts the optional parameters
     # @return [WhatsAppIntegration]
@@ -9608,7 +9683,7 @@ module PureCloud
     end
 
     # Create a WhatsApp Integration
-    # 
+    # You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
     # @param body WhatsAppIntegrationRequest
     # @param [Hash] opts the optional parameters
     # @return [Array<(WhatsAppIntegration, Fixnum, Hash)>] WhatsAppIntegration data, response status code and response headers

data/lib/purecloudplatformclientv2/api/external_contacts_api.rb

@@ -2134,6 +2134,298 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Scan for external contacts using paging
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit The number of contacts per page; must be between 10 and 200, default is 100)
+    # @option opts [String] :cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
+    # @return [CursorContactListing]
+    def get_externalcontacts_scan_contacts(opts = {})
+      data, _status_code, _headers = get_externalcontacts_scan_contacts_with_http_info(opts)
+      return data
+    end
+
+    # Scan for external contacts using paging
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit The number of contacts per page; must be between 10 and 200, default is 100)
+    # @option opts [String] :cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
+    # @return [Array<(CursorContactListing, Fixnum, Hash)>] CursorContactListing data, response status code and response headers
+    def get_externalcontacts_scan_contacts_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_scan_contacts ..."
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/externalcontacts/scan/contacts".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+      query_params[:'cursor'] = opts[:'cursor'] if opts[:'cursor']
+
+      # 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 => 'CursorContactListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ExternalContactsApi#get_externalcontacts_scan_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Scan for notes using paging
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit The number of notes per page; must be between 10 and 200, default is 100)
+    # @option opts [String] :cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
+    # @return [CursorNoteListing]
+    def get_externalcontacts_scan_notes(opts = {})
+      data, _status_code, _headers = get_externalcontacts_scan_notes_with_http_info(opts)
+      return data
+    end
+
+    # Scan for notes using paging
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit The number of notes per page; must be between 10 and 200, default is 100)
+    # @option opts [String] :cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
+    # @return [Array<(CursorNoteListing, Fixnum, Hash)>] CursorNoteListing data, response status code and response headers
+    def get_externalcontacts_scan_notes_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_scan_notes ..."
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/externalcontacts/scan/notes".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+      query_params[:'cursor'] = opts[:'cursor'] if opts[:'cursor']
+
+      # 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 => 'CursorNoteListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ExternalContactsApi#get_externalcontacts_scan_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Scan for external organizations using paging
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit The number of organizations per page; must be between 10 and 200, default is 100)
+    # @option opts [String] :cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
+    # @return [CursorOrganizationListing]
+    def get_externalcontacts_scan_organizations(opts = {})
+      data, _status_code, _headers = get_externalcontacts_scan_organizations_with_http_info(opts)
+      return data
+    end
+
+    # Scan for external organizations using paging
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit The number of organizations per page; must be between 10 and 200, default is 100)
+    # @option opts [String] :cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
+    # @return [Array<(CursorOrganizationListing, Fixnum, Hash)>] CursorOrganizationListing data, response status code and response headers
+    def get_externalcontacts_scan_organizations_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_scan_organizations ..."
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/externalcontacts/scan/organizations".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+      query_params[:'cursor'] = opts[:'cursor'] if opts[:'cursor']
+
+      # 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 => 'CursorOrganizationListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ExternalContactsApi#get_externalcontacts_scan_organizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Scan for relationships
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit The number of relationships per page; must be between 10 and 200, default is 100)
+    # @option opts [String] :cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
+    # @return [CursorRelationshipListing]
+    def get_externalcontacts_scan_relationships(opts = {})
+      data, _status_code, _headers = get_externalcontacts_scan_relationships_with_http_info(opts)
+      return data
+    end
+
+    # Scan for relationships
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit The number of relationships per page; must be between 10 and 200, default is 100)
+    # @option opts [String] :cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
+    # @return [Array<(CursorRelationshipListing, Fixnum, Hash)>] CursorRelationshipListing data, response status code and response headers
+    def get_externalcontacts_scan_relationships_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_scan_relationships ..."
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/externalcontacts/scan/relationships".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+      query_params[:'cursor'] = opts[:'cursor'] if opts[:'cursor']
+
+      # 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 => 'CursorRelationshipListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ExternalContactsApi#get_externalcontacts_scan_relationships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create a note for an external contact
     # 
     # @param contact_id ExternalContact Id
@@ -2844,39 +3136,39 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Associate an external contact with a conversation
-    # 
-    # @param conversation_id Conversation ID
+    # Associate/disassociate an external contact with a conversation
+    # To associate, supply a value for the externalContactId.  To disassociate, do not include the property at all.
     # @param body ConversationAssociation
+    # @param conversation_id Conversation ID
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def put_externalcontacts_conversation(conversation_id, body, opts = {})
-      put_externalcontacts_conversation_with_http_info(conversation_id, body, opts)
+    def put_externalcontacts_conversation(body, conversation_id, opts = {})
+      put_externalcontacts_conversation_with_http_info(body, conversation_id, opts)
       return nil
     end
 
-    # Associate an external contact with a conversation
-    # 
-    # @param conversation_id Conversation ID
+    # Associate/disassociate an external contact with a conversation
+    # To associate, supply a value for the externalContactId.  To disassociate, do not include the property at all.
     # @param body ConversationAssociation
+    # @param conversation_id Conversation ID
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def put_externalcontacts_conversation_with_http_info(conversation_id, body, opts = {})
+    def put_externalcontacts_conversation_with_http_info(body, conversation_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: ExternalContactsApi.put_externalcontacts_conversation ..."
       end
       
       
-      # verify the required parameter 'conversation_id' is set
-      fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ExternalContactsApi.put_externalcontacts_conversation" if conversation_id.nil?
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling ExternalContactsApi.put_externalcontacts_conversation" if body.nil?
       
       
       
       
       
       
-      # verify the required parameter 'body' is set
-      fail ArgumentError, "Missing the required parameter 'body' when calling ExternalContactsApi.put_externalcontacts_conversation" if body.nil?
+      # verify the required parameter 'conversation_id' is set
+      fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ExternalContactsApi.put_externalcontacts_conversation" if conversation_id.nil?