@getbrevo/brevo 1.0.1 → 2.0.0-beta.4

package/README.md

@@ -1,16 +1,12 @@
-# brevo
-Brevo's API exposes the entire Brevo features via a standardized programmatic interface. Please refer to the full documentation to learn more.
+# Brevo typescript
 
-This is the wrapper for the API. It implements all the features of the API v3. It supports promises.
+Brevo's API v3 TypeScript-Node Library
 
-Brevo's API matches the OpenAPI v2 definition. The specification can be downloaded here.
+Brevo's API exposes the entire Brevo features via a standardized programmatic interface. Please refer to the full [documentation](https://developers.brevo.com) to learn more.
 
-This library is automatically generated by the Swagger Codegen project and is reviewed and maintained by Brevo:
+This is the wrapper for the API. It implements all the features of the API v3. It supports promises.
 
-- API version: 3.0.0
-- Package version: 1.0.0
-- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
-For more information, please visit [https://account.brevo.com/support](https://account.brevo.com/support)
+Brevo's API matches the [OpenAPI v2 definition](https://www.openapis.org/). The specification can be downloaded [here](https://api.brevo.com/v3/swagger_definition.yml).
 
 ## Installation
 
@@ -18,666 +14,61 @@ For more information, please visit [https://account.brevo.com/support](https://a
 
 #### npm
 
-To publish the library as a [npm](https://www.npmjs.com/),
-please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
+The following recommended installation requires [npm](https://npmjs.org/). If you are unfamiliar with npm, see the [npm docs](https://npmjs.org/doc/).
 
 Then install it via:
 
 ```shell
-npm install @getbrevo/brevo --save
-```
-
-##### Local development
-
-To use the library locally without publishing to a remote npm registry, first install the dependencies by changing 
-into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:
-
-```shell
-npm install
-```
-
-Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:
-
-```shell
-npm link
-```
-
-Finally, switch to the directory you want to use your brevo from, and run:
-
-```shell
-npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
-```
-
-You should now be able to `require('@getbrevo/brevo')` in javascript files from the directory you ran the last 
-command above from.
-
-#### git
-#
-If the library is hosted at a git repository, e.g.
-https://github.com/GIT_USER_ID/GIT_REPO_ID
-then install it via:
-
-```shell
-    npm install GIT_USER_ID/GIT_REPO_ID --save
-```
-
-### For browser
-
-The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
-the above steps with Node.js and installing browserify with `npm install -g browserify`,
-perform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually 
-use this library):
-
-```shell
-browserify main.js > bundle.js
-```
-
-Then include *bundle.js* in the HTML pages.
-
-### Webpack Configuration
-
-Using Webpack you may encounter the following error: "Module not found: Error:
-Cannot resolve module", most certainly you should disable AMD loader. Add/merge
-the following section to your webpack config:
-
-```javascript
-module: {
-  rules: [
-    {
-      parser: {
-        amd: false
-      }
-    }
-  ]
-}
+npm i @getbrevo/brevo --save
+# or
+yarn add @getbrevo/brevo
 ```
 
 ## Getting Started
 
-Please follow the [installation](#installation) instruction and execute the following JS code:
+Once you have [installed](#installation) the node module in your project, you can execute the following sample code JS code :
 
 ```javascript
-var Brevo = require('@getbrevo/brevo');
+const SibApiV3Sdk = require('@getbrevo/brevo');
 
-var defaultClient = Brevo.ApiClient.instance;
+let apiInstance = new SibApiV3Sdk.AccountApi();
 
-// 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['api-key'] = "Token"
+apiInstance.setApiKey(SibApiV3Sdk.AccountApiApiKeys.apiKey, 'YOUR API KEY')
 
-// 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['partner-key'] = "Token"
+apiInstance.getAccount().then(function(data) {
+  console.log('API called successfully. Returned data: ' + JSON.stringify(data));
 
-var api = new Brevo.AccountApi()
-api.getAccount().then(function(data) {
-  console.log('API called successfully. Returned data: ' + data);
 }, function(error) {
   console.error(error);
 });
-
-
 ```
 
-## Documentation for API Endpoints
-
-All URIs are relative to *https://api.brevo.com/v3*
-
-Class | Method | HTTP request | Description
------------- | ------------- | ------------- | -------------
-*Brevo.AccountApi* | [**getAccount**](docs/AccountApi.md#getAccount) | **GET** /account | Get your account information, plan and credits details
-*Brevo.AccountApi* | [**getAccountActivity**](docs/AccountApi.md#getAccountActivity) | **GET** /organization/activities | Get user activity logs
-*Brevo.CompaniesApi* | [**companiesAttributesGet**](docs/CompaniesApi.md#companiesAttributesGet) | **GET** /companies/attributes | Get company attributes
-*Brevo.CompaniesApi* | [**companiesGet**](docs/CompaniesApi.md#companiesGet) | **GET** /companies | Get all companies
-*Brevo.CompaniesApi* | [**companiesIdDelete**](docs/CompaniesApi.md#companiesIdDelete) | **DELETE** /companies/{id} | Delete a company
-*Brevo.CompaniesApi* | [**companiesIdGet**](docs/CompaniesApi.md#companiesIdGet) | **GET** /companies/{id} | Get a company
-*Brevo.CompaniesApi* | [**companiesIdPatch**](docs/CompaniesApi.md#companiesIdPatch) | **PATCH** /companies/{id} | Update a company
-*Brevo.CompaniesApi* | [**companiesLinkUnlinkIdPatch**](docs/CompaniesApi.md#companiesLinkUnlinkIdPatch) | **PATCH** /companies/link-unlink/{id} | Link and Unlink company with contacts and deals
-*Brevo.CompaniesApi* | [**companiesPost**](docs/CompaniesApi.md#companiesPost) | **POST** /companies | Create a company
-*Brevo.ContactsApi* | [**addContactToList**](docs/ContactsApi.md#addContactToList) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
-*Brevo.ContactsApi* | [**createAttribute**](docs/ContactsApi.md#createAttribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
-*Brevo.ContactsApi* | [**createContact**](docs/ContactsApi.md#createContact) | **POST** /contacts | Create a contact
-*Brevo.ContactsApi* | [**createDoiContact**](docs/ContactsApi.md#createDoiContact) | **POST** /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow
-*Brevo.ContactsApi* | [**createFolder**](docs/ContactsApi.md#createFolder) | **POST** /contacts/folders | Create a folder
-*Brevo.ContactsApi* | [**createList**](docs/ContactsApi.md#createList) | **POST** /contacts/lists | Create a list
-*Brevo.ContactsApi* | [**deleteAttribute**](docs/ContactsApi.md#deleteAttribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
-*Brevo.ContactsApi* | [**deleteContact**](docs/ContactsApi.md#deleteContact) | **DELETE** /contacts/{identifier} | Delete a contact
-*Brevo.ContactsApi* | [**deleteFolder**](docs/ContactsApi.md#deleteFolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
-*Brevo.ContactsApi* | [**deleteList**](docs/ContactsApi.md#deleteList) | **DELETE** /contacts/lists/{listId} | Delete a list
-*Brevo.ContactsApi* | [**getAttributes**](docs/ContactsApi.md#getAttributes) | **GET** /contacts/attributes | List all attributes
-*Brevo.ContactsApi* | [**getContactInfo**](docs/ContactsApi.md#getContactInfo) | **GET** /contacts/{identifier} | Get a contact's details
-*Brevo.ContactsApi* | [**getContactStats**](docs/ContactsApi.md#getContactStats) | **GET** /contacts/{identifier}/campaignStats | Get email campaigns' statistics for a contact
-*Brevo.ContactsApi* | [**getContacts**](docs/ContactsApi.md#getContacts) | **GET** /contacts | Get all the contacts
-*Brevo.ContactsApi* | [**getContactsFromList**](docs/ContactsApi.md#getContactsFromList) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
-*Brevo.ContactsApi* | [**getFolder**](docs/ContactsApi.md#getFolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
-*Brevo.ContactsApi* | [**getFolderLists**](docs/ContactsApi.md#getFolderLists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
-*Brevo.ContactsApi* | [**getFolders**](docs/ContactsApi.md#getFolders) | **GET** /contacts/folders | Get all folders
-*Brevo.ContactsApi* | [**getList**](docs/ContactsApi.md#getList) | **GET** /contacts/lists/{listId} | Get a list's details
-*Brevo.ContactsApi* | [**getLists**](docs/ContactsApi.md#getLists) | **GET** /contacts/lists | Get all the lists
-*Brevo.ContactsApi* | [**getSegments**](docs/ContactsApi.md#getSegments) | **GET** /contacts/segments | Get all the Segments
-*Brevo.ContactsApi* | [**importContacts**](docs/ContactsApi.md#importContacts) | **POST** /contacts/import | Import contacts
-*Brevo.ContactsApi* | [**removeContactFromList**](docs/ContactsApi.md#removeContactFromList) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
-*Brevo.ContactsApi* | [**requestContactExport**](docs/ContactsApi.md#requestContactExport) | **POST** /contacts/export | Export contacts
-*Brevo.ContactsApi* | [**updateAttribute**](docs/ContactsApi.md#updateAttribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
-*Brevo.ContactsApi* | [**updateBatchContacts**](docs/ContactsApi.md#updateBatchContacts) | **POST** /contacts/batch | Update multiple contacts
-*Brevo.ContactsApi* | [**updateContact**](docs/ContactsApi.md#updateContact) | **PUT** /contacts/{identifier} | Update a contact
-*Brevo.ContactsApi* | [**updateFolder**](docs/ContactsApi.md#updateFolder) | **PUT** /contacts/folders/{folderId} | Update a folder
-*Brevo.ContactsApi* | [**updateList**](docs/ContactsApi.md#updateList) | **PUT** /contacts/lists/{listId} | Update a list
-*Brevo.ConversationsApi* | [**conversationsAgentOnlinePingPost**](docs/ConversationsApi.md#conversationsAgentOnlinePingPost) | **POST** /conversations/agentOnlinePing | Sets agent’s status to online for 2-3 minutes
-*Brevo.ConversationsApi* | [**conversationsMessagesIdDelete**](docs/ConversationsApi.md#conversationsMessagesIdDelete) | **DELETE** /conversations/messages/{id} | Delete a message sent by an agent
-*Brevo.ConversationsApi* | [**conversationsMessagesIdGet**](docs/ConversationsApi.md#conversationsMessagesIdGet) | **GET** /conversations/messages/{id} | Get a message
-*Brevo.ConversationsApi* | [**conversationsMessagesIdPut**](docs/ConversationsApi.md#conversationsMessagesIdPut) | **PUT** /conversations/messages/{id} | Update a message sent by an agent
-*Brevo.ConversationsApi* | [**conversationsMessagesPost**](docs/ConversationsApi.md#conversationsMessagesPost) | **POST** /conversations/messages | Send a message as an agent
-*Brevo.ConversationsApi* | [**conversationsPushedMessagesIdDelete**](docs/ConversationsApi.md#conversationsPushedMessagesIdDelete) | **DELETE** /conversations/pushedMessages/{id} | Delete an automated message
-*Brevo.ConversationsApi* | [**conversationsPushedMessagesIdGet**](docs/ConversationsApi.md#conversationsPushedMessagesIdGet) | **GET** /conversations/pushedMessages/{id} | Get an automated message
-*Brevo.ConversationsApi* | [**conversationsPushedMessagesIdPut**](docs/ConversationsApi.md#conversationsPushedMessagesIdPut) | **PUT** /conversations/pushedMessages/{id} | Update an automated message
-*Brevo.ConversationsApi* | [**conversationsPushedMessagesPost**](docs/ConversationsApi.md#conversationsPushedMessagesPost) | **POST** /conversations/pushedMessages | Send an automated message to a visitor
-*Brevo.CouponsApi* | [**createCouponCollection**](docs/CouponsApi.md#createCouponCollection) | **POST** /couponCollections | Create а coupon collection
-*Brevo.CouponsApi* | [**createCoupons**](docs/CouponsApi.md#createCoupons) | **POST** /coupons | Create coupons for a coupon collection
-*Brevo.CouponsApi* | [**getCouponCollection**](docs/CouponsApi.md#getCouponCollection) | **GET** /couponCollections/{id} | Get a coupon collection by id
-*Brevo.CouponsApi* | [**getCouponCollections**](docs/CouponsApi.md#getCouponCollections) | **GET** /couponCollections | Get all your coupon collections
-*Brevo.CouponsApi* | [**updateCouponCollection**](docs/CouponsApi.md#updateCouponCollection) | **PATCH** /couponCollections/{id} | Update a coupon collection by id
-*Brevo.DealsApi* | [**crmAttributesDealsGet**](docs/DealsApi.md#crmAttributesDealsGet) | **GET** /crm/attributes/deals | Get deal attributes
-*Brevo.DealsApi* | [**crmDealsGet**](docs/DealsApi.md#crmDealsGet) | **GET** /crm/deals | Get all deals
-*Brevo.DealsApi* | [**crmDealsIdDelete**](docs/DealsApi.md#crmDealsIdDelete) | **DELETE** /crm/deals/{id} | Delete a deal
-*Brevo.DealsApi* | [**crmDealsIdGet**](docs/DealsApi.md#crmDealsIdGet) | **GET** /crm/deals/{id} | Get a deal
-*Brevo.DealsApi* | [**crmDealsIdPatch**](docs/DealsApi.md#crmDealsIdPatch) | **PATCH** /crm/deals/{id} | Update a deal
-*Brevo.DealsApi* | [**crmDealsLinkUnlinkIdPatch**](docs/DealsApi.md#crmDealsLinkUnlinkIdPatch) | **PATCH** /crm/deals/link-unlink/{id} | Link and Unlink a deal with contacts and companies
-*Brevo.DealsApi* | [**crmDealsPost**](docs/DealsApi.md#crmDealsPost) | **POST** /crm/deals | Create a deal
-*Brevo.DealsApi* | [**crmPipelineDetailsGet**](docs/DealsApi.md#crmPipelineDetailsGet) | **GET** /crm/pipeline/details | Get pipeline stages
-*Brevo.DealsApi* | [**crmPipelineDetailsPipelineIDGet**](docs/DealsApi.md#crmPipelineDetailsPipelineIDGet) | **GET** /crm/pipeline/details/{pipelineID} | Get pipelines and their details
-*Brevo.DomainsApi* | [**authenticateDomain**](docs/DomainsApi.md#authenticateDomain) | **PUT** /senders/domains/{domainName}/authenticate | Authenticate a domain
-*Brevo.DomainsApi* | [**createDomain**](docs/DomainsApi.md#createDomain) | **POST** /senders/domains | Create a new domain
-*Brevo.DomainsApi* | [**deleteDomain**](docs/DomainsApi.md#deleteDomain) | **DELETE** /senders/domains/{domainName} | Delete a domain
-*Brevo.DomainsApi* | [**getDomainConfiguration**](docs/DomainsApi.md#getDomainConfiguration) | **GET** /senders/domains/{domainName} | Validate domain configuration
-*Brevo.DomainsApi* | [**getDomains**](docs/DomainsApi.md#getDomains) | **GET** /senders/domains | Get the list of all your domains
-*Brevo.EcommerceApi* | [**createBatchOrder**](docs/EcommerceApi.md#createBatchOrder) | **POST** /orders/status/batch | Create orders in batch
-*Brevo.EcommerceApi* | [**createOrder**](docs/EcommerceApi.md#createOrder) | **POST** /orders/status | Managing the status of the order
-*Brevo.EcommerceApi* | [**createUpdateBatchCategory**](docs/EcommerceApi.md#createUpdateBatchCategory) | **POST** /categories/batch | Create categories in batch
-*Brevo.EcommerceApi* | [**createUpdateBatchProducts**](docs/EcommerceApi.md#createUpdateBatchProducts) | **POST** /products/batch | Create products in batch
-*Brevo.EcommerceApi* | [**createUpdateCategory**](docs/EcommerceApi.md#createUpdateCategory) | **POST** /categories | Create/Update a category
-*Brevo.EcommerceApi* | [**createUpdateProduct**](docs/EcommerceApi.md#createUpdateProduct) | **POST** /products | Create/Update a product
-*Brevo.EcommerceApi* | [**ecommerceActivatePost**](docs/EcommerceApi.md#ecommerceActivatePost) | **POST** /ecommerce/activate | Activate the eCommerce app
-*Brevo.EcommerceApi* | [**getCategories**](docs/EcommerceApi.md#getCategories) | **GET** /categories | Return all your categories
-*Brevo.EcommerceApi* | [**getCategoryInfo**](docs/EcommerceApi.md#getCategoryInfo) | **GET** /categories/{id} | Get a category details
-*Brevo.EcommerceApi* | [**getProductInfo**](docs/EcommerceApi.md#getProductInfo) | **GET** /products/{id} | Get a product's details
-*Brevo.EcommerceApi* | [**getProducts**](docs/EcommerceApi.md#getProducts) | **GET** /products | Return all your products
-*Brevo.EmailCampaignsApi* | [**createEmailCampaign**](docs/EmailCampaignsApi.md#createEmailCampaign) | **POST** /emailCampaigns | Create an email campaign
-*Brevo.EmailCampaignsApi* | [**deleteEmailCampaign**](docs/EmailCampaignsApi.md#deleteEmailCampaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
-*Brevo.EmailCampaignsApi* | [**emailExportRecipients**](docs/EmailCampaignsApi.md#emailExportRecipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of an email campaign
-*Brevo.EmailCampaignsApi* | [**getAbTestCampaignResult**](docs/EmailCampaignsApi.md#getAbTestCampaignResult) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get an A/B test email campaign results
-*Brevo.EmailCampaignsApi* | [**getEmailCampaign**](docs/EmailCampaignsApi.md#getEmailCampaign) | **GET** /emailCampaigns/{campaignId} | Get an email campaign report
-*Brevo.EmailCampaignsApi* | [**getEmailCampaigns**](docs/EmailCampaignsApi.md#getEmailCampaigns) | **GET** /emailCampaigns | Return all your created email campaigns
-*Brevo.EmailCampaignsApi* | [**getSharedTemplateUrl**](docs/EmailCampaignsApi.md#getSharedTemplateUrl) | **GET** /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url
-*Brevo.EmailCampaignsApi* | [**sendEmailCampaignNow**](docs/EmailCampaignsApi.md#sendEmailCampaignNow) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId
-*Brevo.EmailCampaignsApi* | [**sendReport**](docs/EmailCampaignsApi.md#sendReport) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaign
-*Brevo.EmailCampaignsApi* | [**sendTestEmail**](docs/EmailCampaignsApi.md#sendTestEmail) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
-*Brevo.EmailCampaignsApi* | [**updateCampaignStatus**](docs/EmailCampaignsApi.md#updateCampaignStatus) | **PUT** /emailCampaigns/{campaignId}/status | Update an email campaign status
-*Brevo.EmailCampaignsApi* | [**updateEmailCampaign**](docs/EmailCampaignsApi.md#updateEmailCampaign) | **PUT** /emailCampaigns/{campaignId} | Update an email campaign
-*Brevo.EmailCampaignsApi* | [**uploadImageToGallery**](docs/EmailCampaignsApi.md#uploadImageToGallery) | **POST** /emailCampaigns/images | Upload an image to your account's image gallery
-*Brevo.ExternalFeedsApi* | [**createExternalFeed**](docs/ExternalFeedsApi.md#createExternalFeed) | **POST** /feeds | Create an external feed
-*Brevo.ExternalFeedsApi* | [**deleteExternalFeed**](docs/ExternalFeedsApi.md#deleteExternalFeed) | **DELETE** /feeds/{uuid} | Delete an external feed
-*Brevo.ExternalFeedsApi* | [**getAllExternalFeeds**](docs/ExternalFeedsApi.md#getAllExternalFeeds) | **GET** /feeds | Fetch all external feeds
-*Brevo.ExternalFeedsApi* | [**getExternalFeedByUUID**](docs/ExternalFeedsApi.md#getExternalFeedByUUID) | **GET** /feeds/{uuid} | Get an external feed by UUID
-*Brevo.ExternalFeedsApi* | [**updateExternalFeed**](docs/ExternalFeedsApi.md#updateExternalFeed) | **PUT** /feeds/{uuid} | Update an external feed
-*Brevo.FilesApi* | [**crmFilesGet**](docs/FilesApi.md#crmFilesGet) | **GET** /crm/files | Get all files
-*Brevo.FilesApi* | [**crmFilesIdDataGet**](docs/FilesApi.md#crmFilesIdDataGet) | **GET** /crm/files/{id}/data | Get file details
-*Brevo.FilesApi* | [**crmFilesIdDelete**](docs/FilesApi.md#crmFilesIdDelete) | **DELETE** /crm/files/{id} | Delete a file
-*Brevo.FilesApi* | [**crmFilesIdGet**](docs/FilesApi.md#crmFilesIdGet) | **GET** /crm/files/{id} | Download a file
-*Brevo.FilesApi* | [**crmFilesPost**](docs/FilesApi.md#crmFilesPost) | **POST** /crm/files | Upload a file
-*Brevo.InboundParsingApi* | [**getInboundEmailAttachment**](docs/InboundParsingApi.md#getInboundEmailAttachment) | **GET** /inbound/attachments/{downloadToken} | Retrieve inbound attachment with download token.
-*Brevo.InboundParsingApi* | [**getInboundEmailEvents**](docs/InboundParsingApi.md#getInboundEmailEvents) | **GET** /inbound/events | Get the list of all the events for the received emails.
-*Brevo.InboundParsingApi* | [**getInboundEmailEventsByUuid**](docs/InboundParsingApi.md#getInboundEmailEventsByUuid) | **GET** /inbound/events/{uuid} | Fetch all events history for one particular received email.
-*Brevo.MasterAccountApi* | [**corporateMasterAccountGet**](docs/MasterAccountApi.md#corporateMasterAccountGet) | **GET** /corporate/masterAccount | Get the details of requested master account
-*Brevo.MasterAccountApi* | [**corporateSubAccountGet**](docs/MasterAccountApi.md#corporateSubAccountGet) | **GET** /corporate/subAccount | Get the list of all the sub-accounts of the master account.
-*Brevo.MasterAccountApi* | [**corporateSubAccountIdDelete**](docs/MasterAccountApi.md#corporateSubAccountIdDelete) | **DELETE** /corporate/subAccount/{id} | Delete a sub-account
-*Brevo.MasterAccountApi* | [**corporateSubAccountIdGet**](docs/MasterAccountApi.md#corporateSubAccountIdGet) | **GET** /corporate/subAccount/{id} | Get sub-account details
-*Brevo.MasterAccountApi* | [**corporateSubAccountIdPlanPut**](docs/MasterAccountApi.md#corporateSubAccountIdPlanPut) | **PUT** /corporate/subAccount/{id}/plan | Update sub-account plan
-*Brevo.MasterAccountApi* | [**corporateSubAccountKeyPost**](docs/MasterAccountApi.md#corporateSubAccountKeyPost) | **POST** /corporate/subAccount/key | Create an API key for a sub-account
-*Brevo.MasterAccountApi* | [**corporateSubAccountPost**](docs/MasterAccountApi.md#corporateSubAccountPost) | **POST** /corporate/subAccount | Create a new sub-account under a master account.
-*Brevo.MasterAccountApi* | [**corporateSubAccountSsoTokenPost**](docs/MasterAccountApi.md#corporateSubAccountSsoTokenPost) | **POST** /corporate/subAccount/ssoToken | Generate SSO token to access Brevo
-*Brevo.MasterAccountApi* | [**getAccountActivity**](docs/MasterAccountApi.md#getAccountActivity) | **GET** /organization/activities | Get user activity logs
-*Brevo.NotesApi* | [**crmNotesGet**](docs/NotesApi.md#crmNotesGet) | **GET** /crm/notes | Get all notes
-*Brevo.NotesApi* | [**crmNotesIdDelete**](docs/NotesApi.md#crmNotesIdDelete) | **DELETE** /crm/notes/{id} | Delete a note
-*Brevo.NotesApi* | [**crmNotesIdGet**](docs/NotesApi.md#crmNotesIdGet) | **GET** /crm/notes/{id} | Get a note
-*Brevo.NotesApi* | [**crmNotesIdPatch**](docs/NotesApi.md#crmNotesIdPatch) | **PATCH** /crm/notes/{id} | Update a note
-*Brevo.NotesApi* | [**crmNotesPost**](docs/NotesApi.md#crmNotesPost) | **POST** /crm/notes | Create a note
-*Brevo.ProcessApi* | [**getProcess**](docs/ProcessApi.md#getProcess) | **GET** /processes/{processId} | Return the informations for a process
-*Brevo.ProcessApi* | [**getProcesses**](docs/ProcessApi.md#getProcesses) | **GET** /processes | Return all the processes for your account
-*Brevo.ResellerApi* | [**addCredits**](docs/ResellerApi.md#addCredits) | **POST** /reseller/children/{childIdentifier}/credits/add | Add Email and/or SMS credits to a specific child account
-*Brevo.ResellerApi* | [**associateIpToChild**](docs/ResellerApi.md#associateIpToChild) | **POST** /reseller/children/{childIdentifier}/ips/associate | Associate a dedicated IP to the child
-*Brevo.ResellerApi* | [**createChildDomain**](docs/ResellerApi.md#createChildDomain) | **POST** /reseller/children/{childIdentifier}/domains | Create a domain for a child account
-*Brevo.ResellerApi* | [**createResellerChild**](docs/ResellerApi.md#createResellerChild) | **POST** /reseller/children | Creates a reseller child
-*Brevo.ResellerApi* | [**deleteChildDomain**](docs/ResellerApi.md#deleteChildDomain) | **DELETE** /reseller/children/{childIdentifier}/domains/{domainName} | Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
-*Brevo.ResellerApi* | [**deleteResellerChild**](docs/ResellerApi.md#deleteResellerChild) | **DELETE** /reseller/children/{childIdentifier} | Delete a single reseller child based on the child identifier supplied
-*Brevo.ResellerApi* | [**dissociateIpFromChild**](docs/ResellerApi.md#dissociateIpFromChild) | **POST** /reseller/children/{childIdentifier}/ips/dissociate | Dissociate a dedicated IP to the child
-*Brevo.ResellerApi* | [**getChildAccountCreationStatus**](docs/ResellerApi.md#getChildAccountCreationStatus) | **GET** /reseller/children/{childIdentifier}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
-*Brevo.ResellerApi* | [**getChildDomains**](docs/ResellerApi.md#getChildDomains) | **GET** /reseller/children/{childIdentifier}/domains | Get all sender domains for a specific child account
-*Brevo.ResellerApi* | [**getChildInfo**](docs/ResellerApi.md#getChildInfo) | **GET** /reseller/children/{childIdentifier} | Get a child account's details
-*Brevo.ResellerApi* | [**getResellerChilds**](docs/ResellerApi.md#getResellerChilds) | **GET** /reseller/children | Get the list of all children accounts
-*Brevo.ResellerApi* | [**getSsoToken**](docs/ResellerApi.md#getSsoToken) | **GET** /reseller/children/{childIdentifier}/auth | Get session token to access Brevo (SSO)
-*Brevo.ResellerApi* | [**removeCredits**](docs/ResellerApi.md#removeCredits) | **POST** /reseller/children/{childIdentifier}/credits/remove | Remove Email and/or SMS credits from a specific child account
-*Brevo.ResellerApi* | [**updateChildAccountStatus**](docs/ResellerApi.md#updateChildAccountStatus) | **PUT** /reseller/children/{childIdentifier}/accountStatus | Update info of reseller's child account status based on the childIdentifier supplied
-*Brevo.ResellerApi* | [**updateChildDomain**](docs/ResellerApi.md#updateChildDomain) | **PUT** /reseller/children/{childIdentifier}/domains/{domainName} | Update the sender domain of reseller's child based on the childIdentifier and domainName passed
-*Brevo.ResellerApi* | [**updateResellerChild**](docs/ResellerApi.md#updateResellerChild) | **PUT** /reseller/children/{childIdentifier} | Update info of reseller's child based on the child identifier supplied
-*Brevo.SMSCampaignsApi* | [**createSmsCampaign**](docs/SMSCampaignsApi.md#createSmsCampaign) | **POST** /smsCampaigns | Creates an SMS campaign
-*Brevo.SMSCampaignsApi* | [**deleteSmsCampaign**](docs/SMSCampaignsApi.md#deleteSmsCampaign) | **DELETE** /smsCampaigns/{campaignId} | Delete an SMS campaign
-*Brevo.SMSCampaignsApi* | [**getSmsCampaign**](docs/SMSCampaignsApi.md#getSmsCampaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
-*Brevo.SMSCampaignsApi* | [**getSmsCampaigns**](docs/SMSCampaignsApi.md#getSmsCampaigns) | **GET** /smsCampaigns | Returns the information for all your created SMS campaigns
-*Brevo.SMSCampaignsApi* | [**requestSmsRecipientExport**](docs/SMSCampaignsApi.md#requestSmsRecipientExport) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Export an SMS campaign's recipients
-*Brevo.SMSCampaignsApi* | [**sendSmsCampaignNow**](docs/SMSCampaignsApi.md#sendSmsCampaignNow) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately
-*Brevo.SMSCampaignsApi* | [**sendSmsReport**](docs/SMSCampaignsApi.md#sendSmsReport) | **POST** /smsCampaigns/{campaignId}/sendReport | Send an SMS campaign's report
-*Brevo.SMSCampaignsApi* | [**sendTestSms**](docs/SMSCampaignsApi.md#sendTestSms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign
-*Brevo.SMSCampaignsApi* | [**updateSmsCampaign**](docs/SMSCampaignsApi.md#updateSmsCampaign) | **PUT** /smsCampaigns/{campaignId} | Update an SMS campaign
-*Brevo.SMSCampaignsApi* | [**updateSmsCampaignStatus**](docs/SMSCampaignsApi.md#updateSmsCampaignStatus) | **PUT** /smsCampaigns/{campaignId}/status | Update a campaign's status
-*Brevo.SendersApi* | [**createSender**](docs/SendersApi.md#createSender) | **POST** /senders | Create a new sender
-*Brevo.SendersApi* | [**deleteSender**](docs/SendersApi.md#deleteSender) | **DELETE** /senders/{senderId} | Delete a sender
-*Brevo.SendersApi* | [**getIps**](docs/SendersApi.md#getIps) | **GET** /senders/ips | Get all the dedicated IPs for your account
-*Brevo.SendersApi* | [**getIpsFromSender**](docs/SendersApi.md#getIpsFromSender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender
-*Brevo.SendersApi* | [**getSenders**](docs/SendersApi.md#getSenders) | **GET** /senders | Get the list of all your senders
-*Brevo.SendersApi* | [**updateSender**](docs/SendersApi.md#updateSender) | **PUT** /senders/{senderId} | Update a sender
-*Brevo.SendersApi* | [**validateSenderByOTP**](docs/SendersApi.md#validateSenderByOTP) | **PUT** /senders/{senderId}/validate | Update a sender
-*Brevo.TasksApi* | [**crmTasksGet**](docs/TasksApi.md#crmTasksGet) | **GET** /crm/tasks | Get all tasks
-*Brevo.TasksApi* | [**crmTasksIdDelete**](docs/TasksApi.md#crmTasksIdDelete) | **DELETE** /crm/tasks/{id} | Delete a task
-*Brevo.TasksApi* | [**crmTasksIdGet**](docs/TasksApi.md#crmTasksIdGet) | **GET** /crm/tasks/{id} | Get a task
-*Brevo.TasksApi* | [**crmTasksIdPatch**](docs/TasksApi.md#crmTasksIdPatch) | **PATCH** /crm/tasks/{id} | Update a task
-*Brevo.TasksApi* | [**crmTasksPost**](docs/TasksApi.md#crmTasksPost) | **POST** /crm/tasks | Create a task
-*Brevo.TasksApi* | [**crmTasktypesGet**](docs/TasksApi.md#crmTasktypesGet) | **GET** /crm/tasktypes | Get all task types
-*Brevo.TransactionalEmailsApi* | [**blockNewDomain**](docs/TransactionalEmailsApi.md#blockNewDomain) | **POST** /smtp/blockedDomains | Add a new domain to the list of blocked domains
-*Brevo.TransactionalEmailsApi* | [**createSmtpTemplate**](docs/TransactionalEmailsApi.md#createSmtpTemplate) | **POST** /smtp/templates | Create an email template
-*Brevo.TransactionalEmailsApi* | [**deleteBlockedDomain**](docs/TransactionalEmailsApi.md#deleteBlockedDomain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains
-*Brevo.TransactionalEmailsApi* | [**deleteHardbounces**](docs/TransactionalEmailsApi.md#deleteHardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
-*Brevo.TransactionalEmailsApi* | [**deleteScheduledEmailById**](docs/TransactionalEmailsApi.md#deleteScheduledEmailById) | **DELETE** /smtp/email/{identifier} | Delete scheduled emails by batchId or messageId
-*Brevo.TransactionalEmailsApi* | [**deleteSmtpTemplate**](docs/TransactionalEmailsApi.md#deleteSmtpTemplate) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
-*Brevo.TransactionalEmailsApi* | [**getAggregatedSmtpReport**](docs/TransactionalEmailsApi.md#getAggregatedSmtpReport) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
-*Brevo.TransactionalEmailsApi* | [**getBlockedDomains**](docs/TransactionalEmailsApi.md#getBlockedDomains) | **GET** /smtp/blockedDomains | Get the list of blocked domains
-*Brevo.TransactionalEmailsApi* | [**getEmailEventReport**](docs/TransactionalEmailsApi.md#getEmailEventReport) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
-*Brevo.TransactionalEmailsApi* | [**getScheduledEmailByBatchId**](docs/TransactionalEmailsApi.md#getScheduledEmailByBatchId) | **GET** /smtp/emailStatus/{batchId} | Fetch scheduled emails by batchId
-*Brevo.TransactionalEmailsApi* | [**getScheduledEmailByMessageId**](docs/TransactionalEmailsApi.md#getScheduledEmailByMessageId) | **GET** /smtp/emailStatus/{messageId} | Fetch scheduled email by messageId
-*Brevo.TransactionalEmailsApi* | [**getSmtpReport**](docs/TransactionalEmailsApi.md#getSmtpReport) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
-*Brevo.TransactionalEmailsApi* | [**getSmtpTemplate**](docs/TransactionalEmailsApi.md#getSmtpTemplate) | **GET** /smtp/templates/{templateId} | Returns the template information
-*Brevo.TransactionalEmailsApi* | [**getSmtpTemplates**](docs/TransactionalEmailsApi.md#getSmtpTemplates) | **GET** /smtp/templates | Get the list of email templates
-*Brevo.TransactionalEmailsApi* | [**getTransacBlockedContacts**](docs/TransactionalEmailsApi.md#getTransacBlockedContacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
-*Brevo.TransactionalEmailsApi* | [**getTransacEmailContent**](docs/TransactionalEmailsApi.md#getTransacEmailContent) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
-*Brevo.TransactionalEmailsApi* | [**getTransacEmailsList**](docs/TransactionalEmailsApi.md#getTransacEmailsList) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
-*Brevo.TransactionalEmailsApi* | [**sendTestTemplate**](docs/TransactionalEmailsApi.md#sendTestTemplate) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
-*Brevo.TransactionalEmailsApi* | [**sendTransacEmail**](docs/TransactionalEmailsApi.md#sendTransacEmail) | **POST** /smtp/email | Send a transactional email
-*Brevo.TransactionalEmailsApi* | [**smtpBlockedContactsEmailDelete**](docs/TransactionalEmailsApi.md#smtpBlockedContactsEmailDelete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
-*Brevo.TransactionalEmailsApi* | [**smtpLogMessageIdDelete**](docs/TransactionalEmailsApi.md#smtpLogMessageIdDelete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
-*Brevo.TransactionalEmailsApi* | [**updateSmtpTemplate**](docs/TransactionalEmailsApi.md#updateSmtpTemplate) | **PUT** /smtp/templates/{templateId} | Update an email template
-*Brevo.TransactionalSMSApi* | [**getSmsEvents**](docs/TransactionalSMSApi.md#getSmsEvents) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events)
-*Brevo.TransactionalSMSApi* | [**getTransacAggregatedSmsReport**](docs/TransactionalSMSApi.md#getTransacAggregatedSmsReport) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time
-*Brevo.TransactionalSMSApi* | [**getTransacSmsReport**](docs/TransactionalSMSApi.md#getTransacSmsReport) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day
-*Brevo.TransactionalSMSApi* | [**sendTransacSms**](docs/TransactionalSMSApi.md#sendTransacSms) | **POST** /transactionalSMS/sms | Send SMS message to a mobile number
-*Brevo.TransactionalWhatsAppApi* | [**getWhatsappEventReport**](docs/TransactionalWhatsAppApi.md#getWhatsappEventReport) | **GET** /whatsapp/statistics/events | Get all your WhatsApp activity (unaggregated events)
-*Brevo.TransactionalWhatsAppApi* | [**sendWhatsappMessage**](docs/TransactionalWhatsAppApi.md#sendWhatsappMessage) | **POST** /whatsapp/sendMessage | Send a WhatsApp message
-*Brevo.UserApi* | [**getInvitedUsersList**](docs/UserApi.md#getInvitedUsersList) | **GET** /organization/invited/users | Get the list of all your users
-*Brevo.UserApi* | [**getUserPermission**](docs/UserApi.md#getUserPermission) | **GET** /organization/user/{email}/permissions | Check user permission
-*Brevo.WebhooksApi* | [**createWebhook**](docs/WebhooksApi.md#createWebhook) | **POST** /webhooks | Create a webhook
-*Brevo.WebhooksApi* | [**deleteWebhook**](docs/WebhooksApi.md#deleteWebhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook
-*Brevo.WebhooksApi* | [**exportWebhooksHistory**](docs/WebhooksApi.md#exportWebhooksHistory) | **POST** /webhooks/export | Export all transactional events
-*Brevo.WebhooksApi* | [**getWebhook**](docs/WebhooksApi.md#getWebhook) | **GET** /webhooks/{webhookId} | Get a webhook details
-*Brevo.WebhooksApi* | [**getWebhooks**](docs/WebhooksApi.md#getWebhooks) | **GET** /webhooks | Get all webhooks
-*Brevo.WebhooksApi* | [**updateWebhook**](docs/WebhooksApi.md#updateWebhook) | **PUT** /webhooks/{webhookId} | Update a webhook
-*Brevo.WhatsAppCampaignsApi* | [**createWhatsAppCampaign**](docs/WhatsAppCampaignsApi.md#createWhatsAppCampaign) | **POST** /whatsappCampaigns | Create and Send a WhatsApp campaign
-*Brevo.WhatsAppCampaignsApi* | [**createWhatsAppTemplate**](docs/WhatsAppCampaignsApi.md#createWhatsAppTemplate) | **POST** /whatsppCampaigns/template | Create a WhatsApp template
-*Brevo.WhatsAppCampaignsApi* | [**deleteWhatsAppCampaign**](docs/WhatsAppCampaignsApi.md#deleteWhatsAppCampaign) | **DELETE** /whatsappCampaigns/{campaignId} | Delete a WhatsApp campaign
-*Brevo.WhatsAppCampaignsApi* | [**getWhatsAppCampaign**](docs/WhatsAppCampaignsApi.md#getWhatsAppCampaign) | **GET** /whatsappCampaigns/{campaignId} | Get a WhatsApp campaign
-*Brevo.WhatsAppCampaignsApi* | [**getWhatsAppCampaigns**](docs/WhatsAppCampaignsApi.md#getWhatsAppCampaigns) | **GET** /whatsappCampaigns | Return all your created WhatsApp campaigns
-*Brevo.WhatsAppCampaignsApi* | [**getWhatsAppConfig**](docs/WhatsAppCampaignsApi.md#getWhatsAppConfig) | **GET** /whatsappCampaigns/config | Get your WhatsApp API account information
-*Brevo.WhatsAppCampaignsApi* | [**getWhatsAppTemplates**](docs/WhatsAppCampaignsApi.md#getWhatsAppTemplates) | **GET** /whatsappCampaigns/template-list | Return all your created WhatsApp templates
-*Brevo.WhatsAppCampaignsApi* | [**sendWhatsAppTemplateApproval**](docs/WhatsAppCampaignsApi.md#sendWhatsAppTemplateApproval) | **POST** /whatsappCampaigns/template/approval/{templateId} | Send your WhatsApp template for approval
-*Brevo.WhatsAppCampaignsApi* | [**updateWhatsAppCampaign**](docs/WhatsAppCampaignsApi.md#updateWhatsAppCampaign) | **PUT** /whatsappCampaigns/{campaignId} | Update a WhatsApp campaign
-
-
-## Documentation for Models
-
- - [Brevo.AbTestCampaignResult](docs/AbTestCampaignResult.md)
- - [Brevo.AbTestCampaignResultClickedLinks](docs/AbTestCampaignResultClickedLinks.md)
- - [Brevo.AbTestCampaignResultStatistics](docs/AbTestCampaignResultStatistics.md)
- - [Brevo.AbTestVersionClicks](docs/AbTestVersionClicks.md)
- - [Brevo.AbTestVersionClicksInner](docs/AbTestVersionClicksInner.md)
- - [Brevo.AbTestVersionStats](docs/AbTestVersionStats.md)
- - [Brevo.AddChildDomain](docs/AddChildDomain.md)
- - [Brevo.AddContactToList](docs/AddContactToList.md)
- - [Brevo.AddCredits](docs/AddCredits.md)
- - [Brevo.AuthenticateDomainModel](docs/AuthenticateDomainModel.md)
- - [Brevo.BlockDomain](docs/BlockDomain.md)
- - [Brevo.Body](docs/Body.md)
- - [Brevo.Body1](docs/Body1.md)
- - [Brevo.Body10](docs/Body10.md)
- - [Brevo.Body11](docs/Body11.md)
- - [Brevo.Body12](docs/Body12.md)
- - [Brevo.Body2](docs/Body2.md)
- - [Brevo.Body3](docs/Body3.md)
- - [Brevo.Body4](docs/Body4.md)
- - [Brevo.Body5](docs/Body5.md)
- - [Brevo.Body6](docs/Body6.md)
- - [Brevo.Body7](docs/Body7.md)
- - [Brevo.Body8](docs/Body8.md)
- - [Brevo.Body9](docs/Body9.md)
- - [Brevo.BodyVariablesItems](docs/BodyVariablesItems.md)
- - [Brevo.CompaniesList](docs/CompaniesList.md)
- - [Brevo.Company](docs/Company.md)
- - [Brevo.CompanyAttributes](docs/CompanyAttributes.md)
- - [Brevo.CompanyAttributesInner](docs/CompanyAttributesInner.md)
- - [Brevo.ComponentItems](docs/ComponentItems.md)
- - [Brevo.ConversationsMessage](docs/ConversationsMessage.md)
- - [Brevo.ConversationsMessageFile](docs/ConversationsMessageFile.md)
- - [Brevo.ConversationsMessageFileImageInfo](docs/ConversationsMessageFileImageInfo.md)
- - [Brevo.CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
- - [Brevo.CreateApiKeyResponse](docs/CreateApiKeyResponse.md)
- - [Brevo.CreateAttribute](docs/CreateAttribute.md)
- - [Brevo.CreateAttributeEnumeration](docs/CreateAttributeEnumeration.md)
- - [Brevo.CreateCategoryModel](docs/CreateCategoryModel.md)
- - [Brevo.CreateChild](docs/CreateChild.md)
- - [Brevo.CreateContact](docs/CreateContact.md)
- - [Brevo.CreateCouponCollection](docs/CreateCouponCollection.md)
- - [Brevo.CreateCoupons](docs/CreateCoupons.md)
- - [Brevo.CreateDoiContact](docs/CreateDoiContact.md)
- - [Brevo.CreateDomain](docs/CreateDomain.md)
- - [Brevo.CreateDomainModel](docs/CreateDomainModel.md)
- - [Brevo.CreateDomainModelDnsRecords](docs/CreateDomainModelDnsRecords.md)
- - [Brevo.CreateDomainModelDnsRecordsDkimRecord](docs/CreateDomainModelDnsRecordsDkimRecord.md)
- - [Brevo.CreateEmailCampaign](docs/CreateEmailCampaign.md)
- - [Brevo.CreateEmailCampaignRecipients](docs/CreateEmailCampaignRecipients.md)
- - [Brevo.CreateEmailCampaignSender](docs/CreateEmailCampaignSender.md)
- - [Brevo.CreateExternalFeed](docs/CreateExternalFeed.md)
- - [Brevo.CreateList](docs/CreateList.md)
- - [Brevo.CreateModel](docs/CreateModel.md)
- - [Brevo.CreateProductModel](docs/CreateProductModel.md)
- - [Brevo.CreateReseller](docs/CreateReseller.md)
- - [Brevo.CreateSender](docs/CreateSender.md)
- - [Brevo.CreateSenderIps](docs/CreateSenderIps.md)
- - [Brevo.CreateSenderModel](docs/CreateSenderModel.md)
- - [Brevo.CreateSmsCampaign](docs/CreateSmsCampaign.md)
- - [Brevo.CreateSmsCampaignRecipients](docs/CreateSmsCampaignRecipients.md)
- - [Brevo.CreateSmtpEmail](docs/CreateSmtpEmail.md)
- - [Brevo.CreateSmtpTemplate](docs/CreateSmtpTemplate.md)
- - [Brevo.CreateSmtpTemplateSender](docs/CreateSmtpTemplateSender.md)
- - [Brevo.CreateSubAccount](docs/CreateSubAccount.md)
- - [Brevo.CreateSubAccountResponse](docs/CreateSubAccountResponse.md)
- - [Brevo.CreateUpdateBatchCategory](docs/CreateUpdateBatchCategory.md)
- - [Brevo.CreateUpdateBatchCategoryModel](docs/CreateUpdateBatchCategoryModel.md)
- - [Brevo.CreateUpdateBatchProducts](docs/CreateUpdateBatchProducts.md)
- - [Brevo.CreateUpdateBatchProductsModel](docs/CreateUpdateBatchProductsModel.md)
- - [Brevo.CreateUpdateCategories](docs/CreateUpdateCategories.md)
- - [Brevo.CreateUpdateCategory](docs/CreateUpdateCategory.md)
- - [Brevo.CreateUpdateContactModel](docs/CreateUpdateContactModel.md)
- - [Brevo.CreateUpdateFolder](docs/CreateUpdateFolder.md)
- - [Brevo.CreateUpdateProduct](docs/CreateUpdateProduct.md)
- - [Brevo.CreateUpdateProducts](docs/CreateUpdateProducts.md)
- - [Brevo.CreateWebhook](docs/CreateWebhook.md)
- - [Brevo.CreateWhatsAppCampaign](docs/CreateWhatsAppCampaign.md)
- - [Brevo.CreateWhatsAppCampaignRecipients](docs/CreateWhatsAppCampaignRecipients.md)
- - [Brevo.CreateWhatsAppTemplate](docs/CreateWhatsAppTemplate.md)
- - [Brevo.CreatedBatchId](docs/CreatedBatchId.md)
- - [Brevo.CreatedProcessId](docs/CreatedProcessId.md)
- - [Brevo.Deal](docs/Deal.md)
- - [Brevo.DealAttributes](docs/DealAttributes.md)
- - [Brevo.DealAttributesInner](docs/DealAttributesInner.md)
- - [Brevo.DealsList](docs/DealsList.md)
- - [Brevo.DeleteHardbounces](docs/DeleteHardbounces.md)
- - [Brevo.EmailExportRecipients](docs/EmailExportRecipients.md)
- - [Brevo.ErrorModel](docs/ErrorModel.md)
- - [Brevo.ExportWebhooksHistory](docs/ExportWebhooksHistory.md)
- - [Brevo.FileData](docs/FileData.md)
- - [Brevo.FileDownloadableLink](docs/FileDownloadableLink.md)
- - [Brevo.FileList](docs/FileList.md)
- - [Brevo.GetAccount](docs/GetAccount.md)
- - [Brevo.GetAccountActivity](docs/GetAccountActivity.md)
- - [Brevo.GetAccountActivityLogs](docs/GetAccountActivityLogs.md)
- - [Brevo.GetAccountMarketingAutomation](docs/GetAccountMarketingAutomation.md)
- - [Brevo.GetAccountPlan](docs/GetAccountPlan.md)
- - [Brevo.GetAccountRelay](docs/GetAccountRelay.md)
- - [Brevo.GetAccountRelayData](docs/GetAccountRelayData.md)
- - [Brevo.GetAggregatedReport](docs/GetAggregatedReport.md)
- - [Brevo.GetAllExternalFeeds](docs/GetAllExternalFeeds.md)
- - [Brevo.GetAllExternalFeedsFeeds](docs/GetAllExternalFeedsFeeds.md)
- - [Brevo.GetAttributes](docs/GetAttributes.md)
- - [Brevo.GetAttributesAttributes](docs/GetAttributesAttributes.md)
- - [Brevo.GetAttributesEnumeration](docs/GetAttributesEnumeration.md)
- - [Brevo.GetBlockedDomains](docs/GetBlockedDomains.md)
- - [Brevo.GetCampaignOverview](docs/GetCampaignOverview.md)
- - [Brevo.GetCampaignRecipients](docs/GetCampaignRecipients.md)
- - [Brevo.GetCampaignStats](docs/GetCampaignStats.md)
- - [Brevo.GetCategories](docs/GetCategories.md)
- - [Brevo.GetCategoryDetails](docs/GetCategoryDetails.md)
- - [Brevo.GetChildAccountCreationStatus](docs/GetChildAccountCreationStatus.md)
- - [Brevo.GetChildDomain](docs/GetChildDomain.md)
- - [Brevo.GetChildDomains](docs/GetChildDomains.md)
- - [Brevo.GetChildInfo](docs/GetChildInfo.md)
- - [Brevo.GetChildInfoApiKeys](docs/GetChildInfoApiKeys.md)
- - [Brevo.GetChildInfoApiKeysV2](docs/GetChildInfoApiKeysV2.md)
- - [Brevo.GetChildInfoApiKeysV3](docs/GetChildInfoApiKeysV3.md)
- - [Brevo.GetChildInfoCredits](docs/GetChildInfoCredits.md)
- - [Brevo.GetChildInfoStatistics](docs/GetChildInfoStatistics.md)
- - [Brevo.GetChildrenList](docs/GetChildrenList.md)
- - [Brevo.GetClient](docs/GetClient.md)
- - [Brevo.GetContactCampaignStats](docs/GetContactCampaignStats.md)
- - [Brevo.GetContactCampaignStatsClicked](docs/GetContactCampaignStatsClicked.md)
- - [Brevo.GetContactCampaignStatsOpened](docs/GetContactCampaignStatsOpened.md)
- - [Brevo.GetContactCampaignStatsTransacAttributes](docs/GetContactCampaignStatsTransacAttributes.md)
- - [Brevo.GetContactCampaignStatsUnsubscriptions](docs/GetContactCampaignStatsUnsubscriptions.md)
- - [Brevo.GetContactDetails](docs/GetContactDetails.md)
- - [Brevo.GetContacts](docs/GetContacts.md)
- - [Brevo.GetCouponCollection](docs/GetCouponCollection.md)
- - [Brevo.GetDeviceBrowserStats](docs/GetDeviceBrowserStats.md)
- - [Brevo.GetDomainConfigurationModel](docs/GetDomainConfigurationModel.md)
- - [Brevo.GetDomainsList](docs/GetDomainsList.md)
- - [Brevo.GetDomainsListDomains](docs/GetDomainsListDomains.md)
- - [Brevo.GetEmailCampaign](docs/GetEmailCampaign.md)
- - [Brevo.GetEmailCampaigns](docs/GetEmailCampaigns.md)
- - [Brevo.GetEmailEventReport](docs/GetEmailEventReport.md)
- - [Brevo.GetEmailEventReportEvents](docs/GetEmailEventReportEvents.md)
- - [Brevo.GetExtendedCampaignOverview](docs/GetExtendedCampaignOverview.md)
- - [Brevo.GetExtendedCampaignOverviewSender](docs/GetExtendedCampaignOverviewSender.md)
- - [Brevo.GetExtendedCampaignStats](docs/GetExtendedCampaignStats.md)
- - [Brevo.GetExtendedCampaignStatsGlobalStats](docs/GetExtendedCampaignStatsGlobalStats.md)
- - [Brevo.GetExtendedClient](docs/GetExtendedClient.md)
- - [Brevo.GetExtendedClientAddress](docs/GetExtendedClientAddress.md)
- - [Brevo.GetExtendedContactDetails](docs/GetExtendedContactDetails.md)
- - [Brevo.GetExtendedContactDetailsStatistics](docs/GetExtendedContactDetailsStatistics.md)
- - [Brevo.GetExtendedContactDetailsStatisticsClicked](docs/GetExtendedContactDetailsStatisticsClicked.md)
- - [Brevo.GetExtendedContactDetailsStatisticsLinks](docs/GetExtendedContactDetailsStatisticsLinks.md)
- - [Brevo.GetExtendedContactDetailsStatisticsMessagesSent](docs/GetExtendedContactDetailsStatisticsMessagesSent.md)
- - [Brevo.GetExtendedContactDetailsStatisticsOpened](docs/GetExtendedContactDetailsStatisticsOpened.md)
- - [Brevo.GetExtendedContactDetailsStatisticsUnsubscriptions](docs/GetExtendedContactDetailsStatisticsUnsubscriptions.md)
- - [Brevo.GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription](docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md)
- - [Brevo.GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription](docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md)
- - [Brevo.GetExtendedList](docs/GetExtendedList.md)
- - [Brevo.GetExtendedListCampaignStats](docs/GetExtendedListCampaignStats.md)
- - [Brevo.GetExternalFeedByUUID](docs/GetExternalFeedByUUID.md)
- - [Brevo.GetExternalFeedByUUIDHeaders](docs/GetExternalFeedByUUIDHeaders.md)
- - [Brevo.GetFolder](docs/GetFolder.md)
- - [Brevo.GetFolderLists](docs/GetFolderLists.md)
- - [Brevo.GetFolders](docs/GetFolders.md)
- - [Brevo.GetInboundEmailEvents](docs/GetInboundEmailEvents.md)
- - [Brevo.GetInboundEmailEventsByUuid](docs/GetInboundEmailEventsByUuid.md)
- - [Brevo.GetInboundEmailEventsByUuidAttachments](docs/GetInboundEmailEventsByUuidAttachments.md)
- - [Brevo.GetInboundEmailEventsByUuidLogs](docs/GetInboundEmailEventsByUuidLogs.md)
- - [Brevo.GetInboundEmailEventsEvents](docs/GetInboundEmailEventsEvents.md)
- - [Brevo.GetInvitedUsersList](docs/GetInvitedUsersList.md)
- - [Brevo.GetInvitedUsersListFeatureAccess](docs/GetInvitedUsersListFeatureAccess.md)
- - [Brevo.GetInvitedUsersListUsers](docs/GetInvitedUsersListUsers.md)
- - [Brevo.GetIp](docs/GetIp.md)
- - [Brevo.GetIpFromSender](docs/GetIpFromSender.md)
- - [Brevo.GetIps](docs/GetIps.md)
- - [Brevo.GetIpsFromSender](docs/GetIpsFromSender.md)
- - [Brevo.GetList](docs/GetList.md)
- - [Brevo.GetLists](docs/GetLists.md)
- - [Brevo.GetProcess](docs/GetProcess.md)
- - [Brevo.GetProcesses](docs/GetProcesses.md)
- - [Brevo.GetProductDetails](docs/GetProductDetails.md)
- - [Brevo.GetProducts](docs/GetProducts.md)
- - [Brevo.GetReports](docs/GetReports.md)
- - [Brevo.GetReportsReports](docs/GetReportsReports.md)
- - [Brevo.GetScheduledEmailByBatchId](docs/GetScheduledEmailByBatchId.md)
- - [Brevo.GetScheduledEmailByBatchIdBatches](docs/GetScheduledEmailByBatchIdBatches.md)
- - [Brevo.GetScheduledEmailByMessageId](docs/GetScheduledEmailByMessageId.md)
- - [Brevo.GetSegments](docs/GetSegments.md)
- - [Brevo.GetSegmentsSegments](docs/GetSegmentsSegments.md)
- - [Brevo.GetSendersList](docs/GetSendersList.md)
- - [Brevo.GetSendersListIps](docs/GetSendersListIps.md)
- - [Brevo.GetSendersListSenders](docs/GetSendersListSenders.md)
- - [Brevo.GetSharedTemplateUrl](docs/GetSharedTemplateUrl.md)
- - [Brevo.GetSmsCampaign](docs/GetSmsCampaign.md)
- - [Brevo.GetSmsCampaignOverview](docs/GetSmsCampaignOverview.md)
- - [Brevo.GetSmsCampaignRecipients](docs/GetSmsCampaignRecipients.md)
- - [Brevo.GetSmsCampaignStats](docs/GetSmsCampaignStats.md)
- - [Brevo.GetSmsCampaigns](docs/GetSmsCampaigns.md)
- - [Brevo.GetSmsEventReport](docs/GetSmsEventReport.md)
- - [Brevo.GetSmsEventReportEvents](docs/GetSmsEventReportEvents.md)
- - [Brevo.GetSmtpTemplateOverview](docs/GetSmtpTemplateOverview.md)
- - [Brevo.GetSmtpTemplateOverviewSender](docs/GetSmtpTemplateOverviewSender.md)
- - [Brevo.GetSmtpTemplates](docs/GetSmtpTemplates.md)
- - [Brevo.GetSsoToken](docs/GetSsoToken.md)
- - [Brevo.GetStatsByBrowser](docs/GetStatsByBrowser.md)
- - [Brevo.GetStatsByDevice](docs/GetStatsByDevice.md)
- - [Brevo.GetStatsByDomain](docs/GetStatsByDomain.md)
- - [Brevo.GetTransacAggregatedSmsReport](docs/GetTransacAggregatedSmsReport.md)
- - [Brevo.GetTransacBlockedContacts](docs/GetTransacBlockedContacts.md)
- - [Brevo.GetTransacBlockedContactsContacts](docs/GetTransacBlockedContactsContacts.md)
- - [Brevo.GetTransacBlockedContactsReason](docs/GetTransacBlockedContactsReason.md)
- - [Brevo.GetTransacEmailContent](docs/GetTransacEmailContent.md)
- - [Brevo.GetTransacEmailContentEvents](docs/GetTransacEmailContentEvents.md)
- - [Brevo.GetTransacEmailsList](docs/GetTransacEmailsList.md)
- - [Brevo.GetTransacEmailsListTransactionalEmails](docs/GetTransacEmailsListTransactionalEmails.md)
- - [Brevo.GetTransacSmsReport](docs/GetTransacSmsReport.md)
- - [Brevo.GetTransacSmsReportReports](docs/GetTransacSmsReportReports.md)
- - [Brevo.GetUserPermission](docs/GetUserPermission.md)
- - [Brevo.GetUserPermissionPrivileges](docs/GetUserPermissionPrivileges.md)
- - [Brevo.GetWATemplates](docs/GetWATemplates.md)
- - [Brevo.GetWATemplatesTemplates](docs/GetWATemplatesTemplates.md)
- - [Brevo.GetWebhook](docs/GetWebhook.md)
- - [Brevo.GetWebhooks](docs/GetWebhooks.md)
- - [Brevo.GetWhatsAppConfig](docs/GetWhatsAppConfig.md)
- - [Brevo.GetWhatsappCampaignOverview](docs/GetWhatsappCampaignOverview.md)
- - [Brevo.GetWhatsappCampaigns](docs/GetWhatsappCampaigns.md)
- - [Brevo.GetWhatsappCampaignsCampaigns](docs/GetWhatsappCampaignsCampaigns.md)
- - [Brevo.GetWhatsappEventReport](docs/GetWhatsappEventReport.md)
- - [Brevo.GetWhatsappEventReportEvents](docs/GetWhatsappEventReportEvents.md)
- - [Brevo.InlineResponse200](docs/InlineResponse200.md)
- - [Brevo.InlineResponse2001](docs/InlineResponse2001.md)
- - [Brevo.InlineResponse201](docs/InlineResponse201.md)
- - [Brevo.InlineResponse2011](docs/InlineResponse2011.md)
- - [Brevo.InlineResponse2012](docs/InlineResponse2012.md)
- - [Brevo.InlineResponse2013](docs/InlineResponse2013.md)
- - [Brevo.InlineResponse2014](docs/InlineResponse2014.md)
- - [Brevo.ManageIp](docs/ManageIp.md)
- - [Brevo.MasterDetailsResponse](docs/MasterDetailsResponse.md)
- - [Brevo.MasterDetailsResponseBillingInfo](docs/MasterDetailsResponseBillingInfo.md)
- - [Brevo.MasterDetailsResponseBillingInfoAddress](docs/MasterDetailsResponseBillingInfoAddress.md)
- - [Brevo.MasterDetailsResponseBillingInfoName](docs/MasterDetailsResponseBillingInfoName.md)
- - [Brevo.MasterDetailsResponsePlanInfo](docs/MasterDetailsResponsePlanInfo.md)
- - [Brevo.MasterDetailsResponsePlanInfoFeatures](docs/MasterDetailsResponsePlanInfoFeatures.md)
- - [Brevo.Note](docs/Note.md)
- - [Brevo.NoteData](docs/NoteData.md)
- - [Brevo.NoteId](docs/NoteId.md)
- - [Brevo.NoteList](docs/NoteList.md)
- - [Brevo.Order](docs/Order.md)
- - [Brevo.OrderBatch](docs/OrderBatch.md)
- - [Brevo.OrderBilling](docs/OrderBilling.md)
- - [Brevo.OrderProducts](docs/OrderProducts.md)
- - [Brevo.Otp](docs/Otp.md)
- - [Brevo.Pipeline](docs/Pipeline.md)
- - [Brevo.PipelineStage](docs/PipelineStage.md)
- - [Brevo.Pipelines](docs/Pipelines.md)
- - [Brevo.PostContactInfo](docs/PostContactInfo.md)
- - [Brevo.PostContactInfoContacts](docs/PostContactInfoContacts.md)
- - [Brevo.PostSendFailed](docs/PostSendFailed.md)
- - [Brevo.PostSendSmsTestFailed](docs/PostSendSmsTestFailed.md)
- - [Brevo.RemainingCreditModel](docs/RemainingCreditModel.md)
- - [Brevo.RemainingCreditModelChild](docs/RemainingCreditModelChild.md)
- - [Brevo.RemainingCreditModelReseller](docs/RemainingCreditModelReseller.md)
- - [Brevo.RemoveContactFromList](docs/RemoveContactFromList.md)
- - [Brevo.RemoveCredits](docs/RemoveCredits.md)
- - [Brevo.RequestContactExport](docs/RequestContactExport.md)
- - [Brevo.RequestContactExportCustomContactFilter](docs/RequestContactExportCustomContactFilter.md)
- - [Brevo.RequestContactImport](docs/RequestContactImport.md)
- - [Brevo.RequestContactImportNewList](docs/RequestContactImportNewList.md)
- - [Brevo.RequestSmsRecipientExport](docs/RequestSmsRecipientExport.md)
- - [Brevo.ScheduleSmtpEmail](docs/ScheduleSmtpEmail.md)
- - [Brevo.SendReport](docs/SendReport.md)
- - [Brevo.SendReportEmail](docs/SendReportEmail.md)
- - [Brevo.SendSms](docs/SendSms.md)
- - [Brevo.SendSmtpEmail](docs/SendSmtpEmail.md)
- - [Brevo.SendSmtpEmailAttachment](docs/SendSmtpEmailAttachment.md)
- - [Brevo.SendSmtpEmailBcc](docs/SendSmtpEmailBcc.md)
- - [Brevo.SendSmtpEmailCc](docs/SendSmtpEmailCc.md)
- - [Brevo.SendSmtpEmailMessageVersions](docs/SendSmtpEmailMessageVersions.md)
- - [Brevo.SendSmtpEmailReplyTo](docs/SendSmtpEmailReplyTo.md)
- - [Brevo.SendSmtpEmailReplyTo1](docs/SendSmtpEmailReplyTo1.md)
- - [Brevo.SendSmtpEmailSender](docs/SendSmtpEmailSender.md)
- - [Brevo.SendSmtpEmailTo](docs/SendSmtpEmailTo.md)
- - [Brevo.SendSmtpEmailTo1](docs/SendSmtpEmailTo1.md)
- - [Brevo.SendTestEmail](docs/SendTestEmail.md)
- - [Brevo.SendTestSms](docs/SendTestSms.md)
- - [Brevo.SendTransacSms](docs/SendTransacSms.md)
- - [Brevo.SendWhatsappMessage](docs/SendWhatsappMessage.md)
- - [Brevo.SsoTokenRequest](docs/SsoTokenRequest.md)
- - [Brevo.SubAccountDetailsResponse](docs/SubAccountDetailsResponse.md)
- - [Brevo.SubAccountDetailsResponsePlanInfo](docs/SubAccountDetailsResponsePlanInfo.md)
- - [Brevo.SubAccountDetailsResponsePlanInfoCredits](docs/SubAccountDetailsResponsePlanInfoCredits.md)
- - [Brevo.SubAccountDetailsResponsePlanInfoCreditsEmails](docs/SubAccountDetailsResponsePlanInfoCreditsEmails.md)
- - [Brevo.SubAccountDetailsResponsePlanInfoFeatures](docs/SubAccountDetailsResponsePlanInfoFeatures.md)
- - [Brevo.SubAccountDetailsResponsePlanInfoFeaturesInbox](docs/SubAccountDetailsResponsePlanInfoFeaturesInbox.md)
- - [Brevo.SubAccountDetailsResponsePlanInfoFeaturesLandingPage](docs/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md)
- - [Brevo.SubAccountDetailsResponsePlanInfoFeaturesUsers](docs/SubAccountDetailsResponsePlanInfoFeaturesUsers.md)
- - [Brevo.SubAccountUpdatePlanRequest](docs/SubAccountUpdatePlanRequest.md)
- - [Brevo.SubAccountUpdatePlanRequestCredits](docs/SubAccountUpdatePlanRequestCredits.md)
- - [Brevo.SubAccountUpdatePlanRequestFeatures](docs/SubAccountUpdatePlanRequestFeatures.md)
- - [Brevo.SubAccountsResponse](docs/SubAccountsResponse.md)
- - [Brevo.SubAccountsResponseSubAccounts](docs/SubAccountsResponseSubAccounts.md)
- - [Brevo.Task](docs/Task.md)
- - [Brevo.TaskList](docs/TaskList.md)
- - [Brevo.TaskReminder](docs/TaskReminder.md)
- - [Brevo.TaskTypes](docs/TaskTypes.md)
- - [Brevo.UpdateAttribute](docs/UpdateAttribute.md)
- - [Brevo.UpdateAttributeEnumeration](docs/UpdateAttributeEnumeration.md)
- - [Brevo.UpdateBatchContacts](docs/UpdateBatchContacts.md)
- - [Brevo.UpdateBatchContactsContacts](docs/UpdateBatchContactsContacts.md)
- - [Brevo.UpdateBatchContactsModel](docs/UpdateBatchContactsModel.md)
- - [Brevo.UpdateCampaignStatus](docs/UpdateCampaignStatus.md)
- - [Brevo.UpdateChild](docs/UpdateChild.md)
- - [Brevo.UpdateChildAccountStatus](docs/UpdateChildAccountStatus.md)
- - [Brevo.UpdateChildDomain](docs/UpdateChildDomain.md)
- - [Brevo.UpdateContact](docs/UpdateContact.md)
- - [Brevo.UpdateCouponCollection](docs/UpdateCouponCollection.md)
- - [Brevo.UpdateEmailCampaign](docs/UpdateEmailCampaign.md)
- - [Brevo.UpdateEmailCampaignRecipients](docs/UpdateEmailCampaignRecipients.md)
- - [Brevo.UpdateEmailCampaignSender](docs/UpdateEmailCampaignSender.md)
- - [Brevo.UpdateExternalFeed](docs/UpdateExternalFeed.md)
- - [Brevo.UpdateList](docs/UpdateList.md)
- - [Brevo.UpdateSender](docs/UpdateSender.md)
- - [Brevo.UpdateSmsCampaign](docs/UpdateSmsCampaign.md)
- - [Brevo.UpdateSmtpTemplate](docs/UpdateSmtpTemplate.md)
- - [Brevo.UpdateSmtpTemplateSender](docs/UpdateSmtpTemplateSender.md)
- - [Brevo.UpdateWebhook](docs/UpdateWebhook.md)
- - [Brevo.UpdateWhatsAppCampaign](docs/UpdateWhatsAppCampaign.md)
- - [Brevo.UploadImageModel](docs/UploadImageModel.md)
- - [Brevo.UploadImageToGallery](docs/UploadImageToGallery.md)
- - [Brevo.VariablesItems](docs/VariablesItems.md)
- - [Brevo.WhatsappCampStats](docs/WhatsappCampStats.md)
- - [Brevo.WhatsappCampTemplate](docs/WhatsappCampTemplate.md)
-
+```javascript
+const SibApiV3Sdk = require('@getbrevo/brevo');
 
-## Documentation for Authorization
+let apiInstance = new SibApiV3Sdk.TransactionalEmailsApi();
 
+let apiKey = apiInstance.authentications['apiKey'];
+apiKey.apiKey = 'YOUR API KEY';
 
-### api-key
+let sendSmtpEmail = new SibApiV3Sdk.SendSmtpEmail(); 
 
-- **Type**: API key
-- **API key parameter name**: api-key
-- **Location**: HTTP header
+sendSmtpEmail.subject = "My {{params.subject}}";
+sendSmtpEmail.htmlContent = "<html><body><h1>This is my first transactional email {{params.parameter}}</h1></body></html>";
+sendSmtpEmail.sender = {"name":"John Doe","email":"example@example.com"};
+sendSmtpEmail.to = [{"email":"example@example.com","name":"Jane Doe"}];
+sendSmtpEmail.cc = [{"email":"example2@example2.com","name":"Janice Doe"}];
+sendSmtpEmail.bcc = [{"name":"John Doe","email":"example@example.com"}];
+sendSmtpEmail.replyTo = {"email":"replyto@domain.com","name":"John Doe"};
+sendSmtpEmail.headers = {"Some-Custom-Name":"unique-id-1234"};
+sendSmtpEmail.params = {"parameter":"My param value","subject":"New Subject"};
 
-### partner-key
+apiInstance.sendTransacEmail(sendSmtpEmail).then(function(data) {
+  console.log('API called successfully. Returned data: ' + JSON.stringify(data));
 
-- **Type**: API key
-- **API key parameter name**: partner-key
-- **Location**: HTTP header
+}, function(error) {
+  console.error(error);
+});
+```
 
+For more examples, refer the [Endpoints Guide](https://developers.brevo.com/reference)