@getbrevo/brevo 5.0.3 → 6.0.1

package/dist/cjs/api/resources/customObjects/client/requests/UpsertrecordsRequest.js

@@ -1,3 +1,24 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpsertrecordsRequest = void 0;
+var UpsertrecordsRequest;
+(function (UpsertrecordsRequest) {
+    let Records;
+    (function (Records) {
+        let Item;
+        (function (Item_1) {
+            let Associations;
+            (function (Associations) {
+                let Item;
+                (function (Item) {
+                    /** Action to perform on the association. - `link`: Create association between records (default if not provided) - `unlink`: Remove association between records. Idempotent — unlinking a non-existing association is a no-op success. */
+                    Item.Action = {
+                        Link: "link",
+                        Unlink: "unlink",
+                    };
+                })(Item = Associations.Item || (Associations.Item = {}));
+            })(Associations = Item_1.Associations || (Item_1.Associations = {}));
+        })(Item = Records.Item || (Records.Item = {}));
+    })(Records = UpsertrecordsRequest.Records || (UpsertrecordsRequest.Records = {}));
+})(UpsertrecordsRequest || (exports.UpsertrecordsRequest = UpsertrecordsRequest = {}));

package/dist/cjs/api/resources/customObjects/client/requests/index.d.ts

@@ -1,3 +1,3 @@
 export type { BatchDeleteObjectRecordsRequest } from "./BatchDeleteObjectRecordsRequest.js";
 export type { GetrecordsRequest } from "./GetrecordsRequest.js";
-export type { UpsertrecordsRequest } from "./UpsertrecordsRequest.js";
+export { UpsertrecordsRequest } from "./UpsertrecordsRequest.js";

package/dist/cjs/api/resources/customObjects/client/requests/index.js

@@ -1,2 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpsertrecordsRequest = void 0;
+var UpsertrecordsRequest_js_1 = require("./UpsertrecordsRequest.js");
+Object.defineProperty(exports, "UpsertrecordsRequest", { enumerable: true, get: function () { return UpsertrecordsRequest_js_1.UpsertrecordsRequest; } });

package/dist/cjs/api/resources/customObjects/types/GetrecordsResponse.d.ts

@@ -9,11 +9,18 @@ export declare namespace GetrecordsResponse {
         interface Item {
             /** List of associations for the object record. If association query param is true it will return 5 associated records per association. */
             associations?: Item.Associations.Item[] | undefined;
-            /** Attributes attached with the object record. Only the already created attributes will be used with records. Minimum 1 attribute is required. */
+            /**
+             * Key-value pairs of attribute data for the object record. Each key is the attribute **key** (e.g., `company_name`, `engine_type`), not the attribute label (e.g., "Company Name", "Engine Type"). Only attributes that already exist in the object schema will be present.
+             * For `category` or `multiple_category` attributes, the value is the option **key** (not the option label or option ID).
+             */
             attributes?: Record<string, unknown> | undefined;
             /** Timestamp when the object record was created */
             createdAt?: string | undefined;
-            /** Identifiers attached with the object record. It can have id or ext_id. ext_id is ID of record in the external system that client want to store in the object system, id is an internal ID of object record generated by Brevo system. */
+            /**
+             * Identifiers for the object record. Supports `id` (singular, not `ids`) or `ext_id`.
+             * - `ext_id`: Your external system's identifier for this record.
+             * - `id`: Internal Brevo record ID.
+             */
             identifiers?: Item.Identifiers | undefined;
             /** Timestamp when the object record was last updated */
             updatedAt?: string | undefined;
@@ -46,12 +53,14 @@ export declare namespace GetrecordsResponse {
                 };
             }
             /**
-             * Identifiers attached with the object record. It can have id or ext_id. ext_id is ID of record in the external system that client want to store in the object system, id is an internal ID of object record generated by Brevo system.
+             * Identifiers for the object record. Supports `id` (singular, not `ids`) or `ext_id`.
+             * - `ext_id`: Your external system's identifier for this record.
+             * - `id`: Internal Brevo record ID.
              */
             interface Identifiers {
-                /** ext_id is ID of record in the external system that client_dev want to store in the object system. */
+                /** External ID of the record in your system. */
                 ext_id?: string | undefined;
-                /** Internal ID of the object record generated by Brevo */
+                /** Internal ID of the object record generated by Brevo. */
                 id?: number | undefined;
             }
         }

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

@@ -11,14 +11,20 @@ export declare class DealsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<DealsClient.Options>;
     constructor(options: DealsClient.Options);
     /**
+     * Retrieve the list of all attributes defined for deals, including both system-default and custom attributes. Each attribute includes its label, internal name, type, required status, and available options for select-type attributes.
+     *
      * @param {DealsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Brevo.BadRequestError}
+     *
      * @example
      *     await client.deals.getDealAttributes()
      */
     getDealAttributes(requestOptions?: DealsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetCrmAttributesDealsResponseItem[]>;
     private __getDealAttributes;
     /**
+     * Retrieve a paginated list of deals with optional filtering, sorting, and search capabilities. Results can be filtered by attributes such as deal name or owner, linked companies, linked contacts, or modification/creation timestamps. Default sort order is descending by creation date.
+     *
      * @param {Brevo.GetCrmDealsRequest} request
      * @param {DealsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -30,6 +36,8 @@ export declare class DealsClient {
     getAllDeals(request?: Brevo.GetCrmDealsRequest, requestOptions?: DealsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetCrmDealsResponse>;
     private __getAllDeals;
     /**
+     * Create a new deal in the CRM with the specified name, attributes, and optional associations to contacts and companies. You can assign the deal to a specific pipeline and stage by providing `pipeline` and `deal_stage` attribute IDs, which can be retrieved from the pipeline details endpoint.
+     *
      * @param {Brevo.PostCrmDealsRequest} request
      * @param {DealsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -57,6 +65,8 @@ export declare class DealsClient {
     importDealsCreationAndUpdation(request: Brevo.PostCrmDealsImportRequest, requestOptions?: DealsClient.RequestOptions): core.HttpResponsePromise<Brevo.PostCrmDealsImportResponse>;
     private __importDealsCreationAndUpdation;
     /**
+     * Link or unlink contacts and companies with a specific deal in a single request. You can simultaneously link new contacts/companies and unlink existing ones by providing the respective ID arrays in the request body.
+     *
      * @param {Brevo.PatchCrmDealsLinkUnlinkIdRequest} request
      * @param {DealsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -70,6 +80,8 @@ export declare class DealsClient {
     linkAndUnlinkADealWithContactsAndCompanies(request: Brevo.PatchCrmDealsLinkUnlinkIdRequest, requestOptions?: DealsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __linkAndUnlinkADealWithContactsAndCompanies;
     /**
+     * Retrieve the full details of a single deal by its identifier, including its attributes, pipeline stage, linked contacts, and linked companies. Returns a 404 error if the deal does not exist.
+     *
      * @param {Brevo.GetCrmDealsIdRequest} request
      * @param {DealsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -84,6 +96,8 @@ export declare class DealsClient {
     getADeal(request: Brevo.GetCrmDealsIdRequest, requestOptions?: DealsClient.RequestOptions): core.HttpResponsePromise<Brevo.Deal>;
     private __getADeal;
     /**
+     * Permanently delete a deal by its identifier. The requesting user must be the deal owner or have manage permission on deals; otherwise, a 403 Forbidden error is returned.
+     *
      * @param {Brevo.DeleteCrmDealsIdRequest} request
      * @param {DealsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -98,6 +112,8 @@ export declare class DealsClient {
     deleteADeal(request: Brevo.DeleteCrmDealsIdRequest, requestOptions?: DealsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteADeal;
     /**
+     * Update an existing deal''s attributes, name, linked contacts, or linked companies. Note that passing `linkedContactsIds` or `linkedCompaniesIds` replaces the entire list of associations, so omitted IDs will be removed. To move a deal to a different pipeline or stage, provide both the `pipeline` and `deal_stage` attribute IDs.
+     *
      * @param {Brevo.PatchCrmDealsIdRequest} request
      * @param {DealsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -118,12 +134,16 @@ export declare class DealsClient {
      *
      * @param {DealsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Brevo.BadRequestError}
+     *
      * @example
      *     await client.deals.getPipelineStages()
      */
     getPipelineStages(requestOptions?: DealsClient.RequestOptions): core.HttpResponsePromise<Brevo.Pipeline>;
     private __getPipelineStages;
     /**
+     * Retrieve the list of all deal pipelines configured for your account, including each pipeline''s stages and settings. If no pipelines have been configured yet, a default pipeline is automatically created and returned.
+     *
      * @param {DealsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Brevo.BadRequestError}
@@ -134,6 +154,8 @@ export declare class DealsClient {
     getAllPipelines(requestOptions?: DealsClient.RequestOptions): core.HttpResponsePromise<Brevo.Pipelines>;
     private __getAllPipelines;
     /**
+     * Retrieve the details of a specific deal pipeline by its identifier, including its stages, stage ordering, and configuration. Use this endpoint to obtain the pipeline and stage IDs needed when creating or updating deals.
+     *
      * @param {Brevo.GetCrmPipelineDetailsPipelineIdRequest} request
      * @param {DealsClient.RequestOptions} requestOptions - Request-specific configuration.
      *

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

@@ -68,8 +68,12 @@ class DealsClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
+     * Retrieve the list of all attributes defined for deals, including both system-default and custom attributes. Each attribute includes its label, internal name, type, required status, and available options for select-type attributes.
+     *
      * @param {DealsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Brevo.BadRequestError}
+     *
      * @example
      *     await client.deals.getDealAttributes()
      */
@@ -85,7 +89,7 @@ class DealsClient {
                 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/attributes/deals"),
                 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,
@@ -99,16 +103,23 @@ class DealsClient {
                 };
             }
             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/attributes/deals");
         });
     }
     /**
+     * Retrieve a paginated list of deals with optional filtering, sorting, and search capabilities. Results can be filtered by attributes such as deal name or owner, linked companies, linked contacts, or modification/creation timestamps. Default sort order is descending by creation date.
+     *
      * @param {Brevo.GetCrmDealsRequest} request
      * @param {DealsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -123,7 +134,7 @@ class DealsClient {
     __getAllDeals() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { "filters[attributes.deal_name]": filtersAttributesDealName, "filters[linkedCompaniesIds]": filtersLinkedCompaniesIds, "filters[linkedContactsIds]": filtersLinkedContactsIds, modifiedSince, createdSince, offset, limit, sort, } = request;
+            const { "filters[attributes.deal_name]": filtersAttributesDealName, "filters[linkedCompaniesIds]": filtersLinkedCompaniesIds, "filters[linkedContactsIds]": filtersLinkedContactsIds, modifiedSince, createdSince, offset, limit, sort, sortBy, } = request;
             const _queryParams = {
                 "filters[attributes.deal_name]": filtersAttributesDealName,
                 "filters[linkedCompaniesIds]": filtersLinkedCompaniesIds,
@@ -133,6 +144,7 @@ class DealsClient {
                 offset,
                 limit,
                 sort: sort != null ? sort : undefined,
+                sortBy,
             };
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
@@ -140,7 +152,11 @@ class DealsClient {
                 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/deals"),
                 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,
@@ -166,6 +182,8 @@ class DealsClient {
         });
     }
     /**
+     * Create a new deal in the CRM with the specified name, attributes, and optional associations to contacts and companies. You can assign the deal to a specific pipeline and stage by providing `pipeline` and `deal_stage` attribute IDs, which can be retrieved from the pipeline details endpoint.
+     *
      * @param {Brevo.PostCrmDealsRequest} request
      * @param {DealsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -189,7 +207,7 @@ class DealsClient {
                 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,
@@ -248,7 +266,7 @@ class DealsClient {
                 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/deals/import"),
                 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(),
                 requestType: "file",
                 duplex: _maybeEncodedRequest.duplex,
                 body: _maybeEncodedRequest.body,
@@ -277,6 +295,8 @@ class DealsClient {
         });
     }
     /**
+     * Link or unlink contacts and companies with a specific deal in a single request. You can simultaneously link new contacts/companies and unlink existing ones by providing the respective ID arrays in the request body.
+     *
      * @param {Brevo.PatchCrmDealsLinkUnlinkIdRequest} request
      * @param {DealsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -301,7 +321,7 @@ class DealsClient {
                 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,
@@ -329,6 +349,8 @@ class DealsClient {
         });
     }
     /**
+     * Retrieve the full details of a single deal by its identifier, including its attributes, pipeline stage, linked contacts, and linked companies. Returns a 404 error if the deal does not exist.
+     *
      * @param {Brevo.GetCrmDealsIdRequest} request
      * @param {DealsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -353,7 +375,7 @@ class DealsClient {
                 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/deals/${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,
@@ -381,6 +403,8 @@ class DealsClient {
         });
     }
     /**
+     * Permanently delete a deal by its identifier. The requesting user must be the deal owner or have manage permission on deals; otherwise, a 403 Forbidden error is returned.
+     *
      * @param {Brevo.DeleteCrmDealsIdRequest} request
      * @param {DealsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -405,7 +429,7 @@ class DealsClient {
                 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/deals/${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,
@@ -433,6 +457,8 @@ class DealsClient {
         });
     }
     /**
+     * Update an existing deal''s attributes, name, linked contacts, or linked companies. Note that passing `linkedContactsIds` or `linkedCompaniesIds` replaces the entire list of associations, so omitted IDs will be removed. To move a deal to a different pipeline or stage, provide both the `pipeline` and `deal_stage` attribute IDs.
+     *
      * @param {Brevo.PatchCrmDealsIdRequest} request
      * @param {DealsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -458,7 +484,7 @@ class DealsClient {
                 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,
@@ -494,6 +520,8 @@ class DealsClient {
      *
      * @param {DealsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Brevo.BadRequestError}
+     *
      * @example
      *     await client.deals.getPipelineStages()
      */
@@ -509,7 +537,7 @@ class DealsClient {
                 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/pipeline/details"),
                 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,
@@ -520,16 +548,23 @@ class DealsClient {
                 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/pipeline/details");
         });
     }
     /**
+     * Retrieve the list of all deal pipelines configured for your account, including each pipeline''s stages and settings. If no pipelines have been configured yet, a default pipeline is automatically created and returned.
+     *
      * @param {DealsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Brevo.BadRequestError}
@@ -549,7 +584,7 @@ class DealsClient {
                 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/pipeline/details/all"),
                 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,
@@ -575,6 +610,8 @@ class DealsClient {
         });
     }
     /**
+     * Retrieve the details of a specific deal pipeline by its identifier, including its stages, stage ordering, and configuration. Use this endpoint to obtain the pipeline and stage IDs needed when creating or updating deals.
+     *
      * @param {Brevo.GetCrmPipelineDetailsPipelineIdRequest} request
      * @param {DealsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -598,7 +635,7 @@ class DealsClient {
                 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/pipeline/details/${core.url.encodePathParam(pipelineId)}`),
                 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/deals/client/requests/GetCrmDealsRequest.d.ts

@@ -8,11 +8,11 @@ export interface GetCrmDealsRequest {
     "filters[attributes.deal_name]"?: string;
     /** Filter by linked companies ids */
     "filters[linkedCompaniesIds]"?: string;
-    /** Filter by linked companies ids */
+    /** Filter by linked contacts ids */
     "filters[linkedContactsIds]"?: string;
-    /** Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. */
+    /** Filter (urlencoded) the deals modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. */
     modifiedSince?: string;
-    /** Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. */
+    /** Filter (urlencoded) the deals created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. */
     createdSince?: string;
     /** Index of the first document of the page */
     offset?: number;
@@ -20,4 +20,6 @@ export interface GetCrmDealsRequest {
     limit?: number;
     /** Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed */
     sort?: Brevo.GetCrmDealsRequestSort;
+    /** The field used to sort field names. */
+    sortBy?: string;
 }

package/dist/cjs/api/resources/deals/client/requests/PatchCrmDealsIdRequest.d.ts

@@ -8,7 +8,7 @@ export interface PatchCrmDealsIdRequest {
     id: string;
     /** Attributes for deal update To assign owner of a Deal you can send attributes.deal_owner and utilize the account email or ID. If you wish to update the pipeline of a deal you need to provide the `pipeline` and the `deal_stage` Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}` */
     attributes?: Record<string, unknown>;
-    /** Warning - Using PATCH on linkedCompaniesIds replaces the list of linked contacts. Omitted IDs will be removed. */
+    /** Warning - Using PATCH on linkedCompaniesIds replaces the list of linked companies. Omitted IDs will be removed. */
     linkedCompaniesIds?: string[];
     /** Warning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed. */
     linkedContactsIds?: number[];

package/dist/cjs/api/resources/deals/client/requests/PostCrmDealsImportRequest.d.ts

@@ -10,7 +10,7 @@ export interface PostCrmDealsImportRequest {
      * The mapping options in JSON format. Here is an example of the JSON structure: ```json {
      *   "link_entities": true, // Determines whether to link related entities during the import process
      *   "unlink_entities": false, // Determines whether to unlink related entities during the import process
-     *   "update_existing_records": true, // Determines whether to update based on company ID or treat every row as create
+     *   "update_existing_records": true, // Determines whether to update based on deal ID or treat every row as create
      *   "unset_empty_attributes": false // Determines whether to unset a specific attribute during update if the values input is blank
      * } ```
      */

package/dist/cjs/api/resources/deals/types/GetCrmAttributesDealsResponseItem.d.ts

@@ -1,10 +1,26 @@
 /**
- * List of attributes
+ * Deal attribute details
  */
 export interface GetCrmAttributesDealsResponseItem {
-    attributeOptions?: Record<string, unknown>[] | undefined;
-    attributeTypeName?: string | undefined;
+    /** Internal name of the attribute */
     internalName?: string | undefined;
-    isRequired?: boolean | undefined;
+    /** Type of the attribute */
+    attributeTypeName?: string | undefined;
+    /** Display label of the attribute */
     label?: string | undefined;
+    /** Options for single-select or multi-choice attributes */
+    attributeOptions?: GetCrmAttributesDealsResponseItem.AttributeOptions.Item[] | undefined;
+    /** Whether this attribute is required */
+    isRequired?: boolean | undefined;
+    /** Whether this attribute value is read-only */
+    isValueReadonly?: boolean | undefined;
+}
+export declare namespace GetCrmAttributesDealsResponseItem {
+    type AttributeOptions = AttributeOptions.Item[];
+    namespace AttributeOptions {
+        interface Item {
+            key?: string | undefined;
+            value?: string | undefined;
+        }
+    }
 }

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

@@ -91,7 +91,7 @@ class DomainsClient {
                 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, "senders/domains"),
                 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,
@@ -164,7 +164,7 @@ class DomainsClient {
                 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,
@@ -229,7 +229,7 @@ class DomainsClient {
                 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, `senders/domains/${core.url.encodePathParam(domainName)}`),
                 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,
@@ -291,7 +291,7 @@ class DomainsClient {
                 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, `senders/domains/${core.url.encodePathParam(domainName)}`),
                 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,
@@ -355,7 +355,7 @@ class DomainsClient {
                 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, `senders/domains/${core.url.encodePathParam(domainName)}/authenticate`),
                 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,