users_api.rb in purecloudplatformclientv2-94.0.0

- old
+ new

@@ -1176,10 +1176,11 @@
     # @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] :integration_presence_source Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \&quot;expand\&quot;.
     # @return [UserProfileEntityListing]
     def get_profiles_users(opts = {})
       data, _status_code, _headers = get_profiles_users_with_http_info(opts)
       return data
     end
@@ -1191,10 +1192,11 @@
     # @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] :integration_presence_source Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \&quot;expand\&quot;.
     # @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
@@ -1237,10 +1239,20 @@
       
       
       
       
       
+      
+      
+      
+      if opts[:'integration_presence_source'] && !['MicrosoftTeams', 'ZoomPhone'].include?(opts[:'integration_presence_source'])
+        fail ArgumentError, 'invalid value for "integration_presence_source", must be one of MicrosoftTeams, ZoomPhone'
+      end
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/profiles/users".sub('{format}','json')
 
       # query parameters
       query_params = {}
@@ -1248,10 +1260,11 @@
       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[:'integrationPresenceSource'] = opts[:'integration_presence_source'] if opts[:'integration_presence_source']
 
       # header parameters
       header_params = {}
 
       # HTTP header 'Accept' (if needed)
@@ -1350,10 +1363,11 @@
     # Get user.
     # 
     # @param user_id User ID
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @option opts [String] :integration_presence_source Gets an integration presence for a user instead of their default.
     # @option opts [String] :state Search for a user with this state (default to active)
     # @return [User]
     def get_user(user_id, opts = {})
       data, _status_code, _headers = get_user_with_http_info(user_id, opts)
       return data
@@ -1362,10 +1376,11 @@
     # Get user.
     # 
     # @param user_id User ID
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @option opts [String] :integration_presence_source Gets an integration presence for a user instead of their default.
     # @option opts [String] :state Search for a user with this state
     # @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
     def get_user_with_http_info(user_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: UsersApi.get_user ..."
@@ -1386,10 +1401,20 @@
       
       
       
       
       
+      if opts[:'integration_presence_source'] && !['MicrosoftTeams', 'ZoomPhone'].include?(opts[:'integration_presence_source'])
+        fail ArgumentError, 'invalid value for "integration_presence_source", must be one of MicrosoftTeams, ZoomPhone'
+      end
+      
+      
+      
+      
+      
+      
+      
       if opts[:'state'] && !['active', 'deleted'].include?(opts[:'state'])
         fail ArgumentError, 'invalid value for "state", must be one of active, deleted'
       end
       
       
@@ -1399,10 +1424,11 @@
       local_var_path = "/api/v2/users/{userId}".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']
+      query_params[:'integrationPresenceSource'] = opts[:'integration_presence_source'] if opts[:'integration_presence_source']
       query_params[:'state'] = opts[:'state'] if opts[:'state']
 
       # header parameters
       header_params = {}
 
@@ -1891,10 +1917,11 @@
     # Get user profile
     # This api has been deprecated. Use api/v2/users instead
     # @param user_id userId
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @option opts [String] :integration_presence_source Gets an integration presence for a user instead of their default.
     # @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
@@ -1902,10 +1929,11 @@
     # Get user profile
     # This api has been deprecated. Use api/v2/users instead
     # @param user_id userId
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @option opts [String] :integration_presence_source Gets an integration presence for a user instead of their default.
     # @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
@@ -1922,16 +1950,27 @@
       
       
       
       
       
+      
+      
+      
+      if opts[:'integration_presence_source'] && !['MicrosoftTeams', 'ZoomPhone'].include?(opts[:'integration_presence_source'])
+        fail ArgumentError, 'invalid value for "integration_presence_source", must be one of MicrosoftTeams, ZoomPhone'
+      end
+      
+      
+      
+      
       # 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']
+      query_params[:'integrationPresenceSource'] = opts[:'integration_presence_source'] if opts[:'integration_presence_source']
 
       # header parameters
       header_params = {}
 
       # HTTP header 'Accept' (if needed)
@@ -2679,10 +2718,11 @@
     # @option opts [Integer] :page_number Page number (default to 1)
     # @option opts [Array<String>] :id A list of user IDs to fetch by bulk
     # @option opts [Array<String>] :jabber_id A list of jabberIds to fetch by bulk (cannot be used with the \&quot;id\&quot; parameter)
     # @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] :integration_presence_source Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \&quot;expand\&quot;. When using this parameter the maximum number of users that can be returned is 10.
     # @option opts [String] :state Only list users of this state (default to active)
     # @return [UserEntityListing]
     def get_users(opts = {})
       data, _status_code, _headers = get_users_with_http_info(opts)
       return data
@@ -2695,10 +2735,11 @@
     # @option opts [Integer] :page_number Page number
     # @option opts [Array<String>] :id A list of user IDs to fetch by bulk
     # @option opts [Array<String>] :jabber_id A list of jabberIds to fetch by bulk (cannot be used with the \&quot;id\&quot; parameter)
     # @option opts [String] :sort_order Ascending or descending sort order
     # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @option opts [String] :integration_presence_source Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \&quot;expand\&quot;. When using this parameter the maximum number of users that can be returned is 10.
     # @option opts [String] :state Only list users of this state
     # @return [Array<(UserEntityListing, Fixnum, Hash)>] UserEntityListing data, response status code and response headers
     def get_users_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: UsersApi.get_users ..."
@@ -2745,10 +2786,20 @@
       
       
       
       
       
+      if opts[:'integration_presence_source'] && !['MicrosoftTeams', 'ZoomPhone'].include?(opts[:'integration_presence_source'])
+        fail ArgumentError, 'invalid value for "integration_presence_source", must be one of MicrosoftTeams, ZoomPhone'
+      end
+      
+      
+      
+      
+      
+      
+      
       if opts[:'state'] && !['active', 'inactive', 'deleted', 'any'].include?(opts[:'state'])
         fail ArgumentError, 'invalid value for "state", must be one of active, inactive, deleted, any'
       end
       
       
@@ -2763,10 +2814,11 @@
       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[:'jabberId'] = @api_client.build_collection_param(opts[:'jabber_id'], :multi) if opts[:'jabber_id']
       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[:'integrationPresenceSource'] = opts[:'integration_presence_source'] if opts[:'integration_presence_source']
       query_params[:'state'] = opts[:'state'] if opts[:'state']
 
       # header parameters
       header_params = {}
 
@@ -2800,20 +2852,22 @@
 
     # Get current user details.
     # This request is not valid when using the Client Credentials OAuth grant.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :expand Which fields, if any, to expand.
+    # @option opts [String] :integration_presence_source Get your presence for a given integration. This parameter will only be used when presence is provided as an \&quot;expand\&quot;.
     # @return [UserMe]
     def get_users_me(opts = {})
       data, _status_code, _headers = get_users_me_with_http_info(opts)
       return data
     end
 
     # Get current user details.
     # This request is not valid when using the Client Credentials OAuth grant.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :expand Which fields, if any, to expand.
+    # @option opts [String] :integration_presence_source Get your presence for a given integration. This parameter will only be used when presence is provided as an \&quot;expand\&quot;.
     # @return [Array<(UserMe, Fixnum, Hash)>] UserMe data, response status code and response headers
     def get_users_me_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: UsersApi.get_users_me ..."
       end
@@ -2822,16 +2876,27 @@
       
       
       
       
       
+      
+      
+      
+      if opts[:'integration_presence_source'] && !['MicrosoftTeams', 'ZoomPhone'].include?(opts[:'integration_presence_source'])
+        fail ArgumentError, 'invalid value for "integration_presence_source", must be one of MicrosoftTeams, ZoomPhone'
+      end
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/users/me".sub('{format}','json')
 
       # query parameters
       query_params = {}
       query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
+      query_params[:'integrationPresenceSource'] = opts[:'integration_presence_source'] if opts[:'integration_presence_source']
 
       # header parameters
       header_params = {}
 
       # HTTP header 'Accept' (if needed)
@@ -2865,10 +2930,11 @@
     # Search users using the q64 value returned from a previous search
     # 
     # @param q64 q64
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :expand expand
+    # @option opts [String] :integration_presence_source integrationPresenceSource
     # @return [UsersSearchResponse]
     def get_users_search(q64, opts = {})
       data, _status_code, _headers = get_users_search_with_http_info(q64, opts)
       return data
     end
@@ -2876,10 +2942,11 @@
     # Search users using the q64 value returned from a previous search
     # 
     # @param q64 q64
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :expand expand
+    # @option opts [String] :integration_presence_source integrationPresenceSource
     # @return [Array<(UsersSearchResponse, Fixnum, Hash)>] UsersSearchResponse data, response status code and response headers
     def get_users_search_with_http_info(q64, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: UsersApi.get_users_search ..."
       end
@@ -2896,16 +2963,27 @@
       
       
       
       
       
+      
+      
+      
+      if opts[:'integration_presence_source'] && !['MicrosoftTeams', 'ZoomPhone'].include?(opts[:'integration_presence_source'])
+        fail ArgumentError, 'invalid value for "integration_presence_source", must be one of MicrosoftTeams, ZoomPhone'
+      end
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/users/search".sub('{format}','json')
 
       # query parameters
       query_params = {}
       query_params[:'q64'] = q64
       query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
+      query_params[:'integrationPresenceSource'] = opts[:'integration_presence_source'] if opts[:'integration_presence_source']
 
       # header parameters
       header_params = {}
 
       # HTTP header 'Accept' (if needed)