Package software.xdev.brevo.api

Class ConversationsApi

java.lang.Object

software.xdev.brevo.client.BaseApi

software.xdev.brevo.api.ConversationsApi

public class ConversationsApi
extends BaseApi

Field Summary

Fields inherited from class software.xdev.brevo.client.BaseApi

apiClient

Constructor Summary

Constructors

Constructor	Description
ConversationsApi()
ConversationsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	conversationsAgentOnlinePingPost(ConversationsAgentOnlinePingPostRequest conversationsAgentOnlinePingPostRequest)	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.
void	conversationsAgentOnlinePingPost(ConversationsAgentOnlinePingPostRequest conversationsAgentOnlinePingPostRequest, Map<String,String> additionalHeaders)	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.
void	conversationsMessagesIdDelete(String id)	Delete a message sent by an agent Only agents’ messages can be deleted.
void	conversationsMessagesIdDelete(String id, Map<String,String> additionalHeaders)	Delete a message sent by an agent Only agents’ messages can be deleted.
ConversationsMessage	conversationsMessagesIdGet(String id)	Get a message
ConversationsMessage	conversationsMessagesIdGet(String id, Map<String,String> additionalHeaders)	Get a message
ConversationsMessage	conversationsMessagesIdPut(String id, ConversationsMessagesIdPutRequest conversationsMessagesIdPutRequest)	Update a message sent by an agent Only agents’ messages can be edited.
ConversationsMessage	conversationsMessagesIdPut(String id, ConversationsMessagesIdPutRequest conversationsMessagesIdPutRequest, Map<String,String> additionalHeaders)	Update a message sent by an agent Only agents’ messages can be edited.
ConversationsMessage	conversationsMessagesPost(ConversationsMessagesPostRequest conversationsMessagesPostRequest)	Send a message as an agent
ConversationsMessage	conversationsMessagesPost(ConversationsMessagesPostRequest conversationsMessagesPostRequest, Map<String,String> additionalHeaders)	Send a message as an agent
void	conversationsPushedMessagesIdDelete(String id)	Delete an automated message
void	conversationsPushedMessagesIdDelete(String id, Map<String,String> additionalHeaders)	Delete an automated message
ConversationsMessage	conversationsPushedMessagesIdGet(String id)	Get an automated message
ConversationsMessage	conversationsPushedMessagesIdGet(String id, Map<String,String> additionalHeaders)	Get an automated message
ConversationsMessage	conversationsPushedMessagesIdPut(String id, ConversationsMessagesIdPutRequest conversationsMessagesIdPutRequest)	Update an automated message
ConversationsMessage	conversationsPushedMessagesIdPut(String id, ConversationsMessagesIdPutRequest conversationsMessagesIdPutRequest, Map<String,String> additionalHeaders)	Update an automated message
ConversationsMessage	conversationsPushedMessagesPost(ConversationsPushedMessagesPostRequest conversationsPushedMessagesPostRequest)	Send an automated message to a visitor Example of automated messages: order status, announce new features in your web app, etc.
ConversationsMessage	conversationsPushedMessagesPost(ConversationsPushedMessagesPostRequest conversationsPushedMessagesPostRequest, Map<String,String> additionalHeaders)	Send an automated message to a visitor Example of automated messages: order status, announce new features in your web app, etc.
<T> T	invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String,String> additionalHeaders)	Directly invoke the API for the given URL.

Methods inherited from class software.xdev.brevo.client.BaseApi

getApiClient, invokeAPI, invokeAPI, invokeAPI, invokeAPI, invokeAPI, invokeAPI, setApiClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ConversationsApi

public ConversationsApi()

ConversationsApi

public ConversationsApi(ApiClient apiClient)

Method Details

conversationsAgentOnlinePingPost

public void conversationsAgentOnlinePingPost(@Nonnull
 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(@Nonnull
 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(@Nonnull
 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(@Nonnull
 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(@Nonnull
 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(@Nonnull
 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(@Nonnull
 String id,
 @Nonnull
 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(@Nonnull
 String id,
 @Nonnull
 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(@Nonnull
 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(@Nonnull
 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(@Nonnull
 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(@Nonnull
 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(@Nonnull
 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(@Nonnull
 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(@Nonnull
 String id,
 @Nonnull
 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(@Nonnull
 String id,
 @Nonnull
 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(@Nonnull
 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(@Nonnull
 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

invokeAPI

public <T> T invokeAPI(String url,
 String method,
 Object request,
 com.fasterxml.jackson.core.type.TypeReference<T> returnType,
 Map<String,String> additionalHeaders)
                throws ApiException

Description copied from class: BaseApi

Directly invoke the API for the given URL. Useful if the API returns direct links/URLs for subsequent requests.

Specified by:

invokeAPI in class BaseApi

Parameters:

url - The URL for the request, either full URL or only the path.

method - The HTTP method for the request.

request - The request object.

returnType - The return type.

additionalHeaders - Additional headers for the request.

Returns:

The API response in the specified type.

Throws:

ApiException - if fails to make API call.