@getbrevo/brevo 5.0.3 → 6.0.1

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

@@ -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/cjs/api/resources/whatsAppCampaigns/client/Client.js

@@ -67,6 +67,8 @@ class WhatsAppCampaignsClient {
         this._options = (0, BaseClient_js_1.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.
      *
@@ -95,7 +97,11 @@ 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,
@@ -153,7 +159,7 @@ 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,
@@ -203,7 +209,7 @@ 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,
@@ -258,7 +264,7 @@ 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,
@@ -286,6 +292,8 @@ 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.
      *
@@ -315,7 +323,11 @@ 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,
@@ -367,7 +379,7 @@ 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,
@@ -423,7 +435,7 @@ 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,
@@ -481,7 +493,7 @@ 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,
@@ -509,6 +521,8 @@ 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.
      *
@@ -533,7 +547,7 @@ 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/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignResponse.d.ts

@@ -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/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppTemplatesResponse.d.ts

@@ -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/cjs/api/types/BalanceDefinition.d.ts

@@ -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/cjs/api/types/BalanceDefinition.js

@@ -4,10 +4,54 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BalanceDefinition = void 0;
 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 || (exports.BalanceDefinition = BalanceDefinition = {}));

package/dist/cjs/api/types/BalanceLimit.d.ts

@@ -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/cjs/api/types/BalanceLimit.js

@@ -1,3 +1,25 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.BalanceLimit = void 0;
+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 || (exports.BalanceLimit = BalanceLimit = {}));

package/dist/cjs/api/types/Company.d.ts

@@ -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/cjs/api/types/ConversationsMessage.d.ts

@@ -53,6 +53,14 @@ export interface ConversationsMessage {
     to?: ConversationsMessage.To.Item[] | undefined;
     /** `"agent"` for agents’ messages, `"visitor"` for visitors’ messages. */
     type?: ConversationsMessage.Type | undefined;
+    /** ‘`true` if the message was sent via JavaScript API.’ */
+    isSentViaJsApi?: boolean | undefined;
+    /** The type of message content (e.g. for integration-specific message types). */
+    messageType?: string | undefined;
+    /** ‘`true` if the message is a forwarded message.’ */
+    isForward?: boolean | undefined;
+    /** Source information for the message. */
+    source?: Record<string, unknown> | undefined;
     /** visitor’s ID */
     visitorId?: string | undefined;
 }
@@ -61,17 +69,38 @@ export declare namespace ConversationsMessage {
     namespace Attachments {
         interface Item {
             /** The name of the file. */
-            fileName?: string | undefined;
-            /** The ID of the inline file. */
-            inlineId?: string | undefined;
+            name?: string | undefined;
+            /** The URL of the file. */
+            link?: string | undefined;
+            /** The MIME type of the file. */
+            mimeType?: string | undefined;
             /** `true` for images. */
             isImage?: boolean | undefined;
+            /** `true` for sticker files. */
+            isSticker?: boolean | undefined;
             /** `true` for inline files. */
-            isInline?: string | undefined;
+            isInline?: boolean | undefined;
+            /** The ID of the inline file. */
+            inlineId?: string | undefined;
             /** The size of the file in bytes. */
             size?: number | undefined;
-            /** The URL of the file. */
-            url?: string | undefined;
+            /** Image information (only present for image files). */
+            imageInfo?: Item.ImageInfo | undefined;
+            /** Whether the file extension is allowed for download. */
+            isAllowedFileType?: boolean | undefined;
+        }
+        namespace Item {
+            /**
+             * Image information (only present for image files).
+             */
+            interface ImageInfo {
+                /** Width of the image in pixels. */
+                width?: number | undefined;
+                /** Height of the image in pixels. */
+                height?: number | undefined;
+                /** URL of the image preview. */
+                previewLink?: string | undefined;
+            }
         }
     }
     type Bcc = Bcc.Item[];
@@ -89,28 +118,38 @@ export declare namespace ConversationsMessage {
         }
     }
     interface File_ {
-        /** Name of the file */
-        filename?: string | undefined;
-        /** image info is passed in case the file is an image */
-        imageInfo?: File_.ImageInfo | undefined;
-        /** Whether the file is an image */
+        /** Name of the file. */
+        name?: string | undefined;
+        /** URL of the file. */
+        link?: string | undefined;
+        /** MIME type of the file. */
+        mimeType?: string | undefined;
+        /** Whether the file is an image. */
         isImage?: boolean | undefined;
-        /** Size in bytes */
+        /** Whether the file is a sticker. */
+        isSticker?: boolean | undefined;
+        /** Whether the file is inline. */
+        isInline?: boolean | undefined;
+        /** The ID of the inline file. */
+        inlineId?: string | undefined;
+        /** Size in bytes. */
         size?: number | undefined;
-        /** URL of the file */
-        url?: string | undefined;
+        /** Image info, present when the file is an image. */
+        imageInfo?: File_.ImageInfo | undefined;
+        /** Whether the file extension is allowed for download. */
+        isAllowedFileType?: boolean | undefined;
     }
     namespace File_ {
         /**
-         * image info is passed in case the file is an image
+         * Image info, present when the file is an image.
          */
         interface ImageInfo {
-            /** height of the image */
-            height?: number | undefined;
-            /** URL of the preview */
-            previewUrl?: string | undefined;
-            /** Width of the image */
+            /** Width of the image in pixels. */
             width?: number | undefined;
+            /** Height of the image in pixels. */
+            height?: number | undefined;
+            /** URL of the image preview. */
+            previewLink?: string | undefined;
         }
     }
     /**

package/dist/cjs/api/types/Deal.d.ts

@@ -2,12 +2,12 @@
  * Deal Details
  */
 export interface Deal {
-    /** Deal attributes with values */
-    attributes?: Record<string, unknown> | undefined;
     /** Unique deal id */
     id?: string | undefined;
-    /** Companies ids for companies linked to this deal */
-    linkedCompaniesIds?: string[] | undefined;
+    /** Deal attributes with values */
+    attributes?: Record<string, unknown> | undefined;
     /** Contact ids for contacts linked to this deal */
     linkedContactsIds?: number[] | undefined;
+    /** Companies ids for companies linked to this deal */
+    linkedCompaniesIds?: string[] | undefined;
 }

package/dist/cjs/api/types/FileData.d.ts

@@ -2,18 +2,20 @@
  * File data that is uploaded
  */
 export interface FileData {
+    /** Unique file id */
+    id?: string | undefined;
+    /** Name of uploaded file */
+    name?: string | undefined;
     /** Account id of user which created the file */
     authorId?: string | undefined;
-    /** Company id linked to a file */
-    companyId?: string | undefined;
     /** Contact id of contact on which file is uploaded */
     contactId?: number | undefined;
-    /** File created date/time */
-    createdAt?: string | undefined;
     /** Deal id linked to a file */
     dealId?: string | undefined;
-    /** Name of uploaded file */
-    name?: string | undefined;
+    /** Company id linked to a file */
+    companyId?: string | undefined;
     /** Size of file in bytes */
     size?: number | undefined;
+    /** File created date/time */
+    createdAt?: string | undefined;
 }

package/dist/cjs/api/types/GetCampaignRecipients.d.ts

@@ -1,4 +1,8 @@
 export interface GetCampaignRecipients {
+    /** Segment IDs excluded from the campaign */
+    excludedSegments?: number[] | undefined;
     exclusionLists: number[];
     lists: number[];
+    /** Segment IDs included in the campaign */
+    segments?: number[] | undefined;
 }