@getbrevo/brevo 5.0.1 → 5.0.3

package/dist/esm/api/resources/balance/client/requests/GetContactBalancesRequest.d.mts

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

package/dist/esm/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidActiveBalanceRequest.d.mts

@@ -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/esm/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidTransactionHistoryRequest.d.mts

@@ -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/esm/api/resources/balance/client/requests/GetSubscriptionBalancesRequest.d.mts

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

package/dist/esm/api/resources/balance/client/requests/PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest.d.mts

@@ -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/esm/api/resources/balance/client/requests/UpdateBalanceDefinitionRequest.d.mts

@@ -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/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus.d.mts

@@ -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/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus.mjs

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+export const GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus = {
+    Draft: "draft",
+    Completed: "completed",
+    Rejected: "rejected",
+    Cancelled: "cancelled",
+    Expired: "expired",
+};

package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType.d.mts

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

package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+export const GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType = {
+    Credit: "credit",
+    Debit: "debit",
+};

package/dist/esm/api/resources/balance/types/index.d.mts

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

package/dist/esm/api/resources/balance/types/index.mjs

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

package/dist/esm/api/resources/contacts/client/Client.d.mts

@@ -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/esm/api/resources/contacts/client/Client.mjs

@@ -1544,7 +1544,7 @@ export 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/esm/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.mts

@@ -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/esm/api/resources/ecommerce/client/requests/CreateUpdateProductRequest.d.mts

@@ -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/esm/api/resources/event/client/Client.d.mts

@@ -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/esm/api/resources/event/client/Client.mjs

@@ -19,6 +19,74 @@ export class EventClient {
     constructor(options) {
         this._options = 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 = 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 handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/events");
+        });
+    }
     /**
      * Create an event to track a contact's interaction.
      *
@@ -114,7 +182,7 @@ export 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/esm/api/resources/event/client/requests/GetEventsRequest.d.mts

@@ -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/esm/api/resources/event/client/requests/GetEventsRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/event/client/requests/index.d.mts

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

package/dist/esm/api/resources/program/client/Client.mjs

@@ -453,11 +453,12 @@ export 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 = 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/esm/api/resources/program/client/requests/GetParameterSubscriptionInfoRequest.d.mts

@@ -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/esm/api/resources/tier/client/requests/CreateTierGroupRequest.d.mts

@@ -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";

package/dist/esm/api/resources/tier/client/requests/UpdateTierGroupRequest.d.mts

@@ -18,6 +18,8 @@ export interface UpdateTierGroupRequest {
     downgradeStrategy: UpdateTierGroupRequest.DowngradeStrategy;
     /** Name of the tier group */
     name: string;
+    /** Additional metadata for the tier group. */
+    meta?: UpdateTierGroupRequest.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. */
@@ -31,6 +33,15 @@ export declare namespace UpdateTierGroupRequest {
         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";

package/dist/esm/api/types/BatchAcceptedResponse.d.mts

@@ -0,0 +1,9 @@
+/**
+ * Response returned when all events in the batch are accepted for async processing
+ */
+export interface BatchAcceptedResponse {
+    /** Confirmation message indicating the batch was accepted */
+    message: string;
+    /** Number of events queued for processing */
+    count: number;
+}

package/dist/esm/api/types/BatchAcceptedResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/GetEventsList.d.mts

@@ -0,0 +1,32 @@
+/**
+ * Response containing a list of events and the total count for pagination
+ */
+export interface GetEventsList {
+    /** List of matching events ordered by event_date descending */
+    events?: GetEventsList.Events.Item[] | undefined;
+    /** Total count of events matching the filters (use for pagination) */
+    count: number;
+}
+export declare namespace GetEventsList {
+    type Events = Events.Item[];
+    namespace Events {
+        interface Item {
+            /** Contact ID associated with the event */
+            contact_id?: number | undefined;
+            /** Date and time of the event */
+            event_date?: string | undefined;
+            /** Name of the event */
+            event_name?: string | undefined;
+            /** Filter ID of the event */
+            event_filter_id?: string | undefined;
+            /** Source of the event */
+            source?: string | undefined;
+            /** Object type associated with the event */
+            object_type?: string | undefined;
+            /** Event-level custom properties */
+            event_properties?: Record<string, unknown> | undefined;
+            /** Contact-level properties at time of event */
+            contact_properties?: Record<string, unknown> | undefined;
+        }
+    }
+}

package/dist/esm/api/types/GetEventsList.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/GetProductDetails.d.mts

@@ -1,8 +1,12 @@
 export interface GetProductDetails {
+    /** Brand of the product */
+    brand?: string | undefined;
     /** Category ID-s of the product */
     categories?: string[] | undefined;
     /** Creation UTC date-time of the product (YYYY-MM-DDTHH:mm:ss.SSSZ) */
     createdAt: string;
+    /** 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 */

package/dist/esm/api/types/InternalServerErrorBody.d.mts

@@ -0,0 +1,48 @@
+export interface InternalServerErrorBody {
+    /** Error code displayed in case of a failure */
+    code: InternalServerErrorBody.Code;
+    /** Readable message associated to the failure */
+    message: string;
+}
+export declare namespace InternalServerErrorBody {
+    /** Error code displayed in case of a failure */
+    const Code: {
+        readonly InvalidParameter: "invalid_parameter";
+        readonly MissingParameter: "missing_parameter";
+        readonly OutOfRange: "out_of_range";
+        readonly CampaignProcessing: "campaign_processing";
+        readonly CampaignSent: "campaign_sent";
+        readonly DocumentNotFound: "document_not_found";
+        readonly NotEnoughCredits: "not_enough_credits";
+        readonly PermissionDenied: "permission_denied";
+        readonly DuplicateParameter: "duplicate_parameter";
+        readonly DuplicateRequest: "duplicate_request";
+        readonly MethodNotAllowed: "method_not_allowed";
+        readonly Unauthorized: "unauthorized";
+        readonly AccountUnderValidation: "account_under_validation";
+        readonly NotAcceptable: "not_acceptable";
+        readonly BadRequest: "bad_request";
+        readonly UnprocessableEntity: "unprocessable_entity";
+        readonly DomainDoesNotExist: "Domain does not exist";
+        readonly ContactEmailNotFound: "Contact email not found";
+        readonly AttributeNotFound: "Attribute not found";
+        readonly CategoryIdNotFound: "Category id not found";
+        readonly InvalidParametersPassed: "Invalid parameters passed";
+        readonly RecordSForIdentifierNotFound: "Record(s) for identifier not found";
+        readonly ReturnedWhenQueryParamsAreInvalid: "Returned when query params are invalid";
+        readonly ReturnedWhenInvalidDataPosted: "Returned when invalid data posted";
+        readonly FeedNotFound: "Feed not found";
+        readonly CampaignIdNotFound: "Campaign ID not found";
+        readonly ApiKeyNotFound: "api-key not found";
+        readonly DmarcPolicyRequiresDomainAuthentication: "DMARC policy requires domain authentication";
+        readonly DnsRecordsNotProperlyConfigured: "DNS records not properly configured";
+        readonly InvalidOtpCodeProvided: "Invalid OTP code provided";
+        readonly OtpCodeHasExpired: "OTP code has expired";
+        readonly DomainAlreadyExistsInYourAccount: "Domain already exists in your account";
+        readonly TheSumOfAllIpWeightsMustEqual100: "The sum of all IP weights must equal 100";
+        readonly AuthenticationFailed: "Authentication failed";
+        readonly InsufficientCredits: "Insufficient credits";
+        readonly RequestAlreadyProcessed: "Request already processed";
+    };
+    type Code = (typeof Code)[keyof typeof Code];
+}

package/dist/esm/api/types/InternalServerErrorBody.mjs

@@ -0,0 +1,43 @@
+// This file was auto-generated by Fern from our API Definition.
+export var InternalServerErrorBody;
+(function (InternalServerErrorBody) {
+    /** Error code displayed in case of a failure */
+    InternalServerErrorBody.Code = {
+        InvalidParameter: "invalid_parameter",
+        MissingParameter: "missing_parameter",
+        OutOfRange: "out_of_range",
+        CampaignProcessing: "campaign_processing",
+        CampaignSent: "campaign_sent",
+        DocumentNotFound: "document_not_found",
+        NotEnoughCredits: "not_enough_credits",
+        PermissionDenied: "permission_denied",
+        DuplicateParameter: "duplicate_parameter",
+        DuplicateRequest: "duplicate_request",
+        MethodNotAllowed: "method_not_allowed",
+        Unauthorized: "unauthorized",
+        AccountUnderValidation: "account_under_validation",
+        NotAcceptable: "not_acceptable",
+        BadRequest: "bad_request",
+        UnprocessableEntity: "unprocessable_entity",
+        DomainDoesNotExist: "Domain does not exist",
+        ContactEmailNotFound: "Contact email not found",
+        AttributeNotFound: "Attribute not found",
+        CategoryIdNotFound: "Category id not found",
+        InvalidParametersPassed: "Invalid parameters passed",
+        RecordSForIdentifierNotFound: "Record(s) for identifier not found",
+        ReturnedWhenQueryParamsAreInvalid: "Returned when query params are invalid",
+        ReturnedWhenInvalidDataPosted: "Returned when invalid data posted",
+        FeedNotFound: "Feed not found",
+        CampaignIdNotFound: "Campaign ID not found",
+        ApiKeyNotFound: "api-key not found",
+        DmarcPolicyRequiresDomainAuthentication: "DMARC policy requires domain authentication",
+        DnsRecordsNotProperlyConfigured: "DNS records not properly configured",
+        InvalidOtpCodeProvided: "Invalid OTP code provided",
+        OtpCodeHasExpired: "OTP code has expired",
+        DomainAlreadyExistsInYourAccount: "Domain already exists in your account",
+        TheSumOfAllIpWeightsMustEqual100: "The sum of all IP weights must equal 100",
+        AuthenticationFailed: "Authentication failed",
+        InsufficientCredits: "Insufficient credits",
+        RequestAlreadyProcessed: "Request already processed",
+    };
+})(InternalServerErrorBody || (InternalServerErrorBody = {}));

package/dist/esm/api/types/index.d.mts

@@ -4,6 +4,7 @@ export * from "./AbTestVersionStats.mjs";
 export * from "./BadRequestErrorBody.mjs";
 export * from "./BalanceDefinition.mjs";
 export * from "./BalanceLimit.mjs";
+export * from "./BatchAcceptedResponse.mjs";
 export * from "./BatchEventsResponse.mjs";
 export * from "./Cart.mjs";
 export * from "./Company.mjs";
@@ -23,6 +24,7 @@ export * from "./GetContactDetails.mjs";
 export * from "./GetContacts.mjs";
 export * from "./GetCouponCollection.mjs";
 export * from "./GetDeviceBrowserStats.mjs";
+export * from "./GetEventsList.mjs";
 export * from "./GetExtendedCampaignOverview.mjs";
 export * from "./GetExtendedCampaignStats.mjs";
 export * from "./GetFolder.mjs";
@@ -33,6 +35,7 @@ export * from "./GetSmsCampaignStats.mjs";
 export * from "./GetSmtpTemplateOverview.mjs";
 export * from "./GetSsoToken.mjs";
 export * from "./GetWebhook.mjs";
+export * from "./InternalServerErrorBody.mjs";
 export * from "./Inviteuser.mjs";
 export * from "./LoyaltyProgram.mjs";
 export * from "./NodeResponse.mjs";