@getbrevo/brevo 5.0.4 → 6.0.1

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

@@ -11,6 +11,8 @@ export declare class TasksClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<TasksClient.Options>;
     constructor(options: TasksClient.Options);
     /**
+     * Retrieve a paginated list of CRM tasks with optional filtering by task type, status, date range, assignee, and linked entities (contacts, deals, companies). Results are sorted by creation date in descending order by default, with a default limit of 50 tasks per page.
+     *
      * @param {Brevo.GetCrmTasksRequest} request
      * @param {TasksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -24,6 +26,8 @@ export declare class TasksClient {
     getAllTasks(request?: Brevo.GetCrmTasksRequest, requestOptions?: TasksClient.RequestOptions): core.HttpResponsePromise<Brevo.GetCrmTasksResponse>;
     private __getAllTasks;
     /**
+     * Create a new CRM task with the specified name, type, due date, and optional associations to contacts, companies, or deals. A task requires a name, task type ID, and due date at minimum. You can also set a duration, notes, a reminder, and assign the task to a specific user.
+     *
      * @param {Brevo.PostCrmTasksRequest} request
      * @param {TasksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -32,13 +36,15 @@ export declare class TasksClient {
      * @example
      *     await client.tasks.createATask({
      *         date: "2021-11-01T17:44:54Z",
-     *         name: "Task: Connect with client_dev",
+     *         name: "Task: Connect with client",
      *         taskTypeId: "61a5cd07ca1347c82306ad09"
      *     })
      */
     createATask(request: Brevo.PostCrmTasksRequest, requestOptions?: TasksClient.RequestOptions): core.HttpResponsePromise<Brevo.PostCrmTasksResponse>;
     private __createATask;
     /**
+     * Retrieve the full details of a single CRM task by its identifier. The response includes the task''s name, type, status, due date, duration, notes, assignee, reminder settings, and linked contacts, companies, or deals.
+     *
      * @param {Brevo.GetCrmTasksIdRequest} request
      * @param {TasksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -53,6 +59,8 @@ export declare class TasksClient {
     getATask(request: Brevo.GetCrmTasksIdRequest, requestOptions?: TasksClient.RequestOptions): core.HttpResponsePromise<Brevo.Task>;
     private __getATask;
     /**
+     * Permanently delete a CRM task by its identifier. This removes the task and cancels any associated reminders. The requesting user must be the task assignee or have manage permission on tasks.
+     *
      * @param {Brevo.DeleteCrmTasksIdRequest} request
      * @param {TasksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -67,6 +75,8 @@ export declare class TasksClient {
     deleteATask(request: Brevo.DeleteCrmTasksIdRequest, requestOptions?: TasksClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteATask;
     /**
+     * Update an existing CRM task''s properties such as name, type, due date, status, duration, notes, assignee, reminder, or linked entities. Only the fields provided in the request body will be updated; omitted fields remain unchanged.
+     *
      * @param {Brevo.PatchCrmTasksIdRequest} request
      * @param {TasksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -81,11 +91,15 @@ export declare class TasksClient {
     updateATask(request: Brevo.PatchCrmTasksIdRequest, requestOptions?: TasksClient.RequestOptions): core.HttpResponsePromise<void>;
     private __updateATask;
     /**
+     * Retrieve the list of all available task types, such as Email, Call, Meeting, Todo, Lunch, Deadline, and LinkedIn. If no task types exist yet, the default set is automatically created and returned. Use the task type ID when creating or updating tasks.
+     *
      * @param {TasksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Brevo.BadRequestError}
+     *
      * @example
      *     await client.tasks.getAllTaskTypes()
      */
-    getAllTaskTypes(requestOptions?: TasksClient.RequestOptions): core.HttpResponsePromise<Brevo.GetCrmTasktypesResponse>;
+    getAllTaskTypes(requestOptions?: TasksClient.RequestOptions): core.HttpResponsePromise<Brevo.GetCrmTasktypesResponseItem[]>;
     private __getAllTaskTypes;
 }

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

@@ -67,6 +67,8 @@ class TasksClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
+     * Retrieve a paginated list of CRM tasks with optional filtering by task type, status, date range, assignee, and linked entities (contacts, deals, companies). Results are sorted by creation date in descending order by default, with a default limit of 50 tasks per page.
+     *
      * @param {Brevo.GetCrmTasksRequest} request
      * @param {TasksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -105,7 +107,11 @@ class TasksClient {
                 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, "crm/tasks"),
                 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,
@@ -131,6 +137,8 @@ class TasksClient {
         });
     }
     /**
+     * Create a new CRM task with the specified name, type, due date, and optional associations to contacts, companies, or deals. A task requires a name, task type ID, and due date at minimum. You can also set a duration, notes, a reminder, and assign the task to a specific user.
+     *
      * @param {Brevo.PostCrmTasksRequest} request
      * @param {TasksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -139,7 +147,7 @@ class TasksClient {
      * @example
      *     await client.tasks.createATask({
      *         date: "2021-11-01T17:44:54Z",
-     *         name: "Task: Connect with client_dev",
+     *         name: "Task: Connect with client",
      *         taskTypeId: "61a5cd07ca1347c82306ad09"
      *     })
      */
@@ -156,7 +164,7 @@ class TasksClient {
                 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,
@@ -184,6 +192,8 @@ class TasksClient {
         });
     }
     /**
+     * Retrieve the full details of a single CRM task by its identifier. The response includes the task''s name, type, status, due date, duration, notes, assignee, reminder settings, and linked contacts, companies, or deals.
+     *
      * @param {Brevo.GetCrmTasksIdRequest} request
      * @param {TasksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -208,7 +218,7 @@ class TasksClient {
                 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, `crm/tasks/${core.url.encodePathParam(id)}`),
                 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,
@@ -236,6 +246,8 @@ class TasksClient {
         });
     }
     /**
+     * Permanently delete a CRM task by its identifier. This removes the task and cancels any associated reminders. The requesting user must be the task assignee or have manage permission on tasks.
+     *
      * @param {Brevo.DeleteCrmTasksIdRequest} request
      * @param {TasksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -260,7 +272,7 @@ class TasksClient {
                 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, `crm/tasks/${core.url.encodePathParam(id)}`),
                 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,
@@ -288,6 +300,8 @@ class TasksClient {
         });
     }
     /**
+     * Update an existing CRM task''s properties such as name, type, due date, status, duration, notes, assignee, reminder, or linked entities. Only the fields provided in the request body will be updated; omitted fields remain unchanged.
+     *
      * @param {Brevo.PatchCrmTasksIdRequest} request
      * @param {TasksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -313,7 +327,7 @@ class TasksClient {
                 method: "PATCH",
                 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,
@@ -343,8 +357,12 @@ class TasksClient {
         });
     }
     /**
+     * Retrieve the list of all available task types, such as Email, Call, Meeting, Todo, Lunch, Deadline, and LinkedIn. If no task types exist yet, the default set is automatically created and returned. Use the task type ID when creating or updating tasks.
+     *
      * @param {TasksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Brevo.BadRequestError}
+     *
      * @example
      *     await client.tasks.getAllTaskTypes()
      */
@@ -360,7 +378,7 @@ class TasksClient {
                 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, "crm/tasktypes"),
                 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,
@@ -371,11 +389,16 @@ class TasksClient {
                 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 (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/crm/tasktypes");
         });

package/dist/cjs/api/resources/tasks/client/requests/PostCrmTasksRequest.d.ts

@@ -3,7 +3,7 @@ import type * as Brevo from "../../../../index.js";
  * @example
  *     {
  *         date: "2021-11-01T17:44:54Z",
- *         name: "Task: Connect with client_dev",
+ *         name: "Task: Connect with client",
  *         taskTypeId: "61a5cd07ca1347c82306ad09"
  *     }
  */

package/dist/cjs/api/resources/tasks/types/{GetCrmTasktypesResponse.d.ts → GetCrmTasktypesResponseItem.d.ts}

@@ -1,7 +1,4 @@
-/**
- * Task types details
- */
-export interface GetCrmTasktypesResponse {
+export interface GetCrmTasktypesResponseItem {
     /** Id of task type */
     id?: string | undefined;
     /** Title of task type */

package/dist/cjs/api/resources/tasks/types/GetCrmTasktypesResponseItem.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/tasks/types/index.d.ts

@@ -2,5 +2,5 @@ export * from "./GetCrmTasksRequestFilterDate.js";
 export * from "./GetCrmTasksRequestFilterStatus.js";
 export * from "./GetCrmTasksRequestSort.js";
 export * from "./GetCrmTasksResponse.js";
-export * from "./GetCrmTasktypesResponse.js";
+export * from "./GetCrmTasktypesResponseItem.js";
 export * from "./PostCrmTasksResponse.js";

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

@@ -18,5 +18,5 @@ __exportStar(require("./GetCrmTasksRequestFilterDate.js"), exports);
 __exportStar(require("./GetCrmTasksRequestFilterStatus.js"), exports);
 __exportStar(require("./GetCrmTasksRequestSort.js"), exports);
 __exportStar(require("./GetCrmTasksResponse.js"), exports);
-__exportStar(require("./GetCrmTasktypesResponse.js"), exports);
+__exportStar(require("./GetCrmTasktypesResponseItem.js"), exports);
 __exportStar(require("./PostCrmTasksResponse.js"), exports);

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

@@ -100,7 +100,7 @@ class TierClient {
                 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/tier/programs/${core.url.encodePathParam(pid)}/contacts/${core.url.encodePathParam(cid)}/tiers/${core.url.encodePathParam(tid)}`),
                 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,
@@ -170,7 +170,11 @@ class TierClient {
                 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/tier/programs/${core.url.encodePathParam(pid)}/tier-groups`),
                 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,
@@ -236,7 +240,7 @@ class TierClient {
                 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,
@@ -307,7 +311,11 @@ class TierClient {
                 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/tier/programs/${core.url.encodePathParam(pid)}/tier-groups/${core.url.encodePathParam(gid)}`),
                 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,
@@ -376,7 +384,7 @@ class TierClient {
                 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,
@@ -443,7 +451,7 @@ class TierClient {
                 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/tier/programs/${core.url.encodePathParam(pid)}/tier-groups/${core.url.encodePathParam(gid)}`),
                 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,
@@ -512,7 +520,7 @@ class TierClient {
                 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,
@@ -580,7 +588,11 @@ class TierClient {
                 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/tier/programs/${core.url.encodePathParam(pid)}/tiers`),
                 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,
@@ -648,7 +660,7 @@ class TierClient {
                 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,
@@ -714,7 +726,7 @@ class TierClient {
                 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/tier/programs/${core.url.encodePathParam(pid)}/tiers/${core.url.encodePathParam(tid)}`),
                 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/tier/client/requests/CreateTierGroupRequest.d.ts

@@ -18,6 +18,10 @@ export interface CreateTierGroupRequest {
     tierOrder?: string[];
     /** Select real_time to upgrade tier on real time balance updates. Select membership_anniversary to upgrade tier on subscription anniversary. Select tier_anniversary to upgrade tier on tier anniversary. */
     upgradeStrategy?: CreateTierGroupRequest.UpgradeStrategy;
+    /** Schedule configuration for tier upgrades. Required when upgradeStrategy is set to a schedule-based strategy. */
+    upgradeSchedule?: CreateTierGroupRequest.UpgradeSchedule;
+    /** Schedule configuration for tier downgrades. Required when downgradeStrategy is set to a schedule-based strategy. */
+    downgradeSchedule?: CreateTierGroupRequest.DowngradeSchedule;
 }
 export declare namespace CreateTierGroupRequest {
     /** Select real_time to downgrade tier on real time balance updates. Select membership_anniversary to downgrade tier on subscription anniversary. Select tier_anniversary to downgrade tier on tier anniversary. */
@@ -43,4 +47,62 @@ export declare namespace CreateTierGroupRequest {
         readonly TierAnniversary: "tier_anniversary";
     };
     type UpgradeStrategy = (typeof UpgradeStrategy)[keyof typeof UpgradeStrategy];
+    /**
+     * Schedule configuration for tier upgrades. Required when upgradeStrategy is set to a schedule-based strategy.
+     */
+    interface UpgradeSchedule {
+        /** Duration value for the schedule. */
+        durationValue?: number | undefined;
+        /** Duration unit for the schedule. */
+        durationUnit?: UpgradeSchedule.DurationUnit | undefined;
+        /** Modifier for the duration. */
+        durationModifier?: UpgradeSchedule.DurationModifier | undefined;
+        /** Scheduled date in DD/MM format. */
+        scheduledDate?: string | undefined;
+    }
+    namespace UpgradeSchedule {
+        /** Duration unit for the schedule. */
+        const DurationUnit: {
+            readonly Day: "day";
+            readonly Week: "week";
+            readonly Month: "month";
+            readonly Year: "year";
+        };
+        type DurationUnit = (typeof DurationUnit)[keyof typeof DurationUnit];
+        /** Modifier for the duration. */
+        const DurationModifier: {
+            readonly StartOfPeriod: "start_of_period";
+            readonly EndOfPeriod: "end_of_period";
+        };
+        type DurationModifier = (typeof DurationModifier)[keyof typeof DurationModifier];
+    }
+    /**
+     * Schedule configuration for tier downgrades. Required when downgradeStrategy is set to a schedule-based strategy.
+     */
+    interface DowngradeSchedule {
+        /** Duration value for the schedule. */
+        durationValue?: number | undefined;
+        /** Duration unit for the schedule. */
+        durationUnit?: DowngradeSchedule.DurationUnit | undefined;
+        /** Modifier for the duration. */
+        durationModifier?: DowngradeSchedule.DurationModifier | undefined;
+        /** Scheduled date in DD/MM format. */
+        scheduledDate?: string | undefined;
+    }
+    namespace DowngradeSchedule {
+        /** Duration unit for the schedule. */
+        const DurationUnit: {
+            readonly Day: "day";
+            readonly Week: "week";
+            readonly Month: "month";
+            readonly Year: "year";
+        };
+        type DurationUnit = (typeof DurationUnit)[keyof typeof DurationUnit];
+        /** Modifier for the duration. */
+        const DurationModifier: {
+            readonly StartOfPeriod: "start_of_period";
+            readonly EndOfPeriod: "end_of_period";
+        };
+        type DurationModifier = (typeof DurationModifier)[keyof typeof DurationModifier];
+    }
 }

package/dist/cjs/api/resources/tier/client/requests/CreateTierGroupRequest.js

@@ -16,4 +16,34 @@ var CreateTierGroupRequest;
         MembershipAnniversary: "membership_anniversary",
         TierAnniversary: "tier_anniversary",
     };
+    let UpgradeSchedule;
+    (function (UpgradeSchedule) {
+        /** Duration unit for the schedule. */
+        UpgradeSchedule.DurationUnit = {
+            Day: "day",
+            Week: "week",
+            Month: "month",
+            Year: "year",
+        };
+        /** Modifier for the duration. */
+        UpgradeSchedule.DurationModifier = {
+            StartOfPeriod: "start_of_period",
+            EndOfPeriod: "end_of_period",
+        };
+    })(UpgradeSchedule = CreateTierGroupRequest.UpgradeSchedule || (CreateTierGroupRequest.UpgradeSchedule = {}));
+    let DowngradeSchedule;
+    (function (DowngradeSchedule) {
+        /** Duration unit for the schedule. */
+        DowngradeSchedule.DurationUnit = {
+            Day: "day",
+            Week: "week",
+            Month: "month",
+            Year: "year",
+        };
+        /** Modifier for the duration. */
+        DowngradeSchedule.DurationModifier = {
+            StartOfPeriod: "start_of_period",
+            EndOfPeriod: "end_of_period",
+        };
+    })(DowngradeSchedule = CreateTierGroupRequest.DowngradeSchedule || (CreateTierGroupRequest.DowngradeSchedule = {}));
 })(CreateTierGroupRequest || (exports.CreateTierGroupRequest = CreateTierGroupRequest = {}));

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

@@ -11,6 +11,8 @@ export declare class TransactionalEmailsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<TransactionalEmailsClient.Options>;
     constructor(options: TransactionalEmailsClient.Options);
     /**
+     * Retrieve a paginated list of transactional contacts that have been blocked or unsubscribed, along with the reason for blocking (e.g. hard bounce, admin blocked, spam complaint, or unsubscription via email/API/Marketing Automation). Both `startDate` and `endDate` must be provided together when filtering by date range, and neither date can be in the future. Results default to 50 per page (max 100) and are sorted in descending order of record creation unless overridden with the `sort` parameter.
+     *
      * @param {Brevo.GetTransacBlockedContactsRequest} request
      * @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -22,6 +24,8 @@ export declare class TransactionalEmailsClient {
     getTransacBlockedContacts(request?: Brevo.GetTransacBlockedContactsRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetTransacBlockedContactsResponse>;
     private __getTransacBlockedContacts;
     /**
+     * Unblock or resubscribe a transactional contact by removing their email address from the blacklist. The email address must be URL-encoded in the path parameter and must be a valid email format. If the contact is not found in the blocklist, a 404 error is returned.
+     *
      * @param {Brevo.DeleteSmtpBlockedContactsEmailRequest} request
      * @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -40,6 +44,8 @@ export declare class TransactionalEmailsClient {
      *
      * @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Brevo.BadRequestError}
+     *
      * @example
      *     await client.transactionalEmails.getBlockedDomains()
      */
@@ -90,6 +96,8 @@ export declare class TransactionalEmailsClient {
     deleteHardbounces(request?: Brevo.DeleteHardbouncesRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteHardbounces;
     /**
+     * Send a transactional email to one or more recipients, either using inline HTML content or a pre-built template via `templateId`. You can schedule emails for future delivery using `scheduledAt` (UTC, up to 5-minute delay), send multiple personalized versions with `messageVersions` (max 2000 total recipients, 99 per version), and attach files via URL or base64-encoded content. A `sender` and `subject` are required when no `templateId` is provided; when a `templateId` is used, the template''s sender and subject are applied unless overridden.
+     *
      * @param {Brevo.SendTransacEmailRequest} request
      * @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -184,6 +192,9 @@ export declare class TransactionalEmailsClient {
      * @param {Brevo.GetTransacEmailContentRequest} request
      * @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Brevo.BadRequestError}
+     * @throws {@link Brevo.NotFoundError}
+     *
      * @example
      *     await client.transactionalEmails.getTransacEmailContent({
      *         uuid: "uuid"
@@ -192,6 +203,8 @@ export declare class TransactionalEmailsClient {
     getTransacEmailContent(request: Brevo.GetTransacEmailContentRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetTransacEmailContentResponse>;
     private __getTransacEmailContent;
     /**
+     * Delete SMTP transactional log entries identified by a message ID (enclosed in angle brackets with an @ sign) or a valid email address. Optionally narrow the deletion to a specific date range using `from_date` and `to_date` query parameters (YYYY-MM-DD format). The operation also removes any associated stored email preview content.
+     *
      * @param {Brevo.DeleteSmtpLogIdentifierRequest} request
      * @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -232,6 +245,8 @@ export declare class TransactionalEmailsClient {
     getEmailEventReport(request?: Brevo.GetEmailEventReportRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetEmailEventReportResponse>;
     private __getEmailEventReport;
     /**
+     * This endpoint will show the aggregated stats per day for the past 10 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 30 days.
+     *
      * @param {Brevo.GetSmtpReportRequest} request
      * @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -243,7 +258,9 @@ export declare class TransactionalEmailsClient {
     getSmtpReport(request?: Brevo.GetSmtpReportRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetSmtpReportResponse>;
     private __getSmtpReport;
     /**
-     * @param {unknown} request
+     * Generate a fully rendered preview of a transactional email template by resolving dynamic variables. Provide either an `email` address (to populate variables from the contact''s attributes) or a `params` object with key-value pairs for manual substitution; at least one of these is required alongside the mandatory `templateId`. The response includes the rendered HTML, subject, sender details, preview text, and any feed names used in the template.
+     *
+     * @param {Brevo.PostPreviewSmtpEmailTemplatesRequest} request
      * @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Brevo.BadRequestError}
@@ -253,9 +270,11 @@ export declare class TransactionalEmailsClient {
      *         "key": "value"
      *     })
      */
-    postPreviewSmtpEmailTemplates(request?: unknown, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<Brevo.PostPreviewSmtpEmailTemplatesResponse>;
+    postPreviewSmtpEmailTemplates(request: Brevo.PostPreviewSmtpEmailTemplatesRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<Brevo.PostPreviewSmtpEmailTemplatesResponse>;
     private __postPreviewSmtpEmailTemplates;
     /**
+     * Retrieve a paginated list of all transactional email templates (including automation templates) with their details such as name, subject, sender, status, HTML content, and timestamps. Results default to 50 per page (max 1000) and are sorted in descending creation order unless overridden. You can filter by active/inactive status using `templateStatus` and by editor type using `editorType` (currently only `richTextEditor` is supported).
+     *
      * @param {Brevo.GetSmtpTemplatesRequest} request
      * @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -267,6 +286,8 @@ export declare class TransactionalEmailsClient {
     getSmtpTemplates(request?: Brevo.GetSmtpTemplatesRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetSmtpTemplatesResponse>;
     private __getSmtpTemplates;
     /**
+     * Create a new transactional email template with the specified sender, subject, and content. The `sender`, `subject`, and `templateName` fields are required. Template content can be provided via `htmlContent` (minimum 10 characters) or `htmlUrl`; at least one must be supplied. Templates are created as inactive by default unless `isActive` is explicitly set to `true`.
+     *
      * @param {Brevo.CreateSmtpTemplateRequest} request
      * @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -282,6 +303,8 @@ export declare class TransactionalEmailsClient {
     createSmtpTemplate(request: Brevo.CreateSmtpTemplateRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateSmtpTemplateResponse>;
     private __createSmtpTemplate;
     /**
+     * Retrieve the full details of a specific transactional email template by its numeric ID or custom template identifier string. The response includes the template name, subject, sender information, HTML content, active status, creation and modification timestamps, reply-to address, tag, and a `doiTemplate` flag indicating whether the template is a double opt-in template (detected by the presence of optin-related tags or variables in the content).
+     *
      * @param {Brevo.GetSmtpTemplateRequest} request
      * @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -296,6 +319,8 @@ export declare class TransactionalEmailsClient {
     getSmtpTemplate(request: Brevo.GetSmtpTemplateRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetSmtpTemplateOverview>;
     private __getSmtpTemplate;
     /**
+     * Update an existing transactional email template by its numeric ID or custom template identifier string. All fields in the request body are optional; only the provided fields will be updated. You can update the template name, subject, sender, reply-to address, HTML content (via `htmlContent` or `htmlUrl`), active status, tag, attachment URL, and the personalized `toField`. Only one of sender email or sender ID should be provided per request.
+     *
      * @param {Brevo.UpdateSmtpTemplateRequest} request
      * @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -310,6 +335,8 @@ export declare class TransactionalEmailsClient {
     updateSmtpTemplate(request: Brevo.UpdateSmtpTemplateRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __updateSmtpTemplate;
     /**
+     * Permanently delete a transactional email template by its numeric ID. Only inactive templates can be deleted; attempting to delete an active template returns a 405 error. To deactivate a template before deletion, use `PUT /smtp/templates/{templateId}` with `isActive` set to `false`. Deletion also removes associated newsletter template data and triggers asynchronous cleanup of shared assets.
+     *
      * @param {Brevo.DeleteSmtpTemplateRequest} request
      * @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -324,6 +351,8 @@ export declare class TransactionalEmailsClient {
     deleteSmtpTemplate(request: Brevo.DeleteSmtpTemplateRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteSmtpTemplate;
     /**
+     * Send a test email of the specified transactional template to one or more recipients. Provide an array of email addresses in the `emailTo` field; if left empty, the test mail is sent to your entire test list. You can send a maximum of 50 test emails per day, and all provided email addresses must be valid.
+     *
      * @param {Brevo.SendTestTemplateRequest} request
      * @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
      *