@getbrevo/brevo 5.0.0 → 5.0.3

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

@@ -464,6 +464,113 @@ export class CompaniesClient {
             return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/crm/attributes");
         });
     }
+    /**
+     * @param {Brevo.DeleteCrmAttributesIdRequest} request
+     * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Brevo.BadRequestError}
+     * @throws {@link Brevo.NotFoundError}
+     *
+     * @example
+     *     await client.companies.deleteAnAttribute({
+     *         id: "id"
+     *     })
+     */
+    deleteAnAttribute(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__deleteAnAttribute(request, requestOptions));
+    }
+    __deleteAnAttribute(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { id } = request;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `crm/attributes/${core.url.encodePathParam(id)}`),
+                method: "DELETE",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                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,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: undefined, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Brevo.NotFoundError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.BrevoError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/crm/attributes/{id}");
+        });
+    }
+    /**
+     * @param {Brevo.PatchCrmAttributesIdRequest} request
+     * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Brevo.BadRequestError}
+     * @throws {@link Brevo.NotFoundError}
+     *
+     * @example
+     *     await client.companies.updateAnAttribute({
+     *         id: "id"
+     *     })
+     */
+    updateAnAttribute(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__updateAnAttribute(request, requestOptions));
+    }
+    __updateAnAttribute(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { id } = request, _body = __rest(request, ["id"]);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `crm/attributes/${core.url.encodePathParam(id)}`),
+                method: "PATCH",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                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,
+                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,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: undefined, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Brevo.NotFoundError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.BrevoError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/crm/attributes/{id}");
+        });
+    }
     /**
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/esm/api/resources/companies/client/requests/DeleteCrmAttributesIdRequest.d.mts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         id: "id"
+ *     }
+ */
+export interface DeleteCrmAttributesIdRequest {
+    /** Attribute ID */
+    id: string;
+}

package/dist/esm/api/resources/companies/client/requests/DeleteCrmAttributesIdRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/companies/client/requests/PatchCrmAttributesIdRequest.d.mts

@@ -0,0 +1,33 @@
+/**
+ * @example
+ *     {
+ *         id: "id"
+ *     }
+ */
+export interface PatchCrmAttributesIdRequest {
+    /** Attribute ID */
+    id: string;
+    /** Attribute display label */
+    label?: string;
+    /** Updated labels for selectable options */
+    optionsLabels?: PatchCrmAttributesIdRequest.OptionsLabels.Item[];
+    /** The type of object the attribute belongs to, it cannot be updated after creation */
+    objectType?: PatchCrmAttributesIdRequest.ObjectType;
+}
+export declare namespace PatchCrmAttributesIdRequest {
+    type OptionsLabels = OptionsLabels.Item[];
+    namespace OptionsLabels {
+        interface Item {
+            /** Internal option identifier */
+            key: string;
+            /** Display label for the option */
+            value: string;
+        }
+    }
+    /** The type of object the attribute belongs to, it cannot be updated after creation */
+    const ObjectType: {
+        readonly Companies: "companies";
+        readonly Deals: "deals";
+    };
+    type ObjectType = (typeof ObjectType)[keyof typeof ObjectType];
+}

package/dist/esm/api/resources/companies/client/requests/PatchCrmAttributesIdRequest.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export var PatchCrmAttributesIdRequest;
+(function (PatchCrmAttributesIdRequest) {
+    /** The type of object the attribute belongs to, it cannot be updated after creation */
+    PatchCrmAttributesIdRequest.ObjectType = {
+        Companies: "companies",
+        Deals: "deals",
+    };
+})(PatchCrmAttributesIdRequest || (PatchCrmAttributesIdRequest = {}));

package/dist/esm/api/resources/companies/client/requests/index.d.mts

@@ -1,8 +1,10 @@
 export type { DeleteCompaniesIdRequest } from "./DeleteCompaniesIdRequest.mjs";
+export type { DeleteCrmAttributesIdRequest } from "./DeleteCrmAttributesIdRequest.mjs";
 export type { GetCompaniesIdRequest } from "./GetCompaniesIdRequest.mjs";
 export type { GetCompaniesRequest } from "./GetCompaniesRequest.mjs";
 export type { PatchCompaniesIdRequest } from "./PatchCompaniesIdRequest.mjs";
 export type { PatchCompaniesLinkUnlinkIdRequest } from "./PatchCompaniesLinkUnlinkIdRequest.mjs";
+export { PatchCrmAttributesIdRequest } from "./PatchCrmAttributesIdRequest.mjs";
 export type { PostCompaniesImportRequest } from "./PostCompaniesImportRequest.mjs";
 export type { PostCompaniesRequest } from "./PostCompaniesRequest.mjs";
 export { PostCrmAttributesRequest } from "./PostCrmAttributesRequest.mjs";

package/dist/esm/api/resources/companies/client/requests/index.mjs

@@ -1 +1,2 @@
+export { PatchCrmAttributesIdRequest } from "./PatchCrmAttributesIdRequest.mjs";
 export { PostCrmAttributesRequest } from "./PostCrmAttributesRequest.mjs";

package/dist/esm/api/resources/companies/exports.d.mts

@@ -0,0 +1,2 @@
+export { CompaniesClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/companies/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { CompaniesClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/companies/types/GetCompaniesResponse.d.mts

@@ -4,5 +4,5 @@ import type * as Brevo from "../../../index.mjs";
  */
 export interface GetCompaniesResponse {
     /** List of companies */
-    items?: Brevo.Company[];
+    items?: Brevo.Company[] | undefined;
 }

package/dist/esm/api/resources/companies/types/GetCrmAttributesCompaniesResponseItem.d.mts

@@ -2,9 +2,9 @@
  * List of attributes
  */
 export interface GetCrmAttributesCompaniesResponseItem {
-    attributeOptions?: Record<string, unknown>[];
-    attributeTypeName?: string;
-    internalName?: string;
-    isRequired?: boolean;
-    label?: string;
+    attributeOptions?: Record<string, unknown>[] | undefined;
+    attributeTypeName?: string | undefined;
+    internalName?: string | undefined;
+    isRequired?: boolean | undefined;
+    label?: string | undefined;
 }

package/dist/esm/api/resources/companies/types/PostCompaniesImportResponse.d.mts

@@ -1,4 +1,4 @@
 export interface PostCompaniesImportResponse {
     /** The ID of the import process */
-    processId?: number;
+    processId?: number | undefined;
 }

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

@@ -11,14 +11,6 @@ export declare class ContactsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<ContactsClient.Options>;
     constructor(options: ContactsClient.Options);
     /**
-     * <Note title="Follow this format when passing a SMS phone number as an attribute">
-     * Accepted Number Formats
-     *
-     * 91xxxxxxxxxx
-     * +91xxxxxxxxxx
-     * 0091xxxxxxxxxx
-     * </Note>
-     *
      * @param {Brevo.GetContactsRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -31,6 +23,8 @@ export declare class ContactsClient {
     getContacts(request?: Brevo.GetContactsRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetContacts>;
     private __getContacts;
     /**
+     * <Note>Follow this format when passing a "SMS" phone number as an attribute.
+     * Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx</Note>
      * Creates new contacts on Brevo. Contacts can be created by passing either - <br><br> 1. email address of the contact (email_id),  <br> 2. phone number of the contact (to be passed as "SMS" field in "attributes" along with proper country code), For example- {"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"} <br> 3. ext_id <br>
      *
      * @param {Brevo.CreateContactRequest} request
@@ -124,9 +118,7 @@ export declare class ContactsClient {
     updateBatchContacts(request?: Brevo.UpdateBatchContactsRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __updateBatchContacts;
     /**
-     * <Note title="How to use attributes param?">
-     * attributes param in this endpoint is an object containing key-value pairs where values can be either a string, integer, array, or boolean. You can create key-value pairs with these four datatypes. When a value is an array, it should be an array of strings.
-     * </Note>
+     * <Note title="How to use attributes param?">attributes param in this endpoint is an object containing key-value pairs where values can be either a string, integer, array, or boolean. You can create key-value pairs with these four datatypes. When a value is an array, it should be an array of strings.</Note>
      *
      * @param {Brevo.CreateDoiContactRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -160,17 +152,11 @@ export declare class ContactsClient {
     requestContactExport(request: Brevo.RequestContactExportRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<Brevo.RequestContactExportResponse>;
     private __requestContactExport;
     /**
-     * <Note>
-     * Ongoing changes for this endpoint
-     *
+     * <Note>Ongoing changes for this endpoint
      * We're dropping support for the response attributes totalSubscribers and totalBlacklisted.
-     *
      * These are non breaking changes.
-     *
      * The default value for the attributes will be 0.
-     *
-     * The uniqueSubscribers field is deprecated
-     * </Note>
+     * The uniqueSubscribers field is deprecated</Note>
      *
      * @param {Brevo.GetFoldersRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -194,13 +180,9 @@ export declare class ContactsClient {
     createFolder(request: Brevo.CreateUpdateFolder, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateFolderResponse>;
     private __createFolder;
     /**
-     * <Note>
-     * Ongoing changes for this endpoint.
-     *
+     * <Note>Ongoing changes for this endpoint.
      * We're dropping support for the response attributes totalSubscribers and totalBlacklisted.
-     *
-     * These are non breaking changes. The default value for the attributes will be 0.
-     * </Note>
+     * These are non breaking changes. The default value for the attributes will be 0.</Note>
      *
      * @param {Brevo.GetFolderRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -245,13 +227,9 @@ export declare class ContactsClient {
     deleteFolder(request: Brevo.DeleteFolderRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteFolder;
     /**
-     * <Note>
-     * Ongoing changes for this endpoint.
-     *
+     * <Note>Ongoing changes for this endpoint.
      * We're dropping support for the response attributes totalSubscribers and totalBlacklisted.
-     *
-     * These are non breaking changes. The default value for the attributes will be 0.
-     * </Note>
+     * These are non breaking changes. The default value for the attributes will be 0.</Note>
      *
      * @param {Brevo.GetFolderListsRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -280,13 +258,9 @@ export declare class ContactsClient {
     importContacts(request?: Brevo.ImportContactsRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<Brevo.ImportContactsResponse>;
     private __importContacts;
     /**
-     * <Note>
-     * Ongoing changes for this endpoint.
-     *
+     * <Note>Ongoing changes for this endpoint.
      * We're dropping support for the response attributes totalSubscribers and totalBlacklisted.
-     *
-     * These are non breaking changes. The default value for the attributes will be 0.
-     * </Note>
+     * These are non breaking changes. The default value for the attributes will be 0.</Note>
      *
      * @param {Brevo.GetListsRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -454,14 +428,8 @@ export declare class ContactsClient {
     getSegments(request?: Brevo.GetSegmentsRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetSegmentsResponse>;
     private __getSegments;
     /**
-     * <Note title="Follow this format when passing a SMS phone number as an attribute">
-     * Accepted Number Formats
-     *
-     * 91xxxxxxxxxx
-     * +91xxxxxxxxxx
-     * 0091xxxxxxxxxx
-     * </Note>
-     *
+     * <Note>Follow this format when passing a "SMS" phone number as an attribute.
+     * Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx</Note>
      * There are 2 ways to get a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={} <br> <br> Option 1 only works if identifierType is email_id (for EMAIL), phone_id (for SMS) or contact_id (for ID of the contact),where you can directly pass the value of EMAIL, SMS and ID of the contact.   <br><br> Option 2 works for all identifierType, use email_id for EMAIL attribute, phone_id for SMS attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute <br><br>Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats ``https://developers.brevo.com/reference/contacts-7#getcontactstats`` endpoint with the appropriate date ranges.
      *
      * @param {Brevo.GetContactInfoRequest} request
@@ -478,6 +446,8 @@ export declare class ContactsClient {
     getContactInfo(request: Brevo.GetContactInfoRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetContactInfoResponse>;
     private __getContactInfo;
     /**
+     * <Note>Follow this format when passing a "SMS" phone number as an attribute.
+     * Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx <br><br> If a blocklisted contact's email address is updated, it is going to remove that blocklisting from the contact and they will be resubscribed.</Note>
      * There are 2 ways to update a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={} <br> <br> Option 1 only works if identifierType is email_id (for EMAIL) or contact_id (for ID of the contact),where you can directly pass the value of EMAIL and ID of the contact.   <br><br> Option 2 works for all identifierType, use email_id for EMAIL attribute, 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
      *
      * @param {Brevo.UpdateContactRequest} request

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

@@ -31,14 +31,6 @@ export class ContactsClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
-     * <Note title="Follow this format when passing a SMS phone number as an attribute">
-     * Accepted Number Formats
-     *
-     * 91xxxxxxxxxx
-     * +91xxxxxxxxxx
-     * 0091xxxxxxxxxx
-     * </Note>
-     *
      * @param {Brevo.GetContactsRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -99,6 +91,8 @@ export class ContactsClient {
         });
     }
     /**
+     * <Note>Follow this format when passing a "SMS" phone number as an attribute.
+     * Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx</Note>
      * Creates new contacts on Brevo. Contacts can be created by passing either - <br><br> 1. email address of the contact (email_id),  <br> 2. phone number of the contact (to be passed as "SMS" field in "attributes" along with proper country code), For example- {"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"} <br> 3. ext_id <br>
      *
      * @param {Brevo.CreateContactRequest} request
@@ -456,9 +450,7 @@ export class ContactsClient {
         });
     }
     /**
-     * <Note title="How to use attributes param?">
-     * attributes param in this endpoint is an object containing key-value pairs where values can be either a string, integer, array, or boolean. You can create key-value pairs with these four datatypes. When a value is an array, it should be an array of strings.
-     * </Note>
+     * <Note title="How to use attributes param?">attributes param in this endpoint is an object containing key-value pairs where values can be either a string, integer, array, or boolean. You can create key-value pairs with these four datatypes. When a value is an array, it should be an array of strings.</Note>
      *
      * @param {Brevo.CreateDoiContactRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -570,17 +562,11 @@ export class ContactsClient {
         });
     }
     /**
-     * <Note>
-     * Ongoing changes for this endpoint
-     *
+     * <Note>Ongoing changes for this endpoint
      * We're dropping support for the response attributes totalSubscribers and totalBlacklisted.
-     *
      * These are non breaking changes.
-     *
      * The default value for the attributes will be 0.
-     *
-     * The uniqueSubscribers field is deprecated
-     * </Note>
+     * The uniqueSubscribers field is deprecated</Note>
      *
      * @param {Brevo.GetFoldersRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -683,13 +669,9 @@ export class ContactsClient {
         });
     }
     /**
-     * <Note>
-     * Ongoing changes for this endpoint.
-     *
+     * <Note>Ongoing changes for this endpoint.
      * We're dropping support for the response attributes totalSubscribers and totalBlacklisted.
-     *
-     * These are non breaking changes. The default value for the attributes will be 0.
-     * </Note>
+     * These are non breaking changes. The default value for the attributes will be 0.</Note>
      *
      * @param {Brevo.GetFolderRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -851,13 +833,9 @@ export class ContactsClient {
         });
     }
     /**
-     * <Note>
-     * Ongoing changes for this endpoint.
-     *
+     * <Note>Ongoing changes for this endpoint.
      * We're dropping support for the response attributes totalSubscribers and totalBlacklisted.
-     *
-     * These are non breaking changes. The default value for the attributes will be 0.
-     * </Note>
+     * These are non breaking changes. The default value for the attributes will be 0.</Note>
      *
      * @param {Brevo.GetFolderListsRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -967,13 +945,9 @@ export class ContactsClient {
         });
     }
     /**
-     * <Note>
-     * Ongoing changes for this endpoint.
-     *
+     * <Note>Ongoing changes for this endpoint.
      * We're dropping support for the response attributes totalSubscribers and totalBlacklisted.
-     *
-     * These are non breaking changes. The default value for the attributes will be 0.
-     * </Note>
+     * These are non breaking changes. The default value for the attributes will be 0.</Note>
      *
      * @param {Brevo.GetListsRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -1508,14 +1482,8 @@ export class ContactsClient {
         });
     }
     /**
-     * <Note title="Follow this format when passing a SMS phone number as an attribute">
-     * Accepted Number Formats
-     *
-     * 91xxxxxxxxxx
-     * +91xxxxxxxxxx
-     * 0091xxxxxxxxxx
-     * </Note>
-     *
+     * <Note>Follow this format when passing a "SMS" phone number as an attribute.
+     * Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx</Note>
      * There are 2 ways to get a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={} <br> <br> Option 1 only works if identifierType is email_id (for EMAIL), phone_id (for SMS) or contact_id (for ID of the contact),where you can directly pass the value of EMAIL, SMS and ID of the contact.   <br><br> Option 2 works for all identifierType, use email_id for EMAIL attribute, phone_id for SMS attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute <br><br>Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats ``https://developers.brevo.com/reference/contacts-7#getcontactstats`` endpoint with the appropriate date ranges.
      *
      * @param {Brevo.GetContactInfoRequest} request
@@ -1575,6 +1543,8 @@ export class ContactsClient {
         });
     }
     /**
+     * <Note>Follow this format when passing a "SMS" phone number as an attribute.
+     * Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx <br><br> If a blocklisted contact's email address is updated, it is going to remove that blocklisting from the contact and they will be resubscribed.</Note>
      * There are 2 ways to update a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={} <br> <br> Option 1 only works if identifierType is email_id (for EMAIL) or contact_id (for ID of the contact),where you can directly pass the value of EMAIL and ID of the contact.   <br><br> Option 2 works for all identifierType, use email_id for EMAIL attribute, 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
      *
      * @param {Brevo.UpdateContactRequest} request

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

@@ -23,30 +23,6 @@ import type * as Brevo from "../../../../index.mjs";
  *             ids: [1, 2]
  *         }
  *     }
- *
- * @example
- *     {
- *         listId: 1000000,
- *         body: {
- *             emails: ["jeff32@example.com", "jim56@example.com"]
- *         }
- *     }
- *
- * @example
- *     {
- *         listId: 1000000,
- *         body: {
- *             emails: ["jeff32@example.com", "jim56@example.com"]
- *         }
- *     }
- *
- * @example
- *     {
- *         listId: 1000000,
- *         body: {
- *             emails: ["jeff32@example.com", "jim56@example.com"]
- *         }
- *     }
  */
 export interface AddContactToListRequest {
     /** Id of the list */

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

@@ -31,8 +31,8 @@ export declare namespace ImportContactsRequest {
     namespace JsonBody {
         interface Item {
             /** List of attributes to be imported */
-            attributes?: Record<string, unknown>;
-            email?: string;
+            attributes?: Record<string, unknown> | undefined;
+            email?: string | undefined;
         }
     }
     /**
@@ -40,8 +40,8 @@ export declare namespace ImportContactsRequest {
      */
     interface NewList {
         /** Id of the folder where this new list shall be created. **Mandatory if listName is not empty** */
-        folderId?: number;
+        folderId?: number | undefined;
         /** List with listName will be created first and users will be imported in it. **Mandatory if listIds is empty**. */
-        listName?: string;
+        listName?: string | undefined;
     }
 }

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

@@ -31,38 +31,6 @@ import type * as Brevo from "../../../../index.mjs";
  *             ids: [1, 2]
  *         }
  *     }
- *
- * @example
- *     {
- *         listId: 1000000,
- *         body: {
- *             all: true
- *         }
- *     }
- *
- * @example
- *     {
- *         listId: 1000000,
- *         body: {
- *             all: true
- *         }
- *     }
- *
- * @example
- *     {
- *         listId: 1000000,
- *         body: {
- *             all: true
- *         }
- *     }
- *
- * @example
- *     {
- *         listId: 1000000,
- *         body: {
- *             all: true
- *         }
- *     }
  */
 export interface RemoveContactFromListRequest {
     /** Id of the list */

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

@@ -28,19 +28,19 @@ export declare namespace RequestContactExportRequest {
      */
     interface CustomContactFilter {
         /** **Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed.** This will export the contacts on the basis of provided action applied on contacts as per the list id. * **allContacts** - Fetch the list of all contacts for a particular list. * **subscribed & unsubscribed** - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * **unsubscribedPerList** - Fetch the list of contacts that are unsubscribed from a particular list only. */
-        actionForContacts?: CustomContactFilter.ActionForContacts;
+        actionForContacts?: CustomContactFilter.ActionForContacts | undefined;
         /** **Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed.** This will export the contacts on the basis of provided action applied on email campaigns. * **openers & nonOpeners** - emailCampaignId is mandatory. Fetch the list of readers / non-readers for a particular email campaign. * **clickers & nonClickers** - emailCampaignId is mandatory. Fetch the list of clickers / non-clickers for a particular email campaign. * **unsubscribed** - emailCampaignId is mandatory. Fetch the list of all unsubscribed (blacklisted via any means) contacts for a particular email campaign. * **hardBounces & softBounces** - emailCampaignId is optional. Fetch the list of hard bounces / soft bounces for a particular / all email campaign(s). */
-        actionForEmailCampaigns?: CustomContactFilter.ActionForEmailCampaigns;
+        actionForEmailCampaigns?: CustomContactFilter.ActionForEmailCampaigns | undefined;
         /** **Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed.** This will export the contacts on the basis of provided action applied on sms campaigns. * **unsubscribed** - Fetch the list of all unsubscribed (blacklisted via any means) contacts for all / particular sms campaigns. * **hardBounces & softBounces** - Fetch the list of hard bounces / soft bounces for all / particular sms campaigns. */
-        actionForSmsCampaigns?: CustomContactFilter.ActionForSmsCampaigns;
+        actionForSmsCampaigns?: CustomContactFilter.ActionForSmsCampaigns | undefined;
         /** Considered only if **actionForEmailCampaigns** is passed, ignored otherwise. **Mandatory if action is one of the following - openers, nonOpeners, clickers, nonClickers, unsubscribed.** The id of the email campaign for which the corresponding action shall be applied in the filter. */
-        emailCampaignId?: number;
+        emailCampaignId?: number | undefined;
         /** ID of the list. This is mandatory if actionForContacts is specified and segmentId is not provided. Either segmentId or listId must be included. */
-        listId?: number;
+        listId?: number | undefined;
         /** ID of the segment. This is mandatory if actionForContacts is specified and listId is not provided. Either segmentId or listId must be included. */
-        segmentId?: number;
+        segmentId?: number | undefined;
         /** Considered only if **actionForSmsCampaigns** is passed, ignored otherwise. The id of sms campaign for which the corresponding action shall be applied in the filter. */
-        smsCampaignId?: number;
+        smsCampaignId?: number | undefined;
     }
     namespace CustomContactFilter {
         /** **Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed.** This will export the contacts on the basis of provided action applied on contacts as per the list id. * **allContacts** - Fetch the list of all contacts for a particular list. * **subscribed & unsubscribed** - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * **unsubscribedPerList** - Fetch the list of contacts that are unsubscribed from a particular list only. */