@getbrevo/brevo 5.0.4 → 6.0.1

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

@@ -68,7 +68,7 @@ class EmailCampaignsClient {
     }
     /**
      * <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.
@@ -84,7 +84,7 @@ class EmailCampaignsClient {
     __getEmailCampaigns() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { type: type_, status, statistics, startDate, endDate, limit, offset, sort, excludeHtmlContent, } = request;
+            const { type: type_, status, statistics, startDate, endDate, limit, offset, sort, excludeHtmlContent, excludePdfAttachment, } = request;
             const _queryParams = {
                 type: type_ != null ? type_ : undefined,
                 status: status != null ? status : undefined,
@@ -95,6 +95,7 @@ class EmailCampaignsClient {
                 offset,
                 sort: sort != null ? sort : undefined,
                 excludeHtmlContent,
+                excludePdfAttachment,
             };
             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);
@@ -102,7 +103,11 @@ class EmailCampaignsClient {
                 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, "emailCampaigns"),
                 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,
@@ -128,10 +133,13 @@ class EmailCampaignsClient {
         });
     }
     /**
+     * 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({
@@ -152,7 +160,7 @@ class EmailCampaignsClient {
                 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,
@@ -168,6 +176,8 @@ class EmailCampaignsClient {
                 switch (_response.error.statusCode) {
                     case 400:
                         throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 405:
+                        throw new Brevo.MethodNotAllowedError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.BrevoError({
                             statusCode: _response.error.statusCode,
@@ -180,6 +190,8 @@ class EmailCampaignsClient {
         });
     }
     /**
+     * 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.
      *
@@ -203,7 +215,7 @@ class EmailCampaignsClient {
                 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,
@@ -231,6 +243,8 @@ class EmailCampaignsClient {
         });
     }
     /**
+     * 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.
      *
@@ -259,7 +273,11 @@ class EmailCampaignsClient {
                 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, `emailCampaigns/${core.url.encodePathParam(campaignId)}`),
                 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,
@@ -287,11 +305,14 @@ class EmailCampaignsClient {
         });
     }
     /**
+     * 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({
@@ -312,7 +333,7 @@ class EmailCampaignsClient {
                 method: "PUT",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
                 body: _body,
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -330,6 +351,8 @@ class EmailCampaignsClient {
                         throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Brevo.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 405:
+                        throw new Brevo.MethodNotAllowedError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.BrevoError({
                             statusCode: _response.error.statusCode,
@@ -342,10 +365,13 @@ class EmailCampaignsClient {
         });
     }
     /**
+     * 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
@@ -366,7 +392,7 @@ class EmailCampaignsClient {
                 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, `emailCampaigns/${core.url.encodePathParam(campaignId)}`),
                 method: "DELETE",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
                 maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -380,6 +406,8 @@ class EmailCampaignsClient {
                 switch (_response.error.statusCode) {
                     case 400:
                         throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Brevo.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Brevo.NotFoundError(_response.error.body, _response.rawResponse);
                     default:
@@ -420,7 +448,7 @@ class EmailCampaignsClient {
                 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, `emailCampaigns/${core.url.encodePathParam(campaignId)}/abTestCampaignResult`),
                 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,
@@ -451,6 +479,8 @@ class EmailCampaignsClient {
         });
     }
     /**
+     * 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.
      *
@@ -477,7 +507,7 @@ class EmailCampaignsClient {
                 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,
@@ -507,6 +537,8 @@ class EmailCampaignsClient {
         });
     }
     /**
+     * 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.
      *
@@ -532,7 +564,7 @@ class EmailCampaignsClient {
                 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, `emailCampaigns/${core.url.encodePathParam(campaignId)}/sendNow`),
                 method: "POST",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
                 maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -595,7 +627,7 @@ class EmailCampaignsClient {
                 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,
@@ -625,6 +657,8 @@ class EmailCampaignsClient {
         });
     }
     /**
+     * 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.
      *
@@ -651,7 +685,7 @@ class EmailCampaignsClient {
                 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,
@@ -708,7 +742,7 @@ class EmailCampaignsClient {
                 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, `emailCampaigns/${core.url.encodePathParam(campaignId)}/sharedUrl`),
                 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,
@@ -738,6 +772,8 @@ class EmailCampaignsClient {
         });
     }
     /**
+     * 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.
      *
@@ -764,7 +800,7 @@ class EmailCampaignsClient {
                 method: "PUT",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
                 body: _body,
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,

package/dist/cjs/api/resources/emailCampaigns/client/requests/CreateEmailCampaignRequest.d.ts

@@ -16,9 +16,9 @@ export interface CreateEmailCampaignRequest {
     footer?: string;
     /** Header of the email campaign */
     header?: string;
-    /** Mandatory if htmlUrl and templateId are empty. Body of the message (HTML). */
+    /** **Mandatory if htmlUrl and templateId are empty.** Body of the message (HTML). Must have more than 10 characters and be less than 1MB in size. Cannot be used together with `htmlUrl` or `templateId`. */
     htmlContent?: string;
-    /** **Mandatory if htmlContent and templateId are empty**. Url to the message (HTML). For example: **https://html.domain.com** */
+    /** **Mandatory if htmlContent and templateId are empty.** URL to the message (HTML). Cannot be used together with `htmlContent` or `templateId`. For example: **https://html.domain.com** */
     htmlUrl?: string;
     /** **Mandatory if ipWarmupEnable is set to true**. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. */
     increaseRate?: number;
@@ -44,7 +44,7 @@ export interface CreateEmailCampaignRequest {
     scheduledAt?: string;
     /** Set this to true if you want to send your campaign at best time. */
     sendAtBestTime?: boolean;
-    /** Sender details including id or email and name (_optional_). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: **{"name":"xyz", "email":"example@abc.com"}** **{"name":"xyz", "id":123}** */
+    /** Sender details including id or email and name (optional). Only one of either Sender’s email or Sender’s ID shall be passed in one request at a time. Passing both `email` and `id` will result in an error. For example: **{"name":"xyz", "email":"example@abc.com"}** or **{"name":"xyz", "id":123}** */
     sender: CreateEmailCampaignRequest.Sender;
     /** Add the size of your test groups. **Mandatory if abTesting = true & 'recipients' is passed**. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else */
     splitRule?: number;
@@ -56,7 +56,7 @@ export interface CreateEmailCampaignRequest {
     subjectB?: string;
     /** Tag of the campaign */
     tag?: string;
-    /** **Mandatory if htmlContent and htmlUrl are empty**. Id of the transactional email template with status _active_. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. */
+    /** **Mandatory if htmlContent and htmlUrl are empty.** Id of the transactional email template with status _active_. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. Cannot be used together with `htmlContent` or `htmlUrl`. */
     templateId?: number;
     /** To personalize the **To** Field. If you want to include the first name and last name of your recipient, add **{FNAME} {LNAME}**. These contact attributes must already exist in your Brevo account. If input parameter **params** used please use **{{contact.FNAME}} {{contact.LNAME}}** for personalization */
     toField?: string;
@@ -104,12 +104,12 @@ export declare namespace CreateEmailCampaignRequest {
         segmentIds?: number[] | undefined;
     }
     /**
-     * Sender details including id or email and name (_optional_). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: **{"name":"xyz", "email":"example@abc.com"}** **{"name":"xyz", "id":123}**
+     * Sender details including id or email and name (optional). Only one of either Sender’s email or Sender’s ID shall be passed in one request at a time. Passing both `email` and `id` will result in an error. For example: **{"name":"xyz", "email":"example@abc.com"}** or **{"name":"xyz", "id":123}**
      */
     interface Sender {
-        /** Sender email */
+        /** Sender email. Must be a valid email address. Cannot be used together with `id` in the same request. */
         email?: string | undefined;
-        /** Select the sender for the campaign on the basis of sender id. _In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email)_. */
+        /** Select the sender for the campaign on the basis of sender id. Cannot be used together with `email` in the same request. _In order to select a sender with a specific pool of IPs, dedicated IP users shall pass id (instead of email)._ */
         id?: number | undefined;
         /** Sender Name */
         name?: string | undefined;

package/dist/cjs/api/resources/emailCampaigns/client/requests/GetEmailCampaignRequest.d.ts

@@ -8,7 +8,7 @@ import type * as Brevo from "../../../../index.js";
 export interface GetEmailCampaignRequest {
     /** Id of the campaign */
     campaignId: number;
-    /** Filter on type of the statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response. */
+    /** Filter on the type of statistics required. Example: **globalStats** value will only fetch globalStats info of the campaign in the returned response. `statsByDevice` and `statsByBrowser` are only available when retrieving a single campaign (not in the list endpoint). */
     statistics?: Brevo.GetEmailCampaignRequestStatistics;
     /** Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the response body */
     excludeHtmlContent?: boolean;

package/dist/cjs/api/resources/emailCampaigns/client/requests/GetEmailCampaignsRequest.d.ts

@@ -8,11 +8,11 @@ export interface GetEmailCampaignsRequest {
     type?: Brevo.GetEmailCampaignsRequestType;
     /** Filter on the status of the campaign */
     status?: Brevo.GetEmailCampaignsRequestStatus;
-    /** Filter on type of the statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response.This option only returns data for events occurred in the last 6 months.For older campaigns, it’s advisable to use the **Get Campaign Report** endpoint. */
+    /** Filter on the type of statistics required. Example: **globalStats** value will only fetch globalStats info of the campaign in the returned response. This option only returns data for events that occurred in the last 6 months. For older campaigns, it is advisable to use the **Get Campaign Report** endpoint. */
     statistics?: Brevo.GetEmailCampaignsRequestStatistics;
-    /** **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' ) */
+    /** **Mandatory if endDate is used.** Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. **Prefer to pass your timezone in date-time format for accurate result.** Only available if `status` is not passed or is set to `sent`. The date range between `startDate` and `endDate` must not exceed 2 years. `startDate` must not be in the future. */
     startDate?: string;
-    /** **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' ) */
+    /** **Mandatory if startDate is used.** Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. **Prefer to pass your timezone in date-time format for accurate result.** Only available if `status` is not passed or is set to `sent`. The date range between `startDate` and `endDate` must not exceed 2 years. `endDate` must not be in the future. */
     endDate?: string;
     /** Number of documents per page */
     limit?: number;
@@ -20,6 +20,8 @@ export interface GetEmailCampaignsRequest {
     offset?: number;
     /** Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed */
     sort?: Brevo.GetEmailCampaignsRequestSort;
-    /** Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the response body */
+    /** Use this flag to exclude htmlContent from the response body. If set to **true**, the htmlContent field will be returned as an empty string in the response body. */
     excludeHtmlContent?: boolean;
+    /** Use this flag to filter out campaigns that have a PDF attachment. If set to **true**, only campaigns without a PDF attachment (or with no attachment at all) will be returned. */
+    excludePdfAttachment?: boolean;
 }

package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignResponse.d.ts

@@ -30,8 +30,12 @@ export interface GetEmailCampaignResponse {
     winnerCriteria?: string | undefined;
     /** The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` */
     winnerDelay?: number | undefined;
+    /** URL of the attachment file associated with the campaign. Empty string if no attachment is present. */
+    attachmentUrl?: string | undefined;
     /** Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) */
     createdAt: string;
+    /** Expiration date configuration for the email campaign, if set. Contains the duration and unit of the email expiry. */
+    emailExpirationDate?: GetEmailCampaignResponse.EmailExpirationDate | undefined;
     /** Footer of the campaign */
     footer: string;
     /** Header of the campaign */
@@ -53,7 +57,7 @@ export interface GetEmailCampaignResponse {
     sender: GetEmailCampaignResponse.Sender;
     /** Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' */
     sentDate?: string | undefined;
-    /** Link to share the campaign on social medias */
+    /** Link to share the campaign on social media. For trigger campaigns, this returns a descriptive message instead of a URL. For classic campaigns that have not been sent, this also returns a descriptive message. */
     shareLink?: string | undefined;
     /** Tag of the campaign */
     tag?: string | undefined;
@@ -63,12 +67,13 @@ export interface GetEmailCampaignResponse {
     testSent: boolean;
     /** Customisation of the "to" field of the campaign */
     toField?: string | undefined;
-    /** utm parameter associated with campaign */
+    /** The utm_campaign value associated with the campaign. Only present if a UTM campaign value was set. */
     utmCampaignValue?: string | undefined;
-    /** utm id active */
-    utmIDActive?: boolean | undefined;
+    /** The campaign ID used as utm_id parameter. Only present if UTM campaign tracking with ID is enabled. */
+    utmID?: number | undefined;
+    /** The utm_medium value. Set to "EMAIL" when UTM campaign tracking is enabled. */
     utmMedium?: string | undefined;
-    /** source of utm */
+    /** The utm_source value. Set to "Brevo" when UTM campaign tracking is enabled. */
     utmSource?: string | undefined;
     recipients: Brevo.GetCampaignRecipients;
     statistics: Brevo.GetExtendedCampaignStats;
@@ -93,6 +98,24 @@ export declare namespace GetEmailCampaignResponse {
         readonly Trigger: "trigger";
     };
     type Type = (typeof Type)[keyof typeof Type];
+    /**
+     * Expiration date configuration for the email campaign, if set. Contains the duration and unit of the email expiry.
+     */
+    interface EmailExpirationDate {
+        /** Duration of the email expiry */
+        duration?: number | undefined;
+        /** Unit of the duration */
+        unit?: EmailExpirationDate.Unit | undefined;
+    }
+    namespace EmailExpirationDate {
+        /** Unit of the duration */
+        const Unit: {
+            readonly Days: "days";
+            readonly Weeks: "weeks";
+            readonly Months: "months";
+        };
+        type Unit = (typeof Unit)[keyof typeof Unit];
+    }
     interface Sender {
         /** Sender email of the campaign */
         email?: string | undefined;

package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignResponse.js

@@ -21,4 +21,13 @@ var GetEmailCampaignResponse;
         Classic: "classic",
         Trigger: "trigger",
     };
+    let EmailExpirationDate;
+    (function (EmailExpirationDate) {
+        /** Unit of the duration */
+        EmailExpirationDate.Unit = {
+            Days: "days",
+            Weeks: "weeks",
+            Months: "months",
+        };
+    })(EmailExpirationDate = GetEmailCampaignResponse.EmailExpirationDate || (GetEmailCampaignResponse.EmailExpirationDate = {}));
 })(GetEmailCampaignResponse || (exports.GetEmailCampaignResponse = GetEmailCampaignResponse = {}));

package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.d.ts

@@ -38,8 +38,12 @@ export declare namespace GetEmailCampaignsResponse {
             winnerCriteria?: string | undefined;
             /** The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` */
             winnerDelay?: number | undefined;
+            /** URL of the attachment file associated with the campaign. Empty string if no attachment is present. */
+            attachmentUrl?: string | undefined;
             /** Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) */
             createdAt: string;
+            /** Expiration date configuration for the email campaign, if set. Contains the duration and unit of the email expiry. */
+            emailExpirationDate?: Item.EmailExpirationDate | undefined;
             /** Footer of the campaign */
             footer: string;
             /** Header of the campaign */
@@ -71,12 +75,13 @@ export declare namespace GetEmailCampaignsResponse {
             testSent: boolean;
             /** Customisation of the "to" field of the campaign */
             toField?: string | undefined;
-            /** utm parameter associated with campaign */
+            /** The utm_campaign value associated with the campaign. Only present if a UTM campaign value was set. */
             utmCampaignValue?: string | undefined;
-            /** utm id active */
-            utmIDActive?: boolean | undefined;
+            /** The campaign ID used as utm_id parameter. Only present if UTM campaign tracking with ID is enabled. */
+            utmID?: number | undefined;
+            /** The utm_medium value. Set to "EMAIL" when UTM campaign tracking is enabled. */
             utmMedium?: string | undefined;
-            /** source of utm */
+            /** The utm_source value. Set to "Brevo" when UTM campaign tracking is enabled. */
             utmSource?: string | undefined;
             recipients: Brevo.GetCampaignRecipients;
             statistics: Brevo.GetExtendedCampaignStats;
@@ -101,6 +106,24 @@ export declare namespace GetEmailCampaignsResponse {
                 readonly Trigger: "trigger";
             };
             type Type = (typeof Type)[keyof typeof Type];
+            /**
+             * Expiration date configuration for the email campaign, if set. Contains the duration and unit of the email expiry.
+             */
+            interface EmailExpirationDate {
+                /** Duration of the email expiry */
+                duration?: number | undefined;
+                /** Unit of the duration */
+                unit?: EmailExpirationDate.Unit | undefined;
+            }
+            namespace EmailExpirationDate {
+                /** Unit of the duration */
+                const Unit: {
+                    readonly Days: "days";
+                    readonly Weeks: "weeks";
+                    readonly Months: "months";
+                };
+                type Unit = (typeof Unit)[keyof typeof Unit];
+            }
             interface Sender {
                 /** Sender email of the campaign */
                 email?: string | undefined;

package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.js

@@ -25,6 +25,15 @@ var GetEmailCampaignsResponse;
                 Classic: "classic",
                 Trigger: "trigger",
             };
+            let EmailExpirationDate;
+            (function (EmailExpirationDate) {
+                /** Unit of the duration */
+                EmailExpirationDate.Unit = {
+                    Days: "days",
+                    Weeks: "weeks",
+                    Months: "months",
+                };
+            })(EmailExpirationDate = Item.EmailExpirationDate || (Item.EmailExpirationDate = {}));
         })(Item = Campaigns.Item || (Campaigns.Item = {}));
     })(Campaigns = GetEmailCampaignsResponse.Campaigns || (GetEmailCampaignsResponse.Campaigns = {}));
 })(GetEmailCampaignsResponse || (exports.GetEmailCampaignsResponse = GetEmailCampaignsResponse = {}));

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

@@ -49,18 +49,20 @@ export declare class EventClient {
     /**
      * Create multiple events to track contacts' interactions in a single request.
      *
-     * @param {Brevo.CreateBatchEventsRequestItem[]} request
+     * @param {Brevo.CreateBatchEventsRequest} request
      * @param {EventClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Brevo.BadRequestError}
      * @throws {@link Brevo.UnauthorizedError}
      *
      * @example
-     *     await client.event.createBatchEvents([{
-     *             event_name: "order_created",
-     *             identifiers: {}
-     *         }])
+     *     await client.event.createBatchEvents({
+     *         events: [{
+     *                 event_name: "order_created",
+     *                 identifiers: {}
+     *             }]
+     *     })
      */
-    createBatchEvents(request: Brevo.CreateBatchEventsRequestItem[], requestOptions?: EventClient.RequestOptions): core.HttpResponsePromise<Brevo.BatchAcceptedResponse>;
+    createBatchEvents(request: Brevo.CreateBatchEventsRequest, requestOptions?: EventClient.RequestOptions): core.HttpResponsePromise<Brevo.BatchAcceptedResponse>;
     private __createBatchEvents;
 }

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

@@ -94,7 +94,11 @@ class EventClient {
                 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, "events"),
                 method: "GET",
                 headers: _headers,
-                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                queryString: core.url
+                    .queryBuilder()
+                    .addMany(_queryParams)
+                    .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
+                    .build(),
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
                 maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -151,7 +155,7 @@ class EventClient {
                 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,
@@ -183,17 +187,19 @@ class EventClient {
     /**
      * Create multiple events to track contacts' interactions in a single request.
      *
-     * @param {Brevo.CreateBatchEventsRequestItem[]} request
+     * @param {Brevo.CreateBatchEventsRequest} request
      * @param {EventClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Brevo.BadRequestError}
      * @throws {@link Brevo.UnauthorizedError}
      *
      * @example
-     *     await client.event.createBatchEvents([{
-     *             event_name: "order_created",
-     *             identifiers: {}
-     *         }])
+     *     await client.event.createBatchEvents({
+     *         events: [{
+     *                 event_name: "order_created",
+     *                 identifiers: {}
+     *             }]
+     *     })
      */
     createBatchEvents(request, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__createBatchEvents(request, requestOptions));
@@ -208,7 +214,7 @@ class EventClient {
                 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,