@getbrevo/brevo 1.0.0

package/docs/EmailExportRecipients.md

@@ -0,0 +1,32 @@
+# Brevo.EmailExportRecipients
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**notifyURL** | **String** | Webhook called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479 | [optional] 
+**recipientsType** | **String** | Type of recipients to export for a campaign | 
+
+
+<a name="RecipientsTypeEnum"></a>
+## Enum: RecipientsTypeEnum
+
+
+* `all` (value: `"all"`)
+
+* `nonClickers` (value: `"nonClickers"`)
+
+* `nonOpeners` (value: `"nonOpeners"`)
+
+* `clickers` (value: `"clickers"`)
+
+* `openers` (value: `"openers"`)
+
+* `softBounces` (value: `"softBounces"`)
+
+* `hardBounces` (value: `"hardBounces"`)
+
+* `unsubscribed` (value: `"unsubscribed"`)
+
+
+
+

package/docs/ErrorModel.md

@@ -0,0 +1,48 @@
+# Brevo.ErrorModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Error code displayed in case of a failure | 
+**message** | **String** | Readable message associated to the failure | 
+
+
+<a name="CodeEnum"></a>
+## Enum: CodeEnum
+
+
+* `invalidParameter` (value: `"invalid_parameter"`)
+
+* `missingParameter` (value: `"missing_parameter"`)
+
+* `outOfRange` (value: `"out_of_range"`)
+
+* `campaignProcessing` (value: `"campaign_processing"`)
+
+* `campaignSent` (value: `"campaign_sent"`)
+
+* `documentNotFound` (value: `"document_not_found"`)
+
+* `resellerPermissionDenied` (value: `"reseller_permission_denied"`)
+
+* `notEnoughCredits` (value: `"not_enough_credits"`)
+
+* `permissionDenied` (value: `"permission_denied"`)
+
+* `duplicateParameter` (value: `"duplicate_parameter"`)
+
+* `duplicateRequest` (value: `"duplicate_request"`)
+
+* `methodNotAllowed` (value: `"method_not_allowed"`)
+
+* `unauthorized` (value: `"unauthorized"`)
+
+* `accountUnderValidation` (value: `"account_under_validation"`)
+
+* `notAcceptable` (value: `"not_acceptable"`)
+
+* `badRequest` (value: `"bad_request"`)
+
+
+
+

package/docs/ExportWebhooksHistory.md

@@ -0,0 +1,57 @@
+# Brevo.ExportWebhooksHistory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**days** | **Number** | Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_ | [optional] 
+**startDate** | **String** | Mandatory if endDate is used. Starting date of the history (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] 
+**sort** | **String** | Sorting order of records (asc or desc) | [optional] 
+**event** | **String** | Filter the history for a specific event type | 
+**notifyURL** | **String** | Webhook URL to receive CSV file link | 
+**webhookId** | **Number** | Filter the history for a specific webhook id | [optional] 
+**email** | **String** | Filter the history for a specific email | [optional] 
+**messageId** | **Number** | Filter the history for a specific message id | [optional] 
+
+
+<a name="EventEnum"></a>
+## Enum: EventEnum
+
+
+* `invalidParameter` (value: `"invalid_parameter"`)
+
+* `missingParameter` (value: `"missing_parameter"`)
+
+* `hardBounce` (value: `"hardBounce"`)
+
+* `softBounce` (value: `"softBounce"`)
+
+* `delivered` (value: `"delivered\""`)
+
+* `spam` (value: `"spam"`)
+
+* `request` (value: `"request"`)
+
+* `opened` (value: `"opened"`)
+
+* `click` (value: `"click"`)
+
+* `invalid` (value: `"invalid"`)
+
+* `deferred` (value: `"deferred"`)
+
+* `blocked` (value: `"blocked"`)
+
+* `unsubscribed` (value: `"unsubscribed"`)
+
+* `error` (value: `"error"`)
+
+* `uniqueOpened` (value: `"uniqueOpened"`)
+
+* `loadedByProxy` (value: `"loadedByProxy"`)
+
+* `allEvents` (value: `"allEvents"`)
+
+
+
+

package/docs/ExternalFeedsApi.md

@@ -0,0 +1,309 @@
+# Brevo.ExternalFeedsApi
+
+All URIs are relative to *https://api.brevo.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**createExternalFeed**](ExternalFeedsApi.md#createExternalFeed) | **POST** /feeds | Create an external feed
+[**deleteExternalFeed**](ExternalFeedsApi.md#deleteExternalFeed) | **DELETE** /feeds/{uuid} | Delete an external feed
+[**getAllExternalFeeds**](ExternalFeedsApi.md#getAllExternalFeeds) | **GET** /feeds | Fetch all external feeds
+[**getExternalFeedByUUID**](ExternalFeedsApi.md#getExternalFeedByUUID) | **GET** /feeds/{uuid} | Get an external feed by UUID
+[**updateExternalFeed**](ExternalFeedsApi.md#updateExternalFeed) | **PUT** /feeds/{uuid} | Update an external feed
+
+
+<a name="createExternalFeed"></a>
+# **createExternalFeed**
+> InlineResponse2014 createExternalFeed(createExternalFeed)
+
+Create an external feed
+
+This endpoint will create an external feed.
+
+### 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.ExternalFeedsApi();
+
+var createExternalFeed = new Brevo.CreateExternalFeed(); // CreateExternalFeed | Values to create a feed
+
+apiInstance.createExternalFeed(createExternalFeed).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **createExternalFeed** | [**CreateExternalFeed**](CreateExternalFeed.md)| Values to create a feed | 
+
+### Return type
+
+[**InlineResponse2014**](InlineResponse2014.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="deleteExternalFeed"></a>
+# **deleteExternalFeed**
+> deleteExternalFeed(uuid)
+
+Delete an external feed
+
+This endpoint will delete an external feed.
+
+### 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.ExternalFeedsApi();
+
+var uuid = "uuid_example"; // String | UUID of the feed to delete
+
+apiInstance.deleteExternalFeed(uuid).then(function() {
+  console.log('API called successfully.');
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**| UUID of the feed to delete | 
+
+### 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="getAllExternalFeeds"></a>
+# **getAllExternalFeeds**
+> GetAllExternalFeeds getAllExternalFeeds(opts)
+
+Fetch all external feeds
+
+This endpoint can fetch all created external feeds.
+
+### 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.ExternalFeedsApi();
+
+var opts = { 
+  'search': "search_example", // String | Can be used to filter records by search keyword on feed name
+  'startDate': new Date("2013-10-20"), // Date | Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date.
+  'endDate': new Date("2013-10-20"), // Date | Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
+  'sort': "desc", // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed.
+  'authType': "authType_example", // String | Filter the records by `authType` of the feed.
+  'limit': 50, // Number | Number of documents returned per page.
+  'offset': 0 // Number | Index of the first document on the page.
+};
+apiInstance.getAllExternalFeeds(opts).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **search** | **String**| Can be used to filter records by search keyword on feed name | [optional] 
+ **startDate** | **Date**| Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date. | [optional] 
+ **endDate** | **Date**| Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [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]
+ **authType** | **String**| Filter the records by `authType` of the feed. | [optional] 
+ **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]
+
+### Return type
+
+[**GetAllExternalFeeds**](GetAllExternalFeeds.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="getExternalFeedByUUID"></a>
+# **getExternalFeedByUUID**
+> GetExternalFeedByUUID getExternalFeedByUUID(uuid)
+
+Get an external feed by UUID
+
+This endpoint will update an external feed.
+
+### 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.ExternalFeedsApi();
+
+var uuid = "uuid_example"; // String | UUID of the feed to fetch
+
+apiInstance.getExternalFeedByUUID(uuid).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**| UUID of the feed to fetch | 
+
+### Return type
+
+[**GetExternalFeedByUUID**](GetExternalFeedByUUID.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="updateExternalFeed"></a>
+# **updateExternalFeed**
+> updateExternalFeed(uuid, updateExternalFeed)
+
+Update an external feed
+
+This endpoint will update an external feed.
+
+### 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.ExternalFeedsApi();
+
+var uuid = "uuid_example"; // String | UUID of the feed to update
+
+var updateExternalFeed = new Brevo.UpdateExternalFeed(); // UpdateExternalFeed | Values to update a feed
+
+apiInstance.updateExternalFeed(uuid, updateExternalFeed).then(function() {
+  console.log('API called successfully.');
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**| UUID of the feed to update | 
+ **updateExternalFeed** | [**UpdateExternalFeed**](UpdateExternalFeed.md)| Values to update a feed | 
+
+### 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
+

package/docs/FileData.md

@@ -0,0 +1,14 @@
+# Brevo.FileData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of uploaded file | [optional] 
+**authorId** | **String** | Account id of user which created the file | [optional] 
+**contactId** | **Number** | Contact id of contact on which file is uploaded | [optional] 
+**dealId** | **String** | Deal id linked to a file | [optional] 
+**companyId** | **String** | Company id linked to a file | [optional] 
+**size** | **Number** | Size of file in bytes | [optional] 
+**createdAt** | **Date** | File created date/time | [optional] 
+
+

package/docs/FileDownloadableLink.md

@@ -0,0 +1,8 @@
+# Brevo.FileDownloadableLink
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fileUrl** | **String** | A unique link to download the requested file. | 
+
+

package/docs/FileList.md

@@ -0,0 +1,7 @@
+# Brevo.FileList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+