@getbrevo/brevo 5.0.4 → 6.0.2

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

@@ -67,6 +67,8 @@ class SmsCampaignsClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
+     * Retrieve a paginated list of all your SMS campaigns with their statistics and recipient information. Results can be filtered by status and date range, with a default limit of 500 and maximum of 1000 per page. The sort order defaults to descending by creation date; date filters are only available when status is not passed or is set to sent.
+     *
      * @param {Brevo.GetSmsCampaignsRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -96,7 +98,11 @@ class SmsCampaignsClient {
                 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, "smsCampaigns"),
                 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,
@@ -122,6 +128,8 @@ class SmsCampaignsClient {
         });
     }
     /**
+     * Create a new SMS campaign with the required name, sender, and content fields. The sender name is limited to 11 alphanumeric characters or 15 numeric characters, and the content should stay within 160 characters per SMS segment. If a scheduledAt date is provided, listIds in recipients become mandatory; accounts under validation are limited to 4 total campaigns and campaigns with more than 10 recipients will be saved as draft.
+     *
      * @param {Brevo.CreateSmsCampaignRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -147,7 +155,7 @@ class SmsCampaignsClient {
                 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,
@@ -175,6 +183,8 @@ class SmsCampaignsClient {
         });
     }
     /**
+     * Retrieve detailed information about a specific SMS campaign by its ID, including campaign content, sender, recipients with list names, statistics (delivered, sent, bounces, unsubscriptions, answered), and tags. Unlike the list endpoint, recipients are returned as objects with id and name fields rather than plain IDs.
+     *
      * @param {Brevo.GetSmsCampaignRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -199,7 +209,7 @@ class SmsCampaignsClient {
                 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, `smsCampaigns/${core.url.encodePathParam(campaignId)}`),
                 method: "GET",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
                 maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -227,6 +237,8 @@ class SmsCampaignsClient {
         });
     }
     /**
+     * Update an existing SMS campaign''s properties such as name, sender, content, recipients, scheduled date, organisation prefix, and unsubscribe instructions. The request body must contain at least one valid field to update. The campaign must exist and must be of type SMS; if a scheduledAt is provided, valid recipients must be present either in the request or already configured on the campaign.
+     *
      * @param {Brevo.UpdateSmsCampaignRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -252,7 +264,7 @@ class SmsCampaignsClient {
                 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,
@@ -282,6 +294,8 @@ class SmsCampaignsClient {
         });
     }
     /**
+     * Delete an SMS campaign by its campaign ID. Only campaigns that have not been scheduled or sent can be deleted; attempting to delete a campaign that is queued, in process, or has been sent with recipients will return a 403 permission denied error.
+     *
      * @param {Brevo.DeleteSmsCampaignRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -306,7 +320,7 @@ class SmsCampaignsClient {
                 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, `smsCampaigns/${core.url.encodePathParam(campaignId)}`),
                 method: "DELETE",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
                 maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -362,7 +376,7 @@ class SmsCampaignsClient {
                 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,
@@ -395,6 +409,8 @@ class SmsCampaignsClient {
         });
     }
     /**
+     * Send an existing SMS campaign immediately by scheduling it for the current time. The system verifies your account''s SMS credit balance before dispatching; if credits are insufficient or the remaining credit is less than the number of recipients, a 402 error is returned. The campaign must have valid recipients and content already configured.
+     *
      * @param {Brevo.SendSmsCampaignNowRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -420,7 +436,7 @@ class SmsCampaignsClient {
                 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, `smsCampaigns/${core.url.encodePathParam(campaignId)}/sendNow`),
                 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,
@@ -483,7 +499,7 @@ class SmsCampaignsClient {
                 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,
@@ -513,6 +529,8 @@ class SmsCampaignsClient {
         });
     }
     /**
+     * Send a test SMS to a specified phone number to preview the campaign before sending it to all recipients. The phone number must belong to one of your existing contacts in your Brevo account and must not be blacklisted. The number should include the country code (e.g. 33689965433).
+     *
      * @param {Brevo.SendTestSmsRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -538,7 +556,7 @@ class SmsCampaignsClient {
                 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,
@@ -568,6 +586,8 @@ class SmsCampaignsClient {
         });
     }
     /**
+     * Update the status of an SMS campaign, such as suspending, archiving, or replicating it. Available status values include suspended, archive, darchive, sent, queued, replicate, replicateTemplate, cancel, and draft. Note that the replicateTemplate status is only available for template type campaigns.
+     *
      * @param {Brevo.UpdateSmsCampaignStatusRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -594,7 +614,7 @@ class SmsCampaignsClient {
                 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,

package/dist/cjs/api/resources/smsCampaigns/client/requests/GetSmsCampaignsRequest.d.ts

@@ -6,11 +6,11 @@ import type * as Brevo from "../../../../index.js";
 export interface GetSmsCampaignsRequest {
     /** Status of campaign. */
     status?: Brevo.GetSmsCampaignsRequestStatus;
-    /** **Mandatory if endDate is used.** Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' ) */
+    /** **Mandatory if endDate is used.** Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent SMS campaigns. **Prefer to pass your timezone in date-time format for accurate result.** Only available if `status` is not passed or is set to `sent`. `startDate` must not be in the future. */
     startDate?: string;
-    /** **Mandatory if startDate is used.** Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' ) */
+    /** **Mandatory if startDate is used.** Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent SMS campaigns. **Prefer to pass your timezone in date-time format for accurate result.** Only available if `status` is not passed or is set to `sent`. `endDate` must not be in the future. */
     endDate?: string;
-    /** Number limitation for the result returned */
+    /** Number of documents per page */
     limit?: number;
     /** Beginning point in the list to retrieve from. */
     offset?: number;

package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignResponse.d.ts

@@ -10,14 +10,23 @@ export interface GetSmsCampaignResponse {
     modifiedAt: string;
     /** Name of the SMS Campaign */
     name: string;
-    /** UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format */
+    /** A recognizable prefix added as the Brand Name before the message content. Empty string if not set. */
+    organisationPrefix?: string | undefined;
+    /** UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format. Empty string if not scheduled. */
     scheduledAt?: string | undefined;
     /** Sender of the SMS Campaign */
     sender: string;
+    /** UTC date-time on which the SMS campaign was sent (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if the campaign status is 'sent'. */
+    sentDate?: string | undefined;
     /** Status of the SMS Campaign */
     status: GetSmsCampaignResponse.Status;
-    recipients: Brevo.GetCampaignRecipients;
+    /** Instructions to unsubscribe from future communications. Empty string if not set. */
+    unsubscribeInstruction?: string | undefined;
+    /** Recipients of the SMS campaign. For a single campaign, lists and exclusion lists are returned as objects with id and name. */
+    recipients: GetSmsCampaignResponse.Recipients;
     statistics: Brevo.GetSmsCampaignStats;
+    /** Tags (labels) associated with the SMS campaign. Only available when retrieving a single campaign. */
+    tags?: string[] | undefined;
 }
 export declare namespace GetSmsCampaignResponse {
     /** Status of the SMS Campaign */
@@ -30,4 +39,31 @@ export declare namespace GetSmsCampaignResponse {
         readonly InProcess: "inProcess";
     };
     type Status = (typeof Status)[keyof typeof Status];
+    /**
+     * Recipients of the SMS campaign. For a single campaign, lists and exclusion lists are returned as objects with id and name.
+     */
+    interface Recipients {
+        exclusionLists?: Recipients.ExclusionLists.Item[] | undefined;
+        lists?: Recipients.Lists.Item[] | undefined;
+    }
+    namespace Recipients {
+        type ExclusionLists = ExclusionLists.Item[];
+        namespace ExclusionLists {
+            interface Item {
+                /** ID of the exclusion list */
+                id?: number | undefined;
+                /** Name of the exclusion list */
+                name?: string | undefined;
+            }
+        }
+        type Lists = Lists.Item[];
+        namespace Lists {
+            interface Item {
+                /** ID of the list */
+                id?: number | undefined;
+                /** Name of the list */
+                name?: string | undefined;
+            }
+        }
+    }
 }

package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignsResponse.d.ts

@@ -18,12 +18,18 @@ export declare namespace GetSmsCampaignsResponse {
             modifiedAt: string;
             /** Name of the SMS Campaign */
             name: string;
-            /** UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format */
+            /** A recognizable prefix added as the Brand Name before the message content. Empty string if not set. */
+            organisationPrefix?: string | undefined;
+            /** UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format. Empty string if not scheduled. */
             scheduledAt?: string | undefined;
             /** Sender of the SMS Campaign */
             sender: string;
+            /** UTC date-time on which the SMS campaign was sent (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if the campaign status is 'sent'. */
+            sentDate?: string | undefined;
             /** Status of the SMS Campaign */
             status: Item.Status;
+            /** Instructions to unsubscribe from future communications. Empty string if not set. */
+            unsubscribeInstruction?: string | undefined;
             recipients: Brevo.GetCampaignRecipients;
             statistics: Brevo.GetSmsCampaignStats;
         }

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

@@ -82,7 +82,11 @@ class SmsTemplatesClient {
                 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/templates"),
                 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/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);