@getbrevo/brevo 5.0.3 → 6.0.1

package/dist/esm/api/resources/contacts/client/requests/UpdateContactRequest.d.mts

@@ -6,9 +6,9 @@ import type * as Brevo from "../../../../index.mjs";
  *     }
  */
 export interface UpdateContactRequest {
-    /** Email (urlencoded) OR ID of the contact OR EXT_ID attribute (urlencoded) OR its SMS attribute value OR its WHATSAPP attribute value OR its LANDLINE attribute value */
+    /** Email (urlencoded) OR ID of the contact OR EXT_ID attribute (urlencoded) OR its SMS attribute value OR its WHATSAPP attribute value OR its LANDLINE_NUMBER attribute value */
     identifier: Brevo.UpdateContactRequestIdentifier;
-    /** email_id for Email, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE attribute */
+    /** email_id for Email, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute */
     identifierType?: Brevo.UpdateContactRequestIdentifierType;
     /** Pass the set of attributes to be updated. **These attributes must be present in your account**. To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, **{ "EMAIL":"newemail@domain.com", "FNAME":"Ellie", "LNAME":"Roger", "COUNTRIES":["India","China"]}**. The attribute's parameter should be passed in capital letter while updating a contact. Values that don't match the attribute type (e.g. text or string in a date attribute) will be ignored .Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in **SMS** field should be passed with proper country code. For example: **{"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"}** */
     attributes?: Record<string, UpdateContactRequest.Attributes.Value>;
@@ -24,9 +24,11 @@ export interface UpdateContactRequest {
     smtpBlacklistSender?: string[];
     /** Ids of the lists to remove the contact from */
     unlinkListIds?: number[];
+    /** When true, if the contact being updated shares an identifier (email, SMS, ext_id, whatsapp, landline) with an existing contact, the two contacts are force-merged. The contact with the most recent `last_modified` timestamp is retained; the other is deleted. When false (default), a 4xx error is returned on identifier conflict. */
+    forceMerge?: boolean;
 }
 export declare namespace UpdateContactRequest {
     namespace Attributes {
-        type Value = number | string | boolean | string[];
+        type Value = number | number | string | boolean | string[];
     }
 }

package/dist/esm/api/resources/contacts/types/GetAttributesResponse.d.mts

@@ -34,8 +34,10 @@ export declare namespace GetAttributesResponse {
                 interface Item {
                     /** Label of the "category" type attribute */
                     label: string;
-                    /** ID of Value of the "category" type attribute */
+                    /** Numeric ID of the "category" type attribute value. Set to 0 when the raw value cannot be converted to an integer (for example non-numeric values such as "en" or "fr"). Refer to `valueStr` for the original string representation. */
                     value: number;
+                    /** String representation of the "category" type attribute value. Always contains the original value as stored. Use this field when the attribute value is non-numeric (e.g. "en", "fr") or when you need the exact string form alongside the numeric `value`. */
+                    valueStr: string;
                 }
             }
             /** Type of the attribute */

package/dist/esm/api/resources/contacts/types/GetContactInfoResponse.d.mts

@@ -15,6 +15,8 @@ export interface GetContactInfoResponse {
     modifiedAt: string;
     /** Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) */
     smsBlacklisted: boolean;
+    /** Blacklist status for WhatsApp campaigns (true=blacklisted, false=not blacklisted) */
+    whatsappBlacklisted: boolean;
     /** Campaign statistics of the contact */
     statistics: GetContactInfoResponse.Statistics;
 }
@@ -33,13 +35,13 @@ export declare namespace GetContactInfoResponse {
         complaints?: Statistics.Complaints.Item[] | undefined;
         /** Listing of the delivered campaign for the contact */
         delivered?: Statistics.Delivered.Item[] | undefined;
-        /** Listing of the hardbounes generated by the contact */
+        /** Listing of the hard bounces generated by the contact */
         hardBounces?: Statistics.HardBounces.Item[] | undefined;
         /** Listing of the sent campaign for the contact */
         messagesSent?: Statistics.MessagesSent.Item[] | undefined;
         /** Listing of the openings generated by the contact */
         opened?: Statistics.Opened.Item[] | undefined;
-        /** Listing of the softbounes generated by the contact */
+        /** Listing of the soft bounces generated by the contact */
         softBounces?: Statistics.SoftBounces.Item[] | undefined;
         /** Listing of the transactional attributes for the contact */
         transacAttributes?: Statistics.TransacAttributes.Item[] | undefined;

package/dist/esm/api/resources/contacts/types/GetSegmentsResponse.d.mts

@@ -10,11 +10,11 @@ export declare namespace GetSegmentsResponse {
         interface Item {
             /** Name of the Segment Category */
             categoryName: string;
-            /** ID of the list */
+            /** ID of the segment */
             id: number;
             /** Name of the Segment */
             segmentName: string;
-            /** Updation UTC date-time of the segment (YYYY-MM-DDTHH:mm:ss.SSSZ) */
+            /** Last update UTC date-time of the segment (YYYY-MM-DDTHH:mm:ss.SSSZ) */
             updatedAt?: string | undefined;
         }
     }

package/dist/esm/api/resources/conversations/client/Client.d.mts

@@ -11,7 +11,7 @@ export declare class ConversationsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<ConversationsClient.Options>;
     constructor(options: ConversationsClient.Options);
     /**
-     * We recommend pinging this endpoint every minute for as long as the agent has to be considered online.
+     * Sets the agent's status to online for 2-3 minutes. We recommend pinging this endpoint every minute for as long as the agent has to be considered online. You must provide either `agentId` alone, or all three of `agentEmail` + `agentName` + `receivedFrom`.
      *
      * @param {Brevo.PostConversationsAgentOnlinePingRequest} request
      * @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -33,6 +33,8 @@ export declare class ConversationsClient {
     setsAgentsStatusToOnlineFor23Minutes(request?: Brevo.PostConversationsAgentOnlinePingRequest, requestOptions?: ConversationsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __setsAgentsStatusToOnlineFor23Minutes;
     /**
+     * Send a message as an agent to an existing visitor's conversation. You must provide either `agentId` alone, or all three of `agentEmail` + `agentName` + `receivedFrom` to identify the agent.
+     *
      * @param {Brevo.PostConversationsMessagesRequest} request
      * @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -65,6 +67,8 @@ export declare class ConversationsClient {
     sendAMessageAsAnAgent(request: Brevo.PostConversationsMessagesRequest, requestOptions?: ConversationsClient.RequestOptions): core.HttpResponsePromise<Brevo.ConversationsMessage>;
     private __sendAMessageAsAnAgent;
     /**
+     * Retrieve a single message by its ID.
+     *
      * @param {Brevo.GetConversationsMessagesIdRequest} request
      * @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -79,7 +83,7 @@ export declare class ConversationsClient {
     getAMessage(request: Brevo.GetConversationsMessagesIdRequest, requestOptions?: ConversationsClient.RequestOptions): core.HttpResponsePromise<Brevo.ConversationsMessage>;
     private __getAMessage;
     /**
-     * Only agents’ messages can be edited.
+     * Update the text of a message sent by an agent. Only messages of type `agent` can be edited. The `text` and `html` fields of the message will be updated.
      *
      * @param {Brevo.PutConversationsMessagesIdRequest} request
      * @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -96,7 +100,7 @@ export declare class ConversationsClient {
     updateAMessageSentByAnAgent(request: Brevo.PutConversationsMessagesIdRequest, requestOptions?: ConversationsClient.RequestOptions): core.HttpResponsePromise<Brevo.ConversationsMessage>;
     private __updateAMessageSentByAnAgent;
     /**
-     * Only agents’ messages can be deleted.
+     * Delete a message sent by an agent. Only messages of type `agent` can be deleted.
      *
      * @param {Brevo.DeleteConversationsMessagesIdRequest} request
      * @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -112,7 +116,7 @@ export declare class ConversationsClient {
     deleteAMessageSentByAnAgent(request: Brevo.DeleteConversationsMessagesIdRequest, requestOptions?: ConversationsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteAMessageSentByAnAgent;
     /**
-     * Example of automated messages: order status, announce new features in your web app, etc.
+     * Send an automated (pushed) message to a visitor on behalf of an agent. Example use cases: order status updates, announcing new features in your web app, etc.
      *
      * @param {Brevo.PostConversationsPushedMessagesRequest} request
      * @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -122,26 +126,28 @@ export declare class ConversationsClient {
      * @example
      *     await client.conversations.sendAnAutomatedMessageToAVisitor({
      *         groupId: "PjRBMhWGen6aRHjif",
-     *         text: "Your order has shipped! Here\u2019s your tracking number: 9114 5847 3325 9667 4328 88",
+     *         text: "Your order has shipped! Here's your tracking number: 9114 5847 3325 9667 4328 88",
      *         visitorId: "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg"
      *     })
      *
      * @example
      *     await client.conversations.sendAnAutomatedMessageToAVisitor({
-     *         text: "Your order has shipped! Here\u2019s your tracking number: 9114 5847 3325 9667 4328 88",
+     *         text: "Your order has shipped! Here's your tracking number: 9114 5847 3325 9667 4328 88",
      *         visitorId: "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg"
      *     })
      *
      * @example
      *     await client.conversations.sendAnAutomatedMessageToAVisitor({
      *         agentId: "d9nKoegKSjmCtyK78",
-     *         text: "Your order has shipped! Here\u2019s your tracking number: 9114 5847 3325 9667 4328 88",
+     *         text: "Your order has shipped! Here's your tracking number: 9114 5847 3325 9667 4328 88",
      *         visitorId: "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg"
      *     })
      */
     sendAnAutomatedMessageToAVisitor(request: Brevo.PostConversationsPushedMessagesRequest, requestOptions?: ConversationsClient.RequestOptions): core.HttpResponsePromise<Brevo.ConversationsMessage>;
     private __sendAnAutomatedMessageToAVisitor;
     /**
+     * Retrieve a single automated (pushed) message by its ID.
+     *
      * @param {Brevo.GetConversationsPushedMessagesIdRequest} request
      * @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -156,6 +162,8 @@ export declare class ConversationsClient {
     getAnAutomatedMessage(request: Brevo.GetConversationsPushedMessagesIdRequest, requestOptions?: ConversationsClient.RequestOptions): core.HttpResponsePromise<Brevo.ConversationsMessage>;
     private __getAnAutomatedMessage;
     /**
+     * Update the text of an automated (pushed) message. The `text` and `html` fields of the message will be updated.
+     *
      * @param {Brevo.PutConversationsPushedMessagesIdRequest} request
      * @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -165,12 +173,14 @@ export declare class ConversationsClient {
      * @example
      *     await client.conversations.updateAnAutomatedMessage({
      *         id: "id",
-     *         text: "Your order has shipped! Here\u2019s your tracking number: 9114 5847 4668 7775 9233 54"
+     *         text: "Your order has shipped! Here's your tracking number: 9114 5847 4668 7775 9233 54"
      *     })
      */
     updateAnAutomatedMessage(request: Brevo.PutConversationsPushedMessagesIdRequest, requestOptions?: ConversationsClient.RequestOptions): core.HttpResponsePromise<Brevo.ConversationsMessage>;
     private __updateAnAutomatedMessage;
     /**
+     * Delete an automated (pushed) message by its ID.
+     *
      * @param {Brevo.DeleteConversationsPushedMessagesIdRequest} request
      * @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/esm/api/resources/conversations/client/Client.mjs

@@ -31,7 +31,7 @@ export class ConversationsClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
-     * We recommend pinging this endpoint every minute for as long as the agent has to be considered online.
+     * Sets the agent's status to online for 2-3 minutes. We recommend pinging this endpoint every minute for as long as the agent has to be considered online. You must provide either `agentId` alone, or all three of `agentEmail` + `agentName` + `receivedFrom`.
      *
      * @param {Brevo.PostConversationsAgentOnlinePingRequest} request
      * @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -63,7 +63,7 @@ export class ConversationsClient {
                 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,
@@ -91,6 +91,8 @@ export class ConversationsClient {
         });
     }
     /**
+     * Send a message as an agent to an existing visitor's conversation. You must provide either `agentId` alone, or all three of `agentEmail` + `agentName` + `receivedFrom` to identify the agent.
+     *
      * @param {Brevo.PostConversationsMessagesRequest} request
      * @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -133,7 +135,7 @@ export class ConversationsClient {
                 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,
@@ -161,6 +163,8 @@ export class ConversationsClient {
         });
     }
     /**
+     * Retrieve a single message by its ID.
+     *
      * @param {Brevo.GetConversationsMessagesIdRequest} request
      * @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -185,7 +189,7 @@ export class ConversationsClient {
                 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, `conversations/messages/${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,
@@ -213,7 +217,7 @@ export class ConversationsClient {
         });
     }
     /**
-     * Only agents’ messages can be edited.
+     * Update the text of a message sent by an agent. Only messages of type `agent` can be edited. The `text` and `html` fields of the message will be updated.
      *
      * @param {Brevo.PutConversationsMessagesIdRequest} request
      * @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -241,7 +245,7 @@ export class ConversationsClient {
                 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,
@@ -271,7 +275,7 @@ export class ConversationsClient {
         });
     }
     /**
-     * Only agents’ messages can be deleted.
+     * Delete a message sent by an agent. Only messages of type `agent` can be deleted.
      *
      * @param {Brevo.DeleteConversationsMessagesIdRequest} request
      * @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -297,7 +301,7 @@ export class ConversationsClient {
                 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, `conversations/messages/${core.url.encodePathParam(id)}`),
                 method: "DELETE",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
                 maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -325,7 +329,7 @@ export class ConversationsClient {
         });
     }
     /**
-     * Example of automated messages: order status, announce new features in your web app, etc.
+     * Send an automated (pushed) message to a visitor on behalf of an agent. Example use cases: order status updates, announcing new features in your web app, etc.
      *
      * @param {Brevo.PostConversationsPushedMessagesRequest} request
      * @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -335,20 +339,20 @@ export class ConversationsClient {
      * @example
      *     await client.conversations.sendAnAutomatedMessageToAVisitor({
      *         groupId: "PjRBMhWGen6aRHjif",
-     *         text: "Your order has shipped! Here\u2019s your tracking number: 9114 5847 3325 9667 4328 88",
+     *         text: "Your order has shipped! Here's your tracking number: 9114 5847 3325 9667 4328 88",
      *         visitorId: "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg"
      *     })
      *
      * @example
      *     await client.conversations.sendAnAutomatedMessageToAVisitor({
-     *         text: "Your order has shipped! Here\u2019s your tracking number: 9114 5847 3325 9667 4328 88",
+     *         text: "Your order has shipped! Here's your tracking number: 9114 5847 3325 9667 4328 88",
      *         visitorId: "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg"
      *     })
      *
      * @example
      *     await client.conversations.sendAnAutomatedMessageToAVisitor({
      *         agentId: "d9nKoegKSjmCtyK78",
-     *         text: "Your order has shipped! Here\u2019s your tracking number: 9114 5847 3325 9667 4328 88",
+     *         text: "Your order has shipped! Here's your tracking number: 9114 5847 3325 9667 4328 88",
      *         visitorId: "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg"
      *     })
      */
@@ -365,7 +369,7 @@ export class ConversationsClient {
                 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,
@@ -393,6 +397,8 @@ export class ConversationsClient {
         });
     }
     /**
+     * Retrieve a single automated (pushed) message by its ID.
+     *
      * @param {Brevo.GetConversationsPushedMessagesIdRequest} request
      * @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -417,7 +423,7 @@ export class ConversationsClient {
                 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, `conversations/pushedMessages/${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,
@@ -445,6 +451,8 @@ export class ConversationsClient {
         });
     }
     /**
+     * Update the text of an automated (pushed) message. The `text` and `html` fields of the message will be updated.
+     *
      * @param {Brevo.PutConversationsPushedMessagesIdRequest} request
      * @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -454,7 +462,7 @@ export class ConversationsClient {
      * @example
      *     await client.conversations.updateAnAutomatedMessage({
      *         id: "id",
-     *         text: "Your order has shipped! Here\u2019s your tracking number: 9114 5847 4668 7775 9233 54"
+     *         text: "Your order has shipped! Here's your tracking number: 9114 5847 4668 7775 9233 54"
      *     })
      */
     updateAnAutomatedMessage(request, requestOptions) {
@@ -471,7 +479,7 @@ export class ConversationsClient {
                 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,
@@ -501,6 +509,8 @@ export class ConversationsClient {
         });
     }
     /**
+     * Delete an automated (pushed) message by its ID.
+     *
      * @param {Brevo.DeleteConversationsPushedMessagesIdRequest} request
      * @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -525,7 +535,7 @@ export class ConversationsClient {
                 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, `conversations/pushedMessages/${core.url.encodePathParam(id)}`),
                 method: "DELETE",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
                 maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -579,7 +589,7 @@ export class ConversationsClient {
                 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: 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,

package/dist/esm/api/resources/conversations/client/requests/PostConversationsAgentOnlinePingRequest.d.mts

@@ -12,12 +12,12 @@
  *     }
  */
 export interface PostConversationsAgentOnlinePingRequest {
-    /** agent email. When sending online pings from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. If there’s no agent with the specified email address in your Brevo organization, a dummy agent will be created automatically. */
-    agentEmail?: unknown;
-    /** agent ID. It can be found on agent’s page or received <a href="https://developers.brevo.com/docs/conversations-webhooks">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). */
-    agentId?: unknown;
-    /** agent name */
-    agentName?: unknown;
-    /** mark your messages to distinguish messages created by you from the others. */
-    receivedFrom?: unknown;
+    /** Agent's email address. When sending online pings from a standalone system, it's hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. If there's no agent with the specified email address in your Brevo organization, a dummy agent will be created automatically. */
+    agentEmail?: string;
+    /** Agent ID. It can be found on the agent's page or received <a href="https://developers.brevo.com/docs/conversations-webhooks">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). */
+    agentId?: string;
+    /** Agent's name. */
+    agentName?: string;
+    /** Mark your messages to distinguish messages created by you from the others. */
+    receivedFrom?: string;
 }

package/dist/esm/api/resources/conversations/client/requests/PostConversationsMessagesRequest.d.mts

@@ -24,14 +24,16 @@
  *     }
  */
 export interface PostConversationsMessagesRequest {
-    /** agent email. When sending messages from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. */
-    agentEmail?: unknown;
-    /** agent ID. It can be found on agent’s page or received <a href="https://developers.brevo.com/docs/conversations-webhooks">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). */
-    agentId?: unknown;
-    /** agent name */
-    agentName?: unknown;
-    /** mark your messages to distinguish messages created by you from the others. */
-    receivedFrom?: unknown;
-    text?: unknown;
-    visitorId?: unknown;
+    /** Agent's email address. When sending messages from a standalone system, it's hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. */
+    agentEmail?: string;
+    /** Agent ID. It can be found on the agent's page or received <a href="https://developers.brevo.com/docs/conversations-webhooks">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). */
+    agentId?: string;
+    /** Agent's name. */
+    agentName?: string;
+    /** Mark your messages to distinguish messages created by you from the others. */
+    receivedFrom?: string;
+    /** Message text. */
+    text: string;
+    /** Visitor's ID received <a href="https://developers.brevo.com/docs/conversations-webhooks">from a webhook</a> or generated by you to <a href="https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users">bind an existing user account to Conversations</a>. */
+    visitorId: string;
 }

package/dist/esm/api/resources/conversations/client/requests/PostConversationsPushedMessagesRequest.d.mts

@@ -2,28 +2,30 @@
  * @example
  *     {
  *         groupId: "PjRBMhWGen6aRHjif",
- *         text: "Your order has shipped! Here\u2019s your tracking number: 9114 5847 3325 9667 4328 88",
+ *         text: "Your order has shipped! Here's your tracking number: 9114 5847 3325 9667 4328 88",
  *         visitorId: "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg"
  *     }
  *
  * @example
  *     {
- *         text: "Your order has shipped! Here\u2019s your tracking number: 9114 5847 3325 9667 4328 88",
+ *         text: "Your order has shipped! Here's your tracking number: 9114 5847 3325 9667 4328 88",
  *         visitorId: "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg"
  *     }
  *
  * @example
  *     {
  *         agentId: "d9nKoegKSjmCtyK78",
- *         text: "Your order has shipped! Here\u2019s your tracking number: 9114 5847 3325 9667 4328 88",
+ *         text: "Your order has shipped! Here's your tracking number: 9114 5847 3325 9667 4328 88",
  *         visitorId: "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg"
  *     }
  */
 export interface PostConversationsPushedMessagesRequest {
-    /** agent ID. It can be found on agent’s page or received <a href="https://developers.brevo.com/docs/conversations-webhooks">from a webhook</a>. */
-    agentId?: unknown;
-    /** group ID. It can be found on group’s page. */
-    groupId?: unknown;
-    text?: unknown;
-    visitorId?: unknown;
+    /** Agent ID. It can be found on the agent's page or received <a href="https://developers.brevo.com/docs/conversations-webhooks">from a webhook</a>. */
+    agentId?: string;
+    /** Group ID. It can be found on the group's page. */
+    groupId?: string;
+    /** Message text. */
+    text: string;
+    /** Visitor's ID received <a href="https://developers.brevo.com/docs/conversations-webhooks">from a webhook</a> or generated by you to <a href="https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users">bind an existing user account to Conversations</a>. */
+    visitorId: string;
 }

package/dist/esm/api/resources/conversations/client/requests/PutConversationsMessagesIdRequest.d.mts

@@ -8,6 +8,6 @@
 export interface PutConversationsMessagesIdRequest {
     /** ID of the message */
     id: string;
-    /** edited message text */
+    /** The new message text. */
     text: string;
 }

package/dist/esm/api/resources/conversations/client/requests/PutConversationsPushedMessagesIdRequest.d.mts

@@ -2,12 +2,12 @@
  * @example
  *     {
  *         id: "id",
- *         text: "Your order has shipped! Here\u2019s your tracking number: 9114 5847 4668 7775 9233 54"
+ *         text: "Your order has shipped! Here's your tracking number: 9114 5847 4668 7775 9233 54"
  *     }
  */
 export interface PutConversationsPushedMessagesIdRequest {
     /** ID of the message */
     id: string;
-    /** edited message text */
+    /** The new message text. */
     text: string;
 }

package/dist/esm/api/resources/coupons/client/Client.d.mts

@@ -11,6 +11,8 @@ export declare class CouponsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<CouponsClient.Options>;
     constructor(options: CouponsClient.Options);
     /**
+     * Retrieve a paginated list of all coupon collections in your Brevo account. Results can be sorted by creation date, remaining coupons count, or expiration date, in ascending or descending order. Pagination defaults to 50 collections per page (maximum 100).
+     *
      * @param {Brevo.GetCouponCollectionsRequest} request
      * @param {CouponsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -23,6 +25,8 @@ export declare class CouponsClient {
     getCouponCollections(request?: Brevo.GetCouponCollectionsRequest, requestOptions?: CouponsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetCouponCollection>;
     private __getCouponCollections;
     /**
+     * Create a new coupon collection with a name and a default coupon value. You can optionally set an expiration date in RFC3339 format and configure alert thresholds to receive email notifications when remaining coupons or remaining days before expiration fall below a specified number. The collection ID is auto-generated as a UUID and returned in the response.
+     *
      * @param {Brevo.CreateCouponCollectionRequest} request
      * @param {CouponsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -38,6 +42,8 @@ export declare class CouponsClient {
     createCouponCollection(request: Brevo.CreateCouponCollectionRequest, requestOptions?: CouponsClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateCouponCollectionResponse>;
     private __createCouponCollection;
     /**
+     * Retrieve the details of a single coupon collection by its UUID. The response includes the collection name, default coupon value, total and remaining coupon counts, and creation timestamp. Returns a `404` error if no collection matches the provided ID.
+     *
      * @param {Brevo.GetCouponCollectionRequest} request
      * @param {CouponsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -53,6 +59,8 @@ export declare class CouponsClient {
     getCouponCollection(request: Brevo.GetCouponCollectionRequest, requestOptions?: CouponsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetCouponCollection>;
     private __getCouponCollection;
     /**
+     * Update an existing coupon collection by its UUID. You can modify the default coupon value, set or remove the expiration date (pass `null` to remove), and configure or disable alert thresholds for remaining coupons or remaining days. Only the fields included in the request body are updated; omitted fields remain unchanged.
+     *
      * @param {Brevo.UpdateCouponCollectionRequest} request
      * @param {CouponsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -67,6 +75,8 @@ export declare class CouponsClient {
     updateCouponCollection(request: Brevo.UpdateCouponCollectionRequest, requestOptions?: CouponsClient.RequestOptions): core.HttpResponsePromise<Brevo.UpdateCouponCollectionResponse>;
     private __updateCouponCollection;
     /**
+     * Add coupons to an existing coupon collection. The `coupons` array must contain between 1 and 10,000 unique coupon code strings, all associated with the specified `collectionId`. Coupon creation is processed asynchronously and a `204` status is returned immediately upon acceptance. Returns a `404` error if the specified coupon collection does not exist.
+     *
      * @param {Brevo.CreateCouponsRequest} request
      * @param {CouponsClient.RequestOptions} requestOptions - Request-specific configuration.
      *