@getbrevo/brevo 1.0.0

package/docs/TransactionalSMSApi.md

@@ -0,0 +1,261 @@
+# Brevo.TransactionalSMSApi
+
+All URIs are relative to *https://api.brevo.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**getSmsEvents**](TransactionalSMSApi.md#getSmsEvents) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events)
+[**getTransacAggregatedSmsReport**](TransactionalSMSApi.md#getTransacAggregatedSmsReport) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time
+[**getTransacSmsReport**](TransactionalSMSApi.md#getTransacSmsReport) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day
+[**sendTransacSms**](TransactionalSMSApi.md#sendTransacSms) | **POST** /transactionalSMS/sms | Send SMS message to a mobile number
+
+
+<a name="getSmsEvents"></a>
+# **getSmsEvents**
+> GetSmsEventReport getSmsEvents(opts)
+
+Get all your SMS activity (unaggregated events)
+
+### 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.TransactionalSMSApi();
+
+var opts = { 
+  'limit': 50, // Number | Number of documents per page
+  'startDate': "startDate_example", // String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
+  'endDate': "endDate_example", // String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
+  'offset': 0, // Number | Index of the first document of the page
+  'days': 789, // Number | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
+  'phoneNumber': "phoneNumber_example", // String | Filter the report for a specific phone number
+  'event': "event_example", // String | Filter the report for specific events
+  'tags': "tags_example", // String | Filter the report for specific tags passed as a serialized urlencoded array
+  'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
+};
+apiInstance.getSmsEvents(opts).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Number**| Number of documents per page | [optional] [default to 50]
+ **startDate** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional] 
+ **endDate** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional] 
+ **offset** | **Number**| Index of the first document of the page | [optional] [default to 0]
+ **days** | **Number**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional] 
+ **phoneNumber** | **String**| Filter the report for a specific phone number | [optional] 
+ **event** | **String**| Filter the report for specific events | [optional] 
+ **tags** | **String**| Filter the report for specific tags passed as a serialized urlencoded array | [optional] 
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
+
+### Return type
+
+[**GetSmsEventReport**](GetSmsEventReport.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="getTransacAggregatedSmsReport"></a>
+# **getTransacAggregatedSmsReport**
+> GetTransacAggregatedSmsReport getTransacAggregatedSmsReport(opts)
+
+Get your SMS activity aggregated over a period of time
+
+### 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.TransactionalSMSApi();
+
+var opts = { 
+  'startDate': "startDate_example", // String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
+  'endDate': "endDate_example", // String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
+  'days': 789, // Number | Number of days in the past including today (positive integer). Not compatible with startDate and endDate
+  'tag': "tag_example" // String | Filter on a tag
+};
+apiInstance.getTransacAggregatedSmsReport(opts).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **startDate** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional] 
+ **endDate** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional] 
+ **days** | **Number**| Number of days in the past including today (positive integer). Not compatible with startDate and endDate | [optional] 
+ **tag** | **String**| Filter on a tag | [optional] 
+
+### Return type
+
+[**GetTransacAggregatedSmsReport**](GetTransacAggregatedSmsReport.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="getTransacSmsReport"></a>
+# **getTransacSmsReport**
+> GetTransacSmsReport getTransacSmsReport(opts)
+
+Get your SMS activity aggregated per day
+
+### 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.TransactionalSMSApi();
+
+var opts = { 
+  'startDate': "startDate_example", // String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
+  'endDate': "endDate_example", // String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
+  'days': 789, // Number | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
+  'tag': "tag_example", // String | Filter on a tag
+  'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
+};
+apiInstance.getTransacSmsReport(opts).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **startDate** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional] 
+ **endDate** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional] 
+ **days** | **Number**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional] 
+ **tag** | **String**| Filter on a tag | [optional] 
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
+
+### Return type
+
+[**GetTransacSmsReport**](GetTransacSmsReport.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="sendTransacSms"></a>
+# **sendTransacSms**
+> SendSms sendTransacSms(sendTransacSms)
+
+Send SMS message to a mobile number
+
+### 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.TransactionalSMSApi();
+
+var sendTransacSms = new Brevo.SendTransacSms(); // SendTransacSms | Values to send a transactional SMS
+
+apiInstance.sendTransacSms(sendTransacSms).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sendTransacSms** | [**SendTransacSms**](SendTransacSms.md)| Values to send a transactional SMS | 
+
+### Return type
+
+[**SendSms**](SendSms.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/TransactionalWhatsAppApi.md

@@ -0,0 +1,137 @@
+# Brevo.TransactionalWhatsAppApi
+
+All URIs are relative to *https://api.brevo.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**getWhatsappEventReport**](TransactionalWhatsAppApi.md#getWhatsappEventReport) | **GET** /whatsapp/statistics/events | Get all your WhatsApp activity (unaggregated events)
+[**sendWhatsappMessage**](TransactionalWhatsAppApi.md#sendWhatsappMessage) | **POST** /whatsapp/sendMessage | Send a WhatsApp message
+
+
+<a name="getWhatsappEventReport"></a>
+# **getWhatsappEventReport**
+> GetWhatsappEventReport getWhatsappEventReport(opts)
+
+Get all your WhatsApp activity (unaggregated events)
+
+This endpoint will show the unaggregated statistics for WhatsApp activity (30 days by default if `startDate` and `endDate` or `days` is not passed. The date range can not exceed 90 days)
+
+### 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.TransactionalWhatsAppApi();
+
+var opts = { 
+  'limit': 2500, // Number | Number limitation for the result returned
+  'offset': 0, // Number | Beginning point in the list to retrieve from
+  'startDate': "startDate_example", // String | **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate 
+  'endDate': "endDate_example", // String | **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate 
+  'days': 789, // Number | Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_ 
+  'contactNumber': "contactNumber_example", // String | Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721)
+  'event': "event_example", // String | Filter the report for a specific event type
+  'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
+};
+apiInstance.getWhatsappEventReport(opts).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Number**| Number limitation for the result returned | [optional] [default to 2500]
+ **offset** | **Number**| Beginning point in the list to retrieve from | [optional] [default to 0]
+ **startDate** | **String**| **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate  | [optional] 
+ **endDate** | **String**| **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate  | [optional] 
+ **days** | **Number**| Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_  | [optional] 
+ **contactNumber** | **String**| Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721) | [optional] 
+ **event** | **String**| Filter the report for a specific event type | [optional] 
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
+
+### Return type
+
+[**GetWhatsappEventReport**](GetWhatsappEventReport.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="sendWhatsappMessage"></a>
+# **sendWhatsappMessage**
+> InlineResponse2013 sendWhatsappMessage(sendWhatsappMessage)
+
+Send a WhatsApp message
+
+This endpoint is used to send a WhatsApp message. <br/>(**The first message you send using the API must contain a Template ID. You must create a template on WhatsApp on the Brevo platform to fetch the Template ID.**)
+
+### 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.TransactionalWhatsAppApi();
+
+var sendWhatsappMessage = new Brevo.SendWhatsappMessage(); // SendWhatsappMessage | Values to send WhatsApp message
+
+apiInstance.sendWhatsappMessage(sendWhatsappMessage).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sendWhatsappMessage** | [**SendWhatsappMessage**](SendWhatsappMessage.md)| Values to send WhatsApp message | 
+
+### Return type
+
+[**InlineResponse2013**](InlineResponse2013.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/UpdateAttribute.md

@@ -0,0 +1,9 @@
+# Brevo.UpdateAttribute
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | Value of the attribute to update. Use only if the attribute's category is 'calculated' or 'global' | [optional] 
+**enumeration** | [**[UpdateAttributeEnumeration]**](UpdateAttributeEnumeration.md) | List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] | [optional] 
+
+

package/docs/UpdateAttributeEnumeration.md

@@ -0,0 +1,9 @@
+# Brevo.UpdateAttributeEnumeration
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Number** | Id of the value | 
+**label** | **String** | Label of the value | 
+
+

package/docs/UpdateBatchContacts.md

@@ -0,0 +1,8 @@
+# Brevo.UpdateBatchContacts
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contacts** | [**[UpdateBatchContactsContacts]**](UpdateBatchContactsContacts.md) | List of contacts to be updated | [optional] 
+
+

package/docs/UpdateBatchContactsContacts.md

@@ -0,0 +1,17 @@
+# Brevo.UpdateBatchContactsContacts
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email address of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) | [optional] 
+**id** | **Number** | id of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) | [optional] 
+**sms** | **String** | SMS of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) | [optional] 
+**extId** | **String** | Pass your own Id to update ext_id of a contact. | [optional] 
+**attributes** | **{String: Object}** | Pass the set of attributes to be updated. **These attributes must be present in your account**. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, **{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}**. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in **SMS** field should be passed with proper country code. For example: **{\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"}**  | [optional] 
+**emailBlacklisted** | **Boolean** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | [optional] 
+**smsBlacklisted** | **Boolean** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional] 
+**listIds** | **[Number]** | Ids of the lists to add the contact to | [optional] 
+**unlinkListIds** | **[Number]** | Ids of the lists to remove the contact from | [optional] 
+**smtpBlacklistSender** | **[String]** | transactional email forbidden sender for contact. Use only for email Contact | [optional] 
+
+

package/docs/UpdateBatchContactsModel.md

@@ -0,0 +1,9 @@
+# Brevo.UpdateBatchContactsModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successIds** | **[Number]** |  | [optional] 
+**failureIds** | **[Number]** |  | [optional] 
+
+

package/docs/UpdateCampaignStatus.md

@@ -0,0 +1,31 @@
+# Brevo.UpdateCampaignStatus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | Note:- replicateTemplate status will be available only for template type campaigns. | [optional] 
+
+
+<a name="StatusEnum"></a>
+## Enum: StatusEnum
+
+
+* `suspended` (value: `"suspended"`)
+
+* `archive` (value: `"archive"`)
+
+* `darchive` (value: `"darchive"`)
+
+* `sent` (value: `"sent"`)
+
+* `queued` (value: `"queued"`)
+
+* `replicate` (value: `"replicate"`)
+
+* `replicateTemplate` (value: `"replicateTemplate"`)
+
+* `draft` (value: `"draft"`)
+
+
+
+

package/docs/UpdateChild.md

@@ -0,0 +1,12 @@
+# Brevo.UpdateChild
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | New Email address to update the child account | [optional] 
+**firstName** | **String** | New First name to use to update the child account | [optional] 
+**lastName** | **String** | New Last name to use to update the child account | [optional] 
+**companyName** | **String** | New Company name to use to update the child account | [optional] 
+**password** | **String** | New password for the child account to login | [optional] 
+
+

package/docs/UpdateChildAccountStatus.md

@@ -0,0 +1,11 @@
+# Brevo.UpdateChildAccountStatus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transactionalEmail** | **Boolean** | Status of Transactional Email Platform activation for your account (true=enabled, false=disabled) | [optional] 
+**transactionalSms** | **Boolean** | Status of Transactional SMS Platform activation for your account (true=enabled, false=disabled) | [optional] 
+**marketingAutomation** | **Boolean** | Status of Marketing Automation Platform activation for your account (true=enabled, false=disabled) | [optional] 
+**smsCampaign** | **Boolean** | Status of SMS Campaign Platform activation for your account (true=enabled, false=disabled) | [optional] 
+
+

package/docs/UpdateChildDomain.md

@@ -0,0 +1,8 @@
+# Brevo.UpdateChildDomain
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**domain** | **String** | Value for the sender domain that will replace the existing domain | [optional] 
+
+

package/docs/UpdateContact.md

@@ -0,0 +1,14 @@
+# Brevo.UpdateContact
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attributes** | **Object** | Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. The attribute's parameter should be passed in capital letter while updating a contact. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} | [optional] 
+**extId** | **String** | Pass your own Id to update ext_id of a contact. | [optional] 
+**emailBlacklisted** | **Boolean** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | [optional] 
+**smsBlacklisted** | **Boolean** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional] 
+**listIds** | **[Number]** | Ids of the lists to add the contact to | [optional] 
+**unlinkListIds** | **[Number]** | Ids of the lists to remove the contact from | [optional] 
+**smtpBlacklistSender** | **[String]** | transactional email forbidden sender for contact. Use only for email Contact | [optional] 
+
+

package/docs/UpdateCouponCollection.md

@@ -0,0 +1,8 @@
+# Brevo.UpdateCouponCollection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**defaultCoupon** | **String** | A default coupon to be used in case there are no coupons left | 
+
+

package/docs/UpdateEmailCampaign.md

@@ -0,0 +1,49 @@
+# Brevo.UpdateEmailCampaign
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag** | **String** | Tag of the campaign | [optional] 
+**sender** | [**UpdateEmailCampaignSender**](UpdateEmailCampaignSender.md) |  | [optional] 
+**name** | **String** | Name of the campaign | [optional] 
+**htmlContent** | **String** | Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. REQUIRED if htmlUrl is empty | [optional] 
+**htmlUrl** | **String** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional] 
+**scheduledAt** | **String** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional] 
+**subject** | **String** | Subject of the campaign | [optional] 
+**previewText** | **String** | Preview text or preheader of the email campaign | [optional] 
+**replyTo** | **String** | Email on which campaign recipients will be able to reply to | [optional] 
+**toField** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] 
+**recipients** | [**UpdateEmailCampaignRecipients**](UpdateEmailCampaignRecipients.md) |  | [optional] 
+**attachmentUrl** | **String** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] 
+**inlineImageActivation** | **Boolean** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts. | [optional] [default to false]
+**mirrorActive** | **Boolean** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional] 
+**recurring** | **Boolean** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional] [default to false]
+**footer** | **String** | Footer of the email campaign | [optional] 
+**header** | **String** | Header of the email campaign | [optional] 
+**utmCampaign** | **String** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional] 
+**params** | **Object** | Pass the set of attributes to customize the type 'classic' campaign. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional] 
+**sendAtBestTime** | **Boolean** | Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled. | [optional] 
+**abTesting** | **Boolean** | Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered if abTesting is set to true. 'subject' if passed is ignored.  Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B | [optional] [default to false]
+**subjectA** | **String** | Subject A of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value | [optional] 
+**subjectB** | **String** | Subject B of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value | [optional] 
+**splitRule** | **Number** | Add the size of your test groups. Considered if abTesting = true. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else | [optional] 
+**winnerCriteria** | **String** | Choose the metrics that will determinate the winning version. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed or alreday exist in record | [optional] 
+**winnerDelay** | **Number** | Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed or alreday exist in record | [optional] 
+**ipWarmupEnable** | **Boolean** | Available for dedicated ip clients. Set this to true if you wish to warm up your ip. | [optional] [default to false]
+**initialQuota** | **Number** | Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. | [optional] 
+**increaseRate** | **Number** | Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. | [optional] 
+**unsubscriptionPageId** | **String** | Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. | [optional] 
+**updateFormId** | **String** | Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. | [optional] 
+
+
+<a name="WinnerCriteriaEnum"></a>
+## Enum: WinnerCriteriaEnum
+
+
+* `open` (value: `"open"`)
+
+* `click` (value: `"click"`)
+
+
+
+

package/docs/UpdateEmailCampaignRecipients.md

@@ -0,0 +1,10 @@
+# Brevo.UpdateEmailCampaignRecipients
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**exclusionListIds** | **[Number]** | List ids which have to be excluded from a campaign | [optional] 
+**listIds** | **[Number]** | Lists Ids to send the campaign to. Campaign should only be updated with listIds if listIds were used to create it. REQUIRED if already not present in campaign and scheduledAt is not empty | [optional] 
+**segmentIds** | **[Number]** | Mandatory if listIds are not used. Campaign should only be updated with segmentIds if segmentIds were used to create it. Segment ids to send the campaign to. | [optional] 
+
+

package/docs/UpdateEmailCampaignSender.md

@@ -0,0 +1,10 @@
+# Brevo.UpdateEmailCampaignSender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Sender Name from which the campaign emails are sent | [optional] 
+**email** | **String** | Sender email from which the campaign emails are sent | [optional] 
+**id** | **Number** | Select the sender for the campaign on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional] 
+
+