@getbrevo/brevo 1.0.0

package/docs/ConversationsApi.md

@@ -0,0 +1,518 @@
+# Brevo.ConversationsApi
+
+All URIs are relative to *https://api.brevo.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**conversationsAgentOnlinePingPost**](ConversationsApi.md#conversationsAgentOnlinePingPost) | **POST** /conversations/agentOnlinePing | Sets agent’s status to online for 2-3 minutes
+[**conversationsMessagesIdDelete**](ConversationsApi.md#conversationsMessagesIdDelete) | **DELETE** /conversations/messages/{id} | Delete a message sent by an agent
+[**conversationsMessagesIdGet**](ConversationsApi.md#conversationsMessagesIdGet) | **GET** /conversations/messages/{id} | Get a message
+[**conversationsMessagesIdPut**](ConversationsApi.md#conversationsMessagesIdPut) | **PUT** /conversations/messages/{id} | Update a message sent by an agent
+[**conversationsMessagesPost**](ConversationsApi.md#conversationsMessagesPost) | **POST** /conversations/messages | Send a message as an agent
+[**conversationsPushedMessagesIdDelete**](ConversationsApi.md#conversationsPushedMessagesIdDelete) | **DELETE** /conversations/pushedMessages/{id} | Delete an automated message
+[**conversationsPushedMessagesIdGet**](ConversationsApi.md#conversationsPushedMessagesIdGet) | **GET** /conversations/pushedMessages/{id} | Get an automated message
+[**conversationsPushedMessagesIdPut**](ConversationsApi.md#conversationsPushedMessagesIdPut) | **PUT** /conversations/pushedMessages/{id} | Update an automated message
+[**conversationsPushedMessagesPost**](ConversationsApi.md#conversationsPushedMessagesPost) | **POST** /conversations/pushedMessages | Send an automated message to a visitor
+
+
+<a name="conversationsAgentOnlinePingPost"></a>
+# **conversationsAgentOnlinePingPost**
+> conversationsAgentOnlinePingPost(body)
+
+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.
+
+### Example
+```javascript
+var Brevo = require('@getbrevo/brevo');
+var defaultClient = Brevo.ApiClient.instance;
+
+// Configure API key authorization: api-key
+var apiKey = defaultClient.authentications['api-key'];
+apiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix = 'Token';
+
+// Configure API key authorization: partner-key
+var partnerKey = defaultClient.authentications['partner-key'];
+partnerKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//partnerKey.apiKeyPrefix = 'Token';
+
+var apiInstance = new Brevo.ConversationsApi();
+
+var body = new Brevo.Body12(); // Body12 | Agent fields.
+
+apiInstance.conversationsAgentOnlinePingPost(body).then(function() {
+  console.log('API called successfully.');
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Body12**](Body12.md)| Agent fields. | 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+<a name="conversationsMessagesIdDelete"></a>
+# **conversationsMessagesIdDelete**
+> conversationsMessagesIdDelete(id)
+
+Delete a message sent by an agent
+
+Only agents’ messages can be deleted.
+
+### Example
+```javascript
+var Brevo = require('@getbrevo/brevo');
+var defaultClient = Brevo.ApiClient.instance;
+
+// Configure API key authorization: api-key
+var apiKey = defaultClient.authentications['api-key'];
+apiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix = 'Token';
+
+// Configure API key authorization: partner-key
+var partnerKey = defaultClient.authentications['partner-key'];
+partnerKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//partnerKey.apiKeyPrefix = 'Token';
+
+var apiInstance = new Brevo.ConversationsApi();
+
+var id = "id_example"; // String | ID of the message
+
+apiInstance.conversationsMessagesIdDelete(id).then(function() {
+  console.log('API called successfully.');
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID of the message | 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+<a name="conversationsMessagesIdGet"></a>
+# **conversationsMessagesIdGet**
+> ConversationsMessage conversationsMessagesIdGet(id)
+
+Get a message
+
+### Example
+```javascript
+var Brevo = require('@getbrevo/brevo');
+var defaultClient = Brevo.ApiClient.instance;
+
+// Configure API key authorization: api-key
+var apiKey = defaultClient.authentications['api-key'];
+apiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix = 'Token';
+
+// Configure API key authorization: partner-key
+var partnerKey = defaultClient.authentications['partner-key'];
+partnerKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//partnerKey.apiKeyPrefix = 'Token';
+
+var apiInstance = new Brevo.ConversationsApi();
+
+var id = "id_example"; // String | ID of the message
+
+apiInstance.conversationsMessagesIdGet(id).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID of the message | 
+
+### Return type
+
+[**ConversationsMessage**](ConversationsMessage.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+<a name="conversationsMessagesIdPut"></a>
+# **conversationsMessagesIdPut**
+> ConversationsMessage conversationsMessagesIdPut(id, opts)
+
+Update a message sent by an agent
+
+Only agents’ messages can be edited.
+
+### Example
+```javascript
+var Brevo = require('@getbrevo/brevo');
+var defaultClient = Brevo.ApiClient.instance;
+
+// Configure API key authorization: api-key
+var apiKey = defaultClient.authentications['api-key'];
+apiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix = 'Token';
+
+// Configure API key authorization: partner-key
+var partnerKey = defaultClient.authentications['partner-key'];
+partnerKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//partnerKey.apiKeyPrefix = 'Token';
+
+var apiInstance = new Brevo.ConversationsApi();
+
+var id = "id_example"; // String | ID of the message
+
+var opts = { 
+  'body': new Brevo.Body9() // Body9 | 
+};
+apiInstance.conversationsMessagesIdPut(id, opts).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID of the message | 
+ **body** | [**Body9**](Body9.md)|  | [optional] 
+
+### Return type
+
+[**ConversationsMessage**](ConversationsMessage.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+<a name="conversationsMessagesPost"></a>
+# **conversationsMessagesPost**
+> ConversationsMessage conversationsMessagesPost(body)
+
+Send a message as an agent
+
+### Example
+```javascript
+var Brevo = require('@getbrevo/brevo');
+var defaultClient = Brevo.ApiClient.instance;
+
+// Configure API key authorization: api-key
+var apiKey = defaultClient.authentications['api-key'];
+apiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix = 'Token';
+
+// Configure API key authorization: partner-key
+var partnerKey = defaultClient.authentications['partner-key'];
+partnerKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//partnerKey.apiKeyPrefix = 'Token';
+
+var apiInstance = new Brevo.ConversationsApi();
+
+var body = new Brevo.Body8(); // Body8 | Message fields.
+
+apiInstance.conversationsMessagesPost(body).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Body8**](Body8.md)| Message fields. | 
+
+### Return type
+
+[**ConversationsMessage**](ConversationsMessage.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+<a name="conversationsPushedMessagesIdDelete"></a>
+# **conversationsPushedMessagesIdDelete**
+> conversationsPushedMessagesIdDelete(id)
+
+Delete an automated message
+
+### Example
+```javascript
+var Brevo = require('@getbrevo/brevo');
+var defaultClient = Brevo.ApiClient.instance;
+
+// Configure API key authorization: api-key
+var apiKey = defaultClient.authentications['api-key'];
+apiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix = 'Token';
+
+// Configure API key authorization: partner-key
+var partnerKey = defaultClient.authentications['partner-key'];
+partnerKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//partnerKey.apiKeyPrefix = 'Token';
+
+var apiInstance = new Brevo.ConversationsApi();
+
+var id = "id_example"; // String | ID of the message
+
+apiInstance.conversationsPushedMessagesIdDelete(id).then(function() {
+  console.log('API called successfully.');
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID of the message | 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+<a name="conversationsPushedMessagesIdGet"></a>
+# **conversationsPushedMessagesIdGet**
+> ConversationsMessage conversationsPushedMessagesIdGet(id)
+
+Get an automated message
+
+### Example
+```javascript
+var Brevo = require('@getbrevo/brevo');
+var defaultClient = Brevo.ApiClient.instance;
+
+// Configure API key authorization: api-key
+var apiKey = defaultClient.authentications['api-key'];
+apiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix = 'Token';
+
+// Configure API key authorization: partner-key
+var partnerKey = defaultClient.authentications['partner-key'];
+partnerKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//partnerKey.apiKeyPrefix = 'Token';
+
+var apiInstance = new Brevo.ConversationsApi();
+
+var id = "id_example"; // String | ID of the message sent previously
+
+apiInstance.conversationsPushedMessagesIdGet(id).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID of the message sent previously | 
+
+### Return type
+
+[**ConversationsMessage**](ConversationsMessage.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+<a name="conversationsPushedMessagesIdPut"></a>
+# **conversationsPushedMessagesIdPut**
+> ConversationsMessage conversationsPushedMessagesIdPut(id, body)
+
+Update an automated message
+
+### Example
+```javascript
+var Brevo = require('@getbrevo/brevo');
+var defaultClient = Brevo.ApiClient.instance;
+
+// Configure API key authorization: api-key
+var apiKey = defaultClient.authentications['api-key'];
+apiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix = 'Token';
+
+// Configure API key authorization: partner-key
+var partnerKey = defaultClient.authentications['partner-key'];
+partnerKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//partnerKey.apiKeyPrefix = 'Token';
+
+var apiInstance = new Brevo.ConversationsApi();
+
+var id = "id_example"; // String | ID of the message
+
+var body = new Brevo.Body11(); // Body11 | 
+
+apiInstance.conversationsPushedMessagesIdPut(id, body).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID of the message | 
+ **body** | [**Body11**](Body11.md)|  | 
+
+### Return type
+
+[**ConversationsMessage**](ConversationsMessage.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+<a name="conversationsPushedMessagesPost"></a>
+# **conversationsPushedMessagesPost**
+> ConversationsMessage conversationsPushedMessagesPost(body)
+
+Send an automated message to a visitor
+
+Example of automated messages: order status, announce new features in your web app, etc.
+
+### Example
+```javascript
+var Brevo = require('@getbrevo/brevo');
+var defaultClient = Brevo.ApiClient.instance;
+
+// Configure API key authorization: api-key
+var apiKey = defaultClient.authentications['api-key'];
+apiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix = 'Token';
+
+// Configure API key authorization: partner-key
+var partnerKey = defaultClient.authentications['partner-key'];
+partnerKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//partnerKey.apiKeyPrefix = 'Token';
+
+var apiInstance = new Brevo.ConversationsApi();
+
+var body = new Brevo.Body10(); // Body10 | 
+
+apiInstance.conversationsPushedMessagesPost(body).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Body10**](Body10.md)|  | 
+
+### Return type
+
+[**ConversationsMessage**](ConversationsMessage.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+

package/docs/ConversationsMessage.md

@@ -0,0 +1,28 @@
+# Brevo.ConversationsMessage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Message ID. It can be used for further manipulations with the message. | [optional] 
+**type** | **String** | `\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages. | [optional] 
+**text** | **String** | Message text or name of the attached file | [optional] 
+**visitorId** | **String** | visitor’s ID | [optional] 
+**agentId** | **String** | ID of the agent on whose behalf the message was sent (only in messages sent by an agent). | [optional] 
+**agentName** | **String** | Agent’s name as displayed to the visitor. Only in the messages sent by an agent. | [optional] 
+**createdAt** | **Number** | Timestamp in milliseconds. | [optional] 
+**isPushed** | **Boolean** | `true` for pushed messages | [optional] 
+**receivedFrom** | **String** | In two-way integrations, messages sent via REST API can be marked with receivedFrom property and then filtered out when received in a webhook to avoid infinite loop. | [optional] 
+**file** | [**ConversationsMessageFile**](ConversationsMessageFile.md) |  | [optional] 
+
+
+<a name="TypeEnum"></a>
+## Enum: TypeEnum
+
+
+* `agent` (value: `"agent"`)
+
+* `visitor` (value: `"visitor"`)
+
+
+
+

package/docs/ConversationsMessageFile.md

@@ -0,0 +1,12 @@
+# Brevo.ConversationsMessageFile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filename** | **String** | Name of the file | [optional] 
+**size** | **Number** | Size in bytes | [optional] 
+**isImage** | **Boolean** | Whether the file is an image | [optional] 
+**url** | **String** | URL of the file | [optional] 
+**imageInfo** | [**ConversationsMessageFileImageInfo**](ConversationsMessageFileImageInfo.md) |  | [optional] 
+
+

package/docs/ConversationsMessageFileImageInfo.md

@@ -0,0 +1,10 @@
+# Brevo.ConversationsMessageFileImageInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**width** | **Number** | Width of the image | [optional] 
+**height** | **Number** | height of the image | [optional] 
+**previewUrl** | **String** | URL of the preview | [optional] 
+
+