purecloudplatformclientv2 45.0.0 → 46.0.0

data/lib/purecloudplatformclientv2/api/architect_api.rb

@@ -3856,8 +3856,8 @@ module PureCloud
 
     # Get a pageable list of flows, filtered by query parameters
     # Multiple IDs can be specified, in which case all matching flows will be returned, and no other parameters will be evaluated.
-    # @param type Type
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :type Type
     # @option opts [Integer] :page_number Page number (default to 1)
     # @option opts [Integer] :page_size Page size (default to 25)
     # @option opts [String] :sort_by Sort by (default to id)
@@ -3876,15 +3876,15 @@ module PureCloud
     # @option opts [String] :published_before Published before
     # @option opts [Array<String>] :division_id division ID(s)
     # @return [FlowEntityListing]
-    def get_flows(type, opts = {})
-      data, _status_code, _headers = get_flows_with_http_info(type, opts)
+    def get_flows(opts = {})
+      data, _status_code, _headers = get_flows_with_http_info(opts)
       return data
     end
 
     # Get a pageable list of flows, filtered by query parameters
     # Multiple IDs can be specified, in which case all matching flows will be returned, and no other parameters will be evaluated.
-    # @param type Type
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :type Type
     # @option opts [Integer] :page_number Page number
     # @option opts [Integer] :page_size Page size
     # @option opts [String] :sort_by Sort by
@@ -3903,19 +3903,12 @@ module PureCloud
     # @option opts [String] :published_before Published before
     # @option opts [Array<String>] :division_id division ID(s)
     # @return [Array<(FlowEntityListing, Fixnum, Hash)>] FlowEntityListing data, response status code and response headers
-    def get_flows_with_http_info(type, opts = {})
+    def get_flows_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: ArchitectApi.get_flows ..."
       end
       
       
-      # verify the required parameter 'type' is set
-      fail ArgumentError, "Missing the required parameter 'type' when calling ArchitectApi.get_flows" if type.nil?
-      
-      # verify enum value
-      unless ['inboundcall', 'inboundemail', 'inboundshortmessage', 'outboundcall', 'inqueuecall', 'speech', 'securecall', 'surveyinvite', 'workflow'].include?(type)
-        fail ArgumentError, "invalid value for 'type', must be one of inboundcall, inboundemail, inboundshortmessage, outboundcall, inqueuecall, speech, securecall, surveyinvite, workflow"
-      end
       
       
       
@@ -4032,7 +4025,7 @@ module PureCloud
 
       # query parameters
       query_params = {}
-      query_params[:'type'] = type
+      query_params[:'type'] = @api_client.build_collection_param(opts[:'type'], :multi) if opts[:'type']
       query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
       query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
       query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
@@ -4446,8 +4439,8 @@ module PureCloud
 
     # Get a pageable list of basic flow information objects filterable by query parameters.
     # This returns a simplified version of /flow consisting of name and type.
-    # @param type Type
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :type Type
     # @option opts [Integer] :page_number Page number (default to 1)
     # @option opts [Integer] :page_size Page size (default to 25)
     # @option opts [String] :sort_by Sort by (default to id)
@@ -4459,15 +4452,15 @@ module PureCloud
     # @option opts [String] :published_before Published before
     # @option opts [Array<String>] :division_id division ID(s)
     # @return [FlowDivisionViewEntityListing]
-    def get_flows_divisionviews(type, opts = {})
-      data, _status_code, _headers = get_flows_divisionviews_with_http_info(type, opts)
+    def get_flows_divisionviews(opts = {})
+      data, _status_code, _headers = get_flows_divisionviews_with_http_info(opts)
       return data
     end
 
     # Get a pageable list of basic flow information objects filterable by query parameters.
     # This returns a simplified version of /flow consisting of name and type.
-    # @param type Type
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :type Type
     # @option opts [Integer] :page_number Page number
     # @option opts [Integer] :page_size Page size
     # @option opts [String] :sort_by Sort by
@@ -4479,19 +4472,12 @@ module PureCloud
     # @option opts [String] :published_before Published before
     # @option opts [Array<String>] :division_id division ID(s)
     # @return [Array<(FlowDivisionViewEntityListing, Fixnum, Hash)>] FlowDivisionViewEntityListing data, response status code and response headers
-    def get_flows_divisionviews_with_http_info(type, opts = {})
+    def get_flows_divisionviews_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: ArchitectApi.get_flows_divisionviews ..."
       end
       
       
-      # verify the required parameter 'type' is set
-      fail ArgumentError, "Missing the required parameter 'type' when calling ArchitectApi.get_flows_divisionviews" if type.nil?
-      
-      # verify enum value
-      unless ['inboundcall', 'inboundemail', 'inboundshortmessage', 'outboundcall', 'inqueuecall', 'speech', 'securecall', 'surveyinvite', 'workflow'].include?(type)
-        fail ArgumentError, "invalid value for 'type', must be one of inboundcall, inboundemail, inboundshortmessage, outboundcall, inqueuecall, speech, securecall, surveyinvite, workflow"
-      end
       
       
       
@@ -4562,7 +4548,7 @@ module PureCloud
 
       # query parameters
       query_params = {}
-      query_params[:'type'] = type
+      query_params[:'type'] = @api_client.build_collection_param(opts[:'type'], :multi) if opts[:'type']
       query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
       query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
       query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']

data/lib/purecloudplatformclientv2/api/conversations_api.rb

@@ -321,6 +321,70 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Gets multiple conversations by id
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :id Comma-separated conversation ids
+    # @return [AnalyticsConversation]
+    def get_analytics_conversations_details(opts = {})
+      data, _status_code, _headers = get_analytics_conversations_details_with_http_info(opts)
+      return data
+    end
+
+    # Gets multiple conversations by id
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :id Comma-separated conversation ids
+    # @return [Array<(AnalyticsConversation, Fixnum, Hash)>] AnalyticsConversation data, response status code and response headers
+    def get_analytics_conversations_details_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ConversationsApi.get_analytics_conversations_details ..."
+      end
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/analytics/conversations/details".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['PureCloud Auth']
+      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 => 'AnalyticsConversation')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationsApi#get_analytics_conversations_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get conversation
     # 
     # @param conversation_id conversation ID

data/lib/purecloudplatformclientv2/api/outbound_api.rb

@@ -3127,8 +3127,91 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get a basic ContactList information object
+    # This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size.
+    # @param contact_list_id Contactlist ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :include_import_status Include import status (default to false)
+    # @option opts [BOOLEAN] :include_size Include size (default to false)
+    # @return [ContactListDivisionView]
+    def get_outbound_contactlists_divisionview(contact_list_id, opts = {})
+      data, _status_code, _headers = get_outbound_contactlists_divisionview_with_http_info(contact_list_id, opts)
+      return data
+    end
+
+    # Get a basic ContactList information object
+    # This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size.
+    # @param contact_list_id Contactlist ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :include_import_status Include import status
+    # @option opts [BOOLEAN] :include_size Include size
+    # @return [Array<(ContactListDivisionView, Fixnum, Hash)>] ContactListDivisionView data, response status code and response headers
+    def get_outbound_contactlists_divisionview_with_http_info(contact_list_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlists_divisionview ..."
+      end
+      
+      
+      # verify the required parameter 'contact_list_id' is set
+      fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.get_outbound_contactlists_divisionview" if contact_list_id.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/outbound/contactlists/divisionviews/{contactListId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
+      query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
+
+      # 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 Auth']
+      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 => 'ContactListDivisionView')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlists_divisionview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Query a list of simplified contact list objects.
-    # This return a simplified version of contact lists, consisting of the name, divisions, columns, and phone columns.
+    # This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size.
     # @param [Hash] opts the optional parameters
     # @option opts [BOOLEAN] :include_import_status Include import status (default to false)
     # @option opts [BOOLEAN] :include_size Include size (default to false)
@@ -3146,7 +3229,7 @@ module PureCloud
     end
 
     # Query a list of simplified contact list objects.
-    # This return a simplified version of contact lists, consisting of the name, divisions, columns, and phone columns.
+    # This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size.
     # @param [Hash] opts the optional parameters
     # @option opts [BOOLEAN] :include_import_status Include import status
     # @option opts [BOOLEAN] :include_size Include size
@@ -3650,6 +3733,233 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get a basic DncList information object
+    # This returns a simplified version of a DncList, consisting of the name, division, import status, and size.
+    # @param dnc_list_id Dnclist ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :include_import_status Include import status (default to false)
+    # @option opts [BOOLEAN] :include_size Include size (default to false)
+    # @return [DncListDivisionView]
+    def get_outbound_dnclists_divisionview(dnc_list_id, opts = {})
+      data, _status_code, _headers = get_outbound_dnclists_divisionview_with_http_info(dnc_list_id, opts)
+      return data
+    end
+
+    # Get a basic DncList information object
+    # This returns a simplified version of a DncList, consisting of the name, division, import status, and size.
+    # @param dnc_list_id Dnclist ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :include_import_status Include import status
+    # @option opts [BOOLEAN] :include_size Include size
+    # @return [Array<(DncListDivisionView, Fixnum, Hash)>] DncListDivisionView data, response status code and response headers
+    def get_outbound_dnclists_divisionview_with_http_info(dnc_list_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_dnclists_divisionview ..."
+      end
+      
+      
+      # verify the required parameter 'dnc_list_id' is set
+      fail ArgumentError, "Missing the required parameter 'dnc_list_id' when calling OutboundApi.get_outbound_dnclists_divisionview" if dnc_list_id.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/outbound/dnclists/divisionviews/{dncListId}".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
+      query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
+
+      # 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 Auth']
+      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 => 'DncListDivisionView')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OutboundApi#get_outbound_dnclists_divisionview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Query a list of simplified dnc list objects.
+    # This return a simplified version of dnc lists, consisting of the name, division, import status, and size.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :include_import_status Include import status (default to false)
+    # @option opts [BOOLEAN] :include_size Include size (default to false)
+    # @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25)
+    # @option opts [Integer] :page_number Page number (default to 1)
+    # @option opts [String] :filter_type Filter type (default to Prefix)
+    # @option opts [String] :name Name
+    # @option opts [Array<String>] :id id
+    # @option opts [String] :sort_by Sort by
+    # @option opts [String] :sort_order Sort order (default to a)
+    # @return [DncListDivisionViewListing]
+    def get_outbound_dnclists_divisionviews(opts = {})
+      data, _status_code, _headers = get_outbound_dnclists_divisionviews_with_http_info(opts)
+      return data
+    end
+
+    # Query a list of simplified dnc list objects.
+    # This return a simplified version of dnc lists, consisting of the name, division, import status, and size.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :include_import_status Include import status
+    # @option opts [BOOLEAN] :include_size Include size
+    # @option opts [Integer] :page_size Page size. The max that will be returned is 100.
+    # @option opts [Integer] :page_number Page number
+    # @option opts [String] :filter_type Filter type
+    # @option opts [String] :name Name
+    # @option opts [Array<String>] :id id
+    # @option opts [String] :sort_by Sort by
+    # @option opts [String] :sort_order Sort order
+    # @return [Array<(DncListDivisionViewListing, Fixnum, Hash)>] DncListDivisionViewListing data, response status code and response headers
+    def get_outbound_dnclists_divisionviews_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_dnclists_divisionviews ..."
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
+        fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
+        fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
+      end
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/outbound/dnclists/divisionviews".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
+      query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
+      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
+      query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
+      query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
+      query_params[:'name'] = opts[:'name'] if opts[:'name']
+      query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
+      query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
+      query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
+
+      # 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 Auth']
+      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 => 'DncListDivisionViewListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OutboundApi#get_outbound_dnclists_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get Dialer Event
     # 
     # @param event_id Event Log ID
@@ -5194,70 +5504,6 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.
-    # 
-    # @param contact_list_id Contact List ID
-    # @param [Hash] opts the optional parameters
-    # @return [nil]
-    def post_outbound_contactlist_clear(contact_list_id, opts = {})
-      post_outbound_contactlist_clear_with_http_info(contact_list_id, opts)
-      return nil
-    end
-
-    # Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.
-    # 
-    # @param contact_list_id Contact List ID
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def post_outbound_contactlist_clear_with_http_info(contact_list_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_contactlist_clear ..."
-      end
-      
-      
-      # verify the required parameter 'contact_list_id' is set
-      fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.post_outbound_contactlist_clear" if contact_list_id.nil?
-      
-      
-      
-      
-      
-      # resource path
-      local_var_path = "/api/v2/outbound/contactlists/{contactListId}/clear".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_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 Auth']
-      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: OutboundApi#post_outbound_contactlist_clear\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Add contacts to a contact list.
     # 
     # @param contact_list_id Contact List ID