@getbrevo/brevo 5.0.4 → 6.0.2

package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequest.d.mts

@@ -1,7 +1,6 @@
 /**
  * @example
  *     {
- *         events: ["sent"],
  *         url: "http://requestb.in/173lyyx1"
  *     }
  */
@@ -10,7 +9,7 @@ export interface CreateWebhookRequest {
     auth?: CreateWebhookRequest.Auth;
     /** To send batched webhooks */
     batched?: boolean;
-    /** channel of webhook */
+    /** Channel of the webhook */
     channel?: CreateWebhookRequest.Channel;
     /** Description of the webhook */
     description?: string;
@@ -20,24 +19,18 @@ export interface CreateWebhookRequest {
      */
     domain?: string;
     /**
-     * - Events triggering the webhook. Possible values for
-     * **Transactional** type webhook: #### `sent` OR `request`,
-     * `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`,
-     * `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and
-     * `unsubscribed` - Possible values for **Marketing** type webhook:
-     * #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`,
-     * `unsubscribed`, `listAddition` & `delivered` - Possible values
-     * for **Inbound** type webhook: #### `inboundEmailProcessed` -
-     * Possible values for type **Transactional** and channel **SMS**
-     * ####
-     * `accepted`,`delivered`,`softBounce`,`hardBounce`,`unsubscribe`,`reply`,
-     * `subscribe`,`sent`,`blacklisted`,`skip` - Possible values for
-     * type **Marketing**  channel **SMS** ####
-     * `sent`,`delivered`,`softBounce`,`hardBounce`,`unsubscribe`,`reply`,
-     * `subscribe`,`skip`
-     * #### `reply`
+     * Events triggering the webhook. Required for transactional and
+     * marketing types, optional for inbound type (defaults to
+     * `inboundEmailProcessed`). Possible values for **Transactional**
+     * type webhook: `sent` OR `request`, `delivered`, `hardBounce`,
+     * `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`,
+     * `opened`, `uniqueOpened` and `unsubscribed`. Possible values for
+     * **Marketing** type webhook: `spam`, `opened`, `click`,
+     * `hardBounce`, `softBounce`, `unsubscribed`, `listAddition`,
+     * `delivered`, `contactUpdated` & `contactDeleted`. Possible values
+     * for **Inbound** type webhook: `inboundEmailProcessed`.
      */
-    events: CreateWebhookRequest.Events.Item[];
+    events?: CreateWebhookRequest.Events.Item[];
     /** Custom headers to be send with webhooks */
     headers?: CreateWebhookRequest.Headers.Item[];
     /** Type of the webhook */
@@ -55,10 +48,10 @@ export declare namespace CreateWebhookRequest {
         /** Type of authentication */
         type?: string | undefined;
     }
-    /** channel of webhook */
+    /** Channel of the webhook */
     const Channel: {
-        readonly Sms: "sms";
         readonly Email: "email";
+        readonly Sms: "sms";
     };
     type Channel = (typeof Channel)[keyof typeof Channel];
     type Events = Events.Item[];

package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequest.mjs

@@ -1,10 +1,10 @@
 // This file was auto-generated by Fern from our API Definition.
 export var CreateWebhookRequest;
 (function (CreateWebhookRequest) {
-    /** channel of webhook */
+    /** Channel of the webhook */
     CreateWebhookRequest.Channel = {
-        Sms: "sms",
         Email: "email",
+        Sms: "sms",
     };
     let Events;
     (function (Events) {

package/dist/esm/api/resources/webhooks/client/requests/ExportWebhooksHistoryRequest.d.mts

@@ -25,7 +25,7 @@ export interface ExportWebhooksHistoryRequest {
      * Filter the history for a specific message id. Applicable
      * only for transactional webhooks.
      */
-    messageId?: number;
+    messageId?: string;
     /** Webhook URL to receive CSV file link */
     notifyURL: string;
     /** Sorting order of records (asc or desc) */

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

@@ -11,6 +11,8 @@ export declare class WhatsAppCampaignsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<WhatsAppCampaignsClient.Options>;
     constructor(options: WhatsAppCampaignsClient.Options);
     /**
+     * Retrieve a paginated list of all your WhatsApp campaigns with their statistics and metadata. Results can be filtered by creation date range using startDate and endDate, with a default limit of 50 and maximum of 100 per page. The sort order defaults to descending by modification date.
+     *
      * @param {Brevo.GetWhatsAppCampaignsRequest} request
      * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -76,6 +78,8 @@ export declare class WhatsAppCampaignsClient {
     createWhatsAppTemplate(request: Brevo.CreateWhatsAppTemplateRequest, requestOptions?: WhatsAppCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateWhatsAppTemplateResponse>;
     private __createWhatsAppTemplate;
     /**
+     * Retrieve a paginated list of all your WhatsApp templates with their status, category, language, and metadata. Results can be filtered by creation date range and optionally by source (Automation or Conversations), with a default limit of 50 and maximum of 100 per page. The sort order defaults to descending by modification date.
+     *
      * @param {Brevo.GetWhatsAppTemplatesRequest} request
      * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -142,6 +146,8 @@ export declare class WhatsAppCampaignsClient {
     updateWhatsAppCampaign(request: Brevo.UpdateWhatsAppCampaignRequest, requestOptions?: WhatsAppCampaignsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __updateWhatsAppCampaign;
     /**
+     * Delete a WhatsApp campaign by its campaign ID. The campaign must exist; if the campaign ID is not found, a 404 error is returned. This action is permanent and cannot be undone.
+     *
      * @param {Brevo.DeleteWhatsAppCampaignRequest} request
      * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *

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

@@ -31,6 +31,8 @@ export class WhatsAppCampaignsClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
+     * Retrieve a paginated list of all your WhatsApp campaigns with their statistics and metadata. Results can be filtered by creation date range using startDate and endDate, with a default limit of 50 and maximum of 100 per page. The sort order defaults to descending by modification date.
+     *
      * @param {Brevo.GetWhatsAppCampaignsRequest} request
      * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -59,7 +61,11 @@ export class WhatsAppCampaignsClient {
                 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, "whatsappCampaigns"),
                 method: "GET",
                 headers: _headers,
-                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                queryString: core.url
+                    .queryBuilder()
+                    .addMany(_queryParams)
+                    .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
+                    .build(),
                 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,
@@ -117,7 +123,7 @@ export class WhatsAppCampaignsClient {
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
                 body: request,
                 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,
@@ -167,7 +173,7 @@ export class WhatsAppCampaignsClient {
                 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, "whatsappCampaigns/config"),
                 method: "GET",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 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,
@@ -222,7 +228,7 @@ export class WhatsAppCampaignsClient {
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
                 body: request,
                 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,
@@ -250,6 +256,8 @@ export class WhatsAppCampaignsClient {
         });
     }
     /**
+     * Retrieve a paginated list of all your WhatsApp templates with their status, category, language, and metadata. Results can be filtered by creation date range and optionally by source (Automation or Conversations), with a default limit of 50 and maximum of 100 per page. The sort order defaults to descending by modification date.
+     *
      * @param {Brevo.GetWhatsAppTemplatesRequest} request
      * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -279,7 +287,11 @@ export class WhatsAppCampaignsClient {
                 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, "whatsappCampaigns/template-list"),
                 method: "GET",
                 headers: _headers,
-                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                queryString: core.url
+                    .queryBuilder()
+                    .addMany(_queryParams)
+                    .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
+                    .build(),
                 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,
@@ -331,7 +343,7 @@ export class WhatsAppCampaignsClient {
                 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, `whatsappCampaigns/template/approval/${core.url.encodePathParam(templateId)}`),
                 method: "POST",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 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,
@@ -387,7 +399,7 @@ export class WhatsAppCampaignsClient {
                 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, `whatsappCampaigns/${core.url.encodePathParam(campaignId)}`),
                 method: "GET",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 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,
@@ -445,7 +457,7 @@ export class WhatsAppCampaignsClient {
                 method: "PUT",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
                 body: _body,
                 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,
@@ -473,6 +485,8 @@ export class WhatsAppCampaignsClient {
         });
     }
     /**
+     * Delete a WhatsApp campaign by its campaign ID. The campaign must exist; if the campaign ID is not found, a 404 error is returned. This action is permanent and cannot be undone.
+     *
      * @param {Brevo.DeleteWhatsAppCampaignRequest} request
      * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -497,7 +511,7 @@ export class WhatsAppCampaignsClient {
                 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, `whatsappCampaigns/${core.url.encodePathParam(campaignId)}`),
                 method: "DELETE",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 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,

package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignResponse.d.mts

@@ -12,6 +12,8 @@ export interface GetWhatsAppCampaignResponse {
     modifiedAt: string;
     /** UTC date-time on which WhatsApp campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format */
     scheduledAt?: string | undefined;
+    /** Recipients of the WhatsApp Campaign */
+    recipients: GetWhatsAppCampaignResponse.Recipients;
     /** Sender of the WhatsApp Campaign */
     senderNumber: string;
     stats?: Brevo.WhatsappCampStats | undefined;
@@ -30,6 +32,19 @@ export declare namespace GetWhatsAppCampaignResponse {
         readonly Sent: "sent";
     };
     type CampaignStatus = (typeof CampaignStatus)[keyof typeof CampaignStatus];
+    /**
+     * Recipients of the WhatsApp Campaign
+     */
+    interface Recipients {
+        /** List of excluded list IDs */
+        excludedLists?: number[] | undefined;
+        /** List of included list IDs */
+        includedLists?: number[] | undefined;
+        /** List of segment IDs */
+        segments?: number[] | undefined;
+        /** Type of recipients (list or segment) */
+        type?: string | undefined;
+    }
     interface Template {
         /** array of variables item variables */
         body_variables?: Brevo.VariablesItems[] | undefined;

package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppTemplatesResponse.d.mts

@@ -23,6 +23,8 @@ export declare namespace GetWhatsAppTemplatesResponse {
             name: string;
             /** Status of the whatsApp template */
             status: string;
+            /** Type of the whatsApp template */
+            type: string;
         }
     }
 }

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

@@ -1,51 +1,100 @@
 export interface BalanceDefinition {
-    /** startOfPeriod depicts the balancy expiry on start of day/week/month/year. endOfPeriod depicts the balancy expiry on end of day/week/month/year */
-    balanceAvailabilityDurationModifier?: BalanceDefinition.BalanceAvailabilityDurationModifier | undefined;
-    /** Unit of time for the balance's availability (e.g., day/week/month/year). */
-    balanceAvailabilityDurationUnit?: string | undefined;
-    /** Number of days/weeks/month/year for balance expiry */
-    balanceAvailabilityDurationValue?: number | undefined;
-    /** Date when the balance expires and can no longer be used, in dd/mm format. The balance will be expired when this date appears next in the calendar and only one of balanceExpirationDate or balance availability fields can be used. */
-    balanceExpirationDate?: string | undefined;
-    /** Partial enables partial credit of balance if maximum balance limit is reaching. Strict enables rejection of transaction if it will breach the max credit amount limit. */
-    balanceOptionAmountOvertakingStrategy?: string | undefined;
-    /** Rounding strategy for credit transactions. */
-    balanceOptionCreditRounding?: string | undefined;
-    /** Rounding strategy for debit transactions. */
-    balanceOptionDebitRounding?: string | undefined;
-    /** Timestamp of balance definition creation. */
-    createdAt?: string | undefined;
-    /** Timestamp of balance definition deletion (nullable). */
-    deletedAt?: string | undefined;
-    /** Short description of the balance definition. */
-    description?: string | undefined;
     /** Unique identifier for the balance definition. */
     id?: string | undefined;
+    /** Name of the balance definition. */
+    name?: string | undefined;
+    /** Short description of the balance definition. */
+    description?: string | undefined;
     /** Optional image reference URL. */
     imageRef?: string | undefined;
-    /** Maximum allowable balance. */
-    maxAmount?: number | undefined;
-    /** Max credit allowed per operation. */
-    maxCreditAmountLimit?: number | undefined;
-    /** Max debit allowed per operation. */
-    maxDebitAmountLimit?: number | undefined;
     /** Additional metadata for the balance definition. */
     meta?: Record<string, unknown> | undefined;
+    /** Unit of balance measurement. */
+    unit?: BalanceDefinition.Unit | undefined;
     /** Minimum allowable balance. */
     minAmount?: number | undefined;
-    /** Name of the balance definition. */
-    name?: string | undefined;
-    /** Unit of balance (e.g., points, currency). */
-    unit?: string | undefined;
+    /** Maximum allowable balance. */
+    maxAmount?: number | undefined;
+    /** Maximum credit allowed per operation. */
+    maxCreditAmountLimit?: number | undefined;
+    /** Maximum debit allowed per operation. */
+    maxDebitAmountLimit?: number | undefined;
+    /** Partial enables partial credit of balance if maximum balance limit is reached. Strict enables rejection of a transaction if it will breach the max balance limit. */
+    balanceOptionAmountOvertakingStrategy?: BalanceDefinition.BalanceOptionAmountOvertakingStrategy | undefined;
+    /** Rounding strategy for credit transactions. */
+    balanceOptionCreditRounding?: BalanceDefinition.BalanceOptionCreditRounding | undefined;
+    /** Rounding strategy for debit transactions. */
+    balanceOptionDebitRounding?: BalanceDefinition.BalanceOptionDebitRounding | undefined;
+    /** Number of time units before the balance expires. */
+    balanceAvailabilityDurationValue?: number | undefined;
+    /** Unit of time for the balance availability duration. */
+    balanceAvailabilityDurationUnit?: BalanceDefinition.BalanceAvailabilityDurationUnit | undefined;
+    /** Modifier for balance availability duration. startOfPeriod causes expiry at the start of the period, endOfPeriod at the end. noModification uses the exact duration from the credit date. */
+    balanceAvailabilityDurationModifier?: BalanceDefinition.BalanceAvailabilityDurationModifier | undefined;
+    /** Fixed expiration date in dd/mm format. The balance expires when this date next appears in the calendar. Only one of balanceExpirationDate or balance availability duration fields can be used. */
+    balanceExpirationDate?: string | undefined;
+    /** Timestamp of balance definition creation. */
+    createdAt?: string | undefined;
     /** Timestamp of the last update. */
     updatedAt?: string | undefined;
+    /** Timestamp of balance definition deletion (nullable). */
+    deletedAt?: string | undefined;
 }
 export declare namespace BalanceDefinition {
-    /** startOfPeriod depicts the balancy expiry on start of day/week/month/year. endOfPeriod depicts the balancy expiry on end of day/week/month/year */
+    /** Unit of balance measurement. */
+    const Unit: {
+        readonly Points: "POINTS";
+        readonly Eur: "EUR";
+        readonly Usd: "USD";
+        readonly Mxn: "MXN";
+        readonly Gbp: "GBP";
+        readonly Inr: "INR";
+        readonly Cad: "CAD";
+        readonly Sgd: "SGD";
+        readonly Ron: "RON";
+        readonly Jpy: "JPY";
+        readonly Myr: "MYR";
+        readonly Clp: "CLP";
+        readonly Pen: "PEN";
+        readonly Mad: "MAD";
+        readonly Aud: "AUD";
+        readonly Chf: "CHF";
+        readonly Brl: "BRL";
+    };
+    type Unit = (typeof Unit)[keyof typeof Unit];
+    /** Partial enables partial credit of balance if maximum balance limit is reached. Strict enables rejection of a transaction if it will breach the max balance limit. */
+    const BalanceOptionAmountOvertakingStrategy: {
+        readonly Strict: "strict";
+        readonly Partial: "partial";
+    };
+    type BalanceOptionAmountOvertakingStrategy = (typeof BalanceOptionAmountOvertakingStrategy)[keyof typeof BalanceOptionAmountOvertakingStrategy];
+    /** Rounding strategy for credit transactions. */
+    const BalanceOptionCreditRounding: {
+        readonly Lower: "lower";
+        readonly Upper: "upper";
+        readonly Natural: "natural";
+    };
+    type BalanceOptionCreditRounding = (typeof BalanceOptionCreditRounding)[keyof typeof BalanceOptionCreditRounding];
+    /** Rounding strategy for debit transactions. */
+    const BalanceOptionDebitRounding: {
+        readonly Lower: "lower";
+        readonly Upper: "upper";
+        readonly Natural: "natural";
+    };
+    type BalanceOptionDebitRounding = (typeof BalanceOptionDebitRounding)[keyof typeof BalanceOptionDebitRounding];
+    /** Unit of time for the balance availability duration. */
+    const BalanceAvailabilityDurationUnit: {
+        readonly Day: "day";
+        readonly Week: "week";
+        readonly Month: "month";
+        readonly Year: "year";
+    };
+    type BalanceAvailabilityDurationUnit = (typeof BalanceAvailabilityDurationUnit)[keyof typeof BalanceAvailabilityDurationUnit];
+    /** Modifier for balance availability duration. startOfPeriod causes expiry at the start of the period, endOfPeriod at the end. noModification uses the exact duration from the credit date. */
     const BalanceAvailabilityDurationModifier: {
+        readonly NoModification: "noModification";
         readonly StartOfPeriod: "startOfPeriod";
         readonly EndOfPeriod: "endOfPeriod";
-        readonly NoModification: "noModification";
     };
     type BalanceAvailabilityDurationModifier = (typeof BalanceAvailabilityDurationModifier)[keyof typeof BalanceAvailabilityDurationModifier];
 }

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

@@ -1,10 +1,54 @@
 // This file was auto-generated by Fern from our API Definition.
 export var BalanceDefinition;
 (function (BalanceDefinition) {
-    /** startOfPeriod depicts the balancy expiry on start of day/week/month/year. endOfPeriod depicts the balancy expiry on end of day/week/month/year */
+    /** Unit of balance measurement. */
+    BalanceDefinition.Unit = {
+        Points: "POINTS",
+        Eur: "EUR",
+        Usd: "USD",
+        Mxn: "MXN",
+        Gbp: "GBP",
+        Inr: "INR",
+        Cad: "CAD",
+        Sgd: "SGD",
+        Ron: "RON",
+        Jpy: "JPY",
+        Myr: "MYR",
+        Clp: "CLP",
+        Pen: "PEN",
+        Mad: "MAD",
+        Aud: "AUD",
+        Chf: "CHF",
+        Brl: "BRL",
+    };
+    /** Partial enables partial credit of balance if maximum balance limit is reached. Strict enables rejection of a transaction if it will breach the max balance limit. */
+    BalanceDefinition.BalanceOptionAmountOvertakingStrategy = {
+        Strict: "strict",
+        Partial: "partial",
+    };
+    /** Rounding strategy for credit transactions. */
+    BalanceDefinition.BalanceOptionCreditRounding = {
+        Lower: "lower",
+        Upper: "upper",
+        Natural: "natural",
+    };
+    /** Rounding strategy for debit transactions. */
+    BalanceDefinition.BalanceOptionDebitRounding = {
+        Lower: "lower",
+        Upper: "upper",
+        Natural: "natural",
+    };
+    /** Unit of time for the balance availability duration. */
+    BalanceDefinition.BalanceAvailabilityDurationUnit = {
+        Day: "day",
+        Week: "week",
+        Month: "month",
+        Year: "year",
+    };
+    /** Modifier for balance availability duration. startOfPeriod causes expiry at the start of the period, endOfPeriod at the end. noModification uses the exact duration from the credit date. */
     BalanceDefinition.BalanceAvailabilityDurationModifier = {
+        NoModification: "noModification",
         StartOfPeriod: "startOfPeriod",
         EndOfPeriod: "endOfPeriod",
-        NoModification: "noModification",
     };
 })(BalanceDefinition || (BalanceDefinition = {}));

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

@@ -1,22 +1,45 @@
 export interface BalanceLimit {
-    /** balance definition ID */
+    /** Unique identifier for the balance limit. */
+    id?: string | undefined;
+    /** Balance definition ID. */
     balanceDefinitionId?: string | undefined;
-    /** Defines the type of constraint (e.g., transaction-based or amount-based). */
-    constraintType?: string | undefined;
-    /** Timestamp of when the balance limit was created. */
-    createdAt: string;
-    /** Time unit for the balance limit (day, week, month, year). */
-    durationUnit?: string | undefined;
+    /** Specifies whether the limit applies to credit or debit transactions. */
+    transactionType?: BalanceLimit.TransactionType | undefined;
+    /** Defines the type of constraint (transaction count or amount). */
+    constraintType?: BalanceLimit.ConstraintType | undefined;
     /** Number of time units the balance limit applies to. */
     durationValue?: number | undefined;
-    /** Unique identifier for the balance limit. */
-    id?: string | undefined;
+    /** Time unit for the balance limit. */
+    durationUnit?: BalanceLimit.DurationUnit | undefined;
+    /** The maximum allowed value for the defined constraint. */
+    value?: number | undefined;
     /** Indicates if the limit resets periodically based on a sliding schedule. */
     slidingSchedule?: boolean | undefined;
-    /** Specifies whether the limit applies to credit or debit transactions. */
-    transactionType?: string | undefined;
+    /** Timestamp of when the balance limit was created. */
+    createdAt?: string | undefined;
     /** Timestamp of the last update to the balance limit. */
-    updatedAt: string;
-    /** The maximum allowed value for the defined constraint. */
-    value?: number | undefined;
+    updatedAt?: string | undefined;
+}
+export declare namespace BalanceLimit {
+    /** Specifies whether the limit applies to credit or debit transactions. */
+    const TransactionType: {
+        readonly Credit: "credit";
+        readonly Debit: "debit";
+    };
+    type TransactionType = (typeof TransactionType)[keyof typeof TransactionType];
+    /** Defines the type of constraint (transaction count or amount). */
+    const ConstraintType: {
+        readonly Transaction: "transaction";
+        readonly Amount: "amount";
+    };
+    type ConstraintType = (typeof ConstraintType)[keyof typeof ConstraintType];
+    /** Time unit for the balance limit. */
+    const DurationUnit: {
+        readonly Hour: "hour";
+        readonly Day: "day";
+        readonly Week: "week";
+        readonly Month: "month";
+        readonly Year: "year";
+    };
+    type DurationUnit = (typeof DurationUnit)[keyof typeof DurationUnit];
 }

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

@@ -1,2 +1,22 @@
 // This file was auto-generated by Fern from our API Definition.
-export {};
+export var BalanceLimit;
+(function (BalanceLimit) {
+    /** Specifies whether the limit applies to credit or debit transactions. */
+    BalanceLimit.TransactionType = {
+        Credit: "credit",
+        Debit: "debit",
+    };
+    /** Defines the type of constraint (transaction count or amount). */
+    BalanceLimit.ConstraintType = {
+        Transaction: "transaction",
+        Amount: "amount",
+    };
+    /** Time unit for the balance limit. */
+    BalanceLimit.DurationUnit = {
+        Hour: "hour",
+        Day: "day",
+        Week: "week",
+        Month: "month",
+        Year: "year",
+    };
+})(BalanceLimit || (BalanceLimit = {}));

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

@@ -8,6 +8,6 @@ export interface Company {
     id?: string | undefined;
     /** Contact ids for contacts linked to this company */
     linkedContactsIds?: number[] | undefined;
-    /** Deals ids for companies linked to this company */
+    /** Deal ids for deals linked to this company */
     linkedDealsIds?: string[] | undefined;
 }

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

@@ -0,0 +1,29 @@
+/**
+ * A consent group representing a category of contact opt-in/opt-out preferences.
+ */
+export interface ConsentGroup {
+    /** Unique identifier for the consent group */
+    id: number;
+    /** Display name of the consent group */
+    name: string;
+    /** Optional description of the consent group */
+    description?: string | undefined;
+    /** Controls how contacts are added to the group. `manual` — contacts are added explicitly via the API. `automatic` — contacts are added automatically at signup. */
+    signupMode: ConsentGroup.SignupMode;
+    /** Number of contacts currently in this consent group */
+    contactsCount: number;
+    /** Whether this is a system-created default consent group */
+    isDefault: boolean;
+    /** UTC date-time when the consent group was created (YYYY-MM-DDTHH:mm:ss.SSSZ) */
+    createdAt: string;
+    /** UTC date-time when the consent group was last updated (YYYY-MM-DDTHH:mm:ss.SSSZ) */
+    updatedAt: string;
+}
+export declare namespace ConsentGroup {
+    /** Controls how contacts are added to the group. `manual` — contacts are added explicitly via the API. `automatic` — contacts are added automatically at signup. */
+    const SignupMode: {
+        readonly Manual: "manual";
+        readonly Automatic: "automatic";
+    };
+    type SignupMode = (typeof SignupMode)[keyof typeof SignupMode];
+}

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

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export var ConsentGroup;
+(function (ConsentGroup) {
+    /** Controls how contacts are added to the group. `manual` — contacts are added explicitly via the API. `automatic` — contacts are added automatically at signup. */
+    ConsentGroup.SignupMode = {
+        Manual: "manual",
+        Automatic: "automatic",
+    };
+})(ConsentGroup || (ConsentGroup = {}));

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

@@ -0,0 +1,17 @@
+/**
+ * A contact's membership status in a single consent group.
+ */
+export interface ConsentGroupItem {
+    /** ID of the consent group */
+    id: number;
+    /** The contact's subscription status within this consent group */
+    status: ConsentGroupItem.Status;
+}
+export declare namespace ConsentGroupItem {
+    /** The contact's subscription status within this consent group */
+    const Status: {
+        readonly Subscribed: "subscribed";
+        readonly Unsubscribed: "unsubscribed";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

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

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export var ConsentGroupItem;
+(function (ConsentGroupItem) {
+    /** The contact's subscription status within this consent group */
+    ConsentGroupItem.Status = {
+        Subscribed: "subscribed",
+        Unsubscribed: "unsubscribed",
+    };
+})(ConsentGroupItem || (ConsentGroupItem = {}));