Package software.xdev.brevo.api

Class ConversationsApi

java.lang.Object
software.xdev.brevo.api.ConversationsApi
@Generated("org.openapitools.codegen.languages.JavaClientCodegen") public class ConversationsApi extends Object

  • Constructor Details

    • ConversationsApi

      public ConversationsApi()

    • ConversationsApi

      public ConversationsApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • conversationsAgentOnlinePingPost

      public void conversationsAgentOnlinePingPost(ConversationsAgentOnlinePingPostRequest conversationsAgentOnlinePingPostRequest) throws ApiException
      Sets agent’s status to online for 2-3 minutes We recommend pinging this endpoint every minute for as long as the agent has to be considered online.
      Parameters:
      conversationsAgentOnlinePingPostRequest - (required)
      Throws:
      ApiException - if fails to make API call

    • conversationsAgentOnlinePingPost

      public void conversationsAgentOnlinePingPost(ConversationsAgentOnlinePingPostRequest conversationsAgentOnlinePingPostRequest, Map<String,String> additionalHeaders) throws ApiException
      Sets agent’s status to online for 2-3 minutes We recommend pinging this endpoint every minute for as long as the agent has to be considered online.
      Parameters:
      conversationsAgentOnlinePingPostRequest - (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • conversationsMessagesIdDelete

      public void conversationsMessagesIdDelete(String id) throws ApiException
      Delete a message sent by an agent Only agents’ messages can be deleted.
      Parameters:
      id - ID of the message (required)
      Throws:
      ApiException - if fails to make API call

    • conversationsMessagesIdDelete

      public void conversationsMessagesIdDelete(String id, Map<String,String> additionalHeaders) throws ApiException
      Delete a message sent by an agent Only agents’ messages can be deleted.
      Parameters:
      id - ID of the message (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • conversationsMessagesIdGet

      public ConversationsMessage conversationsMessagesIdGet(String id) throws ApiException
      Get a message
      Parameters:
      id - ID of the message (required)
      Returns:
      ConversationsMessage
      Throws:
      ApiException - if fails to make API call

    • conversationsMessagesIdGet

      public ConversationsMessage conversationsMessagesIdGet(String id, Map<String,String> additionalHeaders) throws ApiException
      Get a message
      Parameters:
      id - ID of the message (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ConversationsMessage
      Throws:
      ApiException - if fails to make API call

    • conversationsMessagesIdPut

      public ConversationsMessage conversationsMessagesIdPut(String id, ConversationsMessagesIdPutRequest conversationsMessagesIdPutRequest) throws ApiException
      Update a message sent by an agent Only agents’ messages can be edited.
      Parameters:
      id - ID of the message (required)
      conversationsMessagesIdPutRequest - (required)
      Returns:
      ConversationsMessage
      Throws:
      ApiException - if fails to make API call

    • conversationsMessagesIdPut

      public ConversationsMessage conversationsMessagesIdPut(String id, ConversationsMessagesIdPutRequest conversationsMessagesIdPutRequest, Map<String,String> additionalHeaders) throws ApiException
      Update a message sent by an agent Only agents’ messages can be edited.
      Parameters:
      id - ID of the message (required)
      conversationsMessagesIdPutRequest - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ConversationsMessage
      Throws:
      ApiException - if fails to make API call

    • conversationsMessagesPost

      public ConversationsMessage conversationsMessagesPost(ConversationsMessagesPostRequest conversationsMessagesPostRequest) throws ApiException
      Send a message as an agent
      Parameters:
      conversationsMessagesPostRequest - (required)
      Returns:
      ConversationsMessage
      Throws:
      ApiException - if fails to make API call

    • conversationsMessagesPost

      public ConversationsMessage conversationsMessagesPost(ConversationsMessagesPostRequest conversationsMessagesPostRequest, Map<String,String> additionalHeaders) throws ApiException
      Send a message as an agent
      Parameters:
      conversationsMessagesPostRequest - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ConversationsMessage
      Throws:
      ApiException - if fails to make API call

    • conversationsPushedMessagesIdDelete

      public void conversationsPushedMessagesIdDelete(String id) throws ApiException
      Delete an automated message
      Parameters:
      id - ID of the message (required)
      Throws:
      ApiException - if fails to make API call

    • conversationsPushedMessagesIdDelete

      public void conversationsPushedMessagesIdDelete(String id, Map<String,String> additionalHeaders) throws ApiException
      Delete an automated message
      Parameters:
      id - ID of the message (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • conversationsPushedMessagesIdGet

      public ConversationsMessage conversationsPushedMessagesIdGet(String id) throws ApiException
      Get an automated message
      Parameters:
      id - ID of the message sent previously (required)
      Returns:
      ConversationsMessage
      Throws:
      ApiException - if fails to make API call

    • conversationsPushedMessagesIdGet

      public ConversationsMessage conversationsPushedMessagesIdGet(String id, Map<String,String> additionalHeaders) throws ApiException
      Get an automated message
      Parameters:
      id - ID of the message sent previously (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ConversationsMessage
      Throws:
      ApiException - if fails to make API call

    • conversationsPushedMessagesIdPut

      public ConversationsMessage conversationsPushedMessagesIdPut(String id, ConversationsMessagesIdPutRequest conversationsMessagesIdPutRequest) throws ApiException
      Update an automated message
      Parameters:
      id - ID of the message (required)
      conversationsMessagesIdPutRequest - (required)
      Returns:
      ConversationsMessage
      Throws:
      ApiException - if fails to make API call

    • conversationsPushedMessagesIdPut

      public ConversationsMessage conversationsPushedMessagesIdPut(String id, ConversationsMessagesIdPutRequest conversationsMessagesIdPutRequest, Map<String,String> additionalHeaders) throws ApiException
      Update an automated message
      Parameters:
      id - ID of the message (required)
      conversationsMessagesIdPutRequest - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ConversationsMessage
      Throws:
      ApiException - if fails to make API call

    • conversationsPushedMessagesPost

      public ConversationsMessage conversationsPushedMessagesPost(ConversationsPushedMessagesPostRequest conversationsPushedMessagesPostRequest) throws ApiException
      Send an automated message to a visitor Example of automated messages: order status, announce new features in your web app, etc.
      Parameters:
      conversationsPushedMessagesPostRequest - (required)
      Returns:
      ConversationsMessage
      Throws:
      ApiException - if fails to make API call

    • conversationsPushedMessagesPost

      public ConversationsMessage conversationsPushedMessagesPost(ConversationsPushedMessagesPostRequest conversationsPushedMessagesPostRequest, Map<String,String> additionalHeaders) throws ApiException
      Send an automated message to a visitor Example of automated messages: order status, announce new features in your web app, etc.
      Parameters:
      conversationsPushedMessagesPostRequest - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ConversationsMessage
      Throws:
      ApiException - if fails to make API call