@getbrevo/brevo 1.0.0

package/docs/UpdateExternalFeed.md

@@ -0,0 +1,29 @@
+# Brevo.UpdateExternalFeed
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the feed | [optional] 
+**url** | **String** | URL of the feed | [optional] 
+**authType** | **String** | Auth type of the feed:   * `basic`   * `token`   * `noAuth`  | [optional] 
+**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/UpdateList.md

@@ -0,0 +1,9 @@
+# Brevo.UpdateList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the list. Either of the two parameters (name, folderId) can be updated at a time. | [optional] 
+**folderId** | **Number** | Id of the folder in which the list is to be moved. Either of the two parameters (name, folderId) can be updated at a time. | [optional] 
+
+

package/docs/UpdateSender.md

@@ -0,0 +1,10 @@
+# Brevo.UpdateSender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | From Name to update the sender | [optional] 
+**email** | **String** | From Email to update the sender | [optional] 
+**ips** | [**[CreateSenderIps]**](CreateSenderIps.md) | Only in case of dedicated IP, IPs to associate to the sender. If passed, will replace all the existing IPs. | [optional] 
+
+

package/docs/UpdateSmsCampaign.md

@@ -0,0 +1,15 @@
+# Brevo.UpdateSmsCampaign
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the campaign | [optional] 
+**sender** | **String** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** | [optional] 
+**content** | **String** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS | [optional] 
+**recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) |  | [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. | [optional] 
+**unicodeEnabled** | **Boolean** | Format of the message. It indicates whether the content should be treated as unicode or not. | [optional] [default to false]
+**organisationPrefix** | **String** | A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.** | [optional] 
+**unsubscribeInstruction** | **String** | Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include **STOP** keyword. This will be added as instructions after the end of message content. **Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.** | [optional] 
+
+

package/docs/UpdateSmtpTemplate.md

@@ -0,0 +1,17 @@
+# Brevo.UpdateSmtpTemplate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag** | **String** | Tag of the template | [optional] 
+**sender** | [**UpdateSmtpTemplateSender**](UpdateSmtpTemplateSender.md) |  | [optional] 
+**templateName** | **String** | Name of the template | [optional] 
+**htmlContent** | **String** | Required if htmlUrl is empty. If the template is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that template. Body of the message (HTML must have more than 10 characters) | [optional] 
+**htmlUrl** | **String** | Required if htmlContent is empty. URL to the body of the email (HTML) | [optional] 
+**subject** | **String** | Subject of the email | [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] 
+**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] 
+**isActive** | **Boolean** | Status of the template. isActive = false means template is inactive, isActive = true means template is active | [optional] 
+
+

package/docs/UpdateSmtpTemplateSender.md

@@ -0,0 +1,10 @@
+# Brevo.UpdateSmtpTemplateSender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the sender | [optional] 
+**email** | **String** | Email of the sender | [optional] 
+**id** | **Number** | Select the sender for the template 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/UpdateWebhook.md

@@ -0,0 +1,52 @@
+# Brevo.UpdateWebhook
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | URL of the webhook | [optional] 
+**description** | **String** | Description of the webhook | [optional] 
+**events** | **[String]** | - Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed`  | [optional] 
+**domain** | **String** | Inbound domain of webhook, used in case of event type `inbound` | [optional] 
+
+
+<a name="[EventsEnum]"></a>
+## Enum: [EventsEnum]
+
+
+* `sent` (value: `"sent"`)
+
+* `hardBounce` (value: `"hardBounce"`)
+
+* `softBounce` (value: `"softBounce"`)
+
+* `blocked` (value: `"blocked"`)
+
+* `spam` (value: `"spam"`)
+
+* `delivered` (value: `"delivered"`)
+
+* `request` (value: `"request"`)
+
+* `click` (value: `"click"`)
+
+* `invalid` (value: `"invalid"`)
+
+* `deferred` (value: `"deferred"`)
+
+* `opened` (value: `"opened"`)
+
+* `uniqueOpened` (value: `"uniqueOpened"`)
+
+* `unsubscribed` (value: `"unsubscribed"`)
+
+* `listAddition` (value: `"listAddition"`)
+
+* `contactUpdated` (value: `"contactUpdated"`)
+
+* `contactDeleted` (value: `"contactDeleted"`)
+
+* `inboundEmailProcessed` (value: `"inboundEmailProcessed"`)
+
+
+
+

package/docs/UpdateWhatsAppCampaign.md

@@ -0,0 +1,22 @@
+# Brevo.UpdateWhatsAppCampaign
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaignName** | **String** | Name of the campaign | [optional] 
+**campaignStatus** | **String** | Status of the campaign | [optional] [default to 'scheduled']
+**rescheduleFor** | **String** | Reschedule the sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of campaign. **Prefer to pass your timezone in date-time format for accurate result.For example: **2017-06-01T12:30:00+02:00** Use this field to update the scheduledAt of any existing draft or scheduled WhatsApp campaign.  | [optional] 
+**recipients** | [**CreateWhatsAppCampaignRecipients**](CreateWhatsAppCampaignRecipients.md) |  | [optional] 
+
+
+<a name="CampaignStatusEnum"></a>
+## Enum: CampaignStatusEnum
+
+
+* `scheduled` (value: `"scheduled"`)
+
+* `suspended` (value: `"suspended"`)
+
+
+
+

package/docs/UploadImageModel.md

@@ -0,0 +1,8 @@
+# Brevo.UploadImageModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | URL of the image uploaded | 
+
+

package/docs/UploadImageToGallery.md

@@ -0,0 +1,9 @@
+# Brevo.UploadImageToGallery
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**imageUrl** | **String** | The absolute url of the image (no local file). Maximum allowed size for image is 2MB. Allowed extensions for images are - jpeg, jpg, png, bmp, gif. | 
+**name** | **String** | Name of the image. | [optional] 
+
+

package/docs/UserApi.md

@@ -0,0 +1,112 @@
+# Brevo.UserApi
+
+All URIs are relative to *https://api.brevo.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**getInvitedUsersList**](UserApi.md#getInvitedUsersList) | **GET** /organization/invited/users | Get the list of all your users
+[**getUserPermission**](UserApi.md#getUserPermission) | **GET** /organization/user/{email}/permissions | Check user permission
+
+
+<a name="getInvitedUsersList"></a>
+# **getInvitedUsersList**
+> GetInvitedUsersList getInvitedUsersList()
+
+Get the list of all your users
+
+### 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.UserApi();
+apiInstance.getInvitedUsersList().then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetInvitedUsersList**](GetInvitedUsersList.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="getUserPermission"></a>
+# **getUserPermission**
+> GetUserPermission getUserPermission(email)
+
+Check user permission
+
+### 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.UserApi();
+
+var email = "email_example"; // String | Email of the invited user.
+
+apiInstance.getUserPermission(email).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email** | **String**| Email of the invited user. | 
+
+### Return type
+
+[**GetUserPermission**](GetUserPermission.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/VariablesItems.md

@@ -0,0 +1,10 @@
+# Brevo.VariablesItems
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**_default** | **String** |  | [optional] 
+**datatype** | **String** |  | [optional] 
+
+

package/docs/WebhooksApi.md

@@ -0,0 +1,346 @@
+# Brevo.WebhooksApi
+
+All URIs are relative to *https://api.brevo.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**createWebhook**](WebhooksApi.md#createWebhook) | **POST** /webhooks | Create a webhook
+[**deleteWebhook**](WebhooksApi.md#deleteWebhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook
+[**exportWebhooksHistory**](WebhooksApi.md#exportWebhooksHistory) | **POST** /webhooks/export | Export all transactional events
+[**getWebhook**](WebhooksApi.md#getWebhook) | **GET** /webhooks/{webhookId} | Get a webhook details
+[**getWebhooks**](WebhooksApi.md#getWebhooks) | **GET** /webhooks | Get all webhooks
+[**updateWebhook**](WebhooksApi.md#updateWebhook) | **PUT** /webhooks/{webhookId} | Update a webhook
+
+
+<a name="createWebhook"></a>
+# **createWebhook**
+> CreateModel createWebhook(createWebhook)
+
+Create a webhook
+
+### 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.WebhooksApi();
+
+var createWebhook = new Brevo.CreateWebhook(); // CreateWebhook | Values to create a webhook
+
+apiInstance.createWebhook(createWebhook).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **createWebhook** | [**CreateWebhook**](CreateWebhook.md)| Values to create a webhook | 
+
+### Return type
+
+[**CreateModel**](CreateModel.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="deleteWebhook"></a>
+# **deleteWebhook**
+> deleteWebhook(webhookId)
+
+Delete a webhook
+
+### 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.WebhooksApi();
+
+var webhookId = 789; // Number | Id of the webhook
+
+apiInstance.deleteWebhook(webhookId).then(function() {
+  console.log('API called successfully.');
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhookId** | **Number**| Id of the webhook | 
+
+### 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="exportWebhooksHistory"></a>
+# **exportWebhooksHistory**
+> CreatedProcessId exportWebhooksHistory(exportWebhookHistory)
+
+Export all transactional events
+
+This endpoint will submit a request to get the history of webhooks in the CSV file. The link to download that CSV file will send to the webhook link provided in notifyURL of the body payload.
+
+### 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.WebhooksApi();
+
+var exportWebhookHistory = new Brevo.ExportWebhooksHistory(); // ExportWebhooksHistory | Values to submit for webhooks history
+
+apiInstance.exportWebhooksHistory(exportWebhookHistory).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **exportWebhookHistory** | [**ExportWebhooksHistory**](ExportWebhooksHistory.md)| Values to submit for webhooks history | 
+
+### Return type
+
+[**CreatedProcessId**](CreatedProcessId.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="getWebhook"></a>
+# **getWebhook**
+> GetWebhook getWebhook(webhookId)
+
+Get a webhook details
+
+### 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.WebhooksApi();
+
+var webhookId = 789; // Number | Id of the webhook
+
+apiInstance.getWebhook(webhookId).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhookId** | **Number**| Id of the webhook | 
+
+### Return type
+
+[**GetWebhook**](GetWebhook.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="getWebhooks"></a>
+# **getWebhooks**
+> GetWebhooks getWebhooks(opts)
+
+Get all webhooks
+
+### 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.WebhooksApi();
+
+var opts = { 
+  'type': "transactional", // String | Filter on webhook type
+  'sort': "desc" // String | Sort the results in the ascending/descending order of webhook creation
+};
+apiInstance.getWebhooks(opts).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **type** | **String**| Filter on webhook type | [optional] [default to transactional]
+ **sort** | **String**| Sort the results in the ascending/descending order of webhook creation | [optional] [default to desc]
+
+### Return type
+
+[**GetWebhooks**](GetWebhooks.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="updateWebhook"></a>
+# **updateWebhook**
+> updateWebhook(webhookId, updateWebhook)
+
+Update a webhook
+
+### 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.WebhooksApi();
+
+var webhookId = 789; // Number | Id of the webhook
+
+var updateWebhook = new Brevo.UpdateWebhook(); // UpdateWebhook | Values to update a webhook
+
+apiInstance.updateWebhook(webhookId, updateWebhook).then(function() {
+  console.log('API called successfully.');
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhookId** | **Number**| Id of the webhook | 
+ **updateWebhook** | [**UpdateWebhook**](UpdateWebhook.md)| Values to update a webhook | 
+
+### 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
+