@getbrevo/brevo 5.0.3 → 6.0.1

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

@@ -18,29 +18,28 @@ export declare class AccountClient {
      * - Check plan details (type, credits, expiration)
      * - Get relay information (for transactional emails)
      * - Check Marketing Automation status
-     * - View date/time preferences and account settings
      * - Access organization and user identifiers
      *
      * **Key information returned:**
      * - Complete account details (organization ID, user ID, company information)
      * - Address and contact information
      * - Plan configurations and credit allocations across different verticals
-     * - Marketing Automation settings and tracker key
+     * - Marketing Automation settings and tracker key (when enabled)
      * - SMTP relay configuration for transactional emails
-     * - Date/time preferences and account settings
      * - Enterprise features availability status
      *
      * **Important considerations:**
      * - Provides comprehensive account overview for billing and configuration management
      * - Essential for understanding current plan limitations and feature availability
-     * - Marketing Automation key required for advanced automation features
-     * - Plan verticals show detailed breakdown across Marketing, Chat, and CRM categories
+     * - Marketing Automation key is only returned when Marketing Automation is enabled on the account
+     * - Plan verticals show detailed breakdown across Marketing, Chat, and CRM categories (only returned when plan verticals are available)
      * - Relay configuration crucial for transactional email setup and deliverability
-     * - Date/time preferences affect campaign scheduling and reporting displays
      * - Enterprise status determines access to advanced features and sub-account management
      *
      * @param {AccountClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Brevo.BadRequestError}
+     *
      * @example
      *     await client.account.getAccount()
      */

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

@@ -27,29 +27,28 @@ export class AccountClient {
      * - Check plan details (type, credits, expiration)
      * - Get relay information (for transactional emails)
      * - Check Marketing Automation status
-     * - View date/time preferences and account settings
      * - Access organization and user identifiers
      *
      * **Key information returned:**
      * - Complete account details (organization ID, user ID, company information)
      * - Address and contact information
      * - Plan configurations and credit allocations across different verticals
-     * - Marketing Automation settings and tracker key
+     * - Marketing Automation settings and tracker key (when enabled)
      * - SMTP relay configuration for transactional emails
-     * - Date/time preferences and account settings
      * - Enterprise features availability status
      *
      * **Important considerations:**
      * - Provides comprehensive account overview for billing and configuration management
      * - Essential for understanding current plan limitations and feature availability
-     * - Marketing Automation key required for advanced automation features
-     * - Plan verticals show detailed breakdown across Marketing, Chat, and CRM categories
+     * - Marketing Automation key is only returned when Marketing Automation is enabled on the account
+     * - Plan verticals show detailed breakdown across Marketing, Chat, and CRM categories (only returned when plan verticals are available)
      * - Relay configuration crucial for transactional email setup and deliverability
-     * - Date/time preferences affect campaign scheduling and reporting displays
      * - Enterprise status determines access to advanced features and sub-account management
      *
      * @param {AccountClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Brevo.BadRequestError}
+     *
      * @example
      *     await client.account.getAccount()
      */
@@ -65,7 +64,7 @@ export class AccountClient {
                 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, "account"),
                 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,
@@ -76,11 +75,16 @@ export class AccountClient {
                 return { data: _response.body, rawResponse: _response.rawResponse };
             }
             if (_response.error.reason === "status-code") {
-                throw new errors.BrevoError({
-                    statusCode: _response.error.statusCode,
-                    body: _response.error.body,
-                    rawResponse: _response.rawResponse,
-                });
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Brevo.BadRequestError(_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", "/account");
         });
@@ -132,7 +136,11 @@ export class AccountClient {
                 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, "organization/activities"),
                 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,

package/dist/esm/api/resources/account/types/GetAccountResponse.d.mts

@@ -14,9 +14,7 @@ export interface GetAccountResponse {
     /** Last Name */
     lastName: string;
     /** Address informations */
-    address: GetAccountResponse.Address;
-    /** User's date and time preferences */
-    dateTimePreferences: GetAccountResponse.DateTimePreferences;
+    address?: GetAccountResponse.Address | undefined;
     marketingAutomation?: GetAccountResponse.MarketingAutomation | undefined;
     /** Information about your plans and credits */
     plan: GetAccountResponse.Plan.Item[];
@@ -39,17 +37,6 @@ export declare namespace GetAccountResponse {
         /** Zip Code information */
         zipCode: string;
     }
-    /**
-     * User's date and time preferences
-     */
-    interface DateTimePreferences {
-        /** User's timezone setting */
-        timezone: string;
-        /** Preferred time format (12 or 24 hour) */
-        timeFormat: string;
-        /** Preferred date format */
-        dateFormat: string;
-    }
     interface MarketingAutomation {
         /**
          * Status of Marketing Automation Plateform activation
@@ -107,11 +94,11 @@ export declare namespace GetAccountResponse {
             /** Current status of the plan */
             status: Item.Status;
             /** Plan start date (Unix timestamp) */
-            startDate: string;
+            startDate?: string | undefined;
             /** Plan end date (Unix timestamp) */
-            endDate: string;
+            endDate?: string | undefined;
             /** User seat information for the plan */
-            users: Item.Users | null;
+            users?: (Item.Users | null) | undefined;
             /** Credits allocated for this plan category (optional, may not be present for all plan categories) */
             credits?: string | undefined;
         }

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

@@ -25,11 +25,11 @@ export declare class BalanceClient {
      * @example
      *     await client.balance.getActiveBalancesApi({
      *         pid: "pid",
-     *         contact_id: 1,
-     *         balance_definition_id: "balance_definition_id"
+     *         contactId: 1000000,
+     *         balanceDefinitionId: "balanceDefinitionId"
      *     })
      */
-    getActiveBalancesApi(request: Brevo.GetLoyaltyBalanceProgramsPidActiveBalanceRequest, requestOptions?: BalanceClient.RequestOptions): core.HttpResponsePromise<Brevo.BalanceLimit>;
+    getActiveBalancesApi(request: Brevo.GetLoyaltyBalanceProgramsPidActiveBalanceRequest, requestOptions?: BalanceClient.RequestOptions): core.HttpResponsePromise<Brevo.GetLoyaltyBalanceProgramsPidActiveBalanceResponse>;
     private __getActiveBalancesApi;
     /**
      * Returns balance definition page
@@ -227,7 +227,7 @@ export declare class BalanceClient {
     deleteBalanceLimit(request: Brevo.DeleteBalanceLimitRequest, requestOptions?: BalanceClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteBalanceLimit;
     /**
-     * Returns balance list
+     * Returns contact balances for a given balance definition across all subscriptions.
      *
      * @param {Brevo.GetContactBalancesRequest} request
      * @param {BalanceClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -240,7 +240,8 @@ export declare class BalanceClient {
      *
      * @example
      *     await client.balance.getContactBalances({
-     *         pid: "pid"
+     *         pid: "pid",
+     *         balanceDefinitionId: "balanceDefinitionId"
      *     })
      */
     getContactBalances(request: Brevo.GetContactBalancesRequest, requestOptions?: BalanceClient.RequestOptions): core.HttpResponsePromise<Brevo.GetContactBalancesResponse>;
@@ -263,7 +264,7 @@ export declare class BalanceClient {
      *         balanceDefinitionId: "balanceDefinitionId",
      *         contactId: 1,
      *         dueAt: "dueAt",
-     *         source: "source"
+     *         source: "engine"
      *     })
      */
     createBalanceOrder(request: Brevo.CreateBalanceOrderRequest, requestOptions?: BalanceClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateBalanceOrderResponse>;
@@ -324,7 +325,7 @@ export declare class BalanceClient {
      * @example
      *     await client.balance.getTransactionHistoryApi({
      *         pid: "pid",
-     *         contactId: 1,
+     *         contactId: 1000000,
      *         balanceDefinitionId: "balanceDefinitionId"
      *     })
      */

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

@@ -45,8 +45,8 @@ export class BalanceClient {
      * @example
      *     await client.balance.getActiveBalancesApi({
      *         pid: "pid",
-     *         contact_id: 1,
-     *         balance_definition_id: "balance_definition_id"
+     *         contactId: 1000000,
+     *         balanceDefinitionId: "balanceDefinitionId"
      *     })
      */
     getActiveBalancesApi(request, requestOptions) {
@@ -55,14 +55,14 @@ export class BalanceClient {
     __getActiveBalancesApi(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { pid, limit, offset, sort_field: sortField, sort, contact_id: contactId, balance_definition_id: balanceDefinitionId, includeInternal, } = request;
+            const { pid, limit, offset, sortField, sort, contactId, balanceDefinitionId, includeInternal } = request;
             const _queryParams = {
                 limit,
                 offset,
-                sort_field: sortField,
-                sort,
-                contact_id: contactId,
-                balance_definition_id: balanceDefinitionId,
+                sortField: sortField != null ? sortField : undefined,
+                sort: sort != null ? sort : undefined,
+                contactId,
+                balanceDefinitionId,
                 includeInternal,
             };
             const _authRequest = yield this._options.authProvider.getAuthRequest();
@@ -71,7 +71,11 @@ export class BalanceClient {
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/active-balance`),
                 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,
@@ -79,7 +83,10 @@ export class BalanceClient {
                 logging: this._options.logging,
             });
             if (_response.ok) {
-                return { data: _response.body, rawResponse: _response.rawResponse };
+                return {
+                    data: _response.body,
+                    rawResponse: _response.rawResponse,
+                };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
@@ -140,7 +147,11 @@ export class BalanceClient {
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/balance-definitions`),
                 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,
@@ -207,7 +218,7 @@ export class BalanceClient {
                 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: _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,
@@ -276,7 +287,11 @@ export class BalanceClient {
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/balance-definitions/${core.url.encodePathParam(bdid)}`),
                 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,
@@ -344,7 +359,7 @@ export class BalanceClient {
                 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,
@@ -412,7 +427,7 @@ export class BalanceClient {
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/balance-definitions/${core.url.encodePathParam(bdid)}`),
                 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,
@@ -482,7 +497,7 @@ export class BalanceClient {
                 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: _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,
@@ -552,7 +567,11 @@ export class BalanceClient {
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/balance-definitions/${core.url.encodePathParam(bdid)}/limits/${core.url.encodePathParam(blid)}`),
                 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,
@@ -623,7 +642,7 @@ export class BalanceClient {
                 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,
@@ -690,7 +709,7 @@ export class BalanceClient {
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/balance-definitions/${core.url.encodePathParam(bdid)}/limits/${core.url.encodePathParam(blid)}`),
                 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,
@@ -724,7 +743,7 @@ export class BalanceClient {
         });
     }
     /**
-     * Returns balance list
+     * Returns contact balances for a given balance definition across all subscriptions.
      *
      * @param {Brevo.GetContactBalancesRequest} request
      * @param {BalanceClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -737,7 +756,8 @@ export class BalanceClient {
      *
      * @example
      *     await client.balance.getContactBalances({
-     *         pid: "pid"
+     *         pid: "pid",
+     *         balanceDefinitionId: "balanceDefinitionId"
      *     })
      */
     getContactBalances(request, requestOptions) {
@@ -746,9 +766,14 @@ export class BalanceClient {
     __getContactBalances(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { pid, includeInternal } = request;
+            const { pid, includeInternal, limit, offset, sort, sortField, balanceDefinitionId } = request;
             const _queryParams = {
                 includeInternal,
+                limit,
+                offset,
+                sort: sort != null ? sort : undefined,
+                sortField: sortField != null ? sortField : undefined,
+                balanceDefinitionId,
             };
             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);
@@ -756,7 +781,11 @@ export class BalanceClient {
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/contact-balances`),
                 method: "GET",
                 headers: _headers,
-                queryParameters: 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,
@@ -807,7 +836,7 @@ export class BalanceClient {
      *         balanceDefinitionId: "balanceDefinitionId",
      *         contactId: 1,
      *         dueAt: "dueAt",
-     *         source: "source"
+     *         source: "engine"
      *     })
      */
     createBalanceOrder(request, requestOptions) {
@@ -824,7 +853,7 @@ export class BalanceClient {
                 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: _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,
@@ -891,7 +920,11 @@ export class BalanceClient {
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/subscriptions/${core.url.encodePathParam(cid)}/balances`),
                 method: "GET",
                 headers: _headers,
-                queryParameters: 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,
@@ -960,7 +993,7 @@ export class BalanceClient {
                 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: _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,
@@ -1013,7 +1046,7 @@ export class BalanceClient {
      * @example
      *     await client.balance.getTransactionHistoryApi({
      *         pid: "pid",
-     *         contactId: 1,
+     *         contactId: 1000000,
      *         balanceDefinitionId: "balanceDefinitionId"
      *     })
      */
@@ -1023,7 +1056,7 @@ export class BalanceClient {
     __getTransactionHistoryApi(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { pid, limit, offset, sortField, sort, contactId, balanceDefinitionId, filters, status, transactionType, } = request;
+            const { pid, limit, offset, sortField, sort, contactId, balanceDefinitionId, status, transactionType, loyaltySubscriptionId, } = request;
             const _queryParams = {
                 limit,
                 offset,
@@ -1031,9 +1064,9 @@ export class BalanceClient {
                 sort: sort != null ? sort : undefined,
                 contactId,
                 balanceDefinitionId,
-                filters,
                 status: status != null ? status : undefined,
                 transactionType: transactionType != null ? transactionType : undefined,
+                loyaltySubscriptionId,
             };
             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);
@@ -1041,7 +1074,11 @@ export class BalanceClient {
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/transaction-history`),
                 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,
@@ -1110,7 +1147,7 @@ export class BalanceClient {
                 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: _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,
@@ -1176,7 +1213,7 @@ export class BalanceClient {
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/transactions/${core.url.encodePathParam(tid)}/cancel`),
                 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,
@@ -1240,7 +1277,7 @@ export class BalanceClient {
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/transactions/${core.url.encodePathParam(tid)}/complete`),
                 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,

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

@@ -9,22 +9,32 @@
 export interface BeginTransactionRequest {
     /** Loyalty Program Id */
     pid: string;
-    /** Unique identifier for the loyalty subscription (required unless `contactId` is provided). */
-    LoyaltySubscriptionId?: string;
-    /** Transaction amount (must be provided). */
+    /** Transaction amount. A positive value creates a credit transaction and a negative value creates a debit transaction (unless transactionType is explicitly provided). */
     amount: number;
-    /** Whether the transaction should be automatically completed. */
-    autoComplete?: boolean;
+    /** Explicit transaction type. If not provided, the type is inferred from the sign of the amount (positive = credit, negative = debit). */
+    transactionType?: BeginTransactionRequest.TransactionType;
     /** Unique identifier (UUID) of the associated balance definition. */
     balanceDefinitionId: string;
-    /** Optional expiry time for the balance in minutes (must be greater than 0 if provided). */
-    balanceExpiryInMinutes?: number;
-    /** Unique identifier of the contact involved in the transaction (required unless `LoyaltySubscriptionId` is provided). */
+    /** Unique identifier of the contact involved in the transaction. Required unless `LoyaltySubscriptionId` is provided. */
     contactId?: number;
-    /** Optional timestamp specifying when the transaction occurred. */
-    eventTime?: string;
+    /** Unique identifier for the loyalty subscription. Required unless `contactId` is provided. */
+    LoyaltySubscriptionId?: string;
     /** Optional metadata associated with the transaction. */
     meta?: Record<string, unknown>;
-    /** Optional time-to-live for the transaction (must be greater than 0 if provided). */
+    /** Time-to-live for the transaction in seconds. Must be at least 10 seconds if provided. */
     ttl?: number;
+    /** Timestamp specifying when the transaction event occurred (ISO 8601 / RFC 3339 format). */
+    eventTime?: string;
+    /** Whether the transaction should be automatically completed. */
+    autoComplete?: boolean;
+    /** Expiry time for the balance in minutes. Must be greater than 0 if provided. Only applicable when autoComplete is true. */
+    balanceExpiryInMinutes?: number;
+}
+export declare namespace BeginTransactionRequest {
+    /** Explicit transaction type. If not provided, the type is inferred from the sign of the amount (positive = credit, negative = debit). */
+    const TransactionType: {
+        readonly Credit: "credit";
+        readonly Debit: "debit";
+    };
+    type TransactionType = (typeof TransactionType)[keyof typeof TransactionType];
 }

package/dist/esm/api/resources/balance/client/requests/BeginTransactionRequest.mjs

@@ -1,2 +1,9 @@
 // This file was auto-generated by Fern from our API Definition.
-export {};
+export var BeginTransactionRequest;
+(function (BeginTransactionRequest) {
+    /** Explicit transaction type. If not provided, the type is inferred from the sign of the amount (positive = credit, negative = debit). */
+    BeginTransactionRequest.TransactionType = {
+        Credit: "credit",
+        Debit: "debit",
+    };
+})(BeginTransactionRequest || (BeginTransactionRequest = {}));

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

@@ -6,7 +6,7 @@
  *         balanceDefinitionId: "balanceDefinitionId",
  *         contactId: 1,
  *         dueAt: "dueAt",
- *         source: "source"
+ *         source: "engine"
  *     }
  */
 export interface CreateBalanceOrderRequest {
@@ -24,6 +24,14 @@ export interface CreateBalanceOrderRequest {
     expiresAt?: string;
     /** Optional metadata associated with the order. */
     meta?: Record<string, unknown>;
-    /** Specifies the origin of the order (`engine` or `user`). */
-    source: string;
+    /** Specifies the origin of the order. */
+    source: CreateBalanceOrderRequest.Source;
+}
+export declare namespace CreateBalanceOrderRequest {
+    /** Specifies the origin of the order. */
+    const Source: {
+        readonly Engine: "engine";
+        readonly User: "user";
+    };
+    type Source = (typeof Source)[keyof typeof Source];
 }

package/dist/esm/api/resources/balance/client/requests/CreateBalanceOrderRequest.mjs

@@ -1,2 +1,9 @@
 // This file was auto-generated by Fern from our API Definition.
-export {};
+export var CreateBalanceOrderRequest;
+(function (CreateBalanceOrderRequest) {
+    /** Specifies the origin of the order. */
+    CreateBalanceOrderRequest.Source = {
+        Engine: "engine",
+        User: "user",
+    };
+})(CreateBalanceOrderRequest || (CreateBalanceOrderRequest = {}));