Package com.mypurecloud.sdk.v2.api

Class PresenceApi

java.lang.Object
com.mypurecloud.sdk.v2.api.PresenceApi
public class PresenceApi extends Object

  • Constructor Details

    • PresenceApi

      public PresenceApi()

    • PresenceApi

      public PresenceApi(ApiClient apiClient)

  • Method Details

    • deletePresenceDefinition0

      public void deletePresenceDefinition0(String definitionId) throws IOException, ApiException
      Delete a Presence Definition
      Parameters:
      definitionId - Presence Definition ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deletePresenceDefinition0WithHttpInfo

      public ApiResponse<Void> deletePresenceDefinition0WithHttpInfo(String definitionId) throws IOException
      Delete a Presence Definition
      Parameters:
      definitionId - Presence Definition ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deletePresenceDefinition0

      public void deletePresenceDefinition0(DeletePresenceDefinition0Request request) throws IOException, ApiException
      Delete a Presence Definition
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deletePresenceDefinition0

      public ApiResponse<Void> deletePresenceDefinition0(ApiRequest<Void> request) throws IOException
      Delete a Presence Definition
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deletePresenceSource

      public void deletePresenceSource(String sourceId) throws IOException, ApiException
      Delete a Presence Source
      Parameters:
      sourceId - Presence Source ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deletePresenceSourceWithHttpInfo

      public ApiResponse<Void> deletePresenceSourceWithHttpInfo(String sourceId) throws IOException
      Delete a Presence Source
      Parameters:
      sourceId - Presence Source ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deletePresenceSource

      public void deletePresenceSource(DeletePresenceSourceRequest request) throws IOException, ApiException
      Delete a Presence Source
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deletePresenceSource

      public ApiResponse<Void> deletePresenceSource(ApiRequest<Void> request) throws IOException
      Delete a Presence Source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deletePresencedefinition

      public void deletePresencedefinition(String presenceId) throws IOException, ApiException
      Deprecated.
      Delete a Presence Definition. Apps should migrate to use DELETE /api/v2/presence/definitions/{definitionId} instead
      Parameters:
      presenceId - Organization Presence ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deletePresencedefinitionWithHttpInfo

      public ApiResponse<Void> deletePresencedefinitionWithHttpInfo(String presenceId) throws IOException
      Deprecated.
      Delete a Presence Definition. Apps should migrate to use DELETE /api/v2/presence/definitions/{definitionId} instead
      Parameters:
      presenceId - Organization Presence ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deletePresencedefinition

      public void deletePresencedefinition(DeletePresencedefinitionRequest request) throws IOException, ApiException
      Deprecated.
      Delete a Presence Definition. Apps should migrate to use DELETE /api/v2/presence/definitions/{definitionId} instead
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deletePresencedefinition

      public ApiResponse<Void> deletePresencedefinition(ApiRequest<Void> request) throws IOException
      Deprecated.
      Delete a Presence Definition. Apps should migrate to use DELETE /api/v2/presence/definitions/{definitionId} instead
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getPresenceDefinition0

      public OrganizationPresenceDefinition getPresenceDefinition0(String definitionId, String localeCode) throws IOException, ApiException
      Get a Presence Definition
      Parameters:
      definitionId - Presence Definition ID (required)
      localeCode - The locale code to fetch for the presence definition. Use ALL to fetch everything. (optional)
      Returns:
      OrganizationPresenceDefinition
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getPresenceDefinition0WithHttpInfo

      public ApiResponse<OrganizationPresenceDefinition> getPresenceDefinition0WithHttpInfo(String definitionId, String localeCode) throws IOException
      Get a Presence Definition
      Parameters:
      definitionId - Presence Definition ID (required)
      localeCode - The locale code to fetch for the presence definition. Use ALL to fetch everything. (optional)
      Returns:
      OrganizationPresenceDefinition
      Throws:
      IOException - if the request fails to be processed

    • getPresenceDefinition0

      public OrganizationPresenceDefinition getPresenceDefinition0(GetPresenceDefinition0Request request) throws IOException, ApiException
      Get a Presence Definition
      Parameters:
      request - The request object
      Returns:
      OrganizationPresenceDefinition
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getPresenceDefinition0

      public ApiResponse<OrganizationPresenceDefinition> getPresenceDefinition0(ApiRequest<Void> request) throws IOException
      Get a Presence Definition
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getPresenceDefinitions0

      public OrganizationPresenceDefinitionEntityListing getPresenceDefinitions0(String deactivated, List<String> divisionId, String localeCode) throws IOException, ApiException
      Get a list of Presence Definitions
      Parameters:
      deactivated - Deactivated query can be TRUE or FALSE (optional, default to false)
      divisionId - One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned. (optional)
      localeCode - The locale code to fetch for the presence definition. Use ALL to fetch everything. (optional)
      Returns:
      OrganizationPresenceDefinitionEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getPresenceDefinitions0WithHttpInfo

      public ApiResponse<OrganizationPresenceDefinitionEntityListing> getPresenceDefinitions0WithHttpInfo(String deactivated, List<String> divisionId, String localeCode) throws IOException
      Get a list of Presence Definitions
      Parameters:
      deactivated - Deactivated query can be TRUE or FALSE (optional, default to false)
      divisionId - One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned. (optional)
      localeCode - The locale code to fetch for the presence definition. Use ALL to fetch everything. (optional)
      Returns:
      OrganizationPresenceDefinitionEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getPresenceDefinitions0

      public OrganizationPresenceDefinitionEntityListing getPresenceDefinitions0(GetPresenceDefinitions0Request request) throws IOException, ApiException
      Get a list of Presence Definitions
      Parameters:
      request - The request object
      Returns:
      OrganizationPresenceDefinitionEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getPresenceDefinitions0

      public ApiResponse<OrganizationPresenceDefinitionEntityListing> getPresenceDefinitions0(ApiRequest<Void> request) throws IOException
      Get a list of Presence Definitions
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getPresenceSettings

      public PresenceSettings getPresenceSettings() throws IOException, ApiException
      Get the presence settings
      Returns:
      PresenceSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getPresenceSettingsWithHttpInfo

      public ApiResponse<PresenceSettings> getPresenceSettingsWithHttpInfo() throws IOException
      Get the presence settings
      Returns:
      PresenceSettings
      Throws:
      IOException - if the request fails to be processed

    • getPresenceSettings

      public PresenceSettings getPresenceSettings(GetPresenceSettingsRequest request) throws IOException, ApiException
      Get the presence settings
      Parameters:
      request - The request object
      Returns:
      PresenceSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getPresenceSettings

      public ApiResponse<PresenceSettings> getPresenceSettings(ApiRequest<Void> request) throws IOException
      Get the presence settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getPresenceSource

      public Source getPresenceSource(String sourceId) throws IOException, ApiException
      Get a Presence Source
      Parameters:
      sourceId - Presence Source ID (required)
      Returns:
      Source
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getPresenceSourceWithHttpInfo

      public ApiResponse<Source> getPresenceSourceWithHttpInfo(String sourceId) throws IOException
      Get a Presence Source
      Parameters:
      sourceId - Presence Source ID (required)
      Returns:
      Source
      Throws:
      IOException - if the request fails to be processed

    • getPresenceSource

      public Source getPresenceSource(GetPresenceSourceRequest request) throws IOException, ApiException
      Get a Presence Source
      Parameters:
      request - The request object
      Returns:
      Source
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getPresenceSource

      public ApiResponse<Source> getPresenceSource(ApiRequest<Void> request) throws IOException
      Get a Presence Source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getPresenceSources

      public SourceEntityListing getPresenceSources(String deactivated) throws IOException, ApiException
      Get a list of Presence Sources
      Parameters:
      deactivated - Deactivated query can be TRUE or FALSE (optional, default to false)
      Returns:
      SourceEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getPresenceSourcesWithHttpInfo

      public ApiResponse<SourceEntityListing> getPresenceSourcesWithHttpInfo(String deactivated) throws IOException
      Get a list of Presence Sources
      Parameters:
      deactivated - Deactivated query can be TRUE or FALSE (optional, default to false)
      Returns:
      SourceEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getPresenceSources

      public SourceEntityListing getPresenceSources(GetPresenceSourcesRequest request) throws IOException, ApiException
      Get a list of Presence Sources
      Parameters:
      request - The request object
      Returns:
      SourceEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getPresenceSources

      public ApiResponse<SourceEntityListing> getPresenceSources(ApiRequest<Void> request) throws IOException
      Get a list of Presence Sources
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getPresenceUserPrimarysource

      public UserPrimarySource getPresenceUserPrimarysource(String userId) throws IOException, ApiException
      Get a user's Primary Presence Source
      Parameters:
      userId - user ID (required)
      Returns:
      UserPrimarySource
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getPresenceUserPrimarysourceWithHttpInfo

      public ApiResponse<UserPrimarySource> getPresenceUserPrimarysourceWithHttpInfo(String userId) throws IOException
      Get a user's Primary Presence Source
      Parameters:
      userId - user ID (required)
      Returns:
      UserPrimarySource
      Throws:
      IOException - if the request fails to be processed

    • getPresenceUserPrimarysource

      public UserPrimarySource getPresenceUserPrimarysource(GetPresenceUserPrimarysourceRequest request) throws IOException, ApiException
      Get a user's Primary Presence Source
      Parameters:
      request - The request object
      Returns:
      UserPrimarySource
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getPresenceUserPrimarysource

      public ApiResponse<UserPrimarySource> getPresenceUserPrimarysource(ApiRequest<Void> request) throws IOException
      Get a user's Primary Presence Source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getPresencedefinition

      public OrganizationPresence getPresencedefinition(String presenceId, String localeCode) throws IOException, ApiException
      Deprecated.
      Get a Presence Definition. Apps should migrate to use GET /api/v2/presence/definitions/{definitionId} instead
      Parameters:
      presenceId - Organization Presence ID (required)
      localeCode - The locale code to fetch for the presence definition. Use ALL to fetch everything. (optional)
      Returns:
      OrganizationPresence
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getPresencedefinitionWithHttpInfo

      public ApiResponse<OrganizationPresence> getPresencedefinitionWithHttpInfo(String presenceId, String localeCode) throws IOException
      Deprecated.
      Get a Presence Definition. Apps should migrate to use GET /api/v2/presence/definitions/{definitionId} instead
      Parameters:
      presenceId - Organization Presence ID (required)
      localeCode - The locale code to fetch for the presence definition. Use ALL to fetch everything. (optional)
      Returns:
      OrganizationPresence
      Throws:
      IOException - if the request fails to be processed

    • getPresencedefinition

      public OrganizationPresence getPresencedefinition(GetPresencedefinitionRequest request) throws IOException, ApiException
      Deprecated.
      Get a Presence Definition. Apps should migrate to use GET /api/v2/presence/definitions/{definitionId} instead
      Parameters:
      request - The request object
      Returns:
      OrganizationPresence
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getPresencedefinition

      public ApiResponse<OrganizationPresence> getPresencedefinition(ApiRequest<Void> request) throws IOException
      Deprecated.
      Get a Presence Definition. Apps should migrate to use GET /api/v2/presence/definitions/{definitionId} instead
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getPresencedefinitions

      public OrganizationPresenceEntityListing getPresencedefinitions(Integer pageNumber, Integer pageSize, String deleted, String localeCode) throws IOException, ApiException
      Deprecated.
      Get an Organization's list of Presence Definitions. Apps should migrate to use GET /api/v2/presence/definitions instead
      Parameters:
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      deleted - Deleted query can be TRUE, FALSE or ALL (optional, default to false)
      localeCode - The locale code to fetch for each presence definition. Use ALL to fetch everything. (optional)
      Returns:
      OrganizationPresenceEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getPresencedefinitionsWithHttpInfo

      public ApiResponse<OrganizationPresenceEntityListing> getPresencedefinitionsWithHttpInfo(Integer pageNumber, Integer pageSize, String deleted, String localeCode) throws IOException
      Deprecated.
      Get an Organization's list of Presence Definitions. Apps should migrate to use GET /api/v2/presence/definitions instead
      Parameters:
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      deleted - Deleted query can be TRUE, FALSE or ALL (optional, default to false)
      localeCode - The locale code to fetch for each presence definition. Use ALL to fetch everything. (optional)
      Returns:
      OrganizationPresenceEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getPresencedefinitions

      public OrganizationPresenceEntityListing getPresencedefinitions(GetPresencedefinitionsRequest request) throws IOException, ApiException
      Deprecated.
      Get an Organization's list of Presence Definitions. Apps should migrate to use GET /api/v2/presence/definitions instead
      Parameters:
      request - The request object
      Returns:
      OrganizationPresenceEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getPresencedefinitions

      public ApiResponse<OrganizationPresenceEntityListing> getPresencedefinitions(ApiRequest<Void> request) throws IOException
      Deprecated.
      Get an Organization's list of Presence Definitions. Apps should migrate to use GET /api/v2/presence/definitions instead
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getSystempresences

      public List<SystemPresence> getSystempresences() throws IOException, ApiException
      Get the list of SystemPresences
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getSystempresencesWithHttpInfo

      public ApiResponse<List<SystemPresence>> getSystempresencesWithHttpInfo() throws IOException
      Get the list of SystemPresences
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed

    • getSystempresences

      public List<SystemPresence> getSystempresences(GetSystempresencesRequest request) throws IOException, ApiException
      Get the list of SystemPresences
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getSystempresences

      public ApiResponse<List<SystemPresence>> getSystempresences(ApiRequest<Void> request) throws IOException
      Get the list of SystemPresences
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getUserPresence

      public UserPresence getUserPresence(String userId, String sourceId) throws IOException, ApiException
      Get a user's Presence Get a user's presence for the specified source that is not specifically listed. Used to support custom presence sources. This endpoint does not support registered presence sources.
      Parameters:
      userId - user Id (required)
      sourceId - Presence source ID (required)
      Returns:
      UserPresence
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUserPresenceWithHttpInfo

      public ApiResponse<UserPresence> getUserPresenceWithHttpInfo(String userId, String sourceId) throws IOException
      Get a user's Presence Get a user's presence for the specified source that is not specifically listed. Used to support custom presence sources. This endpoint does not support registered presence sources.
      Parameters:
      userId - user Id (required)
      sourceId - Presence source ID (required)
      Returns:
      UserPresence
      Throws:
      IOException - if the request fails to be processed

    • getUserPresence

      public UserPresence getUserPresence(GetUserPresenceRequest request) throws IOException, ApiException
      Get a user's Presence Get a user's presence for the specified source that is not specifically listed. Used to support custom presence sources. This endpoint does not support registered presence sources.
      Parameters:
      request - The request object
      Returns:
      UserPresence
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUserPresence

      public ApiResponse<UserPresence> getUserPresence(ApiRequest<Void> request) throws IOException
      Get a user's Presence Get a user's presence for the specified source that is not specifically listed. Used to support custom presence sources. This endpoint does not support registered presence sources.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getUserPresencesPurecloud

      public UserPresence getUserPresencesPurecloud(String userId) throws IOException, ApiException
      Get a user's Genesys Cloud presence. Get the default Genesys Cloud user presence source PURECLOUD
      Parameters:
      userId - user Id (required)
      Returns:
      UserPresence
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUserPresencesPurecloudWithHttpInfo

      public ApiResponse<UserPresence> getUserPresencesPurecloudWithHttpInfo(String userId) throws IOException
      Get a user's Genesys Cloud presence. Get the default Genesys Cloud user presence source PURECLOUD
      Parameters:
      userId - user Id (required)
      Returns:
      UserPresence
      Throws:
      IOException - if the request fails to be processed

    • getUserPresencesPurecloud

      public UserPresence getUserPresencesPurecloud(GetUserPresencesPurecloudRequest request) throws IOException, ApiException
      Get a user's Genesys Cloud presence. Get the default Genesys Cloud user presence source PURECLOUD
      Parameters:
      request - The request object
      Returns:
      UserPresence
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUserPresencesPurecloud

      public ApiResponse<UserPresence> getUserPresencesPurecloud(ApiRequest<Void> request) throws IOException
      Get a user's Genesys Cloud presence. Get the default Genesys Cloud user presence source PURECLOUD
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getUsersPresenceBulk

      public List<UcUserPresence> getUsersPresenceBulk(String sourceId, List<String> id) throws IOException, ApiException
      Get bulk user presences for a single presence source
      Parameters:
      sourceId - The requested presence source ID. (required)
      id - A comma separated list of user IDs to fetch their presence status in bulk. Limit 50. (optional)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsersPresenceBulkWithHttpInfo

      public ApiResponse<List<UcUserPresence>> getUsersPresenceBulkWithHttpInfo(String sourceId, List<String> id) throws IOException
      Get bulk user presences for a single presence source
      Parameters:
      sourceId - The requested presence source ID. (required)
      id - A comma separated list of user IDs to fetch their presence status in bulk. Limit 50. (optional)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed

    • getUsersPresenceBulk

      public List<UcUserPresence> getUsersPresenceBulk(GetUsersPresenceBulkRequest request) throws IOException, ApiException
      Get bulk user presences for a single presence source
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsersPresenceBulk

      public ApiResponse<List<UcUserPresence>> getUsersPresenceBulk(ApiRequest<Void> request) throws IOException
      Get bulk user presences for a single presence source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getUsersPresencesPurecloudBulk

      public List<UcUserPresence> getUsersPresencesPurecloudBulk(List<String> id) throws IOException, ApiException
      Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source
      Parameters:
      id - A comma separated list of user IDs to fetch their presence status in bulk. Limit 50. (optional)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsersPresencesPurecloudBulkWithHttpInfo

      public ApiResponse<List<UcUserPresence>> getUsersPresencesPurecloudBulkWithHttpInfo(List<String> id) throws IOException
      Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source
      Parameters:
      id - A comma separated list of user IDs to fetch their presence status in bulk. Limit 50. (optional)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed

    • getUsersPresencesPurecloudBulk

      public List<UcUserPresence> getUsersPresencesPurecloudBulk(GetUsersPresencesPurecloudBulkRequest request) throws IOException, ApiException
      Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsersPresencesPurecloudBulk

      public ApiResponse<List<UcUserPresence>> getUsersPresencesPurecloudBulk(ApiRequest<Void> request) throws IOException
      Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchUserPresence

      public UserPresence patchUserPresence(String userId, String sourceId, UserPresence body) throws IOException, ApiException
      Patch a user's Presence Patch a user's presence for the specified source that is not specifically listed. This endpoint does not support registered presence sources. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
      Parameters:
      userId - user Id (required)
      sourceId - Presence source ID (required)
      body - User presence (required)
      Returns:
      UserPresence
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchUserPresenceWithHttpInfo

      public ApiResponse<UserPresence> patchUserPresenceWithHttpInfo(String userId, String sourceId, UserPresence body) throws IOException
      Patch a user's Presence Patch a user's presence for the specified source that is not specifically listed. This endpoint does not support registered presence sources. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
      Parameters:
      userId - user Id (required)
      sourceId - Presence source ID (required)
      body - User presence (required)
      Returns:
      UserPresence
      Throws:
      IOException - if the request fails to be processed

    • patchUserPresence

      public UserPresence patchUserPresence(PatchUserPresenceRequest request) throws IOException, ApiException
      Patch a user's Presence Patch a user's presence for the specified source that is not specifically listed. This endpoint does not support registered presence sources. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
      Parameters:
      request - The request object
      Returns:
      UserPresence
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchUserPresence

      public ApiResponse<UserPresence> patchUserPresence(ApiRequest<UserPresence> request) throws IOException
      Patch a user's Presence Patch a user's presence for the specified source that is not specifically listed. This endpoint does not support registered presence sources. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchUserPresencesPurecloud

      public UserPresence patchUserPresencesPurecloud(String userId, UserPresence body) throws IOException, ApiException
      Patch a Genesys Cloud user's presence The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the PURECLOUD source as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
      Parameters:
      userId - user Id (required)
      body - User presence (required)
      Returns:
      UserPresence
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchUserPresencesPurecloudWithHttpInfo

      public ApiResponse<UserPresence> patchUserPresencesPurecloudWithHttpInfo(String userId, UserPresence body) throws IOException
      Patch a Genesys Cloud user's presence The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the PURECLOUD source as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
      Parameters:
      userId - user Id (required)
      body - User presence (required)
      Returns:
      UserPresence
      Throws:
      IOException - if the request fails to be processed

    • patchUserPresencesPurecloud

      public UserPresence patchUserPresencesPurecloud(PatchUserPresencesPurecloudRequest request) throws IOException, ApiException
      Patch a Genesys Cloud user's presence The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the PURECLOUD source as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
      Parameters:
      request - The request object
      Returns:
      UserPresence
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchUserPresencesPurecloud

      public ApiResponse<UserPresence> patchUserPresencesPurecloud(ApiRequest<UserPresence> request) throws IOException
      Patch a Genesys Cloud user's presence The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the PURECLOUD source as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postPresenceDefinitions0

      public OrganizationPresenceDefinition postPresenceDefinitions0(OrganizationPresenceDefinition body) throws IOException, ApiException
      Create a Presence Definition
      Parameters:
      body - The Presence Definition to create (required)
      Returns:
      OrganizationPresenceDefinition
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postPresenceDefinitions0WithHttpInfo

      public ApiResponse<OrganizationPresenceDefinition> postPresenceDefinitions0WithHttpInfo(OrganizationPresenceDefinition body) throws IOException
      Create a Presence Definition
      Parameters:
      body - The Presence Definition to create (required)
      Returns:
      OrganizationPresenceDefinition
      Throws:
      IOException - if the request fails to be processed

    • postPresenceDefinitions0

      public OrganizationPresenceDefinition postPresenceDefinitions0(PostPresenceDefinitions0Request request) throws IOException, ApiException
      Create a Presence Definition
      Parameters:
      request - The request object
      Returns:
      OrganizationPresenceDefinition
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postPresenceDefinitions0

      public ApiResponse<OrganizationPresenceDefinition> postPresenceDefinitions0(ApiRequest<OrganizationPresenceDefinition> request) throws IOException
      Create a Presence Definition
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postPresenceSources

      public Source postPresenceSources(Source body) throws IOException, ApiException
      Create a Presence Source
      Parameters:
      body - The Presence Source to create (required)
      Returns:
      Source
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postPresenceSourcesWithHttpInfo

      public ApiResponse<Source> postPresenceSourcesWithHttpInfo(Source body) throws IOException
      Create a Presence Source
      Parameters:
      body - The Presence Source to create (required)
      Returns:
      Source
      Throws:
      IOException - if the request fails to be processed

    • postPresenceSources

      public Source postPresenceSources(PostPresenceSourcesRequest request) throws IOException, ApiException
      Create a Presence Source
      Parameters:
      request - The request object
      Returns:
      Source
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postPresenceSources

      public ApiResponse<Source> postPresenceSources(ApiRequest<Source> request) throws IOException
      Create a Presence Source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postPresencedefinitions

      public OrganizationPresence postPresencedefinitions(OrganizationPresence body) throws IOException, ApiException
      Deprecated.
      Create a Presence Definition. Apps should migrate to use POST /api/v2/presence/definitions instead
      Parameters:
      body - The Presence Definition to create (required)
      Returns:
      OrganizationPresence
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postPresencedefinitionsWithHttpInfo

      public ApiResponse<OrganizationPresence> postPresencedefinitionsWithHttpInfo(OrganizationPresence body) throws IOException
      Deprecated.
      Create a Presence Definition. Apps should migrate to use POST /api/v2/presence/definitions instead
      Parameters:
      body - The Presence Definition to create (required)
      Returns:
      OrganizationPresence
      Throws:
      IOException - if the request fails to be processed

    • postPresencedefinitions

      public OrganizationPresence postPresencedefinitions(PostPresencedefinitionsRequest request) throws IOException, ApiException
      Deprecated.
      Create a Presence Definition. Apps should migrate to use POST /api/v2/presence/definitions instead
      Parameters:
      request - The request object
      Returns:
      OrganizationPresence
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postPresencedefinitions

      public ApiResponse<OrganizationPresence> postPresencedefinitions(ApiRequest<OrganizationPresence> request) throws IOException
      Deprecated.
      Create a Presence Definition. Apps should migrate to use POST /api/v2/presence/definitions instead
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putPresenceDefinition0

      public OrganizationPresenceDefinition putPresenceDefinition0(String definitionId, OrganizationPresenceDefinition body) throws IOException, ApiException
      Update a Presence Definition
      Parameters:
      definitionId - Presence Definition ID (required)
      body - The updated Presence Definition (required)
      Returns:
      OrganizationPresenceDefinition
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putPresenceDefinition0WithHttpInfo

      public ApiResponse<OrganizationPresenceDefinition> putPresenceDefinition0WithHttpInfo(String definitionId, OrganizationPresenceDefinition body) throws IOException
      Update a Presence Definition
      Parameters:
      definitionId - Presence Definition ID (required)
      body - The updated Presence Definition (required)
      Returns:
      OrganizationPresenceDefinition
      Throws:
      IOException - if the request fails to be processed

    • putPresenceDefinition0

      public OrganizationPresenceDefinition putPresenceDefinition0(PutPresenceDefinition0Request request) throws IOException, ApiException
      Update a Presence Definition
      Parameters:
      request - The request object
      Returns:
      OrganizationPresenceDefinition
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putPresenceDefinition0

      public ApiResponse<OrganizationPresenceDefinition> putPresenceDefinition0(ApiRequest<OrganizationPresenceDefinition> request) throws IOException
      Update a Presence Definition
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putPresenceSettings

      public PresenceSettings putPresenceSettings(PresenceSettings body) throws IOException, ApiException
      Update the presence settings
      Parameters:
      body - Presence Settings (required)
      Returns:
      PresenceSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putPresenceSettingsWithHttpInfo

      public ApiResponse<PresenceSettings> putPresenceSettingsWithHttpInfo(PresenceSettings body) throws IOException
      Update the presence settings
      Parameters:
      body - Presence Settings (required)
      Returns:
      PresenceSettings
      Throws:
      IOException - if the request fails to be processed

    • putPresenceSettings

      public PresenceSettings putPresenceSettings(PutPresenceSettingsRequest request) throws IOException, ApiException
      Update the presence settings
      Parameters:
      request - The request object
      Returns:
      PresenceSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putPresenceSettings

      public ApiResponse<PresenceSettings> putPresenceSettings(ApiRequest<PresenceSettings> request) throws IOException
      Update the presence settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putPresenceSource

      public Source putPresenceSource(String sourceId, Source body) throws IOException, ApiException
      Update a Presence Source
      Parameters:
      sourceId - Presence Source ID (required)
      body - The updated Presence Source (required)
      Returns:
      Source
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putPresenceSourceWithHttpInfo

      public ApiResponse<Source> putPresenceSourceWithHttpInfo(String sourceId, Source body) throws IOException
      Update a Presence Source
      Parameters:
      sourceId - Presence Source ID (required)
      body - The updated Presence Source (required)
      Returns:
      Source
      Throws:
      IOException - if the request fails to be processed

    • putPresenceSource

      public Source putPresenceSource(PutPresenceSourceRequest request) throws IOException, ApiException
      Update a Presence Source
      Parameters:
      request - The request object
      Returns:
      Source
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putPresenceSource

      public ApiResponse<Source> putPresenceSource(ApiRequest<Source> request) throws IOException
      Update a Presence Source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putPresenceUserPrimarysource

      public UserPrimarySource putPresenceUserPrimarysource(String userId, UserPrimarySource body) throws IOException, ApiException
      Update a user's Primary Presence Source
      Parameters:
      userId - user ID (required)
      body - Primary Source (required)
      Returns:
      UserPrimarySource
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putPresenceUserPrimarysourceWithHttpInfo

      public ApiResponse<UserPrimarySource> putPresenceUserPrimarysourceWithHttpInfo(String userId, UserPrimarySource body) throws IOException
      Update a user's Primary Presence Source
      Parameters:
      userId - user ID (required)
      body - Primary Source (required)
      Returns:
      UserPrimarySource
      Throws:
      IOException - if the request fails to be processed

    • putPresenceUserPrimarysource

      public UserPrimarySource putPresenceUserPrimarysource(PutPresenceUserPrimarysourceRequest request) throws IOException, ApiException
      Update a user's Primary Presence Source
      Parameters:
      request - The request object
      Returns:
      UserPrimarySource
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putPresenceUserPrimarysource

      public ApiResponse<UserPrimarySource> putPresenceUserPrimarysource(ApiRequest<UserPrimarySource> request) throws IOException
      Update a user's Primary Presence Source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putPresencedefinition

      public OrganizationPresence putPresencedefinition(String presenceId, OrganizationPresence body) throws IOException, ApiException
      Deprecated.
      Update a Presence Definition. Apps should migrate to use PUT /api/v2/presence/definitions/{definitionId} instead)
      Parameters:
      presenceId - Organization Presence ID (required)
      body - The OrganizationPresence to update (required)
      Returns:
      OrganizationPresence
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putPresencedefinitionWithHttpInfo

      public ApiResponse<OrganizationPresence> putPresencedefinitionWithHttpInfo(String presenceId, OrganizationPresence body) throws IOException
      Deprecated.
      Update a Presence Definition. Apps should migrate to use PUT /api/v2/presence/definitions/{definitionId} instead)
      Parameters:
      presenceId - Organization Presence ID (required)
      body - The OrganizationPresence to update (required)
      Returns:
      OrganizationPresence
      Throws:
      IOException - if the request fails to be processed

    • putPresencedefinition

      public OrganizationPresence putPresencedefinition(PutPresencedefinitionRequest request) throws IOException, ApiException
      Deprecated.
      Update a Presence Definition. Apps should migrate to use PUT /api/v2/presence/definitions/{definitionId} instead)
      Parameters:
      request - The request object
      Returns:
      OrganizationPresence
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putPresencedefinition

      public ApiResponse<OrganizationPresence> putPresencedefinition(ApiRequest<OrganizationPresence> request) throws IOException
      Deprecated.
      Update a Presence Definition. Apps should migrate to use PUT /api/v2/presence/definitions/{definitionId} instead)
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putUsersPresencesBulk

      public List<UserPresence> putUsersPresencesBulk(List<MutableUserPresence> body) throws IOException, ApiException
      Update bulk user Presences
      Parameters:
      body - List of User presences (required)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putUsersPresencesBulkWithHttpInfo

      public ApiResponse<List<UserPresence>> putUsersPresencesBulkWithHttpInfo(List<MutableUserPresence> body) throws IOException
      Update bulk user Presences
      Parameters:
      body - List of User presences (required)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed

    • putUsersPresencesBulk

      public List<UserPresence> putUsersPresencesBulk(PutUsersPresencesBulkRequest request) throws IOException, ApiException
      Update bulk user Presences
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putUsersPresencesBulk

      public ApiResponse<List<UserPresence>> putUsersPresencesBulk(ApiRequest<List<MutableUserPresence>> request) throws IOException
      Update bulk user Presences
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed