outbound_api.rb in purecloudplatformclientv2-46.0.0

- old
+ new

@@ -3125,12 +3125,95 @@
         @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       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)
     # @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)
@@ -3144,11 +3227,11 @@
       data, _status_code, _headers = get_outbound_contactlists_divisionviews_with_http_info(opts)
       return data
     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
     # @option opts [Integer] :page_size Page size. The max that will be returned is 100.
     # @option opts [Integer] :page_number Page number
@@ -3648,10 +3731,237 @@
         @api_client.config.logger.debug "API called: OutboundApi#get_outbound_dnclists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       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
     # @param [Hash] opts the optional parameters
     # @return [EventLog]
@@ -5188,73 +5498,9 @@
         :body => post_body,
         :auth_names => auth_names,
         :return_type => 'Array<CampaignProgress>')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: OutboundApi#post_outbound_campaigns_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      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.