@getbrevo/brevo 1.0.0

package/docs/CouponsApi.md

@@ -0,0 +1,291 @@
+# Brevo.CouponsApi
+
+All URIs are relative to *https://api.brevo.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**createCouponCollection**](CouponsApi.md#createCouponCollection) | **POST** /couponCollections | Create а coupon collection
+[**createCoupons**](CouponsApi.md#createCoupons) | **POST** /coupons | Create coupons for a coupon collection
+[**getCouponCollection**](CouponsApi.md#getCouponCollection) | **GET** /couponCollections/{id} | Get a coupon collection by id
+[**getCouponCollections**](CouponsApi.md#getCouponCollections) | **GET** /couponCollections | Get all your coupon collections
+[**updateCouponCollection**](CouponsApi.md#updateCouponCollection) | **PATCH** /couponCollections/{id} | Update a coupon collection by id
+
+
+<a name="createCouponCollection"></a>
+# **createCouponCollection**
+> InlineResponse2012 createCouponCollection(createCouponCollection)
+
+Create а coupon collection
+
+### 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.CouponsApi();
+
+var createCouponCollection = new Brevo.CreateCouponCollection(); // CreateCouponCollection | Values to create a coupon collection
+
+apiInstance.createCouponCollection(createCouponCollection).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **createCouponCollection** | [**CreateCouponCollection**](CreateCouponCollection.md)| Values to create a coupon collection | 
+
+### Return type
+
+[**InlineResponse2012**](InlineResponse2012.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="createCoupons"></a>
+# **createCoupons**
+> createCoupons(createCoupons)
+
+Create coupons for a coupon collection
+
+### 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.CouponsApi();
+
+var createCoupons = new Brevo.CreateCoupons(); // CreateCoupons | Values to create coupons
+
+apiInstance.createCoupons(createCoupons).then(function() {
+  console.log('API called successfully.');
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **createCoupons** | [**CreateCoupons**](CreateCoupons.md)| Values to create coupons | 
+
+### 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="getCouponCollection"></a>
+# **getCouponCollection**
+> GetCouponCollection getCouponCollection(id)
+
+Get a coupon collection by 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.CouponsApi();
+
+var id = "id_example"; // String | Id of the collection to return
+
+apiInstance.getCouponCollection(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 collection to return | 
+
+### Return type
+
+[**GetCouponCollection**](GetCouponCollection.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="getCouponCollections"></a>
+# **getCouponCollections**
+> GetCouponCollection getCouponCollections(opts)
+
+Get all your coupon collections
+
+### 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.CouponsApi();
+
+var opts = { 
+  'limit': 50, // Number | Number of documents returned per page
+  'offset': 0, // Number | Index of the first document on the page
+  'sort': "desc" // String | Sort the results by creation time in ascending/descending order
+};
+apiInstance.getCouponCollections(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 returned per page | [optional] [default to 50]
+ **offset** | **Number**| Index of the first document on the page | [optional] [default to 0]
+ **sort** | **String**| Sort the results by creation time in ascending/descending order | [optional] [default to desc]
+
+### Return type
+
+[**GetCouponCollection**](GetCouponCollection.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="updateCouponCollection"></a>
+# **updateCouponCollection**
+> InlineResponse2001 updateCouponCollection(id, updateCouponCollection)
+
+Update a coupon collection by 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.CouponsApi();
+
+var id = "id_example"; // String | Id of the collection to update
+
+var updateCouponCollection = new Brevo.UpdateCouponCollection(); // UpdateCouponCollection | Values to update the coupon collection
+
+apiInstance.updateCouponCollection(id, updateCouponCollection).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 collection to update | 
+ **updateCouponCollection** | [**UpdateCouponCollection**](UpdateCouponCollection.md)| Values to update the coupon collection | 
+
+### Return type
+
+[**InlineResponse2001**](InlineResponse2001.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/CreateApiKeyRequest.md

@@ -0,0 +1,9 @@
+# Brevo.CreateApiKeyRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Number** | Id of the sub-account organization | 
+**name** | **String** | Name of the API key | [optional] 
+
+

package/docs/CreateApiKeyResponse.md

@@ -0,0 +1,9 @@
+# Brevo.CreateApiKeyResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | Status of the API operation. | [optional] 
+**key** | **String** | API Key | [optional] 
+
+

package/docs/CreateAttribute.md

@@ -0,0 +1,30 @@
+# Brevo.CreateAttribute
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional] 
+**isRecurring** | **Boolean** | Type of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional] 
+**enumeration** | [**[CreateAttributeEnumeration]**](CreateAttributeEnumeration.md) | List of 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] 
+**type** | **String** | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [optional] 
+
+
+<a name="TypeEnum"></a>
+## Enum: TypeEnum
+
+
+* `text` (value: `"text"`)
+
+* `_date` (value: `"date"`)
+
+* `_float` (value: `"float"`)
+
+* `_boolean` (value: `"boolean"`)
+
+* `id` (value: `"id"`)
+
+* `category` (value: `"category"`)
+
+
+
+

package/docs/CreateAttributeEnumeration.md

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

package/docs/CreateCategoryModel.md

@@ -0,0 +1,8 @@
+# Brevo.CreateCategoryModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Number** | ID of the category when a new category is created | [optional] 
+
+

package/docs/CreateChild.md

@@ -0,0 +1,32 @@
+# Brevo.CreateChild
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email address to create the child account | 
+**firstName** | **String** | First name to use to create the child account | 
+**lastName** | **String** | Last name to use to create the child account | 
+**companyName** | **String** | Company name to use to create the child account | 
+**password** | **String** | Password for the child account to login | 
+**language** | **String** | Language of the child account | [optional] 
+
+
+<a name="LanguageEnum"></a>
+## Enum: LanguageEnum
+
+
+* `fr` (value: `"fr"`)
+
+* `es` (value: `"es"`)
+
+* `pt` (value: `"pt"`)
+
+* `it` (value: `"it"`)
+
+* `de` (value: `"de"`)
+
+* `en` (value: `"en"`)
+
+
+
+

package/docs/CreateContact.md

@@ -0,0 +1,15 @@
+# Brevo.CreateContact
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. 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 create a contact. | [optional] 
+**attributes** | **Object** | Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. These attributes must be present in your Brevo account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} | [optional] 
+**emailBlacklisted** | **Boolean** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional] 
+**smsBlacklisted** | **Boolean** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional] 
+**listIds** | **[Number]** | Ids of the lists to add the contact to | [optional] 
+**updateEnabled** | **Boolean** | Facilitate to update the existing contact in the same request (updateEnabled = true) | [optional] [default to false]
+**smtpBlacklistSender** | **[String]** | transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | [optional] 
+
+

package/docs/CreateCouponCollection.md

@@ -0,0 +1,9 @@
+# Brevo.CreateCouponCollection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **Object** | Name of the collection with no white spaces between words | 
+**defaultCoupon** | **Object** | A default coupon to be used in case there are no coupons left | 
+
+

package/docs/CreateCoupons.md

@@ -0,0 +1,9 @@
+# Brevo.CreateCoupons
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**collectionId** | **String** | The id of the coupon collection for which the coupons will be created | 
+**coupons** | **[String]** |  | 
+
+

package/docs/CreateDoiContact.md

@@ -0,0 +1,13 @@
+# Brevo.CreateDoiContact
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes. | 
+**attributes** | **Object** | Pass the set of attributes and their values. These attributes must be present in your Brevo account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} | [optional] 
+**includeListIds** | **[Number]** | Lists under user account where contact should be added | 
+**excludeListIds** | **[Number]** | Lists under user account where contact should not be added | [optional] 
+**templateId** | **Number** | Id of the Double opt-in (DOI) template | 
+**redirectionUrl** | **String** | URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}. | 
+
+

package/docs/CreateDomain.md

@@ -0,0 +1,8 @@
+# Brevo.CreateDomain
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Domain name | 
+
+

package/docs/CreateDomainModel.md

@@ -0,0 +1,11 @@
+# Brevo.CreateDomainModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Number** | ID of the Domain created | 
+**domainName** | **String** | Domain | [optional] 
+**message** | **String** | Success message | [optional] 
+**dnsRecords** | [**CreateDomainModelDnsRecords**](CreateDomainModelDnsRecords.md) |  | [optional] 
+
+

package/docs/CreateDomainModelDnsRecords.md

@@ -0,0 +1,9 @@
+# Brevo.CreateDomainModelDnsRecords
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dkimRecord** | [**CreateDomainModelDnsRecordsDkimRecord**](CreateDomainModelDnsRecordsDkimRecord.md) |  | [optional] 
+**brevoCode** | [**CreateDomainModelDnsRecordsDkimRecord**](CreateDomainModelDnsRecordsDkimRecord.md) |  | [optional] 
+
+

package/docs/CreateDomainModelDnsRecordsDkimRecord.md

@@ -0,0 +1,11 @@
+# Brevo.CreateDomainModelDnsRecordsDkimRecord
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**value** | **String** |  | [optional] 
+**hostName** | **String** |  | [optional] 
+**status** | **Boolean** |  | [optional] 
+
+

package/docs/CreateEmailCampaign.md

@@ -0,0 +1,49 @@
+# Brevo.CreateEmailCampaign
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag** | **String** | Tag of the campaign | [optional] 
+**sender** | [**CreateEmailCampaignSender**](CreateEmailCampaignSender.md) |  | 
+**name** | **String** | Name of the campaign | 
+**htmlContent** | **String** | Mandatory if htmlUrl and templateId are empty. Body of the message (HTML) | [optional] 
+**htmlUrl** | **String** | Mandatory if htmlContent and templateId are empty. Url to the message (HTML) | [optional] 
+**templateId** | **Number** | Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. | [optional] 
+**scheduledAt** | **String** | Sending UTC date-time (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. Mandatory if abTesting is false. Ignored if abTesting is true. | [optional] 
+**previewText** | **String** | Preview text or preheader of the email campaign | [optional] 
+**replyTo** | **String** | Email on which the 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** | [**CreateEmailCampaignRecipients**](CreateEmailCampaignRecipients.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** | Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts | [optional] [default to false]
+**mirrorActive** | **Boolean** | Use true to enable the mirror link | [optional] 
+**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\"}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. 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. | [optional] [default to false]
+**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 when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & '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. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional] 
+**subjectB** | **String** | Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional] 
+**splitRule** | **Number** | Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. 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. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed | [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. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed | [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** | Mandatory if ipWarmupEnable is set to true. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. | [optional] 
+**increaseRate** | **Number** | Mandatory if ipWarmupEnable is set to true. 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. If not entered, then the default unsubscription page will be used. | [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. If not entered, then the default update profile form will be used. | [optional] 
+
+
+<a name="WinnerCriteriaEnum"></a>
+## Enum: WinnerCriteriaEnum
+
+
+* `open` (value: `"open"`)
+
+* `click` (value: `"click"`)
+
+
+
+

package/docs/CreateEmailCampaignRecipients.md

@@ -0,0 +1,10 @@
+# Brevo.CreateEmailCampaignRecipients
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**exclusionListIds** | **[Number]** | List ids to exclude from the campaign | [optional] 
+**listIds** | **[Number]** | Mandatory if scheduledAt is not empty. List Ids to send the campaign to | [optional] 
+**segmentIds** | **[Number]** | Mandatory if listIds are not used. Segment ids to send the campaign to. | [optional] 
+
+

package/docs/CreateEmailCampaignSender.md

@@ -0,0 +1,10 @@
+# Brevo.CreateEmailCampaignSender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Sender Name | [optional] 
+**email** | **String** | Sender email | 
+**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] 
+
+

package/docs/CreateExternalFeed.md

@@ -0,0 +1,29 @@
+# Brevo.CreateExternalFeed
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the feed | 
+**url** | **String** | URL of the feed | 
+**authType** | **String** | Auth type of the feed:   * `basic`   * `token`   * `noAuth`  | [optional] [default to 'noAuth']
+**username** | **String** | Username for authType `basic` | [optional] 
+**password** | **String** | Password for authType `basic` | [optional] 
+**token** | **String** | Token for authType `token` | [optional] 
+**headers** | [**[GetExternalFeedByUUIDHeaders]**](GetExternalFeedByUUIDHeaders.md) | Custom headers for the feed | [optional] 
+**maxRetries** | **Number** | Maximum number of retries on the feed url | [optional] 
+**cache** | **Boolean** | Toggle caching of feed url response | [optional] [default to false]
+
+
+<a name="AuthTypeEnum"></a>
+## Enum: AuthTypeEnum
+
+
+* `basic` (value: `"basic"`)
+
+* `token` (value: `"token"`)
+
+* `noAuth` (value: `"noAuth"`)
+
+
+
+

package/docs/CreateList.md

@@ -0,0 +1,9 @@
+# Brevo.CreateList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the list | 
+**folderId** | **Number** | Id of the parent folder in which this list is to be created | 
+
+

package/docs/CreateModel.md

@@ -0,0 +1,8 @@
+# Brevo.CreateModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Number** | ID of the object created | 
+
+

package/docs/CreateProductModel.md

@@ -0,0 +1,8 @@
+# Brevo.CreateProductModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Number** | ID of the Product when a new product is created | [optional] 
+
+

package/docs/CreateReseller.md

@@ -0,0 +1,9 @@
+# Brevo.CreateReseller
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**authKey** | **String** | AuthKey of Reseller child created | 
+**id** | **Number** | Id of Reseller child created | [optional] 
+
+

package/docs/CreateSender.md

@@ -0,0 +1,10 @@
+# Brevo.CreateSender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | From Name to use for the sender | 
+**email** | **String** | From email to use for the sender. A verification email will be sent to this address. | 
+**ips** | [**[CreateSenderIps]**](CreateSenderIps.md) | Mandatory in case of dedicated IP, IPs to associate to the sender | [optional] 
+
+