@getbrevo/brevo 5.0.3 → 6.0.1

package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpReportRequest.d.ts

@@ -12,7 +12,7 @@ export interface GetSmtpReportRequest {
     startDate?: string;
     /** **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD) */
     endDate?: string;
-    /** Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_ */
+    /** Number of days in the past including today (positive integer, maximum 30). _Not compatible with 'startDate' and 'endDate'_ */
     days?: number;
     /** Tag of the emails */
     tag?: string;

package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpTemplateRequest.d.ts

@@ -1,3 +1,4 @@
+import type * as Brevo from "../../../../index.js";
 /**
  * @example
  *     {
@@ -5,6 +6,6 @@
  *     }
  */
 export interface GetSmtpTemplateRequest {
-    /** id of the template */
-    templateId: number;
+    /** ID of the template. Can be a numeric template ID or a custom template identifier string (alphanumeric, hyphens, and underscores only, max 64 characters, must start with a letter). */
+    templateId: Brevo.GetSmtpTemplateRequestTemplateId;
 }

package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpTemplatesRequest.d.ts

@@ -12,4 +12,6 @@ export interface GetSmtpTemplatesRequest {
     offset?: number;
     /** Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed */
     sort?: Brevo.GetSmtpTemplatesRequestSort;
+    /** Filter on the editor type used to create the template. Currently only `richTextEditor` is supported as a filter value. */
+    editorType?: "richTextEditor";
 }

package/dist/cjs/api/resources/transactionalEmails/client/requests/UpdateSmtpTemplateRequest.d.ts

@@ -1,3 +1,4 @@
+import type * as Brevo from "../../../../index.js";
 /**
  * @example
  *     {
@@ -5,8 +6,8 @@
  *     }
  */
 export interface UpdateSmtpTemplateRequest {
-    /** id of the template */
-    templateId: number;
+    /** ID of the template. Can be a numeric template ID or a custom template identifier string. */
+    templateId: Brevo.UpdateSmtpTemplateRequestTemplateId;
     /** Absolute url of the attachment (**no local file**). Extensions allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps */
     attachmentUrl?: string;
     /** **Required if htmlUrl is empty**. If the template is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that template. Body of the message (HTML must have more than 10 characters) */

package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.d.ts

@@ -0,0 +1 @@
+export type GetSmtpTemplateRequestTemplateId = number | string;

package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.js

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

package/dist/cjs/api/resources/transactionalEmails/types/GetTransacEmailContentResponse.d.ts

@@ -1,8 +1,8 @@
 export interface GetTransacEmailContentResponse {
     /** Count of the attachments that were sent in the email */
-    attachmentCount: number;
+    attachmentCount?: number | undefined;
     /** Actual content of the transactional email that has been sent */
-    body: string;
+    body?: string | undefined;
     /** Date on which transactional email was sent */
     date: string;
     /** Email address to which transactional email has been sent */

package/dist/cjs/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.d.ts

@@ -0,0 +1 @@
+export type PostPreviewSmtpEmailTemplatesRequest = unknown;

package/dist/cjs/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.js

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

package/dist/cjs/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.d.ts

@@ -0,0 +1 @@
+export type UpdateSmtpTemplateRequestTemplateId = number | string;

package/dist/cjs/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.js

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

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

@@ -9,6 +9,7 @@ export * from "./GetScheduledEmailByIdRequestStatus.js";
 export * from "./GetScheduledEmailByIdResponse.js";
 export * from "./GetSmtpReportRequestSort.js";
 export * from "./GetSmtpReportResponse.js";
+export * from "./GetSmtpTemplateRequestTemplateId.js";
 export * from "./GetSmtpTemplatesRequestSort.js";
 export * from "./GetSmtpTemplatesResponse.js";
 export * from "./GetTransacBlockedContactsRequestSort.js";
@@ -16,5 +17,7 @@ export * from "./GetTransacBlockedContactsResponse.js";
 export * from "./GetTransacEmailContentResponse.js";
 export * from "./GetTransacEmailsListRequestSort.js";
 export * from "./GetTransacEmailsListResponse.js";
+export * from "./PostPreviewSmtpEmailTemplatesRequest.js";
 export * from "./PostPreviewSmtpEmailTemplatesResponse.js";
 export * from "./SendTransacEmailResponse.js";
+export * from "./UpdateSmtpTemplateRequestTemplateId.js";

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

@@ -25,6 +25,7 @@ __exportStar(require("./GetScheduledEmailByIdRequestStatus.js"), exports);
 __exportStar(require("./GetScheduledEmailByIdResponse.js"), exports);
 __exportStar(require("./GetSmtpReportRequestSort.js"), exports);
 __exportStar(require("./GetSmtpReportResponse.js"), exports);
+__exportStar(require("./GetSmtpTemplateRequestTemplateId.js"), exports);
 __exportStar(require("./GetSmtpTemplatesRequestSort.js"), exports);
 __exportStar(require("./GetSmtpTemplatesResponse.js"), exports);
 __exportStar(require("./GetTransacBlockedContactsRequestSort.js"), exports);
@@ -32,5 +33,7 @@ __exportStar(require("./GetTransacBlockedContactsResponse.js"), exports);
 __exportStar(require("./GetTransacEmailContentResponse.js"), exports);
 __exportStar(require("./GetTransacEmailsListRequestSort.js"), exports);
 __exportStar(require("./GetTransacEmailsListResponse.js"), exports);
+__exportStar(require("./PostPreviewSmtpEmailTemplatesRequest.js"), exports);
 __exportStar(require("./PostPreviewSmtpEmailTemplatesResponse.js"), exports);
 __exportStar(require("./SendTransacEmailResponse.js"), exports);
+__exportStar(require("./UpdateSmtpTemplateRequestTemplateId.js"), exports);

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

@@ -31,11 +31,14 @@ export declare class TransactionalSmsClient {
     /**
      * @deprecated
      *
+     * Send a transactional SMS message to a single mobile number. The `sender`, `recipient`, and either `content` or `templateId` fields are required. The sender name is limited to 11 alphanumeric characters or 15 numeric characters, and the recipient must be a valid international phone number (6-15 digits, optional leading +). Tags can be a string or an array of up to 10 strings. The SMS type defaults to `transactional` but can be set to `marketing`; if the content includes a stop code, it is automatically treated as marketing. Returns the message ID, SMS count, credits used, and remaining credits.
+     *
      * @param {Brevo.SendTransacSms} request
      * @param {TransactionalSmsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Brevo.BadRequestError}
      * @throws {@link Brevo.PaymentRequiredError}
+     * @throws {@link Brevo.TooManyRequestsError}
      *
      * @example
      *     await client.transactionalSms.sendTransacSms({
@@ -46,6 +49,8 @@ export declare class TransactionalSmsClient {
     sendTransacSms(request: Brevo.SendTransacSms, requestOptions?: TransactionalSmsClient.RequestOptions): core.HttpResponsePromise<Brevo.SendTransacSmsResponse>;
     private __sendTransacSms;
     /**
+     * Retrieve an aggregated report of your transactional SMS activity over a specified time period, including counts for requests, delivered, hard bounces, soft bounces, blocked, unsubscribed, replied, accepted, rejected, and skipped messages. Filter by date range using `startDate` and `endDate` (both required together, YYYY-MM-DD format) or by a number of past `days` (not compatible with date range). You can further narrow results by `tag`. If no date filter is provided, the report covers all available data and returns the auto-detected date range.
+     *
      * @param {Brevo.GetTransacAggregatedSmsReportRequest} request
      * @param {TransactionalSmsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -57,6 +62,8 @@ export declare class TransactionalSmsClient {
     getTransacAggregatedSmsReport(request?: Brevo.GetTransacAggregatedSmsReportRequest, requestOptions?: TransactionalSmsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetTransacAggregatedSmsReportResponse>;
     private __getTransacAggregatedSmsReport;
     /**
+     * Retrieve a paginated list of individual SMS event records (unaggregated), including event type, phone number, message ID, timestamp, tag, and reason or reply content where applicable. Results default to 50 per page (max 100) and are sorted in descending order unless overridden. Filter by date range (`startDate`/`endDate`), past `days` (not compatible with date range), specific `event` type (e.g. delivered, bounces, replies), `phoneNumber`, or `tags`. Bounce events include the failure reason, and reply events include the reply content.
+     *
      * @param {Brevo.GetSmsEventsRequest} request
      * @param {TransactionalSmsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -68,6 +75,8 @@ export declare class TransactionalSmsClient {
     getSmsEvents(request?: Brevo.GetSmsEventsRequest, requestOptions?: TransactionalSmsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetSmsEventsResponse>;
     private __getSmsEvents;
     /**
+     * Retrieve a day-by-day breakdown of your transactional SMS activity, with each entry containing the date and counts for requests, delivered, hard bounces, soft bounces, blocked, unsubscribed, replied, accepted, rejected, and skipped messages. Filter by date range using `startDate` and `endDate` (both required together, YYYY-MM-DD format), by a number of past `days` (not compatible with date range), or by `tag`. Results are sorted in descending order by default unless overridden with the `sort` parameter.
+     *
      * @param {Brevo.GetTransacSmsReportRequest} request
      * @param {TransactionalSmsClient.RequestOptions} requestOptions - Request-specific configuration.
      *

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

@@ -84,7 +84,7 @@ class TransactionalSmsClient {
                 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,
@@ -117,11 +117,14 @@ class TransactionalSmsClient {
     /**
      * @deprecated
      *
+     * Send a transactional SMS message to a single mobile number. The `sender`, `recipient`, and either `content` or `templateId` fields are required. The sender name is limited to 11 alphanumeric characters or 15 numeric characters, and the recipient must be a valid international phone number (6-15 digits, optional leading +). Tags can be a string or an array of up to 10 strings. The SMS type defaults to `transactional` but can be set to `marketing`; if the content includes a stop code, it is automatically treated as marketing. Returns the message ID, SMS count, credits used, and remaining credits.
+     *
      * @param {Brevo.SendTransacSms} request
      * @param {TransactionalSmsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Brevo.BadRequestError}
      * @throws {@link Brevo.PaymentRequiredError}
+     * @throws {@link Brevo.TooManyRequestsError}
      *
      * @example
      *     await client.transactionalSms.sendTransacSms({
@@ -142,7 +145,7 @@ class TransactionalSmsClient {
                 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,
@@ -160,6 +163,8 @@ class TransactionalSmsClient {
                         throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
                     case 402:
                         throw new Brevo.PaymentRequiredError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new Brevo.TooManyRequestsError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.BrevoError({
                             statusCode: _response.error.statusCode,
@@ -172,6 +177,8 @@ class TransactionalSmsClient {
         });
     }
     /**
+     * Retrieve an aggregated report of your transactional SMS activity over a specified time period, including counts for requests, delivered, hard bounces, soft bounces, blocked, unsubscribed, replied, accepted, rejected, and skipped messages. Filter by date range using `startDate` and `endDate` (both required together, YYYY-MM-DD format) or by a number of past `days` (not compatible with date range). You can further narrow results by `tag`. If no date filter is provided, the report covers all available data and returns the auto-detected date range.
+     *
      * @param {Brevo.GetTransacAggregatedSmsReportRequest} request
      * @param {TransactionalSmsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -199,7 +206,11 @@ class TransactionalSmsClient {
                 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, "transactionalSMS/statistics/aggregatedReport"),
                 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,
@@ -228,6 +239,8 @@ class TransactionalSmsClient {
         });
     }
     /**
+     * Retrieve a paginated list of individual SMS event records (unaggregated), including event type, phone number, message ID, timestamp, tag, and reason or reply content where applicable. Results default to 50 per page (max 100) and are sorted in descending order unless overridden. Filter by date range (`startDate`/`endDate`), past `days` (not compatible with date range), specific `event` type (e.g. delivered, bounces, replies), `phoneNumber`, or `tags`. Bounce events include the failure reason, and reply events include the reply content.
+     *
      * @param {Brevo.GetSmsEventsRequest} request
      * @param {TransactionalSmsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -260,7 +273,11 @@ class TransactionalSmsClient {
                 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, "transactionalSMS/statistics/events"),
                 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,
@@ -286,6 +303,8 @@ class TransactionalSmsClient {
         });
     }
     /**
+     * Retrieve a day-by-day breakdown of your transactional SMS activity, with each entry containing the date and counts for requests, delivered, hard bounces, soft bounces, blocked, unsubscribed, replied, accepted, rejected, and skipped messages. Filter by date range using `startDate` and `endDate` (both required together, YYYY-MM-DD format), by a number of past `days` (not compatible with date range), or by `tag`. Results are sorted in descending order by default unless overridden with the `sort` parameter.
+     *
      * @param {Brevo.GetTransacSmsReportRequest} request
      * @param {TransactionalSmsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -314,7 +333,11 @@ class TransactionalSmsClient {
                 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, "transactionalSMS/statistics/reports"),
                 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/cjs/api/resources/transactionalWhatsApp/client/Client.js

@@ -85,7 +85,7 @@ class TransactionalWhatsAppClient {
                 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,
@@ -146,7 +146,11 @@ class TransactionalWhatsAppClient {
                 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, "whatsapp/statistics/events"),
                 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/cjs/api/resources/user/client/Client.d.ts

@@ -11,6 +11,8 @@ export declare class UserClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<UserClient.Options>;
     constructor(options: UserClient.Options);
     /**
+     * Retrieves the list of all users associated with your organization, including both active and pending invited users. Each user entry includes their email address, owner status, current invitation status, and feature access levels for marketing, CRM, and conversations.
+     *
      * @param {UserClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Brevo.BadRequestError}
@@ -21,6 +23,8 @@ export declare class UserClient {
     getInvitedUsersList(requestOptions?: UserClient.RequestOptions): core.HttpResponsePromise<Brevo.GetInvitedUsersListResponse>;
     private __getInvitedUsersList;
     /**
+     * Revokes all permissions for an invited user in the organization, effectively removing their access to the platform. If the user''s plan change generated credit notes, they are returned in the response for billing reconciliation.
+     *
      * @param {Brevo.PutRevokeUserPermissionRequest} request
      * @param {UserClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -118,6 +122,8 @@ export declare class UserClient {
     inviteuser(request: Brevo.Inviteuser, requestOptions?: UserClient.RequestOptions): core.HttpResponsePromise<Brevo.InviteuserResponse>;
     private __inviteuser;
     /**
+     * Resends or cancels a pending invitation for a user in the organization, depending on the action path parameter. Use `resend` to send a new invitation email to the user, or `cancel` to revoke the pending invitation entirely and remove the user''s pending access.
+     *
      * @param {Brevo.PutresendcancelinvitationRequest} request
      * @param {UserClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -215,6 +221,8 @@ export declare class UserClient {
     editUserPermission(request: Brevo.Inviteuser, requestOptions?: UserClient.RequestOptions): core.HttpResponsePromise<Brevo.EditUserPermissionResponse>;
     private __editUserPermission;
     /**
+     * Retrieves the granular feature-level permissions assigned to a specific user in the organization, identified by their email address. The response includes the user''s current status (active or pending) and a detailed list of privileges specifying which features and permission levels are granted.
+     *
      * @param {Brevo.GetUserPermissionRequest} request
      * @param {UserClient.RequestOptions} requestOptions - Request-specific configuration.
      *

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

@@ -56,6 +56,8 @@ class UserClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
+     * Retrieves the list of all users associated with your organization, including both active and pending invited users. Each user entry includes their email address, owner status, current invitation status, and feature access levels for marketing, CRM, and conversations.
+     *
      * @param {UserClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Brevo.BadRequestError}
@@ -75,7 +77,7 @@ class UserClient {
                 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/invited/users"),
                 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,
@@ -101,6 +103,8 @@ class UserClient {
         });
     }
     /**
+     * Revokes all permissions for an invited user in the organization, effectively removing their access to the platform. If the user''s plan change generated credit notes, they are returned in the response for billing reconciliation.
+     *
      * @param {Brevo.PutRevokeUserPermissionRequest} request
      * @param {UserClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -124,7 +128,7 @@ class UserClient {
                 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/user/invitation/revoke/${core.url.encodePathParam(email)}`),
                 method: "PUT",
                 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,
@@ -247,7 +251,7 @@ class UserClient {
                 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,
@@ -275,6 +279,8 @@ class UserClient {
         });
     }
     /**
+     * Resends or cancels a pending invitation for a user in the organization, depending on the action path parameter. Use `resend` to send a new invitation email to the user, or `cancel` to revoke the pending invitation entirely and remove the user''s pending access.
+     *
      * @param {Brevo.PutresendcancelinvitationRequest} request
      * @param {UserClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -299,7 +305,7 @@ class UserClient {
                 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/user/invitation/${core.url.encodePathParam(action)}/${core.url.encodePathParam(email)}`),
                 method: "PUT",
                 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,
@@ -421,7 +427,7 @@ class UserClient {
                 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,
@@ -449,6 +455,8 @@ class UserClient {
         });
     }
     /**
+     * Retrieves the granular feature-level permissions assigned to a specific user in the organization, identified by their email address. The response includes the user''s current status (active or pending) and a detailed list of privileges specifying which features and permission levels are granted.
+     *
      * @param {Brevo.GetUserPermissionRequest} request
      * @param {UserClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -472,7 +480,7 @@ class UserClient {
                 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/user/${core.url.encodePathParam(email)}/permissions`),
                 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,

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

@@ -58,7 +58,6 @@ export declare class WebhooksClient {
      *
      * @example
      *     await client.webhooks.createWebhook({
-     *         events: ["sent"],
      *         url: "http://requestb.in/173lyyx1"
      *     })
      */

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

@@ -108,7 +108,11 @@ class WebhooksClient {
                 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, "webhooks"),
                 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,
@@ -154,7 +158,6 @@ class WebhooksClient {
      *
      * @example
      *     await client.webhooks.createWebhook({
-     *         events: ["sent"],
      *         url: "http://requestb.in/173lyyx1"
      *     })
      */
@@ -171,7 +174,7 @@ class WebhooksClient {
                 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,
@@ -235,7 +238,7 @@ class WebhooksClient {
                 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,
@@ -303,7 +306,7 @@ class WebhooksClient {
                 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, `webhooks/${core.url.encodePathParam(webhookId)}`),
                 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,
@@ -368,7 +371,7 @@ class WebhooksClient {
                 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,
@@ -433,7 +436,7 @@ class WebhooksClient {
                 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, `webhooks/${core.url.encodePathParam(webhookId)}`),
                 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/webhooks/client/requests/CreateWebhookRequest.d.ts

@@ -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/cjs/api/resources/webhooks/client/requests/CreateWebhookRequest.js

@@ -4,10 +4,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CreateWebhookRequest = void 0;
 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/cjs/api/resources/webhooks/client/requests/ExportWebhooksHistoryRequest.d.ts

@@ -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) */