Package com.mypurecloud.sdk.v2.api

Class NotificationsApi

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

  • Constructor Details

    • NotificationsApi

      public NotificationsApi()

    • NotificationsApi

      public NotificationsApi(ApiClient apiClient)

  • Method Details

    • deleteNotificationsChannelSubscriptions

      public void deleteNotificationsChannelSubscriptions(String channelId) throws IOException, ApiException
      Remove all subscriptions
      Parameters:
      channelId - Channel ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteNotificationsChannelSubscriptionsWithHttpInfo

      public ApiResponse<Void> deleteNotificationsChannelSubscriptionsWithHttpInfo(String channelId) throws IOException
      Remove all subscriptions
      Parameters:
      channelId - Channel ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteNotificationsChannelSubscriptions

      public void deleteNotificationsChannelSubscriptions(DeleteNotificationsChannelSubscriptionsRequest request) throws IOException, ApiException
      Remove all subscriptions
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteNotificationsChannelSubscriptions

      public ApiResponse<Void> deleteNotificationsChannelSubscriptions(ApiRequest<Void> request) throws IOException
      Remove all subscriptions
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getNotificationsAvailabletopics

      public AvailableTopicEntityListing getNotificationsAvailabletopics(List<String> expand, Boolean includePreview) throws IOException, ApiException
      Get available notification topics.
      Parameters:
      expand - Which fields, if any, to expand (optional)
      includePreview - Whether or not to include Preview topics (optional, default to true)
      Returns:
      AvailableTopicEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getNotificationsAvailabletopicsWithHttpInfo

      public ApiResponse<AvailableTopicEntityListing> getNotificationsAvailabletopicsWithHttpInfo(List<String> expand, Boolean includePreview) throws IOException
      Get available notification topics.
      Parameters:
      expand - Which fields, if any, to expand (optional)
      includePreview - Whether or not to include Preview topics (optional, default to true)
      Returns:
      AvailableTopicEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getNotificationsAvailabletopics

      public AvailableTopicEntityListing getNotificationsAvailabletopics(GetNotificationsAvailabletopicsRequest request) throws IOException, ApiException
      Get available notification topics.
      Parameters:
      request - The request object
      Returns:
      AvailableTopicEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getNotificationsAvailabletopics

      public ApiResponse<AvailableTopicEntityListing> getNotificationsAvailabletopics(ApiRequest<Void> request) throws IOException
      Get available notification topics.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getNotificationsChannelSubscriptions

      public ChannelTopicEntityListing getNotificationsChannelSubscriptions(String channelId) throws IOException, ApiException
      The list of all subscriptions for this channel
      Parameters:
      channelId - Channel ID (required)
      Returns:
      ChannelTopicEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getNotificationsChannelSubscriptionsWithHttpInfo

      public ApiResponse<ChannelTopicEntityListing> getNotificationsChannelSubscriptionsWithHttpInfo(String channelId) throws IOException
      The list of all subscriptions for this channel
      Parameters:
      channelId - Channel ID (required)
      Returns:
      ChannelTopicEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getNotificationsChannelSubscriptions

      public ChannelTopicEntityListing getNotificationsChannelSubscriptions(GetNotificationsChannelSubscriptionsRequest request) throws IOException, ApiException
      The list of all subscriptions for this channel
      Parameters:
      request - The request object
      Returns:
      ChannelTopicEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getNotificationsChannelSubscriptions

      public ApiResponse<ChannelTopicEntityListing> getNotificationsChannelSubscriptions(ApiRequest<Void> request) throws IOException
      The list of all subscriptions for this channel
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getNotificationsChannels

      public ChannelEntityListing getNotificationsChannels(String includechannels) throws IOException, ApiException
      The list of existing channels
      Parameters:
      includechannels - Show user's channels for this specific token or across all tokens for this user and app. Channel Ids for other access tokens will not be shown, but will be presented to show their existence. (optional, default to token)
      Returns:
      ChannelEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getNotificationsChannelsWithHttpInfo

      public ApiResponse<ChannelEntityListing> getNotificationsChannelsWithHttpInfo(String includechannels) throws IOException
      The list of existing channels
      Parameters:
      includechannels - Show user's channels for this specific token or across all tokens for this user and app. Channel Ids for other access tokens will not be shown, but will be presented to show their existence. (optional, default to token)
      Returns:
      ChannelEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getNotificationsChannels

      public ChannelEntityListing getNotificationsChannels(GetNotificationsChannelsRequest request) throws IOException, ApiException
      The list of existing channels
      Parameters:
      request - The request object
      Returns:
      ChannelEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getNotificationsChannels

      public ApiResponse<ChannelEntityListing> getNotificationsChannels(ApiRequest<Void> request) throws IOException
      The list of existing channels
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • headNotificationsChannel

      public void headNotificationsChannel(String channelId) throws IOException, ApiException
      Verify a channel still exists and is valid Returns a 200 OK if channel exists, and a 404 Not Found if it doesn't
      Parameters:
      channelId - Channel ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • headNotificationsChannelWithHttpInfo

      public ApiResponse<Void> headNotificationsChannelWithHttpInfo(String channelId) throws IOException
      Verify a channel still exists and is valid Returns a 200 OK if channel exists, and a 404 Not Found if it doesn't
      Parameters:
      channelId - Channel ID (required)
      Throws:
      IOException - if the request fails to be processed

    • headNotificationsChannel

      public void headNotificationsChannel(HeadNotificationsChannelRequest request) throws IOException, ApiException
      Verify a channel still exists and is valid Returns a 200 OK if channel exists, and a 404 Not Found if it doesn't
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • headNotificationsChannel

      public ApiResponse<Void> headNotificationsChannel(ApiRequest<Void> request) throws IOException
      Verify a channel still exists and is valid Returns a 200 OK if channel exists, and a 404 Not Found if it doesn't
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postNotificationsChannelSubscriptions

      public ChannelTopicEntityListing postNotificationsChannelSubscriptions(String channelId, List<ChannelTopic> body, Boolean ignoreErrors) throws IOException, ApiException
      Add a list of subscriptions to the existing list of subscriptions
      Parameters:
      channelId - Channel ID (required)
      body - Body (required)
      ignoreErrors - Optionally prevent throwing of errors for failed permissions checks. (optional, default to false)
      Returns:
      ChannelTopicEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postNotificationsChannelSubscriptionsWithHttpInfo

      public ApiResponse<ChannelTopicEntityListing> postNotificationsChannelSubscriptionsWithHttpInfo(String channelId, List<ChannelTopic> body, Boolean ignoreErrors) throws IOException
      Add a list of subscriptions to the existing list of subscriptions
      Parameters:
      channelId - Channel ID (required)
      body - Body (required)
      ignoreErrors - Optionally prevent throwing of errors for failed permissions checks. (optional, default to false)
      Returns:
      ChannelTopicEntityListing
      Throws:
      IOException - if the request fails to be processed

    • postNotificationsChannelSubscriptions

      public ChannelTopicEntityListing postNotificationsChannelSubscriptions(PostNotificationsChannelSubscriptionsRequest request) throws IOException, ApiException
      Add a list of subscriptions to the existing list of subscriptions
      Parameters:
      request - The request object
      Returns:
      ChannelTopicEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postNotificationsChannelSubscriptions

      public ApiResponse<ChannelTopicEntityListing> postNotificationsChannelSubscriptions(ApiRequest<List<ChannelTopic>> request) throws IOException
      Add a list of subscriptions to the existing list of subscriptions
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postNotificationsChannels

      public Channel postNotificationsChannels() throws IOException, ApiException
      Create a new channel There is a limit of 20 channels per user/app combination. Creating a 21st channel will remove the channel with oldest last used date. Channels without an active connection will be removed first.
      Returns:
      Channel
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postNotificationsChannelsWithHttpInfo

      public ApiResponse<Channel> postNotificationsChannelsWithHttpInfo() throws IOException
      Create a new channel There is a limit of 20 channels per user/app combination. Creating a 21st channel will remove the channel with oldest last used date. Channels without an active connection will be removed first.
      Returns:
      Channel
      Throws:
      IOException - if the request fails to be processed

    • postNotificationsChannels

      public Channel postNotificationsChannels(PostNotificationsChannelsRequest request) throws IOException, ApiException
      Create a new channel There is a limit of 20 channels per user/app combination. Creating a 21st channel will remove the channel with oldest last used date. Channels without an active connection will be removed first.
      Parameters:
      request - The request object
      Returns:
      Channel
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postNotificationsChannels

      public ApiResponse<Channel> postNotificationsChannels(ApiRequest<Void> request) throws IOException
      Create a new channel There is a limit of 20 channels per user/app combination. Creating a 21st channel will remove the channel with oldest last used date. Channels without an active connection will be removed first.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putNotificationsChannelSubscriptions

      public ChannelTopicEntityListing putNotificationsChannelSubscriptions(String channelId, List<ChannelTopic> body, Boolean ignoreErrors) throws IOException, ApiException
      Replace the current list of subscriptions with a new list.
      Parameters:
      channelId - Channel ID (required)
      body - Body (required)
      ignoreErrors - Optionally prevent throwing of errors for failed permissions checks. (optional, default to false)
      Returns:
      ChannelTopicEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putNotificationsChannelSubscriptionsWithHttpInfo

      public ApiResponse<ChannelTopicEntityListing> putNotificationsChannelSubscriptionsWithHttpInfo(String channelId, List<ChannelTopic> body, Boolean ignoreErrors) throws IOException
      Replace the current list of subscriptions with a new list.
      Parameters:
      channelId - Channel ID (required)
      body - Body (required)
      ignoreErrors - Optionally prevent throwing of errors for failed permissions checks. (optional, default to false)
      Returns:
      ChannelTopicEntityListing
      Throws:
      IOException - if the request fails to be processed

    • putNotificationsChannelSubscriptions

      public ChannelTopicEntityListing putNotificationsChannelSubscriptions(PutNotificationsChannelSubscriptionsRequest request) throws IOException, ApiException
      Replace the current list of subscriptions with a new list.
      Parameters:
      request - The request object
      Returns:
      ChannelTopicEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putNotificationsChannelSubscriptions

      public ApiResponse<ChannelTopicEntityListing> putNotificationsChannelSubscriptions(ApiRequest<List<ChannelTopic>> request) throws IOException
      Replace the current list of subscriptions with a new list.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed