purecloud 0.28.0 → 0.29.1

data/lib/purecloud/api/users_api.rb

@@ -259,29 +259,35 @@ module PureCloud
 
     # Get user.
     # 
+    # @param feature The feature toggles to query.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :expand Which fields, if any, to expand
-    # @return [User]
-    def get_me(opts = {})
-      data, status_code, headers = get_me_with_http_info(opts)
+    # @return [UserMe]
+    def get_me(feature, opts = {})
+      data, status_code, headers = get_me_with_http_info(feature, opts)
       return data
     end
 
     # Get user.
     # 
+    # @param feature The feature toggles to query.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :expand Which fields, if any, to expand
-    # @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
-    def get_me_with_http_info(opts = {})
+    # @return [Array<(UserMe, Fixnum, Hash)>] UserMe data, response status code and response headers
+    def get_me_with_http_info(feature, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: UsersApi#get_me ..."
       end
       
+      # verify the required parameter 'feature' is set
+      fail "Missing the required parameter 'feature' when calling get_me" if feature.nil?
+      
       # resource path
       path = "/api/v2/users/me".sub('{format}','json')
 
       # query parameters
       query_params = {}
+      query_params[:'feature'] = @api_client.build_collection_param(feature, :multi)
       query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
 
       # header parameters
@@ -309,13 +315,133 @@ module PureCloud
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'User')
+        :return_type => 'UserMe')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: UsersApi#get_me\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(opts = {})
+      data, status_code, headers = get_search_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_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi#get_search ..."
+      end
+      
+      # resource path
+      path = "/api/v2/users/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']
+
+      # 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, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'UsersSearchResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#get_search\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(opts = {})
+      data, status_code, headers = post_search_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_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi#post_search ..."
+      end
+      
+      # resource path
+      path = "/api/v2/users/search".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 = @api_client.object_to_http_body(opts[:'body'])
+      
+
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:POST, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'UsersSearchResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#post_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get user
     # 
     # @param user_id User ID
@@ -952,31 +1078,36 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Get a user&#39;s PrimaryUserPresenceSource
+    # Get a user&#39;s Presence
     # 
-    # @param user_id User ID
+    # @param user_id user Id
+    # @param source source
     # @param [Hash] opts the optional parameters
-    # @return [PrimaryUserPresenceSource]
-    def get_user_id_primarypresencesource(user_id, opts = {})
-      data, status_code, headers = get_user_id_primarypresencesource_with_http_info(user_id, opts)
+    # @return [UserPresence]
+    def get_user_id_presences_source(user_id, source, opts = {})
+      data, status_code, headers = get_user_id_presences_source_with_http_info(user_id, source, opts)
       return data
     end
 
-    # Get a user&#39;s PrimaryUserPresenceSource
+    # Get a user&#39;s Presence
     # 
-    # @param user_id User ID
+    # @param user_id user Id
+    # @param source source
     # @param [Hash] opts the optional parameters
-    # @return [Array<(PrimaryUserPresenceSource, Fixnum, Hash)>] PrimaryUserPresenceSource data, response status code and response headers
-    def get_user_id_primarypresencesource_with_http_info(user_id, opts = {})
+    # @return [Array<(UserPresence, Fixnum, Hash)>] UserPresence data, response status code and response headers
+    def get_user_id_presences_source_with_http_info(user_id, source, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: UsersApi#get_user_id_primarypresencesource ..."
+        @api_client.config.logger.debug "Calling API: UsersApi#get_user_id_presences_source ..."
       end
       
       # verify the required parameter 'user_id' is set
-      fail "Missing the required parameter 'user_id' when calling get_user_id_primarypresencesource" if user_id.nil?
+      fail "Missing the required parameter 'user_id' when calling get_user_id_presences_source" if user_id.nil?
+      
+      # verify the required parameter 'source' is set
+      fail "Missing the required parameter 'source' when calling get_user_id_presences_source" if source.nil?
       
       # resource path
-      path = "/api/v2/users/{userId}/primarypresencesource".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
+      path = "/api/v2/users/{userId}/presences/{source}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'source' + '}', source.to_s)
 
       # query parameters
       query_params = {}
@@ -1006,40 +1137,45 @@ module PureCloud
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'PrimaryUserPresenceSource')
+        :return_type => 'UserPresence')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: UsersApi#get_user_id_primarypresencesource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: UsersApi#get_user_id_presences_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Update a user&#39;s PrimaryUserPresenceSource
-    # 
-    # @param user_id User ID
+    # Patch a user&#39;s Presence
+    # The presence object can be patched one of three ways. Option 1: Set the &#39;primary&#39; property to true. This will set the &#39;source&#39; defined in the path as the user&#39;s primary presence source. Option 2: Provide the presenceDefinition value. Option 3: Provide the message value.  Option 1 can be combined with Option2 and/or Option 3.
+    # @param user_id user Id
+    # @param source source
     # @param [Hash] opts the optional parameters
-    # @option opts [PrimaryUserPresenceSource] :body 
-    # @return [PrimaryUserPresenceSource]
-    def put_user_id_primarypresencesource(user_id, opts = {})
-      data, status_code, headers = put_user_id_primarypresencesource_with_http_info(user_id, opts)
+    # @option opts [UserPresence] :body 
+    # @return [UserPresence]
+    def patch_user_id_presences_source(user_id, source, opts = {})
+      data, status_code, headers = patch_user_id_presences_source_with_http_info(user_id, source, opts)
       return data
     end
 
-    # Update a user&#39;s PrimaryUserPresenceSource
-    # 
-    # @param user_id User ID
+    # Patch a user&#39;s Presence
+    # The presence object can be patched one of three ways. Option 1: Set the &#39;primary&#39; property to true. This will set the &#39;source&#39; defined in the path as the user&#39;s primary presence source. Option 2: Provide the presenceDefinition value. Option 3: Provide the message value.  Option 1 can be combined with Option2 and/or Option 3.
+    # @param user_id user Id
+    # @param source source
     # @param [Hash] opts the optional parameters
-    # @option opts [PrimaryUserPresenceSource] :body 
-    # @return [Array<(PrimaryUserPresenceSource, Fixnum, Hash)>] PrimaryUserPresenceSource data, response status code and response headers
-    def put_user_id_primarypresencesource_with_http_info(user_id, opts = {})
+    # @option opts [UserPresence] :body 
+    # @return [Array<(UserPresence, Fixnum, Hash)>] UserPresence data, response status code and response headers
+    def patch_user_id_presences_source_with_http_info(user_id, source, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: UsersApi#put_user_id_primarypresencesource ..."
+        @api_client.config.logger.debug "Calling API: UsersApi#patch_user_id_presences_source ..."
       end
       
       # verify the required parameter 'user_id' is set
-      fail "Missing the required parameter 'user_id' when calling put_user_id_primarypresencesource" if user_id.nil?
+      fail "Missing the required parameter 'user_id' when calling patch_user_id_presences_source" if user_id.nil?
+      
+      # verify the required parameter 'source' is set
+      fail "Missing the required parameter 'source' when calling patch_user_id_presences_source" if source.nil?
       
       # resource path
-      path = "/api/v2/users/{userId}/primarypresencesource".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
+      path = "/api/v2/users/{userId}/presences/{source}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'source' + '}', source.to_s)
 
       # query parameters
       query_params = {}
@@ -1063,15 +1199,15 @@ module PureCloud
       
 
       auth_names = ['PureCloud Auth']
-      data, status_code, headers = @api_client.call_api(:PUT, path,
+      data, status_code, headers = @api_client.call_api(:PATCH, path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'PrimaryUserPresenceSource')
+        :return_type => 'UserPresence')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: UsersApi#put_user_id_primarypresencesource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: UsersApi#patch_user_id_presences_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -1274,21 +1410,21 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # List roles for user
+    # Returns a listing of roles and permissions for a user.
     # 
     # @param user_id User ID
     # @param [Hash] opts the optional parameters
-    # @return [Array<DomainOrganizationRole>]
+    # @return [UserAuthorization]
     def get_user_id_roles(user_id, opts = {})
       data, status_code, headers = get_user_id_roles_with_http_info(user_id, opts)
       return data
     end
 
-    # List roles for user
+    # Returns a listing of roles and permissions for a user.
     # 
     # @param user_id User ID
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Array<DomainOrganizationRole>, Fixnum, Hash)>] Array<DomainOrganizationRole> data, response status code and response headers
+    # @return [Array<(UserAuthorization, Fixnum, Hash)>] UserAuthorization data, response status code and response headers
     def get_user_id_roles_with_http_info(user_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: UsersApi#get_user_id_roles ..."
@@ -1328,13 +1464,136 @@ module PureCloud
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'Array<DomainOrganizationRole>')
+        :return_type => 'UserAuthorization')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: UsersApi#get_user_id_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
+    # Sets the user&#39;s roles
+    # 
+    # @param user_id User ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :body 
+    # @return [UserAuthorization]
+    def put_user_id_roles(user_id, opts = {})
+      data, status_code, headers = put_user_id_roles_with_http_info(user_id, opts)
+      return data
+    end
+
+    # Sets the user&#39;s roles
+    # 
+    # @param user_id User ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :body 
+    # @return [Array<(UserAuthorization, Fixnum, Hash)>] UserAuthorization data, response status code and response headers
+    def put_user_id_roles_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi#put_user_id_roles ..."
+      end
+      
+      # verify the required parameter 'user_id' is set
+      fail "Missing the required parameter 'user_id' when calling put_user_id_roles" if user_id.nil?
+      
+      # resource path
+      path = "/api/v2/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_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, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'UserAuthorization')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#put_user_id_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Removes all the roles from the user.
+    # 
+    # @param user_id User ID
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_user_id_roles(user_id, opts = {})
+      delete_user_id_roles_with_http_info(user_id, opts)
+      return nil
+    end
+
+    # Removes all the roles from the user.
+    # 
+    # @param user_id User ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_user_id_roles_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi#delete_user_id_roles ..."
+      end
+      
+      # verify the required parameter 'user_id' is set
+      fail "Missing the required parameter 'user_id' when calling delete_user_id_roles" if user_id.nil?
+      
+      # resource path
+      path = "/api/v2/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_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, 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: UsersApi#delete_user_id_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List routing skills for user
     # 
     # @param user_id User ID