@getbrevo/brevo 5.0.3 → 6.0.1

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

@@ -11,6 +11,8 @@ export declare class ContactsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<ContactsClient.Options>;
     constructor(options: ContactsClient.Options);
     /**
+     * Retrieve all contacts from your Brevo account with support for pagination, filtering, and sorting. Results default to 50 contacts per page (maximum 1000) sorted in descending order of creation, and can be filtered by modification date, creation date, contact IDs (up to 20), list IDs, segment ID, or contact attributes using the equals operator. Note that either listIds or segmentId can be passed but not both simultaneously.
+     *
      * @param {Brevo.GetContactsRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -36,17 +38,23 @@ export declare class ContactsClient {
      * @example
      *     await client.contacts.createContact()
      */
-    createContact(request?: Brevo.CreateContactRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateContactResponse>;
+    createContact(request?: Brevo.CreateContactRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateContactResponse | undefined>;
     private __createContact;
     /**
+     * Retrieve all contact attributes defined in your Brevo account, grouped by category (normal, transactional, category, calculated, global). Each attribute includes its name, type, and category, along with enumeration values for category-type attributes and options for multiple-choice-type attributes.
+     *
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Brevo.BadRequestError}
+     *
      * @example
      *     await client.contacts.getAttributes()
      */
     getAttributes(requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetAttributesResponse>;
     private __getAttributes;
     /**
+     * Create a new contact attribute under the specified category and name. The required body properties depend on the category: use "type" for normal, transactional, or category attributes; use "value" for calculated or global attributes; use "enumeration" for category attributes; and use "multiCategoryOptions" for normal multiple-choice attributes. None of the category or multicategory option values can exceed 200 characters.
+     *
      * @param {Brevo.CreateAttributeRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -61,6 +69,8 @@ export declare class ContactsClient {
     createAttribute(request: Brevo.CreateAttributeRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __createAttribute;
     /**
+     * Update an existing contact attribute identified by its category and name. For category-type attributes, you can update the enumeration values; for calculated or global attributes, update the computed value formula; and for normal multiple-choice attributes, update the multicategory options. None of the category or multicategory option values can exceed 200 characters.
+     *
      * @param {Brevo.UpdateAttributeRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -76,6 +86,8 @@ export declare class ContactsClient {
     updateAttribute(request: Brevo.UpdateAttributeRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __updateAttribute;
     /**
+     * Permanently delete an existing contact attribute by its category and name. The attribute must exist in the specified category (normal, transactional, category, calculated, or global), otherwise a 404 error is returned.
+     *
      * @param {Brevo.DeleteAttributeRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -91,6 +103,8 @@ export declare class ContactsClient {
     deleteAttribute(request: Brevo.DeleteAttributeRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteAttribute;
     /**
+     * Delete a specific option from an existing multiple-choice contact attribute. The attribute type must be "multiple-choice", and both the attribute name and the option to delete must already exist in your account.
+     *
      * @param {Brevo.DeleteMultiAttributeOptionsRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -107,6 +121,8 @@ export declare class ContactsClient {
     deleteMultiAttributeOptions(request: Brevo.DeleteMultiAttributeOptionsRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteMultiAttributeOptions;
     /**
+     * Update multiple contacts in a single API call by passing an array of contact objects. Each contact in the array must be identified by one of: email, id, or sms (only one identifier per contact). You can update attributes, blacklist status, list memberships, ext_id, and transactional email forbidden senders for each contact in the batch.
+     *
      * @param {Brevo.UpdateBatchContactsRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -169,6 +185,8 @@ export declare class ContactsClient {
     getFolders(request?: Brevo.GetFoldersRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetFoldersResponse>;
     private __getFolders;
     /**
+     * Create a new folder to organize your contact lists. Folders serve as containers for grouping related lists together. The folder name is required and must be provided in the request body.
+     *
      * @param {Brevo.CreateUpdateFolder} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -198,6 +216,8 @@ export declare class ContactsClient {
     getFolder(request: Brevo.GetFolderRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetFolder>;
     private __getFolder;
     /**
+     * Update the name of an existing folder identified by its ID. The new folder name must be provided in the request body. Returns a 404 error if the folder ID does not exist.
+     *
      * @param {Brevo.UpdateFolderRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -213,6 +233,8 @@ export declare class ContactsClient {
     updateFolder(request: Brevo.UpdateFolderRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __updateFolder;
     /**
+     * Permanently delete a folder identified by its ID. Deleting a folder will also delete all the contact lists contained within it. This action cannot be undone.
+     *
      * @param {Brevo.DeleteFolderRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -273,6 +295,8 @@ export declare class ContactsClient {
     getLists(request?: Brevo.GetListsRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetListsResponse>;
     private __getLists;
     /**
+     * Create a new contact list inside a specified folder. Both the list name and the parent folder ID are required. The newly created list will be empty and ready to receive contacts via the add contacts endpoint.
+     *
      * @param {Brevo.CreateListRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -287,6 +311,8 @@ export declare class ContactsClient {
     createList(request: Brevo.CreateListRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateListResponse>;
     private __createList;
     /**
+     * Retrieve the details of a specific contact list by its ID, including its name, folder ID, creation date, subscriber counts, and campaign statistics. You can optionally filter campaign statistics by providing startDate and endDate parameters (both must be used together in YYYY-MM-DD format).
+     *
      * @param {Brevo.GetListRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -301,6 +327,8 @@ export declare class ContactsClient {
     getList(request: Brevo.GetListRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetListResponse>;
     private __getList;
     /**
+     * Update an existing contact list identified by its ID. You can update the list name, move it to a different folder by providing a new folderId, or both. Only one of the two parameters (name, folderId) needs to be provided per request.
+     *
      * @param {Brevo.UpdateListRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -315,6 +343,8 @@ export declare class ContactsClient {
     updateList(request: Brevo.UpdateListRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __updateList;
     /**
+     * Permanently delete a contact list identified by its ID. The contacts in the list are not deleted; they are only removed from this list. Returns a 404 error if the list ID does not exist.
+     *
      * @param {Brevo.DeleteListRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -329,11 +359,14 @@ export declare class ContactsClient {
     deleteList(request: Brevo.DeleteListRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteList;
     /**
+     * Retrieve all contacts belonging to a specific list, identified by its list ID. Results are paginated with a default of 50 contacts per page (maximum 500) and sorted in descending order of creation. You can optionally filter contacts by their modification date using the modifiedSince parameter.
+     *
      * @param {Brevo.GetContactsFromListRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Brevo.BadRequestError}
      * @throws {@link Brevo.NotFoundError}
+     * @throws {@link Brevo.TooManyRequestsError}
      *
      * @example
      *     await client.contacts.getContactsFromList({
@@ -417,6 +450,8 @@ export declare class ContactsClient {
     removeContactFromList(request: Brevo.RemoveContactFromListRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<Brevo.PostContactInfo>;
     private __removeContactFromList;
     /**
+     * Retrieve all contact segments defined in your Brevo account with support for pagination and sorting. Results default to 10 segments per page (maximum 50) sorted in descending order of creation. Each segment includes its ID, name, category name, and last update timestamp.
+     *
      * @param {Brevo.GetSegmentsRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -482,6 +517,8 @@ export declare class ContactsClient {
     deleteContact(request: Brevo.DeleteContactRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteContact;
     /**
+     * Retrieve email campaign statistics for a specific contact identified by email address or numeric ID. Statistics include messages sent, opens, clicks, hard/soft bounces, deliveries, unsubscriptions, complaints, and transactional attributes. By default, data covers the last 90 days; use startDate and endDate parameters (YYYY-MM-DD) to specify a custom range with a maximum span of 90 days.
+     *
      * @param {Brevo.GetContactStatsRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
      *