@getbrevo/brevo 5.0.1 → 5.0.3

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@getbrevo/brevo",
-        "X-Fern-SDK-Version": "5.0.1",
-        "User-Agent": "@getbrevo/brevo/5.0.1",
+        "X-Fern-SDK-Version": "5.0.3",
+        "User-Agent": "@getbrevo/brevo/5.0.3",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/cjs/Client.d.ts

@@ -32,6 +32,7 @@ import { WebhooksClient } from "./api/resources/webhooks/client/Client.js";
 import { WhatsAppCampaignsClient } from "./api/resources/whatsAppCampaigns/client/Client.js";
 import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
 import { type NormalizedClientOptionsWithAuth } from "./BaseClient.js";
+import * as core from "./core/index.js";
 export declare namespace BrevoClient {
     type Options = BaseClientOptions;
     interface RequestOptions extends BaseRequestOptions {
@@ -104,4 +105,15 @@ export declare class BrevoClient {
     get transactionalEmails(): TransactionalEmailsClient;
     get transactionalSms(): TransactionalSmsClient;
     get smsTemplates(): SmsTemplatesClient;
+    /**
+     * Make a passthrough request using the SDK's configured auth, retry, logging, etc.
+     * This is useful for making requests to endpoints not yet supported in the SDK.
+     * The input can be a URL string, URL object, or Request object. Relative paths are resolved against the configured base URL.
+     *
+     * @param {Request | string | URL} input - The URL, path, or Request object.
+     * @param {RequestInit} init - Standard fetch RequestInit options.
+     * @param {core.PassthroughRequest.RequestOptions} requestOptions - Per-request overrides (timeout, retries, headers, abort signal).
+     * @returns {Promise<Response>} A standard Response object.
+     */
+    fetch(input: Request | string | URL, init?: RequestInit, requestOptions?: core.PassthroughRequest.RequestOptions): Promise<Response>;
 }

package/dist/cjs/Client.js

@@ -1,5 +1,47 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BrevoClient = void 0;
 const Client_js_1 = require("./api/resources/account/client/Client.js");
@@ -35,6 +77,7 @@ const Client_js_30 = require("./api/resources/user/client/Client.js");
 const Client_js_31 = require("./api/resources/webhooks/client/Client.js");
 const Client_js_32 = require("./api/resources/whatsAppCampaigns/client/Client.js");
 const BaseClient_js_1 = require("./BaseClient.js");
+const core = __importStar(require("./core/index.js"));
 class BrevoClient {
     constructor(options) {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
@@ -167,5 +210,29 @@ class BrevoClient {
         var _a;
         return ((_a = this._smsTemplates) !== null && _a !== void 0 ? _a : (this._smsTemplates = new Client_js_24.SmsTemplatesClient(this._options)));
     }
+    /**
+     * Make a passthrough request using the SDK's configured auth, retry, logging, etc.
+     * This is useful for making requests to endpoints not yet supported in the SDK.
+     * The input can be a URL string, URL object, or Request object. Relative paths are resolved against the configured base URL.
+     *
+     * @param {Request | string | URL} input - The URL, path, or Request object.
+     * @param {RequestInit} init - Standard fetch RequestInit options.
+     * @param {core.PassthroughRequest.RequestOptions} requestOptions - Per-request overrides (timeout, retries, headers, abort signal).
+     * @returns {Promise<Response>} A standard Response object.
+     */
+    fetch(input, init, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            return core.makePassthroughRequest(input, init, {
+                baseUrl: (_a = this._options.baseUrl) !== null && _a !== void 0 ? _a : this._options.environment,
+                headers: this._options.headers,
+                timeoutInSeconds: this._options.timeoutInSeconds,
+                maxRetries: this._options.maxRetries,
+                fetch: this._options.fetch,
+                logging: this._options.logging,
+                getAuthHeaders: () => __awaiter(this, void 0, void 0, function* () { return (yield this._options.authProvider.getAuthRequest()).headers; }),
+            }, requestOptions);
+        });
+    }
 }
 exports.BrevoClient = BrevoClient;

package/dist/cjs/api/resources/balance/client/Client.js

@@ -91,7 +91,7 @@ class BalanceClient {
     __getActiveBalancesApi(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { pid, limit, offset, sort_field: sortField, sort, contact_id: contactId, balance_definition_id: balanceDefinitionId, } = request;
+            const { pid, limit, offset, sort_field: sortField, sort, contact_id: contactId, balance_definition_id: balanceDefinitionId, includeInternal, } = request;
             const _queryParams = {
                 limit,
                 offset,
@@ -99,6 +99,7 @@ class BalanceClient {
                 sort,
                 contact_id: contactId,
                 balance_definition_id: balanceDefinitionId,
+                includeInternal,
             };
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
@@ -781,14 +782,17 @@ class BalanceClient {
     __getContactBalances(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { pid } = request;
+            const { pid, includeInternal } = request;
+            const _queryParams = {
+                includeInternal,
+            };
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/contact-balances`),
                 method: "GET",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
                 maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -913,14 +917,17 @@ class BalanceClient {
     __getSubscriptionBalances(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { pid, cid } = request;
+            const { pid, cid, includeInternal } = request;
+            const _queryParams = {
+                includeInternal,
+            };
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/subscriptions/${core.url.encodePathParam(cid)}/balances`),
                 method: "GET",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
                 maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -1052,7 +1059,7 @@ class BalanceClient {
     __getTransactionHistoryApi(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { pid, limit, offset, sortField, sort, contactId, balanceDefinitionId, filters } = request;
+            const { pid, limit, offset, sortField, sort, contactId, balanceDefinitionId, filters, status, transactionType, } = request;
             const _queryParams = {
                 limit,
                 offset,
@@ -1061,6 +1068,8 @@ class BalanceClient {
                 contactId,
                 balanceDefinitionId,
                 filters,
+                status: status != null ? status : undefined,
+                transactionType: transactionType != null ? transactionType : undefined,
             };
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);

package/dist/cjs/api/resources/balance/client/requests/GetContactBalancesRequest.d.ts

@@ -7,4 +7,6 @@
 export interface GetContactBalancesRequest {
     /** Loyalty Program Id */
     pid: string;
+    /** Include balances tied to internal definitions. */
+    includeInternal?: boolean;
 }

package/dist/cjs/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidActiveBalanceRequest.d.ts

@@ -21,4 +21,6 @@ export interface GetLoyaltyBalanceProgramsPidActiveBalanceRequest {
     contact_id: number;
     /** Balance Definition ID */
     balance_definition_id: string;
+    /** Include balances tied to internal definitions. */
+    includeInternal?: boolean;
 }

package/dist/cjs/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidTransactionHistoryRequest.d.ts

@@ -12,7 +12,7 @@ export interface GetLoyaltyBalanceProgramsPidTransactionHistoryRequest {
     pid: string;
     /** Limit the number of records returned */
     limit?: number;
-    /** Skip a number of records */
+    /** Page number to retrieve */
     offset?: number;
     /** Field to sort by */
     sortField?: "createdAt";
@@ -24,4 +24,8 @@ export interface GetLoyaltyBalanceProgramsPidTransactionHistoryRequest {
     balanceDefinitionId: string;
     /** Filters to apply */
     filters?: string | string[];
+    /** Transaction status filter. Allowed values: draft, completed, rejected, cancelled, expired */
+    status?: Brevo.GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus;
+    /** Transaction type filter. Allowed values: credit, debit */
+    transactionType?: Brevo.GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType;
 }

package/dist/cjs/api/resources/balance/client/requests/GetSubscriptionBalancesRequest.d.ts

@@ -10,4 +10,6 @@ export interface GetSubscriptionBalancesRequest {
     pid: string;
     /** Contact Id */
     cid: string;
+    /** Include balances tied to internal definitions. */
+    includeInternal?: boolean;
 }

package/dist/cjs/api/resources/balance/client/requests/PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest.d.ts

@@ -34,7 +34,7 @@ export interface PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest {
     /** Maximum debit allowed per operation. */
     maxDebitAmountLimit?: number;
     /** Additional metadata for the balance definition. */
-    meta?: Record<string, unknown>;
+    meta?: PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest.Meta;
     /** Minimum allowable balance amount. */
     minAmount?: number;
     /** Name of the balance definition. */
@@ -78,6 +78,15 @@ export declare namespace PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest
         readonly Natural: "natural";
     };
     type BalanceOptionDebitRounding = (typeof BalanceOptionDebitRounding)[keyof typeof BalanceOptionDebitRounding];
+    /**
+     * Additional metadata for the balance definition.
+     */
+    interface Meta {
+        /** Indicates whether the balance definition is internal. */
+        isInternal?: boolean | undefined;
+        /** Accepts any additional properties */
+        [key: string]: any;
+    }
     /** Unit of balance measurement. */
     const Unit: {
         readonly Points: "POINTS";

package/dist/cjs/api/resources/balance/client/requests/UpdateBalanceDefinitionRequest.d.ts

@@ -37,7 +37,7 @@ export interface UpdateBalanceDefinitionRequest {
     /** Maximum debit allowed per operation. */
     maxDebitAmountLimit?: number;
     /** Optional metadata for the balance definition. */
-    meta?: Record<string, unknown>;
+    meta?: UpdateBalanceDefinitionRequest.Meta;
     /** Minimum allowable balance amount. */
     minAmount?: number;
     /** Name of the balance definition. */
@@ -81,6 +81,15 @@ export declare namespace UpdateBalanceDefinitionRequest {
         readonly Natural: "natural";
     };
     type BalanceOptionDebitRounding = (typeof BalanceOptionDebitRounding)[keyof typeof BalanceOptionDebitRounding];
+    /**
+     * Optional metadata for the balance definition.
+     */
+    interface Meta {
+        /** Indicates whether the balance definition is internal. */
+        isInternal?: boolean | undefined;
+        /** Accepts any additional properties */
+        [key: string]: any;
+    }
     /** Unit of balance measurement. */
     const Unit: {
         readonly Points: "POINTS";

package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus.d.ts

@@ -0,0 +1,8 @@
+export declare const GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus: {
+    readonly Draft: "draft";
+    readonly Completed: "completed";
+    readonly Rejected: "rejected";
+    readonly Cancelled: "cancelled";
+    readonly Expired: "expired";
+};
+export type GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus = (typeof GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus)[keyof typeof GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus];

package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus.js

@@ -0,0 +1,11 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus = void 0;
+exports.GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus = {
+    Draft: "draft",
+    Completed: "completed",
+    Rejected: "rejected",
+    Cancelled: "cancelled",
+    Expired: "expired",
+};

package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType.d.ts

@@ -0,0 +1,5 @@
+export declare const GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType: {
+    readonly Credit: "credit";
+    readonly Debit: "debit";
+};
+export type GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType = (typeof GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType)[keyof typeof GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType];

package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType.js

@@ -0,0 +1,8 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType = void 0;
+exports.GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType = {
+    Credit: "credit",
+    Debit: "debit",
+};

package/dist/cjs/api/resources/balance/types/index.d.ts

@@ -7,6 +7,8 @@ export * from "./GetBalanceDefinitionRequestVersion.js";
 export * from "./GetBalanceLimitRequestVersion.js";
 export * from "./GetContactBalancesResponse.js";
 export * from "./GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSort.js";
+export * from "./GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus.js";
+export * from "./GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType.js";
 export * from "./GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.js";
 export * from "./GetSubscriptionBalancesResponse.js";
 export * from "./PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse.js";

package/dist/cjs/api/resources/balance/types/index.js

@@ -23,6 +23,8 @@ __exportStar(require("./GetBalanceDefinitionRequestVersion.js"), exports);
 __exportStar(require("./GetBalanceLimitRequestVersion.js"), exports);
 __exportStar(require("./GetContactBalancesResponse.js"), exports);
 __exportStar(require("./GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSort.js"), exports);
+__exportStar(require("./GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus.js"), exports);
+__exportStar(require("./GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType.js"), exports);
 __exportStar(require("./GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.js"), exports);
 __exportStar(require("./GetSubscriptionBalancesResponse.js"), exports);
 __exportStar(require("./PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse.js"), exports);

package/dist/cjs/api/resources/contacts/client/Client.d.ts

@@ -447,7 +447,7 @@ export declare class ContactsClient {
     private __getContactInfo;
     /**
      * <Note>Follow this format when passing a "SMS" phone number as an attribute.
-     * Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx</Note>
+     * Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx <br><br> If a blocklisted contact's email address is updated, it is going to remove that blocklisting from the contact and they will be resubscribed.</Note>
      * There are 2 ways to update a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={} <br> <br> Option 1 only works if identifierType is email_id (for EMAIL) or contact_id (for ID of the contact),where you can directly pass the value of EMAIL and ID of the contact.   <br><br> Option 2 works for all identifierType, use email_id for EMAIL attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE attribute
      *
      * @param {Brevo.UpdateContactRequest} request

package/dist/cjs/api/resources/contacts/client/Client.js

@@ -1580,7 +1580,7 @@ class ContactsClient {
     }
     /**
      * <Note>Follow this format when passing a "SMS" phone number as an attribute.
-     * Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx</Note>
+     * Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx <br><br> If a blocklisted contact's email address is updated, it is going to remove that blocklisting from the contact and they will be resubscribed.</Note>
      * There are 2 ways to update a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={} <br> <br> Option 1 only works if identifierType is email_id (for EMAIL) or contact_id (for ID of the contact),where you can directly pass the value of EMAIL and ID of the contact.   <br><br> Option 2 works for all identifierType, use email_id for EMAIL attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE attribute
      *
      * @param {Brevo.UpdateContactRequest} request

package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.ts

@@ -17,17 +17,21 @@ export declare namespace CreateUpdateBatchProductsRequest {
     type Products = Products.Item[];
     namespace Products {
         interface Item {
+            /** Brand of the product */
+            brand?: string | undefined;
             /** Category ID-s of the product */
             categories?: string[] | undefined;
             /** UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop's database */
             deletedAt?: string | undefined;
+            /** Description of the product */
+            description?: string | undefined;
             /** Product ID for which you requested the details */
             id: string;
             /** Absolute URL to the cover image of the product */
             imageUrl?: string | undefined;
             /** product deleted from the shop's database */
             isDeleted?: boolean | undefined;
-            /** Meta data of product such as description, vendor, producer, stock level. The size of cumulative metaInfo shall not exceed **1000 KB**. Maximum length of metaInfo object can be 20. */
+            /** Meta data of product such as description, vendor, producer, stock level. The total characters of cumulative metaInfo shall not exceed **20000 characters**. */
             metaInfo?: Record<string, Item.MetaInfo.Value> | undefined;
             /** Mandatory in case of creation**. Name of the product for which you requested the details */
             name: string;

package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateProductRequest.d.ts

@@ -6,17 +6,21 @@
  *     }
  */
 export interface CreateUpdateProductRequest {
+    /** Brand of the product */
+    brand?: string;
     /** Category ID-s of the product */
     categories?: string[];
     /** UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop's database */
     deletedAt?: string;
+    /** Description of the product */
+    description?: string;
     /** Product ID for which you requested the details */
     id: string;
     /** Absolute URL to the cover image of the product */
     imageUrl?: string;
     /** product deleted from the shop's database */
     isDeleted?: boolean;
-    /** Meta data of product such as description, vendor, producer, stock level. The size of cumulative metaInfo shall not exceed **1000 KB**. Maximum length of metaInfo object can be 20. */
+    /** Meta data of product such as description, vendor, producer, stock level. The total characters of cumulative metaInfo shall not exceed **20000 characters**. */
     metaInfo?: Record<string, CreateUpdateProductRequest.MetaInfo.Value>;
     /** Mandatory in case of creation**. Name of the product for which you requested the details */
     name: string;

package/dist/cjs/api/resources/event/client/Client.d.ts

@@ -10,6 +10,25 @@ export declare namespace EventClient {
 export declare class EventClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<EventClient.Options>;
     constructor(options: EventClient.Options);
+    /**
+     * <Note>
+     * This endpoint currently only supports custom events.
+     * </Note>
+     *
+     * Retrieve a list of events filtered by various criteria.
+     *
+     * @param {Brevo.GetEventsRequest} request
+     * @param {EventClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Brevo.BadRequestError}
+     * @throws {@link Brevo.UnauthorizedError}
+     * @throws {@link Brevo.InternalServerError}
+     *
+     * @example
+     *     await client.event.getEvents()
+     */
+    getEvents(request?: Brevo.GetEventsRequest, requestOptions?: EventClient.RequestOptions): core.HttpResponsePromise<Brevo.GetEventsList>;
+    private __getEvents;
     /**
      * Create an event to track a contact's interaction.
      *
@@ -42,6 +61,6 @@ export declare class EventClient {
      *             identifiers: {}
      *         }])
      */
-    createBatchEvents(request: Brevo.CreateBatchEventsRequestItem[], requestOptions?: EventClient.RequestOptions): core.HttpResponsePromise<void>;
+    createBatchEvents(request: Brevo.CreateBatchEventsRequestItem[], requestOptions?: EventClient.RequestOptions): core.HttpResponsePromise<Brevo.BatchAcceptedResponse>;
     private __createBatchEvents;
 }

package/dist/cjs/api/resources/event/client/Client.js

@@ -55,6 +55,74 @@ class EventClient {
     constructor(options) {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
+    /**
+     * <Note>
+     * This endpoint currently only supports custom events.
+     * </Note>
+     *
+     * Retrieve a list of events filtered by various criteria.
+     *
+     * @param {Brevo.GetEventsRequest} request
+     * @param {EventClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Brevo.BadRequestError}
+     * @throws {@link Brevo.UnauthorizedError}
+     * @throws {@link Brevo.InternalServerError}
+     *
+     * @example
+     *     await client.event.getEvents()
+     */
+    getEvents(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getEvents(request, requestOptions));
+    }
+    __getEvents() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { contact_id: contactId, event_name: eventName, object_type: objectType, startDate, endDate, limit, offset, } = request;
+            const _queryParams = {
+                contact_id: contactId,
+                event_name: eventName,
+                object_type: objectType,
+                startDate,
+                endDate,
+                limit,
+                offset,
+            };
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, "events"),
+                method: "GET",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Brevo.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Brevo.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.BrevoError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/events");
+        });
+    }
     /**
      * Create an event to track a contact's interaction.
      *
@@ -150,7 +218,7 @@ class EventClient {
                 logging: this._options.logging,
             });
             if (_response.ok) {
-                return { data: undefined, rawResponse: _response.rawResponse };
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {

package/dist/cjs/api/resources/event/client/requests/GetEventsRequest.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @example
+ *     {}
+ */
+export interface GetEventsRequest {
+    /** Filter by contact ID (repeatable) */
+    contact_id?: number | number[];
+    /** Filter by event name (repeatable) */
+    event_name?: string | string[];
+    /** Filter by object type (repeatable) */
+    object_type?: string | string[];
+    /** Mandatory if endDate is used. Start of date range (YYYY-MM-DD or RFC3339). Defaults to 6 months ago when omitted alongside endDate. Must be ≤ endDate. */
+    startDate?: string;
+    /** Mandatory if startDate is used. End of date range (YYYY-MM-DD or RFC3339). Must be ≥ startDate. */
+    endDate?: string;
+    /** Max events to return. Default 100, min 1, max 10000. */
+    limit?: number;
+    /** Events to skip for pagination. Default 0, min 0. */
+    offset?: number;
+}

package/dist/cjs/api/resources/event/client/requests/GetEventsRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/event/client/requests/index.d.ts

@@ -1 +1,2 @@
 export type { CreateEventRequest } from "./CreateEventRequest.js";
+export type { GetEventsRequest } from "./GetEventsRequest.js";

package/dist/cjs/api/resources/program/client/Client.js

@@ -489,11 +489,12 @@ class ProgramClient {
     __getParameterSubscriptionInfo(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { pid, contactId, params, loyaltySubscriptionId } = request;
+            const { pid, contactId, params, loyaltySubscriptionId, includeInternal } = request;
             const _queryParams = {
                 contactId,
                 params,
                 loyaltySubscriptionId,
+                includeInternal,
             };
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);

package/dist/cjs/api/resources/program/client/requests/GetParameterSubscriptionInfoRequest.d.ts

@@ -13,4 +13,6 @@ export interface GetParameterSubscriptionInfoRequest {
     params?: string;
     /** The loyalty subscription ID to filter by. */
     loyaltySubscriptionId?: string;
+    /** Include balances tied to internal definitions. */
+    includeInternal?: boolean;
 }

package/dist/cjs/api/resources/tier/client/requests/CreateTierGroupRequest.d.ts

@@ -12,6 +12,8 @@ export interface CreateTierGroupRequest {
     downgradeStrategy?: CreateTierGroupRequest.DowngradeStrategy;
     /** Name of the tier group */
     name: string;
+    /** Additional metadata for the tier group. */
+    meta?: CreateTierGroupRequest.Meta;
     /** Order of the tiers in the group in ascending order */
     tierOrder?: string[];
     /** Select real_time to upgrade tier on real time balance updates. Select membership_anniversary to upgrade tier on subscription anniversary. Select tier_anniversary to upgrade tier on tier anniversary. */
@@ -25,6 +27,15 @@ export declare namespace CreateTierGroupRequest {
         readonly TierAnniversary: "tier_anniversary";
     };
     type DowngradeStrategy = (typeof DowngradeStrategy)[keyof typeof DowngradeStrategy];
+    /**
+     * Additional metadata for the tier group.
+     */
+    interface Meta {
+        /** Indicates whether the tier group is internal. */
+        isInternal?: boolean | undefined;
+        /** Accepts any additional properties */
+        [key: string]: any;
+    }
     /** Select real_time to upgrade tier on real time balance updates. Select membership_anniversary to upgrade tier on subscription anniversary. Select tier_anniversary to upgrade tier on tier anniversary. */
     const UpgradeStrategy: {
         readonly RealTime: "real_time";