purecloud 0.38.1 → 0.39.1

data/lib/purecloud/api/outbound_api.rb

@@ -1394,7 +1394,7 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Get dialer contactList.
+    # Get a dialer contact list.
     # 
     # @param contact_list_id ContactList ID
     # @param [Hash] opts the optional parameters
@@ -1406,7 +1406,7 @@ module PureCloud
       return data
     end
 
-    # Get dialer contactList.
+    # Get a dialer contact list.
     # 
     # @param contact_list_id ContactList ID
     # @param [Hash] opts the optional parameters

data/lib/purecloud/api/presence_api.rb

@@ -24,7 +24,7 @@ module PureCloud
       @api_client = api_client
     end
 
-    # Delete an OrganizationPresence
+    # Delete a Presence Definition
     # 
     # @param presence_id Organization Presence ID
     # @param [Hash] opts the optional parameters
@@ -34,7 +34,7 @@ module PureCloud
       return data
     end
 
-    # Delete an OrganizationPresence
+    # Delete a Presence Definition
     # 
     # @param presence_id Organization Presence ID
     # @param [Hash] opts the optional parameters
@@ -84,7 +84,7 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Get an OrganizationPresence
+    # Get a Presence Definition
     # 
     # @param presence_id Organization Presence ID
     # @param [Hash] opts the optional parameters
@@ -94,7 +94,7 @@ module PureCloud
       return data
     end
 
-    # Get an OrganizationPresence
+    # Get a Presence Definition
     # 
     # @param presence_id Organization Presence ID
     # @param [Hash] opts the optional parameters
@@ -144,7 +144,7 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Get an Organization's list of Presences
+    # Get an Organization's list of Presence Definitions
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_number Page number (default to 1)
@@ -155,7 +155,7 @@ module PureCloud
       return data
     end
 
-    # Get an Organization's list of Presences
+    # Get an Organization's list of Presence Definitions
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_number Page number
@@ -205,6 +205,61 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get the list of SystemPresences
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [SystemPresence]
+    def get_systempresences(opts = {})
+      data, status_code, headers = get_systempresences_with_http_info(opts)
+      return data
+    end
+
+    # Get the list of SystemPresences
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SystemPresence, Fixnum, Hash)>] SystemPresence data, response status code and response headers
+    def get_systempresences_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PresenceApi#get_systempresences ..."
+      end
+      
+      # resource path
+      local_var_path = "/api/v2/systempresences".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'SystemPresence')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PresenceApi#get_systempresences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get a user's Presence
     # 
     # @param user_id user Id
@@ -337,9 +392,9 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Create an OrganizationPresence
+    # Create a Presence Definition
     # 
-    # @param body The OrganizationPresence to create
+    # @param body The Presence Definition to create
     # @param [Hash] opts the optional parameters
     # @return [OrganizationPresence]
     def post_presencedefinitions(body, opts = {})
@@ -347,9 +402,9 @@ module PureCloud
       return data
     end
 
-    # Create an OrganizationPresence
+    # Create a Presence Definition
     # 
-    # @param body The OrganizationPresence to create
+    # @param body The Presence Definition to create
     # @param [Hash] opts the optional parameters
     # @return [Array<(OrganizationPresence, Fixnum, Hash)>] OrganizationPresence data, response status code and response headers
     def post_presencedefinitions_with_http_info(body, opts = {})
@@ -397,7 +452,7 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Update an OrganizationPresence
+    # Update a Presence Definition
     # 
     # @param presence_id Organization Presence ID
     # @param body The OrganizationPresence to update
@@ -408,7 +463,7 @@ module PureCloud
       return data
     end
 
-    # Update an OrganizationPresence
+    # Update a Presence Definition
     # 
     # @param presence_id Organization Presence ID
     # @param body The OrganizationPresence to update

data/lib/purecloud/api/quality_api.rb

@@ -218,6 +218,126 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Delete keyword sets
+    # Bulk delete of keyword sets; this will only delete the keyword sets that match the ids specified in the query param.
+    # @param ids A comma-delimited list of valid KeywordSet ids
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def delete_keywordsets(ids, opts = {})
+      data, status_code, headers = delete_keywordsets_with_http_info(ids, opts)
+      return data
+    end
+
+    # Delete keyword sets
+    # Bulk delete of keyword sets; this will only delete the keyword sets that match the ids specified in the query param.
+    # @param ids A comma-delimited list of valid KeywordSet ids
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def delete_keywordsets_with_http_info(ids, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: QualityApi#delete_keywordsets ..."
+      end
+      
+      # verify the required parameter 'ids' is set
+      fail "Missing the required parameter 'ids' when calling delete_keywordsets" if ids.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/quality/keywordsets".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'ids'] = ids
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_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(: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 => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: QualityApi#delete_keywordsets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a keywordSet by id.
+    # 
+    # @param keyword_set_id KeywordSet ID
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_keywordsets_keywordset_id(keyword_set_id, opts = {})
+      delete_keywordsets_keywordset_id_with_http_info(keyword_set_id, opts)
+      return nil
+    end
+
+    # Delete a keywordSet by id.
+    # 
+    # @param keyword_set_id KeywordSet ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_keywordsets_keywordset_id_with_http_info(keyword_set_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: QualityApi#delete_keywordsets_keywordset_id ..."
+      end
+      
+      # verify the required parameter 'keyword_set_id' is set
+      fail "Missing the required parameter 'keyword_set_id' when calling delete_keywordsets_keywordset_id" if keyword_set_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/quality/keywordsets/{keywordSetId}".sub('{format}','json').sub('{' + 'keywordSetId' + '}', keyword_set_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_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(:DELETE, 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: QualityApi#delete_keywordsets_keywordset_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Gets a list of Agent Activities
     # Including the number of evaluations and average evaluation score
     # @param [Hash] opts the optional parameters
@@ -1011,6 +1131,142 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get the list of keyword sets
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size The total page size requested (default to 25)
+    # @option opts [Integer] :page_number The page number requested (default to 1)
+    # @option opts [String] :sort_by variable name requested to sort by
+    # @option opts [Array<String>] :expand variable name requested by expand list
+    # @option opts [String] :next_page next page token
+    # @option opts [String] :previous_page Previous page token
+    # @option opts [String] :name the keyword set name - used for filtering results in searches.
+    # @return [KeywordSetEntityListing]
+    def get_keywordsets(opts = {})
+      data, status_code, headers = get_keywordsets_with_http_info(opts)
+      return data
+    end
+
+    # Get the list of keyword sets
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size The total page size requested
+    # @option opts [Integer] :page_number The page number requested
+    # @option opts [String] :sort_by variable name requested to sort by
+    # @option opts [Array<String>] :expand variable name requested by expand list
+    # @option opts [String] :next_page next page token
+    # @option opts [String] :previous_page Previous page token
+    # @option opts [String] :name the keyword set name - used for filtering results in searches.
+    # @return [Array<(KeywordSetEntityListing, Fixnum, Hash)>] KeywordSetEntityListing data, response status code and response headers
+    def get_keywordsets_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: QualityApi#get_keywordsets ..."
+      end
+      
+      # resource path
+      local_var_path = "/api/v2/quality/keywordsets".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
+      query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
+      query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
+      query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
+      query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
+      query_params[:'name'] = opts[:'name'] if opts[:'name']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'KeywordSetEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: QualityApi#get_keywordsets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a keywordSet by id.
+    # 
+    # @param keyword_set_id KeywordSet ID
+    # @param [Hash] opts the optional parameters
+    # @return [KeywordSet]
+    def get_keywordsets_keywordset_id(keyword_set_id, opts = {})
+      data, status_code, headers = get_keywordsets_keywordset_id_with_http_info(keyword_set_id, opts)
+      return data
+    end
+
+    # Get a keywordSet by id.
+    # 
+    # @param keyword_set_id KeywordSet ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(KeywordSet, Fixnum, Hash)>] KeywordSet data, response status code and response headers
+    def get_keywordsets_keywordset_id_with_http_info(keyword_set_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: QualityApi#get_keywordsets_keywordset_id ..."
+      end
+      
+      # verify the required parameter 'keyword_set_id' is set
+      fail "Missing the required parameter 'keyword_set_id' when calling get_keywordsets_keywordset_id" if keyword_set_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/quality/keywordsets/{keywordSetId}".sub('{format}','json').sub('{' + 'keywordSetId' + '}', keyword_set_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'KeywordSet')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: QualityApi#get_keywordsets_keywordset_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get the published evaluation forms.
     # 
     # @param [Hash] opts the optional parameters
@@ -1431,6 +1687,66 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Create a Keyword Set
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [KeywordSet] :body keywordSet
+    # @option opts [String] :expand queueId
+    # @return [KeywordSet]
+    def post_keywordsets(opts = {})
+      data, status_code, headers = post_keywordsets_with_http_info(opts)
+      return data
+    end
+
+    # Create a Keyword Set
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [KeywordSet] :body keywordSet
+    # @option opts [String] :expand queueId
+    # @return [Array<(KeywordSet, Fixnum, Hash)>] KeywordSet data, response status code and response headers
+    def post_keywordsets_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: QualityApi#post_keywordsets ..."
+      end
+      
+      # resource path
+      local_var_path = "/api/v2/quality/keywordsets".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(opts[:'body'])
+      
+      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,
+        :return_type => 'KeywordSet')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: QualityApi#post_keywordsets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Publish an evaluation form.
     # 
     # @param [Hash] opts the optional parameters
@@ -1681,5 +1997,67 @@ module PureCloud
       end
       return data, status_code, headers
     end
+
+    # Update a keywordSet to the specified keywordSet via PUT.
+    # 
+    # @param keyword_set_id KeywordSet ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [KeywordSet] :body keywordSet
+    # @return [KeywordSet]
+    def put_keywordsets_keywordset_id(keyword_set_id, opts = {})
+      data, status_code, headers = put_keywordsets_keywordset_id_with_http_info(keyword_set_id, opts)
+      return data
+    end
+
+    # Update a keywordSet to the specified keywordSet via PUT.
+    # 
+    # @param keyword_set_id KeywordSet ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [KeywordSet] :body keywordSet
+    # @return [Array<(KeywordSet, Fixnum, Hash)>] KeywordSet data, response status code and response headers
+    def put_keywordsets_keywordset_id_with_http_info(keyword_set_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: QualityApi#put_keywordsets_keywordset_id ..."
+      end
+      
+      # verify the required parameter 'keyword_set_id' is set
+      fail "Missing the required parameter 'keyword_set_id' when calling put_keywordsets_keywordset_id" if keyword_set_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/quality/keywordsets/{keywordSetId}".sub('{format}','json').sub('{' + 'keywordSetId' + '}', keyword_set_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(opts[:'body'])
+      
+      auth_names = ['PureCloud Auth']
+      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,
+        :return_type => 'KeywordSet')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: QualityApi#put_keywordsets_keywordset_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end