Package com.mypurecloud.sdk.v2.api

Class MessagingApi

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

  • Constructor Details

    • MessagingApi

      public MessagingApi()

    • MessagingApi

      public MessagingApi(ApiClient apiClient)

  • Method Details

    • deleteMessagingSetting

      public void deleteMessagingSetting(String messageSettingId) throws IOException, ApiException
      Deprecated.
      Delete a messaging setting
      Parameters:
      messageSettingId - Message Settings ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteMessagingSettingWithHttpInfo

      public ApiResponse<Void> deleteMessagingSettingWithHttpInfo(String messageSettingId) throws IOException
      Deprecated.
      Delete a messaging setting
      Parameters:
      messageSettingId - Message Settings ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteMessagingSetting

      public void deleteMessagingSetting(DeleteMessagingSettingRequest request) throws IOException, ApiException
      Deprecated.
      Delete a messaging setting
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteMessagingSetting

      public ApiResponse<Void> deleteMessagingSetting(ApiRequest<Void> request) throws IOException
      Deprecated.
      Delete a messaging setting
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteMessagingSettingsDefault

      public void deleteMessagingSettingsDefault() throws IOException, ApiException
      Deprecated.
      Delete the organization's default setting, a global default will be applied to integrations without settings When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteMessagingSettingsDefaultWithHttpInfo

      public ApiResponse<Void> deleteMessagingSettingsDefaultWithHttpInfo() throws IOException
      Deprecated.
      Delete the organization's default setting, a global default will be applied to integrations without settings When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.
      Throws:
      IOException - if the request fails to be processed

    • deleteMessagingSettingsDefault

      public void deleteMessagingSettingsDefault(DeleteMessagingSettingsDefaultRequest request) throws IOException, ApiException
      Deprecated.
      Delete the organization's default setting, a global default will be applied to integrations without settings When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteMessagingSettingsDefault

      public ApiResponse<Void> deleteMessagingSettingsDefault(ApiRequest<Void> request) throws IOException
      Deprecated.
      Delete the organization's default setting, a global default will be applied to integrations without settings When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteMessagingSupportedcontentSupportedContentId

      public void deleteMessagingSupportedcontentSupportedContentId(String supportedContentId) throws IOException, ApiException
      Deprecated.
      Delete a supported content profile Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
      Parameters:
      supportedContentId - Supported Content ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteMessagingSupportedcontentSupportedContentIdWithHttpInfo

      public ApiResponse<Void> deleteMessagingSupportedcontentSupportedContentIdWithHttpInfo(String supportedContentId) throws IOException
      Deprecated.
      Delete a supported content profile Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
      Parameters:
      supportedContentId - Supported Content ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteMessagingSupportedcontentSupportedContentId

      public void deleteMessagingSupportedcontentSupportedContentId(DeleteMessagingSupportedcontentSupportedContentIdRequest request) throws IOException, ApiException
      Deprecated.
      Delete a supported content profile Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteMessagingSupportedcontentSupportedContentId

      public ApiResponse<Void> deleteMessagingSupportedcontentSupportedContentId(ApiRequest<Void> request) throws IOException
      Deprecated.
      Delete a supported content profile Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getMessagingSetting

      public MessagingSetting getMessagingSetting(String messageSettingId) throws IOException, ApiException
      Deprecated.
      Get a messaging setting
      Parameters:
      messageSettingId - Message Settings ID (required)
      Returns:
      MessagingSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getMessagingSettingWithHttpInfo

      public ApiResponse<MessagingSetting> getMessagingSettingWithHttpInfo(String messageSettingId) throws IOException
      Deprecated.
      Get a messaging setting
      Parameters:
      messageSettingId - Message Settings ID (required)
      Returns:
      MessagingSetting
      Throws:
      IOException - if the request fails to be processed

    • getMessagingSetting

      public MessagingSetting getMessagingSetting(GetMessagingSettingRequest request) throws IOException, ApiException
      Deprecated.
      Get a messaging setting
      Parameters:
      request - The request object
      Returns:
      MessagingSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getMessagingSetting

      public ApiResponse<MessagingSetting> getMessagingSetting(ApiRequest<Void> request) throws IOException
      Deprecated.
      Get a messaging setting
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getMessagingSettings

      public MessagingConfigListing getMessagingSettings(Integer pageSize, Integer pageNumber) throws IOException, ApiException
      Deprecated.
      Get a list of messaging settings
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      MessagingConfigListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getMessagingSettingsWithHttpInfo

      public ApiResponse<MessagingConfigListing> getMessagingSettingsWithHttpInfo(Integer pageSize, Integer pageNumber) throws IOException
      Deprecated.
      Get a list of messaging settings
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      MessagingConfigListing
      Throws:
      IOException - if the request fails to be processed

    • getMessagingSettings

      public MessagingConfigListing getMessagingSettings(GetMessagingSettingsRequest request) throws IOException, ApiException
      Deprecated.
      Get a list of messaging settings
      Parameters:
      request - The request object
      Returns:
      MessagingConfigListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getMessagingSettings

      public ApiResponse<MessagingConfigListing> getMessagingSettings(ApiRequest<Void> request) throws IOException
      Deprecated.
      Get a list of messaging settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getMessagingSettingsDefault

      public MessagingSetting getMessagingSettingsDefault() throws IOException, ApiException
      Deprecated.
      Get the organization's default settings that will be used as the default when creating an integration. When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.
      Returns:
      MessagingSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getMessagingSettingsDefaultWithHttpInfo

      public ApiResponse<MessagingSetting> getMessagingSettingsDefaultWithHttpInfo() throws IOException
      Deprecated.
      Get the organization's default settings that will be used as the default when creating an integration. When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.
      Returns:
      MessagingSetting
      Throws:
      IOException - if the request fails to be processed

    • getMessagingSettingsDefault

      public MessagingSetting getMessagingSettingsDefault(GetMessagingSettingsDefaultRequest request) throws IOException, ApiException
      Deprecated.
      Get the organization's default settings that will be used as the default when creating an integration. When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.
      Parameters:
      request - The request object
      Returns:
      MessagingSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getMessagingSettingsDefault

      public ApiResponse<MessagingSetting> getMessagingSettingsDefault(ApiRequest<Void> request) throws IOException
      Deprecated.
      Get the organization's default settings that will be used as the default when creating an integration. When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getMessagingSupportedcontent

      public SupportedContentListing getMessagingSupportedcontent(Integer pageSize, Integer pageNumber) throws IOException, ApiException
      Deprecated.
      Get a list of Supported Content profiles Deprecated - use GET /api/v2/conversations/messaging/supportedcontent as replacement
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      SupportedContentListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getMessagingSupportedcontentWithHttpInfo

      public ApiResponse<SupportedContentListing> getMessagingSupportedcontentWithHttpInfo(Integer pageSize, Integer pageNumber) throws IOException
      Deprecated.
      Get a list of Supported Content profiles Deprecated - use GET /api/v2/conversations/messaging/supportedcontent as replacement
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      SupportedContentListing
      Throws:
      IOException - if the request fails to be processed

    • getMessagingSupportedcontent

      public SupportedContentListing getMessagingSupportedcontent(GetMessagingSupportedcontentRequest request) throws IOException, ApiException
      Deprecated.
      Get a list of Supported Content profiles Deprecated - use GET /api/v2/conversations/messaging/supportedcontent as replacement
      Parameters:
      request - The request object
      Returns:
      SupportedContentListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getMessagingSupportedcontent

      public ApiResponse<SupportedContentListing> getMessagingSupportedcontent(ApiRequest<Void> request) throws IOException
      Deprecated.
      Get a list of Supported Content profiles Deprecated - use GET /api/v2/conversations/messaging/supportedcontent as replacement
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getMessagingSupportedcontentSupportedContentId

      public SupportedContent getMessagingSupportedcontentSupportedContentId(String supportedContentId) throws IOException, ApiException
      Deprecated.
      Get a supported content profile Deprecated - use GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
      Parameters:
      supportedContentId - Supported Content ID (required)
      Returns:
      SupportedContent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getMessagingSupportedcontentSupportedContentIdWithHttpInfo

      public ApiResponse<SupportedContent> getMessagingSupportedcontentSupportedContentIdWithHttpInfo(String supportedContentId) throws IOException
      Deprecated.
      Get a supported content profile Deprecated - use GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
      Parameters:
      supportedContentId - Supported Content ID (required)
      Returns:
      SupportedContent
      Throws:
      IOException - if the request fails to be processed

    • getMessagingSupportedcontentSupportedContentId

      public SupportedContent getMessagingSupportedcontentSupportedContentId(GetMessagingSupportedcontentSupportedContentIdRequest request) throws IOException, ApiException
      Deprecated.
      Get a supported content profile Deprecated - use GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
      Parameters:
      request - The request object
      Returns:
      SupportedContent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getMessagingSupportedcontentSupportedContentId

      public ApiResponse<SupportedContent> getMessagingSupportedcontentSupportedContentId(ApiRequest<Void> request) throws IOException
      Deprecated.
      Get a supported content profile Deprecated - use GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchMessagingSetting

      public MessagingSetting patchMessagingSetting(String messageSettingId, MessagingSettingRequest body) throws IOException, ApiException
      Deprecated.
      Update a messaging setting
      Parameters:
      messageSettingId - Message Settings ID (required)
      body - MessagingSetting (required)
      Returns:
      MessagingSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchMessagingSettingWithHttpInfo

      public ApiResponse<MessagingSetting> patchMessagingSettingWithHttpInfo(String messageSettingId, MessagingSettingRequest body) throws IOException
      Deprecated.
      Update a messaging setting
      Parameters:
      messageSettingId - Message Settings ID (required)
      body - MessagingSetting (required)
      Returns:
      MessagingSetting
      Throws:
      IOException - if the request fails to be processed

    • patchMessagingSetting

      public MessagingSetting patchMessagingSetting(PatchMessagingSettingRequest request) throws IOException, ApiException
      Deprecated.
      Update a messaging setting
      Parameters:
      request - The request object
      Returns:
      MessagingSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchMessagingSetting

      public ApiResponse<MessagingSetting> patchMessagingSetting(ApiRequest<MessagingSettingRequest> request) throws IOException
      Deprecated.
      Update a messaging setting
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchMessagingSupportedcontentSupportedContentId

      public SupportedContent patchMessagingSupportedcontentSupportedContentId(String supportedContentId, SupportedContent body) throws IOException, ApiException
      Deprecated.
      Update a supported content profile Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
      Parameters:
      supportedContentId - Supported Content ID (required)
      body - SupportedContent (required)
      Returns:
      SupportedContent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchMessagingSupportedcontentSupportedContentIdWithHttpInfo

      public ApiResponse<SupportedContent> patchMessagingSupportedcontentSupportedContentIdWithHttpInfo(String supportedContentId, SupportedContent body) throws IOException
      Deprecated.
      Update a supported content profile Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
      Parameters:
      supportedContentId - Supported Content ID (required)
      body - SupportedContent (required)
      Returns:
      SupportedContent
      Throws:
      IOException - if the request fails to be processed

    • patchMessagingSupportedcontentSupportedContentId

      public SupportedContent patchMessagingSupportedcontentSupportedContentId(PatchMessagingSupportedcontentSupportedContentIdRequest request) throws IOException, ApiException
      Deprecated.
      Update a supported content profile Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
      Parameters:
      request - The request object
      Returns:
      SupportedContent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchMessagingSupportedcontentSupportedContentId

      public ApiResponse<SupportedContent> patchMessagingSupportedcontentSupportedContentId(ApiRequest<SupportedContent> request) throws IOException
      Deprecated.
      Update a supported content profile Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postMessagingSettings

      public MessagingSetting postMessagingSettings(MessagingSettingRequest body) throws IOException, ApiException
      Deprecated.
      Create a messaging setting
      Parameters:
      body - MessagingSetting (required)
      Returns:
      MessagingSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postMessagingSettingsWithHttpInfo

      public ApiResponse<MessagingSetting> postMessagingSettingsWithHttpInfo(MessagingSettingRequest body) throws IOException
      Deprecated.
      Create a messaging setting
      Parameters:
      body - MessagingSetting (required)
      Returns:
      MessagingSetting
      Throws:
      IOException - if the request fails to be processed

    • postMessagingSettings

      public MessagingSetting postMessagingSettings(PostMessagingSettingsRequest request) throws IOException, ApiException
      Deprecated.
      Create a messaging setting
      Parameters:
      request - The request object
      Returns:
      MessagingSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postMessagingSettings

      public ApiResponse<MessagingSetting> postMessagingSettings(ApiRequest<MessagingSettingRequest> request) throws IOException
      Deprecated.
      Create a messaging setting
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postMessagingSupportedcontent

      public SupportedContent postMessagingSupportedcontent(SupportedContent body) throws IOException, ApiException
      Deprecated.
      Create a Supported Content profile Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement
      Parameters:
      body - SupportedContent (required)
      Returns:
      SupportedContent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postMessagingSupportedcontentWithHttpInfo

      public ApiResponse<SupportedContent> postMessagingSupportedcontentWithHttpInfo(SupportedContent body) throws IOException
      Deprecated.
      Create a Supported Content profile Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement
      Parameters:
      body - SupportedContent (required)
      Returns:
      SupportedContent
      Throws:
      IOException - if the request fails to be processed

    • postMessagingSupportedcontent

      public SupportedContent postMessagingSupportedcontent(PostMessagingSupportedcontentRequest request) throws IOException, ApiException
      Deprecated.
      Create a Supported Content profile Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement
      Parameters:
      request - The request object
      Returns:
      SupportedContent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postMessagingSupportedcontent

      public ApiResponse<SupportedContent> postMessagingSupportedcontent(ApiRequest<SupportedContent> request) throws IOException
      Deprecated.
      Create a Supported Content profile Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putMessagingSettingsDefault

      public MessagingSetting putMessagingSettingsDefault(MessagingSettingDefaultRequest body) throws IOException, ApiException
      Deprecated.
      Set the organization's default settings that may be applied to an integration when it is created. When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.
      Parameters:
      body - Messaging Setting ID (required)
      Returns:
      MessagingSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putMessagingSettingsDefaultWithHttpInfo

      public ApiResponse<MessagingSetting> putMessagingSettingsDefaultWithHttpInfo(MessagingSettingDefaultRequest body) throws IOException
      Deprecated.
      Set the organization's default settings that may be applied to an integration when it is created. When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.
      Parameters:
      body - Messaging Setting ID (required)
      Returns:
      MessagingSetting
      Throws:
      IOException - if the request fails to be processed

    • putMessagingSettingsDefault

      public MessagingSetting putMessagingSettingsDefault(PutMessagingSettingsDefaultRequest request) throws IOException, ApiException
      Deprecated.
      Set the organization's default settings that may be applied to an integration when it is created. When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.
      Parameters:
      request - The request object
      Returns:
      MessagingSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putMessagingSettingsDefault

      public ApiResponse<MessagingSetting> putMessagingSettingsDefault(ApiRequest<MessagingSettingDefaultRequest> request) throws IOException
      Deprecated.
      Set the organization's default settings that may be applied to an integration when it is created. When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed