@getbrevo/brevo 2.3.0 → 3.0.1

package/model/order.ts

@@ -12,7 +12,6 @@
 
 import { RequestFile } from './models';
 import { OrderBilling } from './orderBilling';
-import { OrderIdentifiers } from './orderIdentifiers';
 import { OrderProductsInner } from './orderProductsInner';
 
 export class Order {
@@ -36,21 +35,16 @@ export class Order {
     * Total amount of the order, including all shipping expenses, tax and the price of items.
     */
     'amount': number;
+    'products': Array<OrderProductsInner>;
     /**
-    * ID of store where the order is placed
+    * Email of the contact, Mandatory if \"phone\" field is not passed in \"billing\" parameter.
     */
-    'storeId'?: string;
-    'identifiers'?: OrderIdentifiers;
-    'products': Array<OrderProductsInner>;
+    'email'?: string;
     'billing'?: OrderBilling;
     /**
     * Coupons applied to the order. Stored case insensitive.
     */
     'coupons'?: Array<string>;
-    /**
-    * Meta data of order to store additional detal such as custom message, customer type, source.
-    */
-    'metaInfo'?: { [key: string]: object; };
 
     static discriminator: string | undefined = undefined;
 
@@ -80,21 +74,16 @@ export class Order {
             "baseName": "amount",
             "type": "number"
         },
-        {
-            "name": "storeId",
-            "baseName": "storeId",
-            "type": "string"
-        },
-        {
-            "name": "identifiers",
-            "baseName": "identifiers",
-            "type": "OrderIdentifiers"
-        },
         {
             "name": "products",
             "baseName": "products",
             "type": "Array<OrderProductsInner>"
         },
+        {
+            "name": "email",
+            "baseName": "email",
+            "type": "string"
+        },
         {
             "name": "billing",
             "baseName": "billing",
@@ -104,11 +93,6 @@ export class Order {
             "name": "coupons",
             "baseName": "coupons",
             "type": "Array<string>"
-        },
-        {
-            "name": "metaInfo",
-            "baseName": "metaInfo",
-            "type": "{ [key: string]: object; }"
         }    ];
 
     static getAttributeTypeMap() {

package/model/orderBilling.ts

@@ -33,7 +33,7 @@ export class OrderBilling {
     */
     'country'?: string;
     /**
-    * Billing phone number.
+    * Phone number to contact for further details about the order, Mandatory if \"email\" field is not passed.
     */
     'phone'?: string;
     /**

package/model/removeContactFromList.ts

@@ -14,19 +14,15 @@ import { RequestFile } from './models';
 
 export class RemoveContactFromList {
     /**
-    * Required if \'all\' is false and EXT_ID attributes, IDs are not passed. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request.
+    * Required if \'all\' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request.
     */
     'emails'?: Array<string>;
     /**
-    * Mandatory if Emails, EXT_ID attributes are not passed, ignored otherwise. Contact IDs to add to a list. You can pass a maximum of 150 Ids for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api.
+    * Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api.
     */
     'ids'?: Array<number>;
     /**
-    * Mandatory if \'all\' is false and Emails, IDs are not passed, ignored otherwise. EXT_ID attributes to add to a list. You can pass a maximum of 150 extIds for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api.
-    */
-    'extIds'?: Array<string>;
-    /**
-    * Required if none of \'emails\', EXT_ID attributes or \'ids\' are passed. Remove all existing contacts from a list.  A process will be created in this scenario. You can fetch the process details to know about the progress
+    * Required if none of \'emails\' or \'ids\' are passed. Remove all existing contacts from a list.  A process will be created in this scenario. You can fetch the process details to know about the progress
     */
     'all'?: boolean;
 
@@ -43,11 +39,6 @@ export class RemoveContactFromList {
             "baseName": "ids",
             "type": "Array<number>"
         },
-        {
-            "name": "extIds",
-            "baseName": "extIds",
-            "type": "Array<string>"
-        },
         {
             "name": "all",
             "baseName": "all",

package/model/requestContactExport.ts

@@ -15,7 +15,7 @@ import { RequestContactExportCustomContactFilter } from './requestContactExportC
 
 export class RequestContactExport {
     /**
-    * List of all the attributes that you want to export. These attributes must be present in your contact database. It is required if exportMandatoryAttributes is set false. For example, [\'fname\', \'lname\', \'email\'].
+    * List of all the attributes that you want to export. These attributes must be present in your contact database. For example, [\'fname\', \'lname\', \'email\'].
     */
     'exportAttributes'?: Array<string>;
     'customContactFilter': RequestContactExportCustomContactFilter;
@@ -23,22 +23,6 @@ export class RequestContactExport {
     * Webhook that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479
     */
     'notifyUrl'?: string;
-    /**
-    * To avoid generating the email notification upon contact export, pass **true**
-    */
-    'disableNotification'?: boolean = false;
-    /**
-    * To export mandatory attributes like EMAIL, ADDED_TIME, MODIFIED_TIME
-    */
-    'exportMandatoryAttributes'?: boolean = true;
-    /**
-    * Export subscription status of contacts for email & sms marketting. Pass email_marketing to obtain the marketing email subscription status & sms_marketing to retrieve the marketing SMS status of the contact.
-    */
-    'exportSubscriptionStatus'?: Array<string>;
-    /**
-    * Export metadata of contacts such as _listIds, ADDED_TIME, MODIFIED_TIME.
-    */
-    'exportMetadata'?: Array<string>;
 
     static discriminator: string | undefined = undefined;
 
@@ -57,26 +41,6 @@ export class RequestContactExport {
             "name": "notifyUrl",
             "baseName": "notifyUrl",
             "type": "string"
-        },
-        {
-            "name": "disableNotification",
-            "baseName": "disableNotification",
-            "type": "boolean"
-        },
-        {
-            "name": "exportMandatoryAttributes",
-            "baseName": "exportMandatoryAttributes",
-            "type": "boolean"
-        },
-        {
-            "name": "exportSubscriptionStatus",
-            "baseName": "exportSubscriptionStatus",
-            "type": "Array<string>"
-        },
-        {
-            "name": "exportMetadata",
-            "baseName": "exportMetadata",
-            "type": "Array<string>"
         }    ];
 
     static getAttributeTypeMap() {

package/model/requestContactExportCustomContactFilter.ts

@@ -29,14 +29,10 @@ export class RequestContactExportCustomContactFilter {
     */
     'actionForSmsCampaigns'?: RequestContactExportCustomContactFilter.ActionForSmsCampaignsEnum;
     /**
-    * ID of the list. This is mandatory if actionForContacts is specified and segmentId is not provided. Either segmentId or listId must be included.
+    * Mandatory if actionForContacts is passed, ignored otherwise. Id of the list for which the corresponding action shall be applied in the filter.
     */
     'listId'?: number;
     /**
-    * ID of the segment. This is mandatory if actionForContacts is specified and listId is not provided. Either segmentId or listId must be included. 
-    */
-    'segmentId'?: number;
-    /**
     * Considered only if actionForEmailCampaigns is passed, ignored otherwise. Mandatory if action is one of the following - openers, nonOpeners, clickers, nonClickers, unsubscribed. The id of the email campaign for which the corresponding action shall be applied in the filter.
     */
     'emailCampaignId'?: number;
@@ -68,11 +64,6 @@ export class RequestContactExportCustomContactFilter {
             "baseName": "listId",
             "type": "number"
         },
-        {
-            "name": "segmentId",
-            "baseName": "segmentId",
-            "type": "number"
-        },
         {
             "name": "emailCampaignId",
             "baseName": "emailCampaignId",

package/model/sendSmtpEmail.ts

@@ -71,7 +71,7 @@ export class SendSmtpEmail {
     */
     'tags'?: Array<string>;
     /**
-    * UTC date-time on which the email has to schedule (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for scheduling. There can be an expected delay of +5 minutes in scheduled email delivery.
+    * UTC date-time on which the email has to schedule (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for scheduling. There can be an expected delay of +5 minutes in scheduled email delivery. **Please note this feature is currently a public beta**.
     */
     'scheduledAt'?: Date;
     /**

package/model/sendTransacSms.ts

@@ -11,7 +11,6 @@
  */
 
 import { RequestFile } from './models';
-import { SendTransacSmsTag } from './sendTransacSmsTag';
 
 export class SendTransacSms {
     /**
@@ -30,7 +29,10 @@ export class SendTransacSms {
     * Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc.
     */
     'type'?: SendTransacSms.TypeEnum = SendTransacSms.TypeEnum.Transactional;
-    'tag'?: SendTransacSmsTag;
+    /**
+    * Tag of the message
+    */
+    'tag'?: string;
     /**
     * Webhook to call for each event triggered by the message (delivered etc.)
     */
@@ -70,7 +72,7 @@ export class SendTransacSms {
         {
             "name": "tag",
             "baseName": "tag",
-            "type": "SendTransacSmsTag"
+            "type": "string"
         },
         {
             "name": "webUrl",

package/model/subAccountDetailsResponsePlanInfoCredits.ts

@@ -12,9 +12,7 @@
 
 import { RequestFile } from './models';
 import { SubAccountDetailsResponsePlanInfoCreditsEmails } from './subAccountDetailsResponsePlanInfoCreditsEmails';
-import { SubAccountDetailsResponsePlanInfoCreditsExternalFeeds } from './subAccountDetailsResponsePlanInfoCreditsExternalFeeds';
 import { SubAccountDetailsResponsePlanInfoCreditsSms } from './subAccountDetailsResponsePlanInfoCreditsSms';
-import { SubAccountDetailsResponsePlanInfoCreditsWhatsapp } from './subAccountDetailsResponsePlanInfoCreditsWhatsapp';
 import { SubAccountDetailsResponsePlanInfoCreditsWpSubscribers } from './subAccountDetailsResponsePlanInfoCreditsWpSubscribers';
 
 /**
@@ -24,8 +22,6 @@ export class SubAccountDetailsResponsePlanInfoCredits {
     'emails'?: SubAccountDetailsResponsePlanInfoCreditsEmails;
     'sms'?: SubAccountDetailsResponsePlanInfoCreditsSms;
     'wpSubscribers'?: SubAccountDetailsResponsePlanInfoCreditsWpSubscribers;
-    'whatsapp'?: SubAccountDetailsResponsePlanInfoCreditsWhatsapp;
-    'externalFeeds'?: SubAccountDetailsResponsePlanInfoCreditsExternalFeeds;
 
     static discriminator: string | undefined = undefined;
 
@@ -44,16 +40,6 @@ export class SubAccountDetailsResponsePlanInfoCredits {
             "name": "wpSubscribers",
             "baseName": "wpSubscribers",
             "type": "SubAccountDetailsResponsePlanInfoCreditsWpSubscribers"
-        },
-        {
-            "name": "whatsapp",
-            "baseName": "whatsapp",
-            "type": "SubAccountDetailsResponsePlanInfoCreditsWhatsapp"
-        },
-        {
-            "name": "externalFeeds",
-            "baseName": "externalFeeds",
-            "type": "SubAccountDetailsResponsePlanInfoCreditsExternalFeeds"
         }    ];
 
     static getAttributeTypeMap() {

package/model/subAccountDetailsResponsePlanInfoFeatures.ts

@@ -13,7 +13,6 @@
 import { RequestFile } from './models';
 import { SubAccountDetailsResponsePlanInfoFeaturesInbox } from './subAccountDetailsResponsePlanInfoFeaturesInbox';
 import { SubAccountDetailsResponsePlanInfoFeaturesLandingPage } from './subAccountDetailsResponsePlanInfoFeaturesLandingPage';
-import { SubAccountDetailsResponsePlanInfoFeaturesSalesUsers } from './subAccountDetailsResponsePlanInfoFeaturesSalesUsers';
 import { SubAccountDetailsResponsePlanInfoFeaturesUsers } from './subAccountDetailsResponsePlanInfoFeaturesUsers';
 
 /**
@@ -23,7 +22,6 @@ export class SubAccountDetailsResponsePlanInfoFeatures {
     'inbox'?: SubAccountDetailsResponsePlanInfoFeaturesInbox;
     'landingPage'?: SubAccountDetailsResponsePlanInfoFeaturesLandingPage;
     'users'?: SubAccountDetailsResponsePlanInfoFeaturesUsers;
-    'salesUsers'?: SubAccountDetailsResponsePlanInfoFeaturesSalesUsers;
 
     static discriminator: string | undefined = undefined;
 
@@ -42,11 +40,6 @@ export class SubAccountDetailsResponsePlanInfoFeatures {
             "name": "users",
             "baseName": "users",
             "type": "SubAccountDetailsResponsePlanInfoFeaturesUsers"
-        },
-        {
-            "name": "salesUsers",
-            "baseName": "salesUsers",
-            "type": "SubAccountDetailsResponsePlanInfoFeaturesSalesUsers"
         }    ];
 
     static getAttributeTypeMap() {

package/model/subAccountDetailsResponsePlanInfoFeaturesUsers.ts

@@ -13,15 +13,15 @@
 import { RequestFile } from './models';
 
 /**
-* Marketing users to manage the marketing channels
+* Multi-account details
 */
 export class SubAccountDetailsResponsePlanInfoFeaturesUsers {
     /**
-    * Quantity of marketing users provided
+    * Quantity of multi-account\'s provided
     */
     'quantity'?: number;
     /**
-    * Available marketing users for use
+    * Available multi-accounts for use
     */
     'remaining'?: number;
 

package/model/subAccountUpdatePlanRequestCredits.ts

@@ -17,25 +17,17 @@ import { RequestFile } from './models';
 */
 export class SubAccountUpdatePlanRequestCredits {
     /**
-    * Number of email credits | Pass the value -1 for unlimited emails in ENTv2 only
+    * Number of email credits
     */
     'email'?: number;
     /**
-    * Number of SMS credits | Pass the value -1 for unlimited SMS in ENTv2 only
+    * Number of SMS credits | available in ENT-v2 only
     */
     'sms'?: number;
     /**
     * Number of Push credits, possible value is 0 and -1 | available in ENT-v2 only
     */
     'wpSubscribers'?: number;
-    /**
-    * Number of externalFeeds credits, possible values are 0 or 1 |available in ENTv2 only
-    */
-    'externalFeeds'?: number;
-    /**
-    * Number of whatsapp credits | Pass the value -1 for unlimited whatsapp in ENTv2 only
-    */
-    'whatsapp'?: number;
 
     static discriminator: string | undefined = undefined;
 
@@ -54,16 +46,6 @@ export class SubAccountUpdatePlanRequestCredits {
             "name": "wpSubscribers",
             "baseName": "wpSubscribers",
             "type": "number"
-        },
-        {
-            "name": "externalFeeds",
-            "baseName": "externalFeeds",
-            "type": "number"
-        },
-        {
-            "name": "whatsapp",
-            "baseName": "whatsapp",
-            "type": "number"
         }    ];
 
     static getAttributeTypeMap() {

package/model/subAccountUpdatePlanRequestFeatures.ts

@@ -21,17 +21,13 @@ export class SubAccountUpdatePlanRequestFeatures {
     */
     'users'?: number;
     /**
-    * Number of landing pages
+    * Number of landing pages / Not required on ENTv2
     */
     'landingPage'?: number;
     /**
     * Number of inboxes / Not required on ENTv2
     */
     'inbox'?: number;
-    /**
-    * Number of sales users
-    */
-    'salesUsers'?: number;
 
     static discriminator: string | undefined = undefined;
 
@@ -50,11 +46,6 @@ export class SubAccountUpdatePlanRequestFeatures {
             "name": "inbox",
             "baseName": "inbox",
             "type": "number"
-        },
-        {
-            "name": "salesUsers",
-            "baseName": "salesUsers",
-            "type": "number"
         }    ];
 
     static getAttributeTypeMap() {

package/model/updateAttribute.ts

@@ -19,13 +19,9 @@ export class UpdateAttribute {
     */
     'value'?: string;
     /**
-    * List of the values and labels that the attribute can take. Use only if the attribute\'s category is \"category\". None of the category options can exceed max 200 characters. For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}]
+    * List of the values and labels that the attribute can take. Use only if the attribute\'s category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}]
     */
     'enumeration'?: Array<UpdateAttributeEnumerationInner>;
-    /**
-    * Use this option to add multiple-choice attributes options only if the attribute\'s category is \"normal\". **This option is specifically designed for updating multiple-choice attributes. None of the multicategory options can exceed max 200 characters **. For example: **[\"USA\",\"INDIA\"]** 
-    */
-    'multiCategoryOptions'?: Array<string>;
 
     static discriminator: string | undefined = undefined;
 
@@ -39,11 +35,6 @@ export class UpdateAttribute {
             "name": "enumeration",
             "baseName": "enumeration",
             "type": "Array<UpdateAttributeEnumerationInner>"
-        },
-        {
-            "name": "multiCategoryOptions",
-            "baseName": "multiCategoryOptions",
-            "type": "Array<string>"
         }    ];
 
     static getAttributeTypeMap() {

package/model/updateContact.ts

@@ -14,9 +14,9 @@ import { RequestFile } from './models';
 
 export class UpdateContact {
     /**
-    * Pass the set of attributes to be updated. These attributes must be present in your account. Values that don\'t match the attribute type (e.g. text or string in a date attribute) will be ignored.To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\", \"COUNTRIES\":[\"India\",\"China\"]}`. The attribute\'s parameter should be passed in capital letter while updating a contact. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"}
+    * Pass the set of attributes to be updated. These attributes must be present in your account. Values that don\'t match the attribute type (e.g. text or string in a date attribute) will be ignored.To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. The attribute\'s parameter should be passed in capital letter while updating a contact. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"}
     */
-    'attributes'?: { [key: string]: object; };
+    'attributes'?: object;
     /**
     * Pass your own Id to update ext_id of a contact.
     */
@@ -48,7 +48,7 @@ export class UpdateContact {
         {
             "name": "attributes",
             "baseName": "attributes",
-            "type": "{ [key: string]: object; }"
+            "type": "object"
         },
         {
             "name": "extId",

package/model/updateEmailCampaign.ts

@@ -11,7 +11,6 @@
  */
 
 import { RequestFile } from './models';
-import { UpdateEmailCampaignEmailExpirationDate } from './updateEmailCampaignEmailExpirationDate';
 import { UpdateEmailCampaignRecipients } from './updateEmailCampaignRecipients';
 import { UpdateEmailCampaignSender } from './updateEmailCampaignSender';
 
@@ -134,7 +133,6 @@ export class UpdateEmailCampaign {
     * Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form.
     */
     'updateFormId'?: string;
-    'emailExpirationDate'?: UpdateEmailCampaignEmailExpirationDate;
 
     static discriminator: string | undefined = undefined;
 
@@ -293,11 +291,6 @@ export class UpdateEmailCampaign {
             "name": "updateFormId",
             "baseName": "updateFormId",
             "type": "string"
-        },
-        {
-            "name": "emailExpirationDate",
-            "baseName": "emailExpirationDate",
-            "type": "UpdateEmailCampaignEmailExpirationDate"
         }    ];
 
     static getAttributeTypeMap() {

package/model/updateEmailCampaignRecipients.ts

@@ -28,10 +28,6 @@ export class UpdateEmailCampaignRecipients {
     * Mandatory if listIds are not used. Campaign should only be updated with segmentIds if segmentIds were used to create it. Segment ids to send the campaign to.
     */
     'segmentIds'?: Array<number>;
-    /**
-    * Segment ids which have to be excluded from a campaign. 
-    */
-    'exclusionSegmentIds'?: Array<number>;
 
     static discriminator: string | undefined = undefined;
 
@@ -50,11 +46,6 @@ export class UpdateEmailCampaignRecipients {
             "name": "segmentIds",
             "baseName": "segmentIds",
             "type": "Array<number>"
-        },
-        {
-            "name": "exclusionSegmentIds",
-            "baseName": "exclusionSegmentIds",
-            "type": "Array<number>"
         }    ];
 
     static getAttributeTypeMap() {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@getbrevo/brevo",
-    "version": "2.3.0",
+    "version": "3.0.1",
     "description": "NodeJS client for @getbrevo/brevo",
     "repository": {
         "type": "git",
@@ -15,13 +15,13 @@
     "author": "Brevo",
     "license": "MIT",
     "dependencies": {
-        "bluebird": "^3.7.2",
-        "request": "^2.88.2"
+        "axios": "^1.6.8",
+        "bluebird": "^3.5.0",
+        "rewire": "^7.0.0"
     },
     "devDependencies": {
         "@types/bluebird": "^3.5.33",
-        "@types/node": "^12",
-        "@types/request": "^2.48.8",
-        "typescript": "^4.0 || ^5.0"
+        "@types/node": "^12.20.55",
+        "typescript": "^4.0"
     }
 }