purecloud 0.37.1 → 0.38.1

data/lib/purecloud/api/objects_api.rb

@@ -0,0 +1,87 @@
+=begin
+PureCloud Platform API
+
+With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
+
+OpenAPI spec version: v2
+Contact: DeveloperEvangelists@inin.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+License: ININ
+http://www.inin.com
+
+Terms of Service: https://developer.mypurecloud.com/tos
+
+=end
+
+require "uri"
+
+module PureCloud
+  class ObjectsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Returns a permission-protected object, showing the permission contexts it belongs to.
+    # 
+    # @param object_id Object ID
+    # @param [Hash] opts the optional parameters
+    # @return [AuthzObject]
+    def get_objects_object_id(object_id, opts = {})
+      data, status_code, headers = get_objects_object_id_with_http_info(object_id, opts)
+      return data
+    end
+
+    # Returns a permission-protected object, showing the permission contexts it belongs to.
+    # 
+    # @param object_id Object ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AuthzObject, Fixnum, Hash)>] AuthzObject data, response status code and response headers
+    def get_objects_object_id_with_http_info(object_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ObjectsApi#get_objects_object_id ..."
+      end
+      
+      # verify the required parameter 'object_id' is set
+      fail "Missing the required parameter 'object_id' when calling get_objects_object_id" if object_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/authorization/objects/{objectId}".sub('{format}','json').sub('{' + 'objectId' + '}', object_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 => 'AuthzObject')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ObjectsApi#get_objects_object_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/purecloud/api/outbound_api.rb

@@ -1525,6 +1525,69 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get the URI of a contact list export.
+    # 
+    # @param contact_list_id ContactList ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :download Redirect to download uri (default to false)
+    # @return [ExportUri]
+    def get_contactlists_contactlist_id_export(contact_list_id, opts = {})
+      data, status_code, headers = get_contactlists_contactlist_id_export_with_http_info(contact_list_id, opts)
+      return data
+    end
+
+    # Get the URI of a contact list export.
+    # 
+    # @param contact_list_id ContactList ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :download Redirect to download uri
+    # @return [Array<(ExportUri, Fixnum, Hash)>] ExportUri data, response status code and response headers
+    def get_contactlists_contactlist_id_export_with_http_info(contact_list_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OutboundApi#get_contactlists_contactlist_id_export ..."
+      end
+      
+      # verify the required parameter 'contact_list_id' is set
+      fail "Missing the required parameter 'contact_list_id' when calling get_contactlists_contactlist_id_export" if contact_list_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/outbound/contactlists/{contactListId}/export".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'download'] = opts[:'download'] if opts[:'download']
+
+      # 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 => 'ExportUri')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OutboundApi#get_contactlists_contactlist_id_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get dialer contactList import status.
     # 
     # @param contact_list_id ContactList ID
@@ -1738,6 +1801,69 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get the URI of a DNC list export.
+    # 
+    # @param dnc_list_id DncList ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :download Redirect to download uri (default to false)
+    # @return [ExportUri]
+    def get_dnclists_dnclist_id_export(dnc_list_id, opts = {})
+      data, status_code, headers = get_dnclists_dnclist_id_export_with_http_info(dnc_list_id, opts)
+      return data
+    end
+
+    # Get the URI of a DNC list export.
+    # 
+    # @param dnc_list_id DncList ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :download Redirect to download uri
+    # @return [Array<(ExportUri, Fixnum, Hash)>] ExportUri data, response status code and response headers
+    def get_dnclists_dnclist_id_export_with_http_info(dnc_list_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OutboundApi#get_dnclists_dnclist_id_export ..."
+      end
+      
+      # verify the required parameter 'dnc_list_id' is set
+      fail "Missing the required parameter 'dnc_list_id' when calling get_dnclists_dnclist_id_export" if dnc_list_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/outbound/dnclists/{dncListId}/export".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'download'] = opts[:'download'] if opts[:'download']
+
+      # 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 => 'ExportUri')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OutboundApi#get_dnclists_dnclist_id_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get dialer dncList import status.
     # 
     # @param dnc_list_id DncList ID

data/lib/purecloud/api/search_api.rb

@@ -90,7 +90,7 @@ module PureCloud
     # @param [Hash] opts the optional parameters
     # @option opts [String] :q64 
     # @option opts [Array<String>] :expand 
-    # @return [JsonNodeSearchResponse]
+    # @return [GroupsSearchResponse]
     def get_search_0(opts = {})
       data, status_code, headers = get_search_0_with_http_info(opts)
       return data
@@ -101,14 +101,14 @@ module PureCloud
     # @param [Hash] opts the optional parameters
     # @option opts [String] :q64 
     # @option opts [Array<String>] :expand 
-    # @return [Array<(JsonNodeSearchResponse, Fixnum, Hash)>] JsonNodeSearchResponse data, response status code and response headers
+    # @return [Array<(GroupsSearchResponse, Fixnum, Hash)>] GroupsSearchResponse data, response status code and response headers
     def get_search_0_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: SearchApi#get_search_0 ..."
       end
       
       # resource path
-      local_var_path = "/api/v2/search".sub('{format}','json')
+      local_var_path = "/api/v2/locations/search".sub('{format}','json')
 
       # query parameters
       query_params = {}
@@ -139,7 +139,7 @@ module PureCloud
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'JsonNodeSearchResponse')
+        :return_type => 'GroupsSearchResponse')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: SearchApi#get_search_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -151,7 +151,8 @@ module PureCloud
     # @param [Hash] opts the optional parameters
     # @option opts [String] :q64 
     # @option opts [Array<String>] :expand 
-    # @return [UsersSearchResponse]
+    # @option opts [BOOLEAN] :profile  (default to true)
+    # @return [JsonNodeSearchResponse]
     def get_search_1(opts = {})
       data, status_code, headers = get_search_1_with_http_info(opts)
       return data
@@ -162,12 +163,75 @@ module PureCloud
     # @param [Hash] opts the optional parameters
     # @option opts [String] :q64 
     # @option opts [Array<String>] :expand 
-    # @return [Array<(UsersSearchResponse, Fixnum, Hash)>] UsersSearchResponse data, response status code and response headers
+    # @option opts [BOOLEAN] :profile 
+    # @return [Array<(JsonNodeSearchResponse, Fixnum, Hash)>] JsonNodeSearchResponse data, response status code and response headers
     def get_search_1_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: SearchApi#get_search_1 ..."
       end
       
+      # resource path
+      local_var_path = "/api/v2/search".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'q64'] = opts[:'q64'] if opts[:'q64']
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
+      query_params[:'profile'] = opts[:'profile'] if opts[:'profile']
+
+      # 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 => 'JsonNodeSearchResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SearchApi#get_search_1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Search using q64
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :q64 
+    # @option opts [Array<String>] :expand 
+    # @return [UsersSearchResponse]
+    def get_search_2(opts = {})
+      data, status_code, headers = get_search_2_with_http_info(opts)
+      return data
+    end
+
+    # Search using q64
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :q64 
+    # @option opts [Array<String>] :expand 
+    # @return [Array<(UsersSearchResponse, Fixnum, Hash)>] UsersSearchResponse data, response status code and response headers
+    def get_search_2_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SearchApi#get_search_2 ..."
+      end
+      
       # resource path
       local_var_path = "/api/v2/users/search".sub('{format}','json')
 
@@ -202,7 +266,68 @@ module PureCloud
         :auth_names => auth_names,
         :return_type => 'UsersSearchResponse')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: SearchApi#get_search_1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: SearchApi#get_search_2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Suggest using q64
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :q64 
+    # @option opts [BOOLEAN] :profile  (default to true)
+    # @return [JsonNodeSearchResponse]
+    def get_suggest(opts = {})
+      data, status_code, headers = get_suggest_with_http_info(opts)
+      return data
+    end
+
+    # Suggest using q64
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :q64 
+    # @option opts [BOOLEAN] :profile 
+    # @return [Array<(JsonNodeSearchResponse, Fixnum, Hash)>] JsonNodeSearchResponse data, response status code and response headers
+    def get_suggest_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SearchApi#get_suggest ..."
+      end
+      
+      # resource path
+      local_var_path = "/api/v2/search/suggest".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'q64'] = opts[:'q64'] if opts[:'q64']
+      query_params[:'profile'] = opts[:'profile'] if opts[:'profile']
+
+      # 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 => 'JsonNodeSearchResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SearchApi#get_suggest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -268,7 +393,7 @@ module PureCloud
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [SearchRequest] :body Search request options
-    # @return [JsonNodeSearchResponse]
+    # @return [GroupsSearchResponse]
     def post_search_0(opts = {})
       data, status_code, headers = post_search_0_with_http_info(opts)
       return data
@@ -278,14 +403,14 @@ module PureCloud
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [SearchRequest] :body Search request options
-    # @return [Array<(JsonNodeSearchResponse, Fixnum, Hash)>] JsonNodeSearchResponse data, response status code and response headers
+    # @return [Array<(GroupsSearchResponse, Fixnum, Hash)>] GroupsSearchResponse data, response status code and response headers
     def post_search_0_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: SearchApi#post_search_0 ..."
       end
       
       # resource path
-      local_var_path = "/api/v2/search".sub('{format}','json')
+      local_var_path = "/api/v2/locations/search".sub('{format}','json')
 
       # query parameters
       query_params = {}
@@ -314,7 +439,7 @@ module PureCloud
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'JsonNodeSearchResponse')
+        :return_type => 'GroupsSearchResponse')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: SearchApi#post_search_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -325,7 +450,8 @@ module PureCloud
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [SearchRequest] :body Search request options
-    # @return [UsersSearchResponse]
+    # @option opts [BOOLEAN] :profile  (default to true)
+    # @return [JsonNodeSearchResponse]
     def post_search_1(opts = {})
       data, status_code, headers = post_search_1_with_http_info(opts)
       return data
@@ -335,12 +461,71 @@ module PureCloud
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [SearchRequest] :body Search request options
-    # @return [Array<(UsersSearchResponse, Fixnum, Hash)>] UsersSearchResponse data, response status code and response headers
+    # @option opts [BOOLEAN] :profile 
+    # @return [Array<(JsonNodeSearchResponse, Fixnum, Hash)>] JsonNodeSearchResponse data, response status code and response headers
     def post_search_1_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: SearchApi#post_search_1 ..."
       end
       
+      # resource path
+      local_var_path = "/api/v2/search".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'profile'] = opts[:'profile'] if opts[:'profile']
+
+      # 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 => 'JsonNodeSearchResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SearchApi#post_search_1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Search
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [SearchRequest] :body Search request options
+    # @return [UsersSearchResponse]
+    def post_search_2(opts = {})
+      data, status_code, headers = post_search_2_with_http_info(opts)
+      return data
+    end
+
+    # Search
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [SearchRequest] :body Search request options
+    # @return [Array<(UsersSearchResponse, Fixnum, Hash)>] UsersSearchResponse data, response status code and response headers
+    def post_search_2_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SearchApi#post_search_2 ..."
+      end
+      
       # resource path
       local_var_path = "/api/v2/users/search".sub('{format}','json')
 
@@ -373,7 +558,67 @@ module PureCloud
         :auth_names => auth_names,
         :return_type => 'UsersSearchResponse')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: SearchApi#post_search_1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: SearchApi#post_search_2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Suggest
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [SearchRequest] :body Search request options
+    # @option opts [BOOLEAN] :profile  (default to true)
+    # @return [JsonNodeSearchResponse]
+    def post_suggest(opts = {})
+      data, status_code, headers = post_suggest_with_http_info(opts)
+      return data
+    end
+
+    # Suggest
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [SearchRequest] :body Search request options
+    # @option opts [BOOLEAN] :profile 
+    # @return [Array<(JsonNodeSearchResponse, Fixnum, Hash)>] JsonNodeSearchResponse data, response status code and response headers
+    def post_suggest_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SearchApi#post_suggest ..."
+      end
+      
+      # resource path
+      local_var_path = "/api/v2/search/suggest".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'profile'] = opts[:'profile'] if opts[:'profile']
+
+      # 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 => 'JsonNodeSearchResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SearchApi#post_suggest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end