@getbrevo/brevo 1.0.0

package/docs/NotesApi.md

@@ -0,0 +1,299 @@
+# Brevo.NotesApi
+
+All URIs are relative to *https://api.brevo.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**crmNotesGet**](NotesApi.md#crmNotesGet) | **GET** /crm/notes | Get all notes
+[**crmNotesIdDelete**](NotesApi.md#crmNotesIdDelete) | **DELETE** /crm/notes/{id} | Delete a note
+[**crmNotesIdGet**](NotesApi.md#crmNotesIdGet) | **GET** /crm/notes/{id} | Get a note
+[**crmNotesIdPatch**](NotesApi.md#crmNotesIdPatch) | **PATCH** /crm/notes/{id} | Update a note
+[**crmNotesPost**](NotesApi.md#crmNotesPost) | **POST** /crm/notes | Create a note
+
+
+<a name="crmNotesGet"></a>
+# **crmNotesGet**
+> NoteList crmNotesGet(opts)
+
+Get all notes
+
+### 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.NotesApi();
+
+var opts = { 
+  'entity': "entity_example", // String | Filter by note entity type
+  'entityIds': "entityIds_example", // String | Filter by note entity IDs
+  'dateFrom': 56, // Number | dateFrom to date range filter type (timestamp in milliseconds)
+  'dateTo': 56, // Number | dateTo to date range filter type (timestamp in milliseconds)
+  'offset': 789, // Number | Index of the first document of the page
+  'limit': 50, // Number | Number of documents per page
+  'sort': "sort_example" // String | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
+};
+apiInstance.crmNotesGet(opts).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **entity** | **String**| Filter by note entity type | [optional] 
+ **entityIds** | **String**| Filter by note entity IDs | [optional] 
+ **dateFrom** | **Number**| dateFrom to date range filter type (timestamp in milliseconds) | [optional] 
+ **dateTo** | **Number**| dateTo to date range filter type (timestamp in milliseconds) | [optional] 
+ **offset** | **Number**| Index of the first document of the page | [optional] 
+ **limit** | **Number**| Number of documents per page | [optional] [default to 50]
+ **sort** | **String**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional] 
+
+### Return type
+
+[**NoteList**](NoteList.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="crmNotesIdDelete"></a>
+# **crmNotesIdDelete**
+> crmNotesIdDelete(id)
+
+Delete a note
+
+### 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.NotesApi();
+
+var id = "id_example"; // String | Note ID to delete
+
+apiInstance.crmNotesIdDelete(id).then(function() {
+  console.log('API called successfully.');
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Note ID 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="crmNotesIdGet"></a>
+# **crmNotesIdGet**
+> Note crmNotesIdGet(id)
+
+Get a note
+
+### 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.NotesApi();
+
+var id = "id_example"; // String | Note ID to get
+
+apiInstance.crmNotesIdGet(id).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Note ID to get | 
+
+### Return type
+
+[**Note**](Note.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="crmNotesIdPatch"></a>
+# **crmNotesIdPatch**
+> crmNotesIdPatch(id, body)
+
+Update a note
+
+### 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.NotesApi();
+
+var id = "id_example"; // String | Note ID to update
+
+var body = new Brevo.NoteData(); // NoteData | Note data to update a note
+
+apiInstance.crmNotesIdPatch(id, body).then(function() {
+  console.log('API called successfully.');
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Note ID to update | 
+ **body** | [**NoteData**](NoteData.md)| Note data to update a note | 
+
+### 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="crmNotesPost"></a>
+# **crmNotesPost**
+> NoteId crmNotesPost(body)
+
+Create a note
+
+### 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.NotesApi();
+
+var body = new Brevo.NoteData(); // NoteData | Note data to create a note.
+
+apiInstance.crmNotesPost(body).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**NoteData**](NoteData.md)| Note data to create a note. | 
+
+### Return type
+
+[**NoteId**](NoteId.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/Order.md

@@ -0,0 +1,16 @@
+# Brevo.Order
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique ID of the order. | 
+**createdAt** | **String** | Event occurrence UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when order is actually created. | 
+**updatedAt** | **String** | Event updated UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when the status of the order is actually changed/updated. | 
+**status** | **String** | State of the order. | 
+**amount** | **Number** | Total amount of the order, including all shipping expenses, tax and the price of items. | 
+**products** | [**[OrderProducts]**](OrderProducts.md) |  | 
+**email** | **String** | Email of the contact, Mandatory if \"phone\" field is not passed in \"billing\" parameter. | [optional] 
+**billing** | [**OrderBilling**](OrderBilling.md) |  | [optional] 
+**coupons** | **[String]** | Coupons applied to the order. Stored case insensitive. | [optional] 
+
+

package/docs/OrderBatch.md

@@ -0,0 +1,9 @@
+# Brevo.OrderBatch
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**orders** | [**[Order]**](Order.md) | array of order objects | 
+**notifyUrl** | **String** | Notify Url provided by client to get the status of batch request | [optional] 
+
+

package/docs/OrderBilling.md

@@ -0,0 +1,14 @@
+# Brevo.OrderBilling
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address** | **String** | Full billing address. | [optional] 
+**city** | **String** | Exact city of the address. | [optional] 
+**countryCode** | **String** | Billing country 2-letter ISO code. | [optional] 
+**phone** | **String** | Phone number to contact for further details about the order, Mandatory if \"email\" field is not passed. | [optional] 
+**postCode** | **String** | Postcode for delivery and billing. | [optional] 
+**paymentMethod** | **String** | How the visitor will pay for the item(s), e.g. paypal, check, etc. | [optional] 
+**region** | **String** | Exact region (state/province) for delivery and billing. | [optional] 
+
+

package/docs/OrderProducts.md

@@ -0,0 +1,11 @@
+# Brevo.OrderProducts
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**productId** | **String** | ID of the product. | 
+**quantity** | **Number** | How many pieces of the product the visitor has added to the cart. | 
+**variantId** | **String** | Product ID of the red color shirts. | [optional] 
+**price** | **Number** | The price of a unit of product | 
+
+

package/docs/Otp.md

@@ -0,0 +1,8 @@
+# Brevo.Otp
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **Number** | 6 digit OTP received on email | [optional] 
+
+

package/docs/Pipeline.md

@@ -0,0 +1,10 @@
+# Brevo.Pipeline
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pipeline** | **String** | Pipeline id | [optional] 
+**pipelineName** | **String** | Pipeline Name | [optional] 
+**stages** | [**[PipelineStage]**](PipelineStage.md) | List of stages | [optional] 
+
+

package/docs/PipelineStage.md

@@ -0,0 +1,9 @@
+# Brevo.PipelineStage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Stage id | [optional] 
+**name** | **String** | Stage name | [optional] 
+
+

package/docs/Pipelines.md

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

package/docs/PostContactInfo.md

@@ -0,0 +1,8 @@
+# Brevo.PostContactInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contacts** | [**PostContactInfoContacts**](PostContactInfoContacts.md) |  | 
+
+

package/docs/PostContactInfoContacts.md

@@ -0,0 +1,11 @@
+# Brevo.PostContactInfoContacts
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **[String]** |  | [optional] 
+**failure** | **[String]** |  | [optional] 
+**total** | **Number** | Displays the count of total number of contacts removed from list when user opts for \"all\" option. | [optional] 
+**processId** | **Number** | Id of the process created to remove contacts from list when user opts for \"all\" option. | [optional] 
+
+

package/docs/PostSendFailed.md

@@ -0,0 +1,12 @@
+# Brevo.PostSendFailed
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **Number** | Response code | 
+**message** | **String** | Response message | 
+**unexistingEmails** | **[String]** |  | [optional] 
+**withoutListEmails** | **[String]** |  | [optional] 
+**blackListedEmails** | **[String]** |  | [optional] 
+
+

package/docs/PostSendSmsTestFailed.md

@@ -0,0 +1,11 @@
+# Brevo.PostSendSmsTestFailed
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **Number** | Response code | 
+**message** | **String** | Response message | 
+**unexistingSms** | **[String]** |  | [optional] 
+**withoutListSms** | **[String]** |  | [optional] 
+
+

package/docs/ProcessApi.md

@@ -0,0 +1,123 @@
+# Brevo.ProcessApi
+
+All URIs are relative to *https://api.brevo.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**getProcess**](ProcessApi.md#getProcess) | **GET** /processes/{processId} | Return the informations for a process
+[**getProcesses**](ProcessApi.md#getProcesses) | **GET** /processes | Return all the processes for your account
+
+
+<a name="getProcess"></a>
+# **getProcess**
+> GetProcess getProcess(processId)
+
+Return the informations for a process
+
+### 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.ProcessApi();
+
+var processId = 789; // Number | Id of the process
+
+apiInstance.getProcess(processId).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **processId** | **Number**| Id of the process | 
+
+### Return type
+
+[**GetProcess**](GetProcess.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="getProcesses"></a>
+# **getProcesses**
+> GetProcesses getProcesses(opts)
+
+Return all the processes for your account
+
+### 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.ProcessApi();
+
+var opts = { 
+  'limit': 10, // Number | Number limitation for the result returned
+  'offset': 0, // Number | Beginning point in the list to retrieve from.
+  'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
+};
+apiInstance.getProcesses(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 10]
+ **offset** | **Number**| Beginning point in the list to retrieve from. | [optional] [default to 0]
+ **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
+
+[**GetProcesses**](GetProcesses.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/RemainingCreditModel.md

@@ -0,0 +1,9 @@
+# Brevo.RemainingCreditModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**child** | [**RemainingCreditModelChild**](RemainingCreditModelChild.md) |  | 
+**reseller** | [**RemainingCreditModelReseller**](RemainingCreditModelReseller.md) |  | 
+
+

package/docs/RemainingCreditModelChild.md

@@ -0,0 +1,9 @@
+# Brevo.RemainingCreditModelChild
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sms** | **Number** | SMS Credits remaining for child account | 
+**email** | **Number** | Email Credits remaining for child account | 
+
+

package/docs/RemainingCreditModelReseller.md

@@ -0,0 +1,9 @@
+# Brevo.RemainingCreditModelReseller
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sms** | **Number** | SMS Credits remaining for reseller account | 
+**email** | **Number** | Email Credits remaining for reseller account | 
+
+

package/docs/RemoveContactFromList.md

@@ -0,0 +1,10 @@
+# Brevo.RemoveContactFromList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**emails** | **[String]** | Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request. | [optional] 
+**ids** | **[Number]** | Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional] 
+**all** | **Boolean** | Required if none of 'emails' or 'ids' are passed. Remove all existing contacts from a list.  A process will be created in this scenario. You can fetch the process details to know about the progress | [optional] 
+
+

package/docs/RemoveCredits.md

@@ -0,0 +1,9 @@
+# Brevo.RemoveCredits
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sms** | **Number** | Required if email credits are empty. SMS credits to be removed from the child account | [optional] 
+**email** | **Number** | Required if sms credits are empty. Email credits to be removed from the child account | [optional] 
+
+

package/docs/RequestContactExport.md

@@ -0,0 +1,10 @@
+# Brevo.RequestContactExport
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**exportAttributes** | **[String]** | List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email']. | [optional] 
+**customContactFilter** | [**RequestContactExportCustomContactFilter**](RequestContactExportCustomContactFilter.md) |  | 
+**notifyUrl** | **String** | Webhook that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479 | [optional] 
+
+