@getbrevo/brevo 2.3.0 → 3.0.1

package/.openapi-generator/FILES

@@ -2,7 +2,6 @@
 api.ts
 api/accountApi.ts
 api/apis.ts
-api/balanceApi.ts
 api/companiesApi.ts
 api/contactsApi.ts
 api/conversationsApi.ts
@@ -19,12 +18,10 @@ api/masterAccountApi.ts
 api/notesApi.ts
 api/paymentsApi.ts
 api/processApi.ts
-api/programApi.ts
-api/rewardApi.ts
+api/resellerApi.ts
 api/sMSCampaignsApi.ts
 api/sendersApi.ts
 api/tasksApi.ts
-api/tierApi.ts
 api/transactionalEmailsApi.ts
 api/transactionalSMSApi.ts
 api/transactionalWhatsAppApi.ts
@@ -39,20 +36,11 @@ model/abTestVersionClicksInner.ts
 model/abTestVersionStats.ts
 model/addChildDomain.ts
 model/addContactToList.ts
-model/addSubscriptionMemberPayload.ts
-model/aggregateBalance.ts
+model/addCredits.ts
 model/authenticateDomainModel.ts
-model/balance.ts
-model/balanceDataPerContact.ts
-model/balanceDefinition.ts
-model/balanceDefinitionPage.ts
-model/balanceLimit.ts
-model/balanceOrder.ts
 model/blockDomain.ts
 model/cart.ts
 model/companiesIdPatchRequest.ts
-model/companiesImportPost200Response.ts
-model/companiesImportPost400Response.ts
 model/companiesLinkUnlinkIdPatchRequest.ts
 model/companiesList.ts
 model/companiesPost200Response.ts
@@ -61,17 +49,10 @@ model/company.ts
 model/companyAttributesInner.ts
 model/componentItems.ts
 model/configuration.ts
-model/contactBalancesResp.ts
-model/contactErrorModel.ts
 model/conversationsAgentOnlinePingPostRequest.ts
 model/conversationsMessage.ts
-model/conversationsMessageAttachmentsInner.ts
 model/conversationsMessageFile.ts
 model/conversationsMessageFileImageInfo.ts
-model/conversationsMessageForwardedToSourceStatus.ts
-model/conversationsMessageFrom.ts
-model/conversationsMessageReplyTo.ts
-model/conversationsMessageToInner.ts
 model/conversationsMessagesIdPutRequest.ts
 model/conversationsMessagesPostRequest.ts
 model/conversationsPushedMessagesIdPutRequest.ts
@@ -87,16 +68,11 @@ model/corporateGroupPostRequest.ts
 model/corporateGroupUnlinkGroupIdSubAccountsPutRequest.ts
 model/corporateSubAccountIpAssociatePostRequest.ts
 model/corporateSubAccountIpDissociatePutRequest.ts
-model/corporateUserEmailPermissionsPutRequest.ts
-model/corporateUserEmailPermissionsPutRequestPrivilegesInner.ts
 model/corporateUserInvitationActionEmailPut200Response.ts
 model/createApiKeyRequest.ts
 model/createApiKeyResponse.ts
 model/createAttribute.ts
 model/createAttributeEnumerationInner.ts
-model/createBalanceDefinitionPayload.ts
-model/createBalanceLimitPayload.ts
-model/createBalancePayload.ts
 model/createCategoryModel.ts
 model/createChild.ts
 model/createContact.ts
@@ -109,18 +85,16 @@ model/createDomainModel.ts
 model/createDomainModelDnsRecords.ts
 model/createDomainModelDnsRecordsDkimRecord.ts
 model/createEmailCampaign.ts
-model/createEmailCampaignEmailExpirationDate.ts
 model/createEmailCampaignRecipients.ts
 model/createEmailCampaignSender.ts
 model/createExternalFeed.ts
 model/createExternalFeed201Response.ts
 model/createList.ts
-model/createLoyaltyProgramPayload.ts
 model/createModel.ts
-model/createOrderPayload.ts
 model/createPaymentRequest.ts
 model/createPaymentResponse.ts
 model/createProductModel.ts
+model/createReseller.ts
 model/createSender.ts
 model/createSenderIpsInner.ts
 model/createSenderModel.ts
@@ -131,10 +105,6 @@ model/createSmtpTemplate.ts
 model/createSmtpTemplateSender.ts
 model/createSubAccount.ts
 model/createSubAccountResponse.ts
-model/createSubscriptionPayload.ts
-model/createSubscriptionResponse.ts
-model/createTierGroupRequest.ts
-model/createTransactionPayload.ts
 model/createUpdateBatchCategory.ts
 model/createUpdateBatchCategoryModel.ts
 model/createUpdateBatchProducts.ts
@@ -151,8 +121,6 @@ model/createWhatsAppCampaignRecipients.ts
 model/createWhatsAppTemplate.ts
 model/createdBatchId.ts
 model/createdProcessId.ts
-model/crmAttributesPost200Response.ts
-model/crmAttributesPostRequest.ts
 model/crmDealsIdPatchRequest.ts
 model/crmDealsLinkUnlinkIdPatchRequest.ts
 model/crmDealsPost201Response.ts
@@ -171,11 +139,9 @@ model/ecommerceAttributionProductsConversionSourceConversionSourceIdGet200Respon
 model/ecommerceConfigDisplayCurrencyGet200Response.ts
 model/emailExportRecipients.ts
 model/errorModel.ts
-model/errorResponse.ts
 model/event.ts
 model/eventIdentifiers.ts
 model/exportWebhooksHistory.ts
-model/fetchTemplatePreview.ts
 model/fileData.ts
 model/fileDownloadableLink.ts
 model/getAccount.ts
@@ -197,13 +163,26 @@ model/getCampaignRecipients.ts
 model/getCampaignStats.ts
 model/getCategories.ts
 model/getCategoryDetails.ts
+model/getChildAccountCreationStatus.ts
 model/getChildDomain.ts
+model/getChildInfo.ts
+model/getChildInfoAllOfApiKeys.ts
+model/getChildInfoAllOfApiKeysV2.ts
+model/getChildInfoAllOfApiKeysV3.ts
+model/getChildInfoAllOfCredits.ts
+model/getChildInfoAllOfStatistics.ts
+model/getChildrenList.ts
+model/getChildrenListChildrenInner.ts
 model/getClient.ts
 model/getContactCampaignStats.ts
 model/getContactCampaignStatsClickedInner.ts
+model/getContactCampaignStatsClickedInnerLinksInner.ts
+model/getContactCampaignStatsMessagesSentInner.ts
 model/getContactCampaignStatsOpenedInner.ts
 model/getContactCampaignStatsTransacAttributesInner.ts
 model/getContactCampaignStatsUnsubscriptions.ts
+model/getContactCampaignStatsUnsubscriptionsAdminUnsubscriptionInner.ts
+model/getContactCampaignStatsUnsubscriptionsUserUnsubscriptionInner.ts
 model/getContactDetails.ts
 model/getContacts.ts
 model/getCorporateInvitedUsersList.ts
@@ -271,8 +250,8 @@ model/getReportsReportsInner.ts
 model/getScheduledEmailByBatchId.ts
 model/getScheduledEmailByBatchIdBatchesInner.ts
 model/getScheduledEmailByMessageId.ts
-model/getSegment.ts
 model/getSegments.ts
+model/getSegmentsSegments.ts
 model/getSendersList.ts
 model/getSendersListSendersInner.ts
 model/getSendersListSendersInnerIpsInner.ts
@@ -318,51 +297,13 @@ model/inviteAdminUser.ts
 model/inviteAdminUserPrivilegesInner.ts
 model/inviteuser.ts
 model/inviteuserPrivilegesInner.ts
-model/loyaltyProgram.ts
-model/loyaltyProgramPage.ts
-model/loyaltyProgramValidationError.ts
-model/loyaltyTierPage.ts
-model/mainAttributeRewardPayload.ts
-model/mainBillingPayload.ts
-model/mainCodeCountHttpResponse.ts
-model/mainCreateRedeemPayload.ts
-model/mainCreateRewardPayload.ts
-model/mainCreateRewardResponse.ts
-model/mainErrorResponse.ts
-model/mainFilter.ts
-model/mainGenerator.ts
-model/mainGetContactRewardsPayload.ts
-model/mainIdentifiersPayload.ts
-model/mainLimit.ts
-model/mainModelContactReward.ts
-model/mainModelContactRewardsResp.ts
-model/mainNodeResponse.ts
-model/mainOrderPayload.ts
-model/mainProduct.ts
-model/mainProductPayload.ts
-model/mainRedeem.ts
-model/mainResultParameterResponse.ts
-model/mainReward.ts
-model/mainRewardAttribution.ts
-model/mainRewardConfigurations.ts
-model/mainRewardPage.ts
-model/mainRewardPageObj.ts
-model/mainRewardValidate.ts
-model/mainRule.ts
-model/mainRuleConditionResponse.ts
-model/mainRuleEventResponse.ts
-model/mainRuleResultResponse.ts
-model/mainValidateRewardPayload.ts
-model/mainValueResponse.ts
-model/mainVoucherRevokePayload.ts
+model/manageIp.ts
 model/masterDetailsResponse.ts
 model/masterDetailsResponseBillingInfo.ts
 model/masterDetailsResponseBillingInfoAddress.ts
 model/masterDetailsResponseBillingInfoName.ts
 model/masterDetailsResponsePlanInfo.ts
 model/masterDetailsResponsePlanInfoFeaturesInner.ts
-model/memberContact.ts
-model/modelSubscriptionBalanceResp.ts
 model/models.ts
 model/note.ts
 model/noteData.ts
@@ -371,10 +312,8 @@ model/notification.ts
 model/order.ts
 model/orderBatch.ts
 model/orderBilling.ts
-model/orderIdentifiers.ts
 model/orderProductsInner.ts
 model/otp.ts
-model/patchLoyaltyProgramPayload.ts
 model/pipeline.ts
 model/pipelineStage.ts
 model/postContactInfo.ts
@@ -383,7 +322,11 @@ model/postSendFailed.ts
 model/postSendSmsTestFailed.ts
 model/putRevokeUserPermission.ts
 model/putresendcancelinvitation.ts
+model/remainingCreditModel.ts
+model/remainingCreditModelChild.ts
+model/remainingCreditModelReseller.ts
 model/removeContactFromList.ts
+model/removeCredits.ts
 model/requestContactExport.ts
 model/requestContactExportCustomContactFilter.ts
 model/requestContactImport.ts
@@ -407,7 +350,6 @@ model/sendSmtpEmailToInner.ts
 model/sendTestEmail.ts
 model/sendTestSms.ts
 model/sendTransacSms.ts
-model/sendTransacSmsTag.ts
 model/sendWhatsappMessage.ts
 model/sendWhatsappMessage201Response.ts
 model/ssoTokenRequest.ts
@@ -418,14 +360,11 @@ model/subAccountDetailsResponseGroupsInner.ts
 model/subAccountDetailsResponsePlanInfo.ts
 model/subAccountDetailsResponsePlanInfoCredits.ts
 model/subAccountDetailsResponsePlanInfoCreditsEmails.ts
-model/subAccountDetailsResponsePlanInfoCreditsExternalFeeds.ts
 model/subAccountDetailsResponsePlanInfoCreditsSms.ts
-model/subAccountDetailsResponsePlanInfoCreditsWhatsapp.ts
 model/subAccountDetailsResponsePlanInfoCreditsWpSubscribers.ts
 model/subAccountDetailsResponsePlanInfoFeatures.ts
 model/subAccountDetailsResponsePlanInfoFeaturesInbox.ts
 model/subAccountDetailsResponsePlanInfoFeaturesLandingPage.ts
-model/subAccountDetailsResponsePlanInfoFeaturesSalesUsers.ts
 model/subAccountDetailsResponsePlanInfoFeaturesUsers.ts
 model/subAccountUpdatePlanRequest.ts
 model/subAccountUpdatePlanRequestCredits.ts
@@ -433,59 +372,31 @@ model/subAccountUpdatePlanRequestFeatures.ts
 model/subAccountsResponse.ts
 model/subAccountsResponseSubAccountsInner.ts
 model/subAccountsResponseSubAccountsInnerGroupsInner.ts
-model/subAccountsUpdatePlanRequest.ts
-model/subAccountsUpdatePlanRequestCredits.ts
-model/subAccountsUpdatePlanRequestFeatures.ts
-model/subscription.ts
-model/subscriptionAggregateBalance.ts
-model/subscriptionAttributedReward.ts
-model/subscriptionBalances.ts
-model/subscriptionHandlerInfo.ts
-model/subscriptionMember.ts
-model/subscriptionTier.ts
 model/task.ts
 model/taskList.ts
 model/taskReminder.ts
 model/taskTypes.ts
-model/templatePreview.ts
-model/tier.ts
-model/tierAccessConditionsInner.ts
-model/tierForContact.ts
-model/tierGroup.ts
-model/tierGroupPage.ts
-model/tierRequest.ts
-model/tierRequestAccessConditionsInner.ts
-model/tierRequestPutPayload.ts
-model/tierRequestTierRewardsInner.ts
-model/tierTierRewardsInner.ts
-model/transaction.ts
-model/transactionHistory.ts
-model/transactionHistoryResp.ts
-model/unauthorizedResponse.ts
 model/updateAttribute.ts
 model/updateAttributeEnumerationInner.ts
-model/updateBalanceDefinitionPayload.ts
-model/updateBalanceLimitPayload.ts
 model/updateBatchContacts.ts
 model/updateBatchContactsContactsInner.ts
 model/updateBatchContactsModel.ts
 model/updateCampaignStatus.ts
 model/updateChild.ts
+model/updateChildAccountStatus.ts
+model/updateChildDomain.ts
 model/updateContact.ts
 model/updateCouponCollection200Response.ts
 model/updateCouponCollectionRequest.ts
 model/updateEmailCampaign.ts
-model/updateEmailCampaignEmailExpirationDate.ts
 model/updateEmailCampaignRecipients.ts
 model/updateEmailCampaignSender.ts
 model/updateExternalFeed.ts
 model/updateList.ts
-model/updateLoyaltyProgramPayload.ts
 model/updateSender.ts
 model/updateSmsCampaign.ts
 model/updateSmtpTemplate.ts
 model/updateSmtpTemplateSender.ts
-model/updateTierGroupRequest.ts
 model/updateWebhook.ts
 model/updateWhatsAppCampaign.ts
 model/uploadImageModel.ts

package/.openapi-generator/VERSION

@@ -1 +1 @@
-7.13.0
+7.1.0

package/README.md

@@ -1,156 +1,234 @@
-# Brevo typescript
+# Brevo Node SDK
 
-Brevo's API v3 TypeScript-Node Library
+> ⚠️ **Important Notice**: This is the current stable version but we are currently working on rebuilding our Node library from scratch.
 
-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.
+## Overview
 
-This is the wrapper for the API. It implements all the features of the API v3. It supports promises.
+Brevo's API exposes the entire Brevo features via a standardized programmatic interface. Please refer to the full [documentation](https://developers.brevo.com) to see all the supported operations.
 
 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_v3.yml).
 
-## Installation
+Our current library is not fully compatible with all modern Node.js and TypeScript environments. To help you integrate Brevo into your applications, we're providing both plain Node.js and TypeScript-specific implementation approaches below while we work on the next generation of our SDK.
 
-### For [Node.js](https://nodejs.org/)
+## Table of Contents
 
-#### npm
+- [Node.js Implementation](#nodejs-implementation)
+  - [Send Transactional Email](#send-transactional-email)
+  - [Create Contact](#create-contact)
+- [TypeScript Implementation](#typescript-implementation)
+  - [Send Transactional Email](#send-transactional-email-1)
+  - [Create Contact](#create-contact-1)
+- [Support](#support)
+- [License](#license)
 
-The following recommended installation requires [npm](https://npmjs.org/). If you are unfamiliar with npm, see the [npm docs](https://npmjs.org/doc/).
+## Node.js Implementation
 
-Then install it via:
+### Send Transactional Email
 
-```shell
+#### Installation
+
+```bash
 npm i @getbrevo/brevo --save
-# or
-yarn add @getbrevo/brevo
 ```
 
-## Getting Started
-
+#### Import packages
 
+```javascript
+import { TransactionalEmailsApi, SendSmtpEmail } from "@getbrevo/brevo";
+```
 
-# We have two options:
-- First example is where **typescript is not supported** i.e. [v1.0.1]([url](https://www.npmjs.com/package/@getbrevo/brevo/v/1.0.1))
-- Second example is where **typescript is supported** i.e. [v2.1.1]([url](https://www.npmjs.com/package/@getbrevo/brevo/v/2.1.1))
+#### Instantiate API with your credentials
 
+```javascript
+let emailAPI = new TransactionalEmailsApi();
+emailAPI.authentications.apiKey.apiKey = "xkeysib-xxxxxxxxxxxxxxxxxxxxx"
+```
 
-```shell
--------------------------------------------------------------------------------------------------------------------------
-----------------------------------------------   Typescript not supported v1.0.1  ---------------------------------------
--------------------------------------------------------------------------------------------------------------------------
-const brevo = require('@getbrevo/brevo');
-let defaultClient = brevo.ApiClient.instance;
+#### Build your message
 
-let apiKey = defaultClient.authentications['api-key'];
-apiKey.apiKey = 'YOUR API KEY';
+```javascript
+let message = new SendSmtpEmail();
+message.subject = "First email";
+message.textContent = "Hello world!";
+message.sender = { name: "John Doe", email: "john.doe@example.com" };
+message.to = [{ email: "jane.smith@example.com", name: "Jane Smith" }];
+```
 
-let apiInstance = new brevo.TransactionalEmailsApi();
-let sendSmtpEmail = new brevo.SendSmtpEmail();
+#### Send the message
 
-sendSmtpEmail.subject = "My {{params.subject}}";
-sendSmtpEmail.htmlContent = "<html><body><h1>Common: This is my first transactional email {{params.parameter}}</h1></body></html>";
-sendSmtpEmail.sender = { "name": "John", "email": "example@example.com" };
-sendSmtpEmail.to = [
-  { "email": "example@brevo.com", "name": "sample-name" }
-];
-sendSmtpEmail.replyTo = { "email": "example@brevo.com", "name": "sample-name" };
-sendSmtpEmail.headers = { "Some-Custom-Name": "unique-id-1234" };
-sendSmtpEmail.params = { "parameter": "My param value", "subject": "common subject" };
+```javascript
+emailAPI.sendTransacEmail(message)
+```
 
+#### (Optional) Log the response
 
-apiInstance.sendTransacEmail(sendSmtpEmail).then(function (data) {
-  console.log('API called successfully. Returned data: ' + JSON.stringify(data));
-}, function (error) {
-  console.error(error);
+```javascript
+emailAPI.sendTransacEmail(message).then(res => {
+    console.log(JSON.stringify(res.body));
+}).catch(err => {
+    console.error("Error sending email:", err.body);
 });
+```
+
+### Create Contact
 
+#### Installation
+
+```bash
+npm i @getbrevo/brevo --save
 ```
--------------------------------------------------------------------------------------------------------------------------
-## Typescript supported with version v2.1.1
 
-```shell
--------------------------------------------------------------------------------------------------------------------------
-----------------------------------------------   Typescript supported with v2.1.1  --------------------------------------
--------------------------------------------------------------------------------------------------------------------------
-const brevo = require('@getbrevo/brevo');
-let apiInstance = new brevo.TransactionalEmailsApi();
+#### Import packages
 
-let apiKey = apiInstance.authentications['api-key'];
-apiKey.apiKey = 'YOUR API KEY';
+```javascript
+import { CreateContact, ContactsApi } from "@getbrevo/brevo";
+```
+
+#### Instantiate API with your credentials
 
-let sendSmtpEmail = new brevo.SendSmtpEmail();
+```javascript
+let contactAPI = new ContactsApi();
+contactAPI.authentications.apiKey.apiKey = "xkeysib-xxxxxx"
+```
 
-sendSmtpEmail.subject = "My {{params.subject}}";
-sendSmtpEmail.htmlContent = "<html><body><h1>Common: This is my first transactional email {{params.parameter}}</h1></body></html>";
-sendSmtpEmail.sender = { "name": "John", "email": "shubham.upadhyay@sendinblue.com" };
-sendSmtpEmail.to = [
-  { "email": "shubham.upadhyay@sendinblue.com", "name": "shubham upadhyay" }
-];
-sendSmtpEmail.replyTo = { "email": "shubham.upadhyay@sendinblue.com", "name": "Shubham Upadhyay" };
-sendSmtpEmail.headers = { "Some-Custom-Name": "unique-id-1234" };
-sendSmtpEmail.params = { "parameter": "My param value", "subject": "common subject" };
+#### Build your contact
+
+```javascript
+let contact = new CreateContact();
+contact.email = "alice.johnson@example.com";
+contact.attributes = {
+  FIRSTNAME: "Alice",
+  LASTNAME: "Johnson",
+};
+```
 
+#### Create the contact
 
-apiInstance.sendTransacEmail(sendSmtpEmail).then(function (data) {
-  console.log('API called successfully. Returned data: ' + JSON.stringify(data));
-}, function (error) {
-  console.error(error);
+```javascript
+contactAPI.createContact(contact).then(res => {
+  console.log(JSON.stringify(res.body));
+}).catch(err => {
+  console.error("Error creating contact:", err.body);
 });
+```
 
+## TypeScript Implementation
+
+### Recommended tsconfig.json Settings
+
+We recommend using the following TypeScript configuration for optimal compatibility:
+
+```json
+{
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "commonjs",
+    "outDir": "dist",
+    "rootDir": "src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true
+  },
+  "include": ["src"]
+}
 ```
--------------------------------------------------------------------------------------------------------------------------
-## Get Contact attributes API example:
 
-```shell
-const brevo = require('@getbrevo/brevo');
+### Send Transactional Email
 
-let apiInstance = new brevo.ContactsApi()
+#### Installation
 
-let apiKey = apiInstance.authentications['api-key'];
-apiKey.apiKey = 'YOUR API KEY';
+```bash
+npm i @getbrevo/brevo --save
+```
 
-apiInstance.getAttributes().then(function(data) {
-  console.log('API called successfully. Returned data: ' + JSON.stringify(data));
+#### Import packages
 
-}, function(error) {
-  console.error(error);
-});
+```typescript
+import { TransactionalEmailsApi, SendSmtpEmail } from "@getbrevo/brevo";
+```
+
+#### Instantiate API with your credentials
 
+```typescript
+let emailAPI = new TransactionalEmailsApi();
+(emailAPI as any).authentications.apiKey.apiKey = "xkeysib-xxxxxxxxxxxxxxxxxxxxx";
 ```
--------------------------------------------------------------------------------------------------------------------------
-## Get Account API example:
 
-```shell
-const brevo = require('@getbrevo/brevo');
+#### Build your message
 
-let apiInstance = new brevo.AccountApi()
+```typescript
+let message = new SendSmtpEmail();
+message.subject = "First email";
+message.textContent = "Hello world!";
+message.sender = { name: "Bob Wilson", email: "bob.wilson@example.com" };
+message.to = [{ email: "sarah.davis@example.com", name: "Sarah Davis" }];
+```
 
-let apiKey = apiInstance.authentications['api-key'];
-apiKey.apiKey = 'YOUR API KEY';
+#### Send the message
 
-apiInstance.getAccount().then(function(data) {
-  console.log('API called successfully. Returned data: ' + JSON.stringify(data));
+```typescript
+emailAPI.sendTransacEmail(message)
+```
 
-}, function(error) {
-  console.error(error);
-});
+#### (Optional) Log the response
+
+```typescript
+emailAPI
+  .sendTransacEmail(message)
+  .then((res) => {
+    console.log(JSON.stringify(res.body));
+  })
+  .catch((err) => {
+    console.error("Error sending email:", err.body);
+  });
+```
+
+### Create Contact
+
+#### Installation
 
+```bash
+npm i @getbrevo/brevo --save
 ```
--------------------------------------------------------------------------------------------------------------------------
-## Get Contacts API example:
-```shell
-const brevo = require('@getbrevo/brevo');
 
-let apiInstance = new brevo.ContactsApi()
+#### Import packages
 
-let apiKey = apiInstance.authentications['api-key'];
-apiKey.apiKey = 'YOUR API KEY';
+```typescript
+import { CreateContact, ContactsApi } from "@getbrevo/brevo";
+```
 
-apiInstance.getContacts().then(function(data) {
-  console.log('API called successfully. Returned data: ' + JSON.stringify(data));
+#### Instantiate API with your credentials
 
-}, function(error) {
-  console.error(error);
+```typescript
+let contactAPI = new ContactsApi();
+(contactAPI as any).authentications.apiKey.apiKey = "xkeysib-xxxxxxxxx"
+```
+
+#### Build your contact
+
+```typescript
+let contact = new CreateContact();
+contact.email = "michael.brown@example.com";
+contact.attributes = {
+  FIRSTNAME: { value: "Michael" },
+  LASTNAME: { value: "Brown" },
+};
+```
+
+#### Create the contact
+
+```typescript
+contactAPI.createContact(contact).then(res => {
+  console.log(JSON.stringify(res.body));
+}).catch(err => {
+  console.error("Error creating contact:", err.body);
 });
 ```
 
-For more examples, refer the [Endpoints Guide](https://developers.brevo.com/reference)
+## Support
+
+For questions and support, please refer to our [documentation](https://developers.brevo.com) or contact our support team.
+
+## License
+
+This SDK is distributed under the MIT License.