users_api.rb in purecloudplatformclientv2-22.0.0

- old
+ new

@@ -424,10 +424,136 @@
         @api_client.config.logger.debug "API called: UsersApi#get_fieldconfig\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
+    # Get a user profile listing
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size (default to 25)
+    # @option opts [Integer] :page_number Page number (default to 1)
+    # @option opts [Array<String>] :id id
+    # @option opts [Array<String>] :jid jid
+    # @option opts [String] :sort_order Ascending or descending sort order (default to ASC)
+    # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @option opts [String] :state Only list users of this state (default to active)
+    # @return [UserProfileEntityListing]
+    def get_profiles_users(opts = {})
+      data, _status_code, _headers = get_profiles_users_with_http_info(opts)
+      return data
+    end
+
+    # Get a user profile listing
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size
+    # @option opts [Integer] :page_number Page number
+    # @option opts [Array<String>] :id id
+    # @option opts [Array<String>] :jid jid
+    # @option opts [String] :sort_order Ascending or descending sort order
+    # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @option opts [String] :state Only list users of this state
+    # @return [Array<(UserProfileEntityListing, Fixnum, Hash)>] UserProfileEntityListing data, response status code and response headers
+    def get_profiles_users_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi.get_profiles_users ..."
+      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
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      if opts[:'state'] && !['active', 'deleted'].include?(opts[:'state'])
+        fail ArgumentError, 'invalid value for "state", must be one of active, deleted'
+      end
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/profiles/users".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[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
+      query_params[:'jid'] = @api_client.build_collection_param(opts[:'jid'], :multi) if opts[:'jid']
+      query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
+      query_params[:'state'] = opts[:'state'] if opts[:'state']
+
+      # 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 => 'UserProfileEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#get_profiles_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get user.
     # 
     # @param user_id User ID
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :expand Which fields, if any, to expand
@@ -961,9 +1087,83 @@
         :body => post_body,
         :auth_names => auth_names,
         :return_type => 'OutOfOffice')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: UsersApi#get_user_outofoffice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get user profile
+    # 
+    # @param user_id userId
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @return [UserProfile]
+    def get_user_profile(user_id, opts = {})
+      data, _status_code, _headers = get_user_profile_with_http_info(user_id, opts)
+      return data
+    end
+
+    # Get user profile
+    # 
+    # @param user_id userId
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @return [Array<(UserProfile, Fixnum, Hash)>] UserProfile data, response status code and response headers
+    def get_user_profile_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi.get_user_profile ..."
+      end
+      
+      
+      # verify the required parameter 'user_id' is set
+      fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_profile" if user_id.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/users/{userId}/profile".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
+
+      # 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 => 'UserProfile')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#get_user_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
     # List profile skills for a user