@getbrevo/brevo 5.0.4 → 6.0.2

package/dist/cjs/api/resources/balance/client/requests/BeginTransactionRequest.d.ts

@@ -9,22 +9,32 @@
 export interface BeginTransactionRequest {
     /** Loyalty Program Id */
     pid: string;
-    /** Unique identifier for the loyalty subscription (required unless `contactId` is provided). */
-    LoyaltySubscriptionId?: string;
-    /** Transaction amount (must be provided). */
+    /** Transaction amount. A positive value creates a credit transaction and a negative value creates a debit transaction (unless transactionType is explicitly provided). */
     amount: number;
-    /** Whether the transaction should be automatically completed. */
-    autoComplete?: boolean;
+    /** Explicit transaction type. If not provided, the type is inferred from the sign of the amount (positive = credit, negative = debit). */
+    transactionType?: BeginTransactionRequest.TransactionType;
     /** Unique identifier (UUID) of the associated balance definition. */
     balanceDefinitionId: string;
-    /** Optional expiry time for the balance in minutes (must be greater than 0 if provided). */
-    balanceExpiryInMinutes?: number;
-    /** Unique identifier of the contact involved in the transaction (required unless `LoyaltySubscriptionId` is provided). */
+    /** Unique identifier of the contact involved in the transaction. Required unless `LoyaltySubscriptionId` is provided. */
     contactId?: number;
-    /** Optional timestamp specifying when the transaction occurred. */
-    eventTime?: string;
+    /** Unique identifier for the loyalty subscription. Required unless `contactId` is provided. */
+    LoyaltySubscriptionId?: string;
     /** Optional metadata associated with the transaction. */
     meta?: Record<string, unknown>;
-    /** Optional time-to-live for the transaction (must be greater than 0 if provided). */
+    /** Time-to-live for the transaction in seconds. Must be at least 10 seconds if provided. */
     ttl?: number;
+    /** Timestamp specifying when the transaction event occurred (ISO 8601 / RFC 3339 format). */
+    eventTime?: string;
+    /** Whether the transaction should be automatically completed. */
+    autoComplete?: boolean;
+    /** Expiry time for the balance in minutes. Must be greater than 0 if provided. Only applicable when autoComplete is true. */
+    balanceExpiryInMinutes?: number;
+}
+export declare namespace BeginTransactionRequest {
+    /** Explicit transaction type. If not provided, the type is inferred from the sign of the amount (positive = credit, negative = debit). */
+    const TransactionType: {
+        readonly Credit: "credit";
+        readonly Debit: "debit";
+    };
+    type TransactionType = (typeof TransactionType)[keyof typeof TransactionType];
 }

package/dist/cjs/api/resources/balance/client/requests/BeginTransactionRequest.js

@@ -1,3 +1,12 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.BeginTransactionRequest = void 0;
+var BeginTransactionRequest;
+(function (BeginTransactionRequest) {
+    /** Explicit transaction type. If not provided, the type is inferred from the sign of the amount (positive = credit, negative = debit). */
+    BeginTransactionRequest.TransactionType = {
+        Credit: "credit",
+        Debit: "debit",
+    };
+})(BeginTransactionRequest || (exports.BeginTransactionRequest = BeginTransactionRequest = {}));

package/dist/cjs/api/resources/balance/client/requests/CreateBalanceOrderRequest.d.ts

@@ -6,7 +6,7 @@
  *         balanceDefinitionId: "balanceDefinitionId",
  *         contactId: 1,
  *         dueAt: "dueAt",
- *         source: "source"
+ *         source: "engine"
  *     }
  */
 export interface CreateBalanceOrderRequest {
@@ -24,6 +24,14 @@ export interface CreateBalanceOrderRequest {
     expiresAt?: string;
     /** Optional metadata associated with the order. */
     meta?: Record<string, unknown>;
-    /** Specifies the origin of the order (`engine` or `user`). */
-    source: string;
+    /** Specifies the origin of the order. */
+    source: CreateBalanceOrderRequest.Source;
+}
+export declare namespace CreateBalanceOrderRequest {
+    /** Specifies the origin of the order. */
+    const Source: {
+        readonly Engine: "engine";
+        readonly User: "user";
+    };
+    type Source = (typeof Source)[keyof typeof Source];
 }

package/dist/cjs/api/resources/balance/client/requests/CreateBalanceOrderRequest.js

@@ -1,3 +1,12 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateBalanceOrderRequest = void 0;
+var CreateBalanceOrderRequest;
+(function (CreateBalanceOrderRequest) {
+    /** Specifies the origin of the order. */
+    CreateBalanceOrderRequest.Source = {
+        Engine: "engine",
+        User: "user",
+    };
+})(CreateBalanceOrderRequest || (exports.CreateBalanceOrderRequest = CreateBalanceOrderRequest = {}));

package/dist/cjs/api/resources/balance/client/requests/GetContactBalancesRequest.d.ts

@@ -1,7 +1,9 @@
+import type * as Brevo from "../../../../index.js";
 /**
  * @example
  *     {
- *         pid: "pid"
+ *         pid: "pid",
+ *         balanceDefinitionId: "balanceDefinitionId"
  *     }
  */
 export interface GetContactBalancesRequest {
@@ -9,4 +11,14 @@ export interface GetContactBalancesRequest {
     pid: string;
     /** Include balances tied to internal definitions. */
     includeInternal?: boolean;
+    /** Limit the number of records returned */
+    limit?: number;
+    /** Skip a number of records */
+    offset?: number;
+    /** Sort order */
+    sort?: Brevo.GetContactBalancesRequestSort;
+    /** Field to sort by */
+    sortField?: Brevo.GetContactBalancesRequestSortField;
+    /** Balance Definition ID (required) */
+    balanceDefinitionId: string;
 }

package/dist/cjs/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidActiveBalanceRequest.d.ts

@@ -1,9 +1,10 @@
+import type * as Brevo from "../../../../index.js";
 /**
  * @example
  *     {
  *         pid: "pid",
- *         contact_id: 1,
- *         balance_definition_id: "balance_definition_id"
+ *         contactId: 1000000,
+ *         balanceDefinitionId: "balanceDefinitionId"
  *     }
  */
 export interface GetLoyaltyBalanceProgramsPidActiveBalanceRequest {
@@ -14,13 +15,13 @@ export interface GetLoyaltyBalanceProgramsPidActiveBalanceRequest {
     /** Offset */
     offset?: number;
     /** Sort Field */
-    sort_field?: string;
+    sortField?: "createdAt";
     /** Sort Order */
-    sort?: string;
+    sort?: Brevo.GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort;
     /** Contact ID */
-    contact_id: number;
+    contactId: number;
     /** Balance Definition ID */
-    balance_definition_id: string;
+    balanceDefinitionId: string;
     /** Include balances tied to internal definitions. */
     includeInternal?: boolean;
 }

package/dist/cjs/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidTransactionHistoryRequest.d.ts

@@ -3,7 +3,7 @@ import type * as Brevo from "../../../../index.js";
  * @example
  *     {
  *         pid: "pid",
- *         contactId: 1,
+ *         contactId: 1000000,
  *         balanceDefinitionId: "balanceDefinitionId"
  *     }
  */
@@ -16,16 +16,16 @@ export interface GetLoyaltyBalanceProgramsPidTransactionHistoryRequest {
     offset?: number;
     /** Field to sort by */
     sortField?: "createdAt";
-    /** Sort order, either asc or desc */
+    /** Sort order */
     sort?: Brevo.GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSort;
     /** Contact ID */
     contactId: number;
     /** Balance Definition ID */
     balanceDefinitionId: string;
-    /** Filters to apply */
-    filters?: string | string[];
-    /** Transaction status filter. Allowed values: draft, completed, rejected, cancelled, expired */
+    /** Transaction status filter */
     status?: Brevo.GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus;
-    /** Transaction type filter. Allowed values: credit, debit */
+    /** Transaction type filter */
     transactionType?: Brevo.GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType;
+    /** Loyalty Subscription ID filter */
+    loyaltySubscriptionId?: string;
 }

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

@@ -1,8 +1,8 @@
-export type { BeginTransactionRequest } from "./BeginTransactionRequest.js";
+export { BeginTransactionRequest } from "./BeginTransactionRequest.js";
 export type { CancelTransactionRequest } from "./CancelTransactionRequest.js";
 export type { CompleteTransactionRequest } from "./CompleteTransactionRequest.js";
 export { CreateBalanceLimitRequest } from "./CreateBalanceLimitRequest.js";
-export type { CreateBalanceOrderRequest } from "./CreateBalanceOrderRequest.js";
+export { CreateBalanceOrderRequest } from "./CreateBalanceOrderRequest.js";
 export type { DeleteBalanceDefinitionRequest } from "./DeleteBalanceDefinitionRequest.js";
 export type { DeleteBalanceLimitRequest } from "./DeleteBalanceLimitRequest.js";
 export type { GetBalanceDefinitionListRequest } from "./GetBalanceDefinitionListRequest.js";

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

@@ -1,8 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UpdateBalanceLimitRequest = exports.UpdateBalanceDefinitionRequest = exports.PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest = exports.CreateBalanceLimitRequest = void 0;
+exports.UpdateBalanceLimitRequest = exports.UpdateBalanceDefinitionRequest = exports.PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest = exports.CreateBalanceOrderRequest = exports.CreateBalanceLimitRequest = exports.BeginTransactionRequest = void 0;
+var BeginTransactionRequest_js_1 = require("./BeginTransactionRequest.js");
+Object.defineProperty(exports, "BeginTransactionRequest", { enumerable: true, get: function () { return BeginTransactionRequest_js_1.BeginTransactionRequest; } });
 var CreateBalanceLimitRequest_js_1 = require("./CreateBalanceLimitRequest.js");
 Object.defineProperty(exports, "CreateBalanceLimitRequest", { enumerable: true, get: function () { return CreateBalanceLimitRequest_js_1.CreateBalanceLimitRequest; } });
+var CreateBalanceOrderRequest_js_1 = require("./CreateBalanceOrderRequest.js");
+Object.defineProperty(exports, "CreateBalanceOrderRequest", { enumerable: true, get: function () { return CreateBalanceOrderRequest_js_1.CreateBalanceOrderRequest; } });
 var PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest_js_1 = require("./PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest.js");
 Object.defineProperty(exports, "PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest", { enumerable: true, get: function () { return PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest_js_1.PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest; } });
 var UpdateBalanceDefinitionRequest_js_1 = require("./UpdateBalanceDefinitionRequest.js");

package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSort.d.ts

@@ -0,0 +1,5 @@
+export declare const GetContactBalancesRequestSort: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type GetContactBalancesRequestSort = (typeof GetContactBalancesRequestSort)[keyof typeof GetContactBalancesRequestSort];

package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSort.js

@@ -0,0 +1,8 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetContactBalancesRequestSort = void 0;
+exports.GetContactBalancesRequestSort = {
+    Asc: "asc",
+    Desc: "desc",
+};

package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSortField.d.ts

@@ -0,0 +1,5 @@
+export declare const GetContactBalancesRequestSortField: {
+    readonly UpdatedAt: "updatedAt";
+    readonly Value: "value";
+};
+export type GetContactBalancesRequestSortField = (typeof GetContactBalancesRequestSortField)[keyof typeof GetContactBalancesRequestSortField];

package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSortField.js

@@ -0,0 +1,8 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetContactBalancesRequestSortField = void 0;
+exports.GetContactBalancesRequestSortField = {
+    UpdatedAt: "updatedAt",
+    Value: "value",
+};

package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.d.ts

@@ -0,0 +1,5 @@
+export declare const GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort = (typeof GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort)[keyof typeof GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort];

package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.js

@@ -0,0 +1,8 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort = void 0;
+exports.GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort = {
+    Asc: "asc",
+    Desc: "desc",
+};

package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Active balance response for a specific contact and balance definition.
+ */
+export interface GetLoyaltyBalanceProgramsPidActiveBalanceResponse {
+    /** Total number of active balances. */
+    count?: number | undefined;
+    /** Unique identifier of the loyalty program. */
+    loyaltyProgramId?: string | undefined;
+    /** Unique identifier of the contact. */
+    contactId?: number | undefined;
+    /** Unique identifier of the balance definition. */
+    balanceDefinitionId?: string | undefined;
+    /** List of active balances. */
+    activeBalances?: GetLoyaltyBalanceProgramsPidActiveBalanceResponse.ActiveBalances.Item[] | undefined;
+}
+export declare namespace GetLoyaltyBalanceProgramsPidActiveBalanceResponse {
+    type ActiveBalances = ActiveBalances.Item[];
+    namespace ActiveBalances {
+        interface Item {
+            /** Unique identifier of the balance entry. */
+            id?: string | undefined;
+            /** Current balance amount. */
+            amount?: number | undefined;
+            /** Timestamp when the balance was created. */
+            createdAt?: string | undefined;
+            /** Timestamp when the balance expires (if applicable). */
+            expiresAt?: string | undefined;
+        }
+    }
+}

package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.d.ts

@@ -22,6 +22,8 @@ export declare namespace GetLoyaltyBalanceProgramsPidTransactionHistoryResponse
         interface Item {
             /** The transaction amount. */
             amount?: number | undefined;
+            /** The type of the transaction. */
+            transactionType?: Item.TransactionType | undefined;
             /** Expiration date of the balance associated with this transaction. */
             balanceExpirationDate?: string | undefined;
             /** Timestamp when the transaction was canceled, if applicable. */
@@ -41,5 +43,13 @@ export declare namespace GetLoyaltyBalanceProgramsPidTransactionHistoryResponse
             /** Current status of the transaction (e.g., pending, completed, rejected). */
             status?: string | undefined;
         }
+        namespace Item {
+            /** The type of the transaction. */
+            const TransactionType: {
+                readonly Credit: "credit";
+                readonly Debit: "debit";
+            };
+            type TransactionType = (typeof TransactionType)[keyof typeof TransactionType];
+        }
     }
 }

package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.js

@@ -1,3 +1,18 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetLoyaltyBalanceProgramsPidTransactionHistoryResponse = void 0;
+var GetLoyaltyBalanceProgramsPidTransactionHistoryResponse;
+(function (GetLoyaltyBalanceProgramsPidTransactionHistoryResponse) {
+    let TransactionHistory;
+    (function (TransactionHistory) {
+        let Item;
+        (function (Item) {
+            /** The type of the transaction. */
+            Item.TransactionType = {
+                Credit: "credit",
+                Debit: "debit",
+            };
+        })(Item = TransactionHistory.Item || (TransactionHistory.Item = {}));
+    })(TransactionHistory = GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.TransactionHistory || (GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.TransactionHistory = {}));
+})(GetLoyaltyBalanceProgramsPidTransactionHistoryResponse || (exports.GetLoyaltyBalanceProgramsPidTransactionHistoryResponse = GetLoyaltyBalanceProgramsPidTransactionHistoryResponse = {}));

package/dist/cjs/api/resources/balance/types/GetSubscriptionBalancesResponse.d.ts

@@ -1,13 +1,18 @@
 export interface GetSubscriptionBalancesResponse {
+    /** Unique identifier of the loyalty program. */
+    loyaltyProgramId?: string | undefined;
+    /** Unique identifier of the contact. */
+    contactId?: number | undefined;
+    /** Aggregate balance per balance definition. */
     balance?: GetSubscriptionBalancesResponse.Balance.Item[] | undefined;
 }
 export declare namespace GetSubscriptionBalancesResponse {
     type Balance = Balance.Item[];
     namespace Balance {
         interface Item {
-            /** balance definition ID */
+            /** Balance definition ID. */
             balanceDefinitionId?: string | undefined;
-            /** Unique identifier for the balance definition associated with this aggregate balance */
+            /** Aggregate balance value for this definition. */
             value?: number | undefined;
         }
     }

package/dist/cjs/api/resources/balance/types/PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse.d.ts

@@ -1,20 +1,20 @@
 export interface PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse {
-    /** The current amount available in the balance */
+    /** Unique identifier for the balance. */
+    id?: string | undefined;
+    /** The current amount available in the balance. */
     amount?: number | undefined;
-    /** balance definition ID */
-    balanceDefinitionId?: string | undefined;
-    /** Timestamp of when the balance was last consumed */
-    consumedAt?: string | undefined;
-    /** contact ID */
+    /** Loyalty program ID. */
+    loyaltyProgramId?: string | undefined;
+    /** Organization ID. */
+    organizationId?: number | undefined;
+    /** Contact ID. */
     contactId?: number | undefined;
-    /** Timestamp of when the balance was created */
+    /** Balance definition ID. */
+    balanceDefinitionId?: string | undefined;
+    /** Timestamp of when the balance was created. */
     createdAt?: string | undefined;
-    /** Expiration timestamp of the balance */
+    /** Expiration timestamp of the balance. */
     expiresAt?: string | undefined;
-    /** Unique identifier for the balance */
-    id?: string | undefined;
-    /** loyalty program ID */
-    loyaltyProgramId?: string | undefined;
-    /** organization ID */
-    organizationId?: number | undefined;
+    /** Timestamp of when the balance was last consumed. */
+    consumedAt?: string | undefined;
 }

package/dist/cjs/api/resources/balance/types/index.d.ts

@@ -5,7 +5,11 @@ export * from "./GetBalanceDefinitionListRequestVersion.js";
 export * from "./GetBalanceDefinitionListResponse.js";
 export * from "./GetBalanceDefinitionRequestVersion.js";
 export * from "./GetBalanceLimitRequestVersion.js";
+export * from "./GetContactBalancesRequestSort.js";
+export * from "./GetContactBalancesRequestSortField.js";
 export * from "./GetContactBalancesResponse.js";
+export * from "./GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.js";
+export * from "./GetLoyaltyBalanceProgramsPidActiveBalanceResponse.js";
 export * from "./GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSort.js";
 export * from "./GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus.js";
 export * from "./GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType.js";

package/dist/cjs/api/resources/balance/types/index.js

@@ -21,7 +21,11 @@ __exportStar(require("./GetBalanceDefinitionListRequestVersion.js"), exports);
 __exportStar(require("./GetBalanceDefinitionListResponse.js"), exports);
 __exportStar(require("./GetBalanceDefinitionRequestVersion.js"), exports);
 __exportStar(require("./GetBalanceLimitRequestVersion.js"), exports);
+__exportStar(require("./GetContactBalancesRequestSort.js"), exports);
+__exportStar(require("./GetContactBalancesRequestSortField.js"), exports);
 __exportStar(require("./GetContactBalancesResponse.js"), exports);
+__exportStar(require("./GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.js"), exports);
+__exportStar(require("./GetLoyaltyBalanceProgramsPidActiveBalanceResponse.js"), exports);
 __exportStar(require("./GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSort.js"), exports);
 __exportStar(require("./GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus.js"), exports);
 __exportStar(require("./GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType.js"), exports);

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

@@ -11,6 +11,8 @@ export declare class CompaniesClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<CompaniesClient.Options>;
     constructor(options: CompaniesClient.Options);
     /**
+     * Retrieve a paginated list of companies with optional filtering, sorting, and search capabilities. Results are sorted by creation date in descending order by default, and can be filtered by attributes, linked contacts, linked deals, or modification/creation timestamps.
+     *
      * @param {Brevo.GetCompaniesRequest} request
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -22,6 +24,8 @@ export declare class CompaniesClient {
     getAllCompanies(request?: Brevo.GetCompaniesRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Brevo.GetCompaniesResponse>;
     private __getAllCompanies;
     /**
+     * Create a new CRM company with the specified name, attributes, and optional associations to contacts and deals. The company name is required, and you can optionally provide a country code when a phone number attribute is included.
+     *
      * @param {Brevo.PostCompaniesRequest} request
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -49,6 +53,8 @@ export declare class CompaniesClient {
     importCompaniesCreationAndUpdation(request: Brevo.PostCompaniesImportRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Brevo.PostCompaniesImportResponse>;
     private __importCompaniesCreationAndUpdation;
     /**
+     * Link or unlink contacts and deals with a specific company in a single request. You can simultaneously link new contacts/deals and unlink existing ones by providing the respective ID arrays in the request body.
+     *
      * @param {Brevo.PatchCompaniesLinkUnlinkIdRequest} request
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -62,6 +68,8 @@ export declare class CompaniesClient {
     linkAndUnlinkCompanyWithContactAndDeal(request: Brevo.PatchCompaniesLinkUnlinkIdRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<void>;
     private __linkAndUnlinkCompanyWithContactAndDeal;
     /**
+     * Retrieve the full details of a single company by its identifier, including its attributes, linked contacts, and linked deals. Returns a 404 error if the company does not exist, or a 403 error if the user lacks permission to view the company.
+     *
      * @param {Brevo.GetCompaniesIdRequest} request
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -76,6 +84,8 @@ export declare class CompaniesClient {
     getACompany(request: Brevo.GetCompaniesIdRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Brevo.Company>;
     private __getACompany;
     /**
+     * Permanently delete a company by its identifier. The requesting user must be the company owner or have manage permission on companies; otherwise, a 403 Forbidden error is returned.
+     *
      * @param {Brevo.DeleteCompaniesIdRequest} request
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -90,6 +100,8 @@ export declare class CompaniesClient {
     deleteACompany(request: Brevo.DeleteCompaniesIdRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteACompany;
     /**
+     * Update an existing company''s attributes, name, linked contacts, or linked deals. Note that passing `linkedContactsIds` or `linkedDealsIds` replaces the entire list of associations, so omitted IDs will be removed. The company name cannot be set to an empty string.
+     *
      * @param {Brevo.PatchCompaniesIdRequest} request
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -104,6 +116,8 @@ export declare class CompaniesClient {
     updateACompany(request: Brevo.PatchCompaniesIdRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Brevo.Company>;
     private __updateACompany;
     /**
+     * Create a new custom attribute for companies or deals. The attribute label must be unique within the object type, cannot exceed 50 characters, and cannot use reserved names. For `single-select` or `multi-choice` attribute types, you must also provide the `optionsLabels` array.
+     *
      * @param {Brevo.PostCrmAttributesRequest} request
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -119,6 +133,8 @@ export declare class CompaniesClient {
     createACompanyDealAttribute(request: Brevo.PostCrmAttributesRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Brevo.PostCrmAttributesResponse>;
     private __createACompanyDealAttribute;
     /**
+     * Delete an existing custom attribute by its identifier. This permanently removes the attribute definition and cleans up all references to it across companies or deals. System-default and non-editable attributes cannot be deleted.
+     *
      * @param {Brevo.DeleteCrmAttributesIdRequest} request
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -133,6 +149,8 @@ export declare class CompaniesClient {
     deleteAnAttribute(request: Brevo.DeleteCrmAttributesIdRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteAnAttribute;
     /**
+     * Update an existing custom attribute''s label or options. You can rename the attribute label or modify the available options for `single-select` and `multi-choice` attribute types. System-default attributes cannot be modified except for specific editable fields.
+     *
      * @param {Brevo.PatchCrmAttributesIdRequest} request
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -147,8 +165,12 @@ export declare class CompaniesClient {
     updateAnAttribute(request: Brevo.PatchCrmAttributesIdRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<void>;
     private __updateAnAttribute;
     /**
+     * Retrieve the list of all attributes defined for companies, including both system-default and custom attributes. Each attribute includes its label, internal name, type, required status, and available options for select-type attributes.
+     *
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Brevo.BadRequestError}
+     *
      * @example
      *     await client.companies.getCompanyAttributes()
      */