@getbrevo/brevo 5.0.4 → 6.0.1

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

@@ -13,24 +13,51 @@ export declare class CustomObjectsClient {
     /**
      * <Note title="Enterprise access only">Custom objects are only available to Enterprise plans.
      * This feature is in beta. These are subject to change.</Note>
-     * This API allows bulk upsert of object records in a single request. Each object record may include
-     *   - Attributes
-     *   - Identifiers
-     *   - Associations
-     * **Response:**
-     *   The API processes the request asynchronously and returns a processId that you can use to track the background process status.
-     * **API and Schema Limitation:**
-     *   - Size:
-     *       - Max 1000 objects records per request
-     *       - Max request body size: 1 MB
-     *   - Max 500 attributes defined per object record upsert request
-     *     - This is coherent with schema limitation: an object cannot have more than 500 attributes.
-     *     - Worth noting: Nothing happens If an attribute is mentioned in the request, but was not previously defined for the object schema (no error, no attribute creation)
-     *   - Max 10 associations defined per associated object type, in each record of the request
-     *     - This is not a schema limitation. You can associate an object record to an unlimited number of other object records by running multiple requests.
+     * Performs bulk create or update (upsert) operations for object records in a single asynchronous request. This endpoint is optimized for high-volume data imports and synchronization scenarios.
+     *
+     * **How Upsert Works:**
+     * - **Create**: Omit `identifiers`, or provide only `ext_id` (if it doesn't already exist). A new record is created with a Brevo-generated `id`.
+     * - **Update**: Provide `id` (Brevo internal ID) or an `ext_id` that already exists. The matching record is updated with the new attribute values.
+     * - **Important:** `id` is for **updates only**. Providing an `id` that does not belong to an existing record will fail during async processing (the HTTP response will still be 202, but the record will be rejected in the background). To create a new record with a stable external reference, use `ext_id` instead.
+     *
+     * **Request Structure:**
+     * Each object record in the `records` array can include:
+     * - `identifiers`: Either `id` (internal Brevo ID) or `ext_id` (your external system ID) — required for updates. **Note:** use `id` (singular), not `ids`.
+     * - `attributes`: Key-value pairs where each key is the attribute **key** (e.g., `company_name`), not the attribute label (e.g., "Company Name").
+     * - `associations`: Controls linking and unlinking of associated records (optional). Each entry specifies:
+     *     - `object_type`: The type of the associated object
+     *     - `action`: `link` (default) to create the association, or `unlink` to remove it
+     *     - `records`: The associated records to link or unlink (each identified by `ext_id` or `id`)
+     *     - **Unlink is idempotent** — unlinking a non-existing association is a no-op (no error returned)
+     *     - `link` and `unlink` actions can be submitted for the same `object_type` in a single record entry
+     *     - Both associated records must already exist before a link can be created
+     *
+     * > **Common mistake:** Passing the attribute **label** (the display name you see in the UI) instead of the attribute **key** will cause the attribute to be silently ignored and the record may not be created as expected.
+     *
+     * **Asynchronous Processing:**
+     * - Returns immediately with a `processId` (HTTP 202 Accepted)
+     * - Use the processId to track status via the Get process API
+     *
+     * **API and Schema Limitations:**
+     * - Max 1000 object records per request
+     * - Max request body size: 1 MB
+     * - Max 500 attributes per object record (matches the schema limit of 500 attributes per object)
+     * - Unknown attribute keys are silently ignored (no error, no attribute creation)
+     * - Max 10 association records per associated object-type in each record of the request. If you need more, send multiple requests.
+     *
+     * **Important Behaviors:**
+     * - The object schema must be created before upserting records
+     * - Unknown attribute keys are silently ignored (no error, no creation)
+     * - Both associated object records must already exist before creating a link association
+     * - Unlink operations are idempotent: attempting to unlink a non-existing association returns success
+     * - `link` and `unlink` actions can be submitted for the same `object_type` in a single record entry
+     * - Contact objects cannot be created via this endpoint
+     * - For `category` and `multiple_category` attributes, pass the option **key** as the value (not the option label or option ID).
+     * - The `id` identifier (internal Brevo ID) can only be used for **updating** existing records. To create new records, either omit identifiers (Brevo auto-generates an ID) or provide an `ext_id`.
+     *
      * **Errors:**
-     *     - Make sure both object records exist before associating them, else the API will return an error.
-     *     - This route does not create objects. The object where the object records are upserted by this API must be created already else the API will return an error "invalid object type".
+     * - Make sure both object records exist before associating them, else the API will return an error.
+     * - This route does not create objects. The object where the object records are upserted by this API must be created already else the API will return an error "invalid object type".
      *
      * @param {Brevo.UpsertrecordsRequest} request
      * @param {CustomObjectsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -43,7 +70,61 @@ export declare class CustomObjectsClient {
      * @example
      *     await client.customObjects.upsertrecords({
      *         object_type: "vehicle",
-     *         records: [{}]
+     *         records: [{
+     *                 associations: [{
+     *                         object_type: "garage",
+     *                         action: "link",
+     *                         records: [{
+     *                                 identifiers: {
+     *                                     id: 435435
+     *                                 }
+     *                             }]
+     *                     }, {
+     *                         object_type: "garage",
+     *                         action: "unlink",
+     *                         records: [{
+     *                                 identifiers: {
+     *                                     ext_id: "old-garage-001"
+     *                                 }
+     *                             }]
+     *                     }],
+     *                 attributes: {
+     *                     "make": "Toyota",
+     *                     "model": "Camry",
+     *                     "year": 2020,
+     *                     "engine_type": "hybrid"
+     *                 },
+     *                 identifiers: {
+     *                     ext_id: "VIN123"
+     *                 }
+     *             }]
+     *     })
+     *
+     * @example
+     *     await client.customObjects.upsertrecords({
+     *         object_type: "vehicle",
+     *         records: [{
+     *                 attributes: {
+     *                     "make": "Honda",
+     *                     "model": "Civic",
+     *                     "year": 2023,
+     *                     "engine_type": "petrol"
+     *                 }
+     *             }]
+     *     })
+     *
+     * @example
+     *     await client.customObjects.upsertrecords({
+     *         object_type: "vehicle",
+     *         records: [{
+     *                 attributes: {
+     *                     "color": "red",
+     *                     "engine_type": "diesel"
+     *                 },
+     *                 identifiers: {
+     *                     id: 42
+     *                 }
+     *             }]
      *     })
      */
     upsertrecords(request: Brevo.UpsertrecordsRequest, requestOptions?: CustomObjectsClient.RequestOptions): core.HttpResponsePromise<Brevo.UpsertrecordsResponse>;
@@ -72,15 +153,14 @@ export declare class CustomObjectsClient {
     private __getrecords;
     /**
      * Use this endpoint to delete multiple object records of the same object-type in one request.
-     * The request is accepted and processed asynchronously.   You can track the status of the deletion process using the returned **processId**.
-     * **API and Schema Limitations:** - Each request can contain up to **1000** object record identifiers   - If more records must be deleted → send multiple batch requests
+     * The request is accepted and processed asynchronously. You can track the status of the deletion process using the returned **processId**.
+     * **Limitations:** - Each request can contain up to **1000** object record identifiers - Either `ids` or `ext_ids` must be provided, but **not both** in the same request - Deletion of Brevo standard object records is not supported via this endpoint - If more records must be deleted, send multiple batch requests
      *
      * @param {Brevo.BatchDeleteObjectRecordsRequest} request
      * @param {CustomObjectsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Brevo.BadRequestError}
      * @throws {@link Brevo.ForbiddenError}
-     * @throws {@link Brevo.NotFoundError}
      * @throws {@link Brevo.InternalServerError}
      *
      * @example

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

@@ -69,24 +69,51 @@ class CustomObjectsClient {
     /**
      * <Note title="Enterprise access only">Custom objects are only available to Enterprise plans.
      * This feature is in beta. These are subject to change.</Note>
-     * This API allows bulk upsert of object records in a single request. Each object record may include
-     *   - Attributes
-     *   - Identifiers
-     *   - Associations
-     * **Response:**
-     *   The API processes the request asynchronously and returns a processId that you can use to track the background process status.
-     * **API and Schema Limitation:**
-     *   - Size:
-     *       - Max 1000 objects records per request
-     *       - Max request body size: 1 MB
-     *   - Max 500 attributes defined per object record upsert request
-     *     - This is coherent with schema limitation: an object cannot have more than 500 attributes.
-     *     - Worth noting: Nothing happens If an attribute is mentioned in the request, but was not previously defined for the object schema (no error, no attribute creation)
-     *   - Max 10 associations defined per associated object type, in each record of the request
-     *     - This is not a schema limitation. You can associate an object record to an unlimited number of other object records by running multiple requests.
+     * Performs bulk create or update (upsert) operations for object records in a single asynchronous request. This endpoint is optimized for high-volume data imports and synchronization scenarios.
+     *
+     * **How Upsert Works:**
+     * - **Create**: Omit `identifiers`, or provide only `ext_id` (if it doesn't already exist). A new record is created with a Brevo-generated `id`.
+     * - **Update**: Provide `id` (Brevo internal ID) or an `ext_id` that already exists. The matching record is updated with the new attribute values.
+     * - **Important:** `id` is for **updates only**. Providing an `id` that does not belong to an existing record will fail during async processing (the HTTP response will still be 202, but the record will be rejected in the background). To create a new record with a stable external reference, use `ext_id` instead.
+     *
+     * **Request Structure:**
+     * Each object record in the `records` array can include:
+     * - `identifiers`: Either `id` (internal Brevo ID) or `ext_id` (your external system ID) — required for updates. **Note:** use `id` (singular), not `ids`.
+     * - `attributes`: Key-value pairs where each key is the attribute **key** (e.g., `company_name`), not the attribute label (e.g., "Company Name").
+     * - `associations`: Controls linking and unlinking of associated records (optional). Each entry specifies:
+     *     - `object_type`: The type of the associated object
+     *     - `action`: `link` (default) to create the association, or `unlink` to remove it
+     *     - `records`: The associated records to link or unlink (each identified by `ext_id` or `id`)
+     *     - **Unlink is idempotent** — unlinking a non-existing association is a no-op (no error returned)
+     *     - `link` and `unlink` actions can be submitted for the same `object_type` in a single record entry
+     *     - Both associated records must already exist before a link can be created
+     *
+     * > **Common mistake:** Passing the attribute **label** (the display name you see in the UI) instead of the attribute **key** will cause the attribute to be silently ignored and the record may not be created as expected.
+     *
+     * **Asynchronous Processing:**
+     * - Returns immediately with a `processId` (HTTP 202 Accepted)
+     * - Use the processId to track status via the Get process API
+     *
+     * **API and Schema Limitations:**
+     * - Max 1000 object records per request
+     * - Max request body size: 1 MB
+     * - Max 500 attributes per object record (matches the schema limit of 500 attributes per object)
+     * - Unknown attribute keys are silently ignored (no error, no attribute creation)
+     * - Max 10 association records per associated object-type in each record of the request. If you need more, send multiple requests.
+     *
+     * **Important Behaviors:**
+     * - The object schema must be created before upserting records
+     * - Unknown attribute keys are silently ignored (no error, no creation)
+     * - Both associated object records must already exist before creating a link association
+     * - Unlink operations are idempotent: attempting to unlink a non-existing association returns success
+     * - `link` and `unlink` actions can be submitted for the same `object_type` in a single record entry
+     * - Contact objects cannot be created via this endpoint
+     * - For `category` and `multiple_category` attributes, pass the option **key** as the value (not the option label or option ID).
+     * - The `id` identifier (internal Brevo ID) can only be used for **updating** existing records. To create new records, either omit identifiers (Brevo auto-generates an ID) or provide an `ext_id`.
+     *
      * **Errors:**
-     *     - Make sure both object records exist before associating them, else the API will return an error.
-     *     - This route does not create objects. The object where the object records are upserted by this API must be created already else the API will return an error "invalid object type".
+     * - Make sure both object records exist before associating them, else the API will return an error.
+     * - This route does not create objects. The object where the object records are upserted by this API must be created already else the API will return an error "invalid object type".
      *
      * @param {Brevo.UpsertrecordsRequest} request
      * @param {CustomObjectsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -99,7 +126,61 @@ class CustomObjectsClient {
      * @example
      *     await client.customObjects.upsertrecords({
      *         object_type: "vehicle",
-     *         records: [{}]
+     *         records: [{
+     *                 associations: [{
+     *                         object_type: "garage",
+     *                         action: "link",
+     *                         records: [{
+     *                                 identifiers: {
+     *                                     id: 435435
+     *                                 }
+     *                             }]
+     *                     }, {
+     *                         object_type: "garage",
+     *                         action: "unlink",
+     *                         records: [{
+     *                                 identifiers: {
+     *                                     ext_id: "old-garage-001"
+     *                                 }
+     *                             }]
+     *                     }],
+     *                 attributes: {
+     *                     "make": "Toyota",
+     *                     "model": "Camry",
+     *                     "year": 2020,
+     *                     "engine_type": "hybrid"
+     *                 },
+     *                 identifiers: {
+     *                     ext_id: "VIN123"
+     *                 }
+     *             }]
+     *     })
+     *
+     * @example
+     *     await client.customObjects.upsertrecords({
+     *         object_type: "vehicle",
+     *         records: [{
+     *                 attributes: {
+     *                     "make": "Honda",
+     *                     "model": "Civic",
+     *                     "year": 2023,
+     *                     "engine_type": "petrol"
+     *                 }
+     *             }]
+     *     })
+     *
+     * @example
+     *     await client.customObjects.upsertrecords({
+     *         object_type: "vehicle",
+     *         records: [{
+     *                 attributes: {
+     *                     "color": "red",
+     *                     "engine_type": "diesel"
+     *                 },
+     *                 identifiers: {
+     *                     id: 42
+     *                 }
+     *             }]
      *     })
      */
     upsertrecords(request, requestOptions) {
@@ -116,7 +197,7 @@ class CustomObjectsClient {
                 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,
@@ -188,7 +269,11 @@ class CustomObjectsClient {
                 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, `objects/${core.url.encodePathParam(objectType)}/records`),
                 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,
@@ -221,15 +306,14 @@ class CustomObjectsClient {
     }
     /**
      * Use this endpoint to delete multiple object records of the same object-type in one request.
-     * The request is accepted and processed asynchronously.   You can track the status of the deletion process using the returned **processId**.
-     * **API and Schema Limitations:** - Each request can contain up to **1000** object record identifiers   - If more records must be deleted → send multiple batch requests
+     * The request is accepted and processed asynchronously. You can track the status of the deletion process using the returned **processId**.
+     * **Limitations:** - Each request can contain up to **1000** object record identifiers - Either `ids` or `ext_ids` must be provided, but **not both** in the same request - Deletion of Brevo standard object records is not supported via this endpoint - If more records must be deleted, send multiple batch requests
      *
      * @param {Brevo.BatchDeleteObjectRecordsRequest} request
      * @param {CustomObjectsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Brevo.BadRequestError}
      * @throws {@link Brevo.ForbiddenError}
-     * @throws {@link Brevo.NotFoundError}
      * @throws {@link Brevo.InternalServerError}
      *
      * @example
@@ -254,7 +338,7 @@ class CustomObjectsClient {
                 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,
@@ -275,8 +359,6 @@ class CustomObjectsClient {
                         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);
                     case 500:
                         throw new Brevo.InternalServerError(_response.error.body, _response.rawResponse);
                     default:

package/dist/cjs/api/resources/customObjects/client/requests/BatchDeleteObjectRecordsRequest.d.ts

@@ -10,12 +10,12 @@
 export interface BatchDeleteObjectRecordsRequest {
     /** Object type for the records to delete */
     object_type: string;
-    /** One of the below must be provided */
+    /** Either `ids` or `ext_ids` must be provided, but not both in the same request. */
     identifiers?: BatchDeleteObjectRecordsRequest.Identifiers;
 }
 export declare namespace BatchDeleteObjectRecordsRequest {
     /**
-     * One of the below must be provided
+     * Either `ids` or `ext_ids` must be provided, but not both in the same request.
      */
     type Identifiers = {
         ids: number[];

package/dist/cjs/api/resources/customObjects/client/requests/GetrecordsRequest.d.ts

@@ -8,7 +8,7 @@ import type * as Brevo from "../../../../index.js";
  *     }
  */
 export interface GetrecordsRequest {
-    /** object type for the attribute */
+    /** Object type for the records to retrieve. Must be a previously created custom object type. Contact as object type is not supported in this endpoint. */
     object_type: string;
     /** Number of records returned per page */
     limit: number;

package/dist/cjs/api/resources/customObjects/client/requests/UpsertrecordsRequest.d.ts

@@ -2,11 +2,65 @@
  * @example
  *     {
  *         object_type: "vehicle",
- *         records: [{}]
+ *         records: [{
+ *                 associations: [{
+ *                         object_type: "garage",
+ *                         action: "link",
+ *                         records: [{
+ *                                 identifiers: {
+ *                                     id: 435435
+ *                                 }
+ *                             }]
+ *                     }, {
+ *                         object_type: "garage",
+ *                         action: "unlink",
+ *                         records: [{
+ *                                 identifiers: {
+ *                                     ext_id: "old-garage-001"
+ *                                 }
+ *                             }]
+ *                     }],
+ *                 attributes: {
+ *                     "make": "Toyota",
+ *                     "model": "Camry",
+ *                     "year": 2020,
+ *                     "engine_type": "hybrid"
+ *                 },
+ *                 identifiers: {
+ *                     ext_id: "VIN123"
+ *                 }
+ *             }]
+ *     }
+ *
+ * @example
+ *     {
+ *         object_type: "vehicle",
+ *         records: [{
+ *                 attributes: {
+ *                     "make": "Honda",
+ *                     "model": "Civic",
+ *                     "year": 2023,
+ *                     "engine_type": "petrol"
+ *                 }
+ *             }]
+ *     }
+ *
+ * @example
+ *     {
+ *         object_type: "vehicle",
+ *         records: [{
+ *                 attributes: {
+ *                     "color": "red",
+ *                     "engine_type": "diesel"
+ *                 },
+ *                 identifiers: {
+ *                     id: 42
+ *                 }
+ *             }]
  *     }
  */
 export interface UpsertrecordsRequest {
-    /** object type for the attribute */
+    /** Object type for the records to upsert. Must be a previously created custom object type. Only lowercase alphanumeric characters and underscores are allowed (max 32 characters). */
     object_type: string;
     /** List of object records to be upsert. Each record can have attributes, identifiers, and associations. */
     records: UpsertrecordsRequest.Records.Item[];
@@ -15,40 +69,75 @@ export declare namespace UpsertrecordsRequest {
     type Records = Records.Item[];
     namespace Records {
         interface Item {
+            /** List of associations for the object record. Maximum 20 total entries allowed, with a maximum of 10 link actions and 10 unlink actions. Each entry specifies an object_type and an action (link or unlink). Unlink is idempotent — removing a non-existing association does not return an error. Both associated records must already exist before creating a link. */
             associations?: Item.Associations.Item[] | undefined;
-            /** Attributes attached with the object record. Only the already created attributes will be used with records. Pass the value with the attributes key you want to set or update for the object record. Minimum 1 attribute is required. */
+            /**
+             * Key-value pairs of attribute data for the object record. Each key must be the attribute **key** (e.g., `company_name`, `engine_type`), not the attribute label (e.g., "Company Name", "Engine Type"). Only attributes that already exist in the object schema will be accepted — unknown keys are silently ignored. Minimum 1 attribute is required.
+             *
+             * For `category` or `multiple_category` attributes, set the value to the option **key** (not the option label or option ID). You can find available option keys in the `options` array returned by the GET attributes endpoint, or in the frontend under each attribute's settings.
+             *
+             * For example, use the option key "hybrid" not the label "Hybrid" — using the label will be silently ignored.
+             *
+             * For `multiple_choice` type, pass an **array of option keys** (not display labels). For example, if options have keys `"sunroof"` and `"leather_seats"`, pass `["sunroof", "leather_seats"]`.
+             */
             attributes?: Record<string, unknown> | undefined;
-            /** Identifiers attached with the object record. It can have id or ext_id. ext_id is ID of record in the external system that client want to store in the object system, id is an internal ID of object record generated by Brevo system. NOTE: - Its an optional field, if identifier is not provided, then id of object records will be generated by Brevo. This id can be used for further operation with the object record. - Both ext_id and id cannot be provided in the same request. */
+            /**
+             * Identifiers for the object record. Supports `id` (singular, not `ids`) or `ext_id`.
+             * - `ext_id`: Your external system's identifier for this record.
+             * - `id`: Internal Brevo record ID — can only be used for **updating** existing records, not for creation.
+             * NOTE:
+             * - This is an optional field. If no identifier is provided, Brevo auto-generates an internal ID that you can use for future operations.
+             * - If both `ext_id` and `id` are provided, `id` takes precedence and the operation is treated as an update. It is recommended to provide only one identifier per record.
+             */
             identifiers?: Item.Identifiers | undefined;
         }
         namespace Item {
             type Associations = Associations.Item[];
             namespace Associations {
-                type Item = {
-                    object_type?: string | undefined;
-                    records?: {
-                        identifiers?: {
-                            ext_id?: string | undefined;
-                            id?: number | undefined;
-                        } | undefined;
-                    }[] | undefined;
-                } | {
-                    object_type?: string | undefined;
-                    records?: ({
-                        identifiers?: {
-                            ext_id?: string | undefined;
-                            id?: number | undefined;
-                        } | undefined;
-                    } | {
-                        identifiers?: Record<string, unknown> | undefined;
-                    })[] | undefined;
-                };
+                interface Item {
+                    /** Type of the associated object */
+                    object_type: string;
+                    /** Action to perform on the association. - `link`: Create association between records (default if not provided) - `unlink`: Remove association between records. Idempotent — unlinking a non-existing association is a no-op success. */
+                    action?: Item.Action | undefined;
+                    records: Item.Records.Item[];
+                }
+                namespace Item {
+                    /** Action to perform on the association. - `link`: Create association between records (default if not provided) - `unlink`: Remove association between records. Idempotent — unlinking a non-existing association is a no-op success. */
+                    const Action: {
+                        readonly Link: "link";
+                        readonly Unlink: "unlink";
+                    };
+                    type Action = (typeof Action)[keyof typeof Action];
+                    type Records = Records.Item[];
+                    namespace Records {
+                        interface Item {
+                            /** Identifiers for the associated object record. Provide either `ext_id` or `id`. */
+                            identifiers?: Item.Identifiers | undefined;
+                        }
+                        namespace Item {
+                            /**
+                             * Identifiers for the associated object record. Provide either `ext_id` or `id`.
+                             */
+                            interface Identifiers {
+                                /** External ID of the associated record in your system. */
+                                ext_id?: string | undefined;
+                                /** Internal ID of the associated object record generated by Brevo. */
+                                id?: number | undefined;
+                            }
+                        }
+                    }
+                }
             }
             /**
-             * Identifiers attached with the object record. It can have id or ext_id. ext_id is ID of record in the external system that client want to store in the object system, id is an internal ID of object record generated by Brevo system. NOTE: - Its an optional field, if identifier is not provided, then id of object records will be generated by Brevo. This id can be used for further operation with the object record. - Both ext_id and id cannot be provided in the same request.
+             * Identifiers for the object record. Supports `id` (singular, not `ids`) or `ext_id`.
+             * - `ext_id`: Your external system's identifier for this record.
+             * - `id`: Internal Brevo record ID — can only be used for **updating** existing records, not for creation.
+             * NOTE:
+             * - This is an optional field. If no identifier is provided, Brevo auto-generates an internal ID that you can use for future operations.
+             * - If both `ext_id` and `id` are provided, `id` takes precedence and the operation is treated as an update. It is recommended to provide only one identifier per record.
              */
             interface Identifiers {
-                /** ext_id is ID of record in the external system that client_dev want to store in the object system. */
+                /** ext_id is ID of record in the external system that client wants to store in the object system. */
                 ext_id?: string | undefined;
                 /** Internal ID of the object record generated by Brevo */
                 id?: number | undefined;

package/dist/cjs/api/resources/customObjects/client/requests/UpsertrecordsRequest.js

@@ -1,3 +1,24 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpsertrecordsRequest = void 0;
+var UpsertrecordsRequest;
+(function (UpsertrecordsRequest) {
+    let Records;
+    (function (Records) {
+        let Item;
+        (function (Item_1) {
+            let Associations;
+            (function (Associations) {
+                let Item;
+                (function (Item) {
+                    /** Action to perform on the association. - `link`: Create association between records (default if not provided) - `unlink`: Remove association between records. Idempotent — unlinking a non-existing association is a no-op success. */
+                    Item.Action = {
+                        Link: "link",
+                        Unlink: "unlink",
+                    };
+                })(Item = Associations.Item || (Associations.Item = {}));
+            })(Associations = Item_1.Associations || (Item_1.Associations = {}));
+        })(Item = Records.Item || (Records.Item = {}));
+    })(Records = UpsertrecordsRequest.Records || (UpsertrecordsRequest.Records = {}));
+})(UpsertrecordsRequest || (exports.UpsertrecordsRequest = UpsertrecordsRequest = {}));

package/dist/cjs/api/resources/customObjects/client/requests/index.d.ts

@@ -1,3 +1,3 @@
 export type { BatchDeleteObjectRecordsRequest } from "./BatchDeleteObjectRecordsRequest.js";
 export type { GetrecordsRequest } from "./GetrecordsRequest.js";
-export type { UpsertrecordsRequest } from "./UpsertrecordsRequest.js";
+export { UpsertrecordsRequest } from "./UpsertrecordsRequest.js";

package/dist/cjs/api/resources/customObjects/client/requests/index.js

@@ -1,2 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpsertrecordsRequest = void 0;
+var UpsertrecordsRequest_js_1 = require("./UpsertrecordsRequest.js");
+Object.defineProperty(exports, "UpsertrecordsRequest", { enumerable: true, get: function () { return UpsertrecordsRequest_js_1.UpsertrecordsRequest; } });

package/dist/cjs/api/resources/customObjects/types/GetrecordsResponse.d.ts

@@ -9,11 +9,18 @@ export declare namespace GetrecordsResponse {
         interface Item {
             /** List of associations for the object record. If association query param is true it will return 5 associated records per association. */
             associations?: Item.Associations.Item[] | undefined;
-            /** Attributes attached with the object record. Only the already created attributes will be used with records. Minimum 1 attribute is required. */
+            /**
+             * Key-value pairs of attribute data for the object record. Each key is the attribute **key** (e.g., `company_name`, `engine_type`), not the attribute label (e.g., "Company Name", "Engine Type"). Only attributes that already exist in the object schema will be present.
+             * For `category` or `multiple_category` attributes, the value is the option **key** (not the option label or option ID).
+             */
             attributes?: Record<string, unknown> | undefined;
             /** Timestamp when the object record was created */
             createdAt?: string | undefined;
-            /** Identifiers attached with the object record. It can have id or ext_id. ext_id is ID of record in the external system that client want to store in the object system, id is an internal ID of object record generated by Brevo system. */
+            /**
+             * Identifiers for the object record. Supports `id` (singular, not `ids`) or `ext_id`.
+             * - `ext_id`: Your external system's identifier for this record.
+             * - `id`: Internal Brevo record ID.
+             */
             identifiers?: Item.Identifiers | undefined;
             /** Timestamp when the object record was last updated */
             updatedAt?: string | undefined;
@@ -46,12 +53,14 @@ export declare namespace GetrecordsResponse {
                 };
             }
             /**
-             * Identifiers attached with the object record. It can have id or ext_id. ext_id is ID of record in the external system that client want to store in the object system, id is an internal ID of object record generated by Brevo system.
+             * Identifiers for the object record. Supports `id` (singular, not `ids`) or `ext_id`.
+             * - `ext_id`: Your external system's identifier for this record.
+             * - `id`: Internal Brevo record ID.
              */
             interface Identifiers {
-                /** ext_id is ID of record in the external system that client_dev want to store in the object system. */
+                /** External ID of the record in your system. */
                 ext_id?: string | undefined;
-                /** Internal ID of the object record generated by Brevo */
+                /** Internal ID of the object record generated by Brevo. */
                 id?: number | undefined;
             }
         }