@getbrevo/brevo 5.0.4 → 6.0.1

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

@@ -67,6 +67,8 @@ class EcommerceClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
+     * Retrieve a paginated list of all ecommerce categories stored in your Brevo account. Results are sorted by creation date in descending order by default, and can be filtered by category IDs, name, modification date, creation date, or deletion status. The response includes a `count` field with the total number of matching categories, and pagination defaults to 50 categories per page (maximum 100).
+     *
      * @param {Brevo.GetCategoriesRequest} request
      * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -98,7 +100,11 @@ class EcommerceClient {
                 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, "categories"),
                 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,
@@ -124,6 +130,8 @@ class EcommerceClient {
         });
     }
     /**
+     * Create a new ecommerce category or update an existing one, identified by the mandatory `id` field. When `updateEnabled` is set to `false` (the default), the endpoint performs an insert and returns `201`; if the category ID already exists, a `400` error is returned. When `updateEnabled` is `true`, the endpoint performs an upsert, returning `201` for a new category or `204` when an existing category is updated. The `name` field is mandatory for creation but optional for updates.
+     *
      * @param {Brevo.CreateUpdateCategoryRequest} request
      * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -147,7 +155,7 @@ class EcommerceClient {
                 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,
@@ -178,6 +186,8 @@ class EcommerceClient {
         });
     }
     /**
+     * Create or update multiple ecommerce categories in a single request. The `categories` array accepts up to 100 category objects, each requiring a unique `id`. When `updateEnabled` is `false` (the default), all categories are inserted as new; if any ID already exists, a `400` error is returned. When `updateEnabled` is `true`, existing categories are updated and new ones are created via upsert. Duplicate IDs within the same request payload are rejected. The response returns the count of created and updated categories.
+     *
      * @param {Brevo.CreateUpdateBatchCategoryRequest} request
      * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -203,7 +213,7 @@ class EcommerceClient {
                 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,
@@ -234,6 +244,8 @@ class EcommerceClient {
         });
     }
     /**
+     * Retrieve the full details of a single ecommerce category by its unique ID. The response includes the category name, URL, creation and modification timestamps, and deletion status. Returns a `404` error if no category matches the provided ID.
+     *
      * @param {Brevo.GetCategoryInfoRequest} request
      * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -258,7 +270,7 @@ class EcommerceClient {
                 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, `categories/${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,
@@ -308,7 +320,7 @@ class EcommerceClient {
                 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, "ecommerce/activate"),
                 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,
@@ -336,6 +348,8 @@ class EcommerceClient {
         });
     }
     /**
+     * Retrieve aggregated ecommerce attribution metrics for one or more Brevo email campaigns, SMS campaigns, or automation workflows. You can optionally filter by a date range using `periodFrom` and `periodTo` in RFC3339 format. The response includes per-source metrics (orders count, revenue, and average basket) as well as aggregated totals across all requested sources.
+     *
      * @param {Brevo.GetEcommerceAttributionMetricsRequest} request
      * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -344,7 +358,8 @@ class EcommerceClient {
      * @example
      *     await client.ecommerce.getAttributionMetricsForOneOrMoreBrevoCampaignsOrWorkflows({
      *         periodFrom: "2022-01-02T00:00:00Z",
-     *         periodTo: "2022-01-03T00:00:00Z"
+     *         periodTo: "2022-01-03T00:00:00Z",
+     *         "emailCampaignId[]": ["sale"]
      *     })
      */
     getAttributionMetricsForOneOrMoreBrevoCampaignsOrWorkflows(request = {}, requestOptions) {
@@ -368,7 +383,11 @@ class EcommerceClient {
                 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, "ecommerce/attribution/metrics"),
                 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,
@@ -397,6 +416,8 @@ class EcommerceClient {
         });
     }
     /**
+     * Retrieve detailed attribution metrics for a single Brevo campaign or automation workflow, identified by its conversion source type and ID. The response includes orders count, revenue, average basket value, and the number of new customers attributed to that specific campaign or workflow.
+     *
      * @param {Brevo.GetEcommerceAttributionMetricsConversionSourceConversionSourceIdRequest} request
      * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -421,7 +442,7 @@ class EcommerceClient {
                 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, `ecommerce/attribution/metrics/${core.url.encodePathParam(conversionSource)}/${core.url.encodePathParam(conversionSourceId)}`),
                 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,
@@ -450,6 +471,8 @@ class EcommerceClient {
         });
     }
     /**
+     * Retrieve the list of products whose sales have been attributed to a specific Brevo campaign or automation workflow. Each product entry includes its ID, name, SKU, image URL, product URL, price, revenue, and orders count. The conversion source type must be one of `email_campaign`, `sms_campaign`, `automation_workflow_email`, or `automation_workflow_sms`.
+     *
      * @param {Brevo.GetEcommerceAttributionProductsConversionSourceConversionSourceIdRequest} request
      * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -474,7 +497,7 @@ class EcommerceClient {
                 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, `ecommerce/attribution/products/${core.url.encodePathParam(conversionSource)}/${core.url.encodePathParam(conversionSourceId)}`),
                 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,
@@ -503,6 +526,8 @@ class EcommerceClient {
         });
     }
     /**
+     * Retrieve the ISO 4217 display currency code currently configured for your Brevo ecommerce account. This currency is used to display monetary values across the ecommerce dashboard and reports. Returns a `403` error if ecommerce is not activated on the account.
+     *
      * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Brevo.BadRequestError}
@@ -524,7 +549,7 @@ class EcommerceClient {
                 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, "ecommerce/config/displayCurrency"),
                 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,
@@ -557,6 +582,8 @@ class EcommerceClient {
         });
     }
     /**
+     * Set or update the ISO 4217 display currency code for your Brevo ecommerce account. This currency determines how monetary values are displayed in the ecommerce dashboard and reports. The provided currency code must be a valid ISO 4217 code; invalid codes result in a `422` error. Returns a `403` error if ecommerce is not activated on the account.
+     *
      * @param {Brevo.SetConfigDisplayCurrencyRequest} request
      * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -583,7 +610,7 @@ class EcommerceClient {
                 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,
@@ -650,7 +677,11 @@ class EcommerceClient {
                 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, "orders"),
                 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,
@@ -709,7 +740,7 @@ class EcommerceClient {
                 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,
@@ -772,7 +803,7 @@ class EcommerceClient {
                 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,
@@ -800,6 +831,8 @@ class EcommerceClient {
         });
     }
     /**
+     * Retrieve a paginated list of all ecommerce products stored in your Brevo account. Results are sorted by creation date in descending order by default, and can be filtered by product IDs, name (minimum 3 characters), price range, category IDs, modification date, creation date, or deletion status. Use the `search` parameter to query across SKU, name, and ID simultaneously — results are prioritized as exact SKU match > SKU prefix match > name match > ID match. Pagination defaults to 50 products per page (maximum 1000), and the response includes a `count` field with the total number of matching products.
+     *
      * @param {Brevo.GetProductsRequest} request
      * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -814,12 +847,13 @@ class EcommerceClient {
     __getProducts() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { limit, offset, sort, ids, name, "price[lte]": priceLte, "price[gte]": priceGte, "price[lt]": priceLt, "price[gt]": priceGt, "price[eq]": priceEq, "price[ne]": priceNe, categories, modifiedSince, createdSince, isDeleted, } = request;
+            const { limit, offset, sort, ids, search, name, "price[lte]": priceLte, "price[gte]": priceGte, "price[lt]": priceLt, "price[gt]": priceGt, "price[eq]": priceEq, "price[ne]": priceNe, "alternativePrice[lte]": alternativePriceLte, "alternativePrice[gte]": alternativePriceGte, "alternativePrice[lt]": alternativePriceLt, "alternativePrice[gt]": alternativePriceGt, "alternativePrice[eq]": alternativePriceEq, "alternativePrice[ne]": alternativePriceNe, categories, modifiedSince, createdSince, sortByField, isDeleted, } = request;
             const _queryParams = {
                 limit,
                 offset,
                 sort: sort != null ? sort : undefined,
                 ids,
+                search,
                 name,
                 "price[lte]": priceLte,
                 "price[gte]": priceGte,
@@ -827,9 +861,16 @@ class EcommerceClient {
                 "price[gt]": priceGt,
                 "price[eq]": priceEq,
                 "price[ne]": priceNe,
+                "alternativePrice[lte]": alternativePriceLte,
+                "alternativePrice[gte]": alternativePriceGte,
+                "alternativePrice[lt]": alternativePriceLt,
+                "alternativePrice[gt]": alternativePriceGt,
+                "alternativePrice[eq]": alternativePriceEq,
+                "alternativePrice[ne]": alternativePriceNe,
                 categories,
                 modifiedSince,
                 createdSince,
+                sortByField: sortByField != null ? sortByField : undefined,
                 isDeleted,
             };
             const _authRequest = yield this._options.authProvider.getAuthRequest();
@@ -838,7 +879,11 @@ class EcommerceClient {
                 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, "products"),
                 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,
@@ -864,6 +909,8 @@ class EcommerceClient {
         });
     }
     /**
+     * Create a new ecommerce product or update an existing one, identified by the mandatory `id` field. When `updateEnabled` is `false` (the default), the endpoint inserts a new product and returns `201`; if the product ID already exists, a `400` error is returned. When `updateEnabled` is `true`, the endpoint performs an upsert, returning `201` for a new product or `204` for an update. The `name` field is mandatory for creation but optional for updates. Product images are downloaded, validated (max 5 MB, formats: jpeg, jpg, png, bmp, gif, webp), and re-hosted on S3. The `metaInfo` object supports up to 20 keys with a cumulative size limit of approximately 1000 KB.
+     *
      * @param {Brevo.CreateUpdateProductRequest} request
      * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -888,7 +935,7 @@ class EcommerceClient {
                 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,
@@ -919,6 +966,8 @@ class EcommerceClient {
         });
     }
     /**
+     * Create or update multiple ecommerce products in a single request. The `products` array accepts up to 100 product objects for creation (or up to 1000 when `updateEnabled` is `true` and the account has an increased limit). Each product requires a unique `id` and `name` (name is mandatory for creation only). When `updateEnabled` is `false`, all products are inserted as new; if any ID already exists, a `400` error is returned. When `updateEnabled` is `true`, existing products are updated and new ones are created via upsert. Duplicate IDs within the same request payload are rejected. The response returns the count of created and updated products.
+     *
      * @param {Brevo.CreateUpdateBatchProductsRequest} request
      * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -945,7 +994,7 @@ class EcommerceClient {
                 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,
@@ -976,6 +1025,8 @@ class EcommerceClient {
         });
     }
     /**
+     * Retrieve the full details of a single ecommerce product by its unique ID. The response includes the product name, price, SKU, URL, image URLs (original and thumbnails), categories, stock level, meta information, creation and modification timestamps, and deletion status. Returns a `404` error if no product matches the provided ID.
+     *
      * @param {Brevo.GetProductInfoRequest} request
      * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -1000,7 +1051,7 @@ class EcommerceClient {
                 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, `products/${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,
@@ -1028,6 +1079,8 @@ class EcommerceClient {
         });
     }
     /**
+     * Register a contact to receive an alert for a specific product event, such as `back_in_stock`. At least one contact identifier (`ext_id`, `email`, or `sms`) must be provided; when multiple are given, priority is `ext_id` > `email` > `sms`. Returns a `404` error if the product ID does not exist, and a `403` error if product alerts are not enabled for the account.
+     *
      * @param {Brevo.CreateProductAlertRequest} request
      * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -1056,7 +1109,7 @@ class EcommerceClient {
                 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,

package/dist/cjs/api/resources/ecommerce/client/requests/CreateBatchOrderRequest.d.ts

@@ -16,9 +16,9 @@ import type * as Brevo from "../../../../index.js";
  *     }
  */
 export interface CreateBatchOrderRequest {
-    /** Defines wether you want your orders to be considered as live data or as historical data (import of past data, synchronising data). True: orders will not trigger any automation workflows. False: orders will trigger workflows as usual. */
+    /** Defines whether you want your orders to be considered as live data or as historical data (import of past data, synchronising data). True: orders will not trigger any automation workflows. False: orders will trigger workflows as usual. */
     historical?: boolean;
-    /** Notify Url provided by client_dev to get the status of batch request */
+    /** Webhook URL to receive the status of the batch request */
     notifyUrl?: string;
     /** array of order objects */
     orders: Brevo.Order[];

package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.ts

@@ -10,7 +10,7 @@
 export interface CreateUpdateBatchProductsRequest {
     /** array of products objects */
     products: CreateUpdateBatchProductsRequest.Products.Item[];
-    /** Facilitate to update the existing categories in the same request (updateEnabled = true) */
+    /** Facilitate to update the existing products in the same request (updateEnabled = true) */
     updateEnabled?: boolean;
 }
 export declare namespace CreateUpdateBatchProductsRequest {
@@ -33,12 +33,14 @@ export declare namespace CreateUpdateBatchProductsRequest {
             isDeleted?: boolean | undefined;
             /** Meta data of product such as description, vendor, producer, stock level. The total characters of cumulative metaInfo shall not exceed **20000 characters**. */
             metaInfo?: Record<string, Item.MetaInfo.Value> | undefined;
-            /** Mandatory in case of creation**. Name of the product for which you requested the details */
+            /** **Mandatory in case of creation**. Name of the product, as displayed in the shop */
             name: string;
             /** Parent product id of the product */
             parentId?: string | undefined;
             /** Price of the product */
             price?: number | undefined;
+            /** Alternative price of the product */
+            alternativePrice?: number | undefined;
             /** Product identifier from the shop */
             sku?: string | undefined;
             /** Current stock value of the product from the shop's database */

package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateProductRequest.d.ts

@@ -22,17 +22,19 @@ export interface CreateUpdateProductRequest {
     isDeleted?: boolean;
     /** Meta data of product such as description, vendor, producer, stock level. The total characters of cumulative metaInfo shall not exceed **20000 characters**. */
     metaInfo?: Record<string, CreateUpdateProductRequest.MetaInfo.Value>;
-    /** Mandatory in case of creation**. Name of the product for which you requested the details */
+    /** **Mandatory in case of creation**. Name of the product, as displayed in the shop */
     name: string;
     /** Parent product id of the product */
     parentId?: string;
     /** Price of the product */
     price?: number;
+    /** Alternative price of the product */
+    alternativePrice?: number;
     /** Product identifier from the shop */
     sku?: string;
     /** Current stock value of the product from the shop's database */
     stock?: number;
-    /** Facilitate to update the existing category in the same request (updateEnabled = true) */
+    /** Facilitate to update the existing product in the same request (updateEnabled = true) */
     updateEnabled?: boolean;
     /** URL to the product */
     url?: string;

package/dist/cjs/api/resources/ecommerce/client/requests/GetEcommerceAttributionMetricsRequest.d.ts

@@ -2,7 +2,8 @@
  * @example
  *     {
  *         periodFrom: "2022-01-02T00:00:00Z",
- *         periodTo: "2022-01-03T00:00:00Z"
+ *         periodTo: "2022-01-03T00:00:00Z",
+ *         "emailCampaignId[]": ["sale"]
  *     }
  */
 export interface GetEcommerceAttributionMetricsRequest {

package/dist/cjs/api/resources/ecommerce/client/requests/GetProductsRequest.d.ts

@@ -12,6 +12,8 @@ export interface GetProductsRequest {
     sort?: Brevo.GetProductsRequestSort;
     /** Filter by product ids */
     ids?: string | string[];
+    /** Search products simultaneously across SKU, name, and ID fields. Results are returned in the following priority order: **exact SKU match** > **SKU prefix match** > **name match** > **ID match**. For example, `?search=123` on products with `{sku: "123"}` and `{sku: "123456"}` returns the exact SKU match first. */
+    search?: string;
     /** Filter by product name, minimum 3 characters should be present for search. */
     name?: string;
     /** Price filter for products less than and equals to particular amount */
@@ -26,12 +28,26 @@ export interface GetProductsRequest {
     "price[eq]"?: number;
     /** Price filter for products not equals to particular amount */
     "price[ne]"?: number;
+    /** Alternative price filter for products less than and equals to particular amount */
+    "alternativePrice[lte]"?: number;
+    /** Alternative price filter for products greater than and equals to particular amount */
+    "alternativePrice[gte]"?: number;
+    /** Alternative price filter for products less than particular amount */
+    "alternativePrice[lt]"?: number;
+    /** Alternative price filter for products greater than particular amount */
+    "alternativePrice[gt]"?: number;
+    /** Alternative price filter for products equals to particular amount */
+    "alternativePrice[eq]"?: number;
+    /** Alternative price filter for products not equals to particular amount */
+    "alternativePrice[ne]"?: number;
     /** Filter by categories ids */
     categories?: string | string[];
-    /** Filter (urlencoded) the orders 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 products 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 orders 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 products 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;
+    /** Sort the results by a specific field. Default sort field is `created_at` when not passed. */
+    sortByField?: Brevo.GetProductsRequestSortByField;
     /** Filter products by their deletion status. If `false` is passed, only products that are not deleted will be returned. */
     isDeleted?: string;
 }

package/dist/cjs/api/resources/ecommerce/types/CreateUpdateCategoryResponse.d.ts

@@ -1,4 +1,4 @@
 export interface CreateUpdateCategoryResponse {
     /** ID of the category when a new category is created */
-    id?: number | undefined;
+    id?: string | undefined;
 }

package/dist/cjs/api/resources/ecommerce/types/CreateUpdateProductResponse.d.ts

@@ -1,4 +1,4 @@
 export interface CreateUpdateProductResponse {
-    /** ID of the Product when a new product is created */
-    id?: number | undefined;
+    /** ID of the product when a new product is created */
+    id?: string | undefined;
 }

package/dist/cjs/api/resources/ecommerce/types/GetProductsRequestSortByField.d.ts

@@ -0,0 +1,7 @@
+export declare const GetProductsRequestSortByField: {
+    readonly CreatedAt: "created_at";
+    readonly Name: "name";
+    readonly Price: "price";
+    readonly Id: "id";
+};
+export type GetProductsRequestSortByField = (typeof GetProductsRequestSortByField)[keyof typeof GetProductsRequestSortByField];

package/dist/cjs/api/resources/ecommerce/types/GetProductsRequestSortByField.js

@@ -0,0 +1,10 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetProductsRequestSortByField = void 0;
+exports.GetProductsRequestSortByField = {
+    CreatedAt: "created_at",
+    Name: "name",
+    Price: "price",
+    Id: "id",
+};

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

@@ -13,5 +13,6 @@ export * from "./GetEcommerceAttributionProductsConversionSourceConversionSource
 export * from "./GetEcommerceConfigDisplayCurrencyResponse.js";
 export * from "./GetOrdersRequestSort.js";
 export * from "./GetProductsRequestSort.js";
+export * from "./GetProductsRequestSortByField.js";
 export * from "./GetProductsResponse.js";
 export * from "./SetConfigDisplayCurrencyResponse.js";

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

@@ -29,5 +29,6 @@ __exportStar(require("./GetEcommerceAttributionProductsConversionSourceConversio
 __exportStar(require("./GetEcommerceConfigDisplayCurrencyResponse.js"), exports);
 __exportStar(require("./GetOrdersRequestSort.js"), exports);
 __exportStar(require("./GetProductsRequestSort.js"), exports);
+__exportStar(require("./GetProductsRequestSortByField.js"), exports);
 __exportStar(require("./GetProductsResponse.js"), exports);
 __exportStar(require("./SetConfigDisplayCurrencyResponse.js"), exports);

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

@@ -12,7 +12,7 @@ export declare class EmailCampaignsClient {
     constructor(options: EmailCampaignsClient.Options);
     /**
      * <Note>The response payload for this endpoint has changed
-     * You now need to specify which type of statistics you would like to retrieve. For more information visit [this page](https://developers.brevo.com/changelog/get-all-marketing-campaigns).</Note>
+     * You now need to specify which type of statistics you would like to retrieve. For more information visit [this page](https://developers.brevo.com/changelog/2023/2/7).</Note>
      *
      * @param {Brevo.GetEmailCampaignsRequest} request
      * @param {EmailCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -25,10 +25,13 @@ export declare class EmailCampaignsClient {
     getEmailCampaigns(request?: Brevo.GetEmailCampaignsRequest, requestOptions?: EmailCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetEmailCampaignsResponse>;
     private __getEmailCampaigns;
     /**
+     * Create a new email campaign. The campaign requires at minimum a name and sender details, and is created in draft status by default. You must provide email content via one of three mutually exclusive options: htmlContent (inline HTML), htmlUrl (remote URL), or templateId (existing template); additionally, A/B testing can be enabled by setting abTesting to true with subjectA and subjectB, but this is incompatible with sendAtBestTime.
+     *
      * @param {Brevo.CreateEmailCampaignRequest} request
      * @param {EmailCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Brevo.BadRequestError}
+     * @throws {@link Brevo.MethodNotAllowedError}
      *
      * @example
      *     await client.emailCampaigns.createEmailCampaign({
@@ -39,6 +42,8 @@ export declare class EmailCampaignsClient {
     createEmailCampaign(request: Brevo.CreateEmailCampaignRequest, requestOptions?: EmailCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateEmailCampaignResponse>;
     private __createEmailCampaign;
     /**
+     * Upload an image to your account''s image gallery by providing an absolute URL to the image. The maximum allowed image size is 2MB and supported formats are jpeg, jpg, png, bmp, and gif; local file uploads are not supported.
+     *
      * @param {Brevo.UploadImageToGalleryRequest} request
      * @param {EmailCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -52,6 +57,8 @@ export declare class EmailCampaignsClient {
     uploadImageToGallery(request: Brevo.UploadImageToGalleryRequest, requestOptions?: EmailCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.UploadImageToGalleryResponse>;
     private __uploadImageToGallery;
     /**
+     * Retrieve detailed information about a specific email campaign by its ID, including recipients, statistics, and HTML content. Use the statistics query parameter to select which statistics to include (globalStats, linksStats, statsByDomain, statsByDevice, or statsByBrowser); statsByDevice and statsByBrowser are only available on this single-campaign endpoint. You can exclude HTML content from the response by setting excludeHtmlContent to true.
+     *
      * @param {Brevo.GetEmailCampaignRequest} request
      * @param {EmailCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -66,11 +73,14 @@ export declare class EmailCampaignsClient {
     getEmailCampaign(request: Brevo.GetEmailCampaignRequest, requestOptions?: EmailCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetEmailCampaignResponse>;
     private __getEmailCampaign;
     /**
+     * Update an existing email campaign''s properties such as name, subject, content, sender, recipients, schedule, and A/B testing configuration. The campaign must exist and the request body must contain at least one valid field to update. Only draft or scheduled campaigns can be modified; if sendAtBestTime is enabled, IP warmup will be automatically disabled.
+     *
      * @param {Brevo.UpdateEmailCampaignRequest} request
      * @param {EmailCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Brevo.BadRequestError}
      * @throws {@link Brevo.NotFoundError}
+     * @throws {@link Brevo.MethodNotAllowedError}
      *
      * @example
      *     await client.emailCampaigns.updateEmailCampaign({
@@ -80,10 +90,13 @@ export declare class EmailCampaignsClient {
     updateEmailCampaign(request: Brevo.UpdateEmailCampaignRequest, requestOptions?: EmailCampaignsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __updateEmailCampaign;
     /**
+     * Delete an email campaign by its campaign ID. Only campaigns that have not been scheduled can be deleted; attempting to delete a campaign that has already been scheduled will return a 403 permission denied error. Related data in templates, newsletter builder, and schedule collections is also cleaned up.
+     *
      * @param {Brevo.DeleteEmailCampaignRequest} request
      * @param {EmailCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Brevo.BadRequestError}
+     * @throws {@link Brevo.ForbiddenError}
      * @throws {@link Brevo.NotFoundError}
      *
      * @example
@@ -110,6 +123,8 @@ export declare class EmailCampaignsClient {
     getAbTestCampaignResult(request: Brevo.GetAbTestCampaignResultRequest, requestOptions?: EmailCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetAbTestCampaignResultResponse>;
     private __getAbTestCampaignResult;
     /**
+     * Export the recipients of a sent email campaign as an asynchronous process, filtered by recipient type (e.g. openers, clickers, hardBounces). The recipientsType field is required and determines which subset of recipients to export. An optional notifyURL webhook will be called once the export is complete, and the response returns a processId to track the export status.
+     *
      * @param {Brevo.EmailExportRecipientsRequest} request
      * @param {EmailCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -125,6 +140,8 @@ export declare class EmailCampaignsClient {
     emailExportRecipients(request: Brevo.EmailExportRecipientsRequest, requestOptions?: EmailCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.EmailExportRecipientsResponse>;
     private __emailExportRecipients;
     /**
+     * Send an existing email campaign immediately by scheduling it for the current time. The campaign must have valid recipients and content configured before sending. The system verifies your account''s send limit and credit balance before dispatching; if credits are insufficient, a 402 error is returned.
+     *
      * @param {Brevo.SendEmailCampaignNowRequest} request
      * @param {EmailCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -162,6 +179,8 @@ export declare class EmailCampaignsClient {
     sendReport(request: Brevo.SendReportRequest, requestOptions?: EmailCampaignsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __sendReport;
     /**
+     * Send a test version of an email campaign to specified email addresses or your entire test list. If the emailTo array is left empty, the test mail will be sent to all addresses in your test list. You can send a maximum of 50 test emails per day.
+     *
      * @param {Brevo.SendTestEmailRequest} request
      * @param {EmailCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -194,6 +213,8 @@ export declare class EmailCampaignsClient {
     getSharedTemplateUrl(request: Brevo.GetSharedTemplateUrlRequest, requestOptions?: EmailCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetSharedTemplateUrlResponse>;
     private __getSharedTemplateUrl;
     /**
+     * Update the status of an email 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.UpdateCampaignStatusRequest} request
      * @param {EmailCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *