@getbrevo/brevo 2.2.0 → 2.3.0

package/model/balanceDefinitionPage.ts

@@ -0,0 +1,35 @@
+/**
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |   | 422  | Error. Unprocessable Entity | 
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+import { BalanceDefinition } from './balanceDefinition';
+
+export class BalanceDefinitionPage {
+    /**
+    * list of balance definitions
+    */
+    'items'?: Array<BalanceDefinition>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "items",
+            "baseName": "items",
+            "type": "Array<BalanceDefinition>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return BalanceDefinitionPage.attributeTypeMap;
+    }
+}
+

package/model/balanceLimit.ts

@@ -0,0 +1,115 @@
+/**
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |   | 422  | Error. Unprocessable Entity | 
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+export class BalanceLimit {
+    /**
+    * balance definition ID
+    */
+    'balanceDefinitionId'?: string;
+    /**
+    * Defines the type of constraint (e.g., transaction-based or amount-based).
+    */
+    'constraintType'?: string;
+    /**
+    * Timestamp of when the balance limit was created.
+    */
+    'createdAt': string;
+    /**
+    * Time unit for the balance limit (day, week, month, year).
+    */
+    'durationUnit'?: string;
+    /**
+    * Number of time units the balance limit applies to.
+    */
+    'durationValue'?: number;
+    /**
+    * Unique identifier for the balance limit.
+    */
+    'id'?: string;
+    /**
+    * Indicates if the limit resets periodically based on a sliding schedule.
+    */
+    'slidingSchedule'?: boolean;
+    /**
+    * Specifies whether the limit applies to credit or debit transactions.
+    */
+    'transactionType'?: string;
+    /**
+    * Timestamp of the last update to the balance limit.
+    */
+    'updatedAt': string;
+    /**
+    * The maximum allowed value for the defined constraint.
+    */
+    'value'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "balanceDefinitionId",
+            "baseName": "balanceDefinitionId",
+            "type": "string"
+        },
+        {
+            "name": "constraintType",
+            "baseName": "constraintType",
+            "type": "string"
+        },
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "string"
+        },
+        {
+            "name": "durationUnit",
+            "baseName": "durationUnit",
+            "type": "string"
+        },
+        {
+            "name": "durationValue",
+            "baseName": "durationValue",
+            "type": "number"
+        },
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "slidingSchedule",
+            "baseName": "slidingSchedule",
+            "type": "boolean"
+        },
+        {
+            "name": "transactionType",
+            "baseName": "transactionType",
+            "type": "string"
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "string"
+        },
+        {
+            "name": "value",
+            "baseName": "value",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return BalanceLimit.attributeTypeMap;
+    }
+}
+

package/model/balanceOrder.ts

@@ -0,0 +1,136 @@
+/**
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |   | 422  | Error. Unprocessable Entity | 
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+/**
+* Represents an order linked to a balance definition, including amount, due date, and transaction details.
+*/
+export class BalanceOrder {
+    /**
+    * Order amount (must not be zero).
+    */
+    'amount': number;
+    /**
+    * Optional unique identifier (UUID) of the associated balance definition.
+    */
+    'balanceDefinitionId'?: string;
+    /**
+    * Unique identifier of the contact placing the order (must be ≥ 1).
+    */
+    'contactId': number;
+    /**
+    * RFC3339 timestamp indicating when the order was created.
+    */
+    'createdAt': string;
+    /**
+    * RFC3339 timestamp specifying when the order is due in the future.
+    */
+    'dueAt': string;
+    /**
+    * Optional RFC3339 timestamp defining order expiration in the future.
+    */
+    'expiresAt'?: string;
+    /**
+    * Unique identifier for the balance order.
+    */
+    'id'?: string;
+    /**
+    * Unique identifier of the loyalty program associated with the order.
+    */
+    'loyaltyProgramId': string;
+    /**
+    * Optional metadata associated with the order.
+    */
+    'meta'?: { [key: string]: any; };
+    /**
+    * Optional RFC3339 timestamp indicating when the order was processed.
+    */
+    'processedAt'?: string;
+    /**
+    * Optional reference to the associated transaction ID.
+    */
+    'transactionid'?: string;
+    /**
+    * RFC3339 timestamp indicating the last update to the order.
+    */
+    'updatedAt': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "amount",
+            "baseName": "amount",
+            "type": "number"
+        },
+        {
+            "name": "balanceDefinitionId",
+            "baseName": "balanceDefinitionId",
+            "type": "string"
+        },
+        {
+            "name": "contactId",
+            "baseName": "contactId",
+            "type": "number"
+        },
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "string"
+        },
+        {
+            "name": "dueAt",
+            "baseName": "dueAt",
+            "type": "string"
+        },
+        {
+            "name": "expiresAt",
+            "baseName": "expiresAt",
+            "type": "string"
+        },
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "loyaltyProgramId",
+            "baseName": "loyaltyProgramId",
+            "type": "string"
+        },
+        {
+            "name": "meta",
+            "baseName": "meta",
+            "type": "{ [key: string]: any; }"
+        },
+        {
+            "name": "processedAt",
+            "baseName": "processedAt",
+            "type": "string"
+        },
+        {
+            "name": "transactionid",
+            "baseName": "transactionid",
+            "type": "string"
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return BalanceOrder.attributeTypeMap;
+    }
+}
+

package/model/companiesIdPatchRequest.ts

@@ -25,6 +25,14 @@ export class CompaniesIdPatchRequest {
     * Country code if phone_number is passed in attributes.
     */
     'countryCode'?: number;
+    /**
+    * Warning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed.
+    */
+    'linkedContactsIds'?: Array<number>;
+    /**
+    * Warning - Using PATCH on linkedDealsIds replaces the list of linked contacts. Omitted IDs will be removed.
+    */
+    'linkedDealsIds'?: Array<string>;
 
     static discriminator: string | undefined = undefined;
 
@@ -43,6 +51,16 @@ export class CompaniesIdPatchRequest {
             "name": "countryCode",
             "baseName": "countryCode",
             "type": "number"
+        },
+        {
+            "name": "linkedContactsIds",
+            "baseName": "linkedContactsIds",
+            "type": "Array<number>"
+        },
+        {
+            "name": "linkedDealsIds",
+            "baseName": "linkedDealsIds",
+            "type": "Array<string>"
         }    ];
 
     static getAttributeTypeMap() {

package/model/companiesImportPost200Response.ts

@@ -0,0 +1,34 @@
+/**
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |   | 422  | Error. Unprocessable Entity | 
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+export class CompaniesImportPost200Response {
+    /**
+    * The ID of the import process
+    */
+    'processId'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "processId",
+            "baseName": "processId",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CompaniesImportPost200Response.attributeTypeMap;
+    }
+}
+

package/model/companiesImportPost400Response.ts

@@ -0,0 +1,31 @@
+/**
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |   | 422  | Error. Unprocessable Entity | 
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+export class CompaniesImportPost400Response {
+    'message'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "message",
+            "baseName": "message",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CompaniesImportPost400Response.attributeTypeMap;
+    }
+}
+

package/model/contactBalancesResp.ts

@@ -0,0 +1,50 @@
+/**
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |   | 422  | Error. Unprocessable Entity | 
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+import { BalanceDataPerContact } from './balanceDataPerContact';
+
+export class ContactBalancesResp {
+    'balanceDefinitionId'?: string;
+    'balances'?: Array<BalanceDataPerContact>;
+    'count'?: number;
+    'loyaltyProgramId'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "balanceDefinitionId",
+            "baseName": "balanceDefinitionId",
+            "type": "string"
+        },
+        {
+            "name": "balances",
+            "baseName": "balances",
+            "type": "Array<BalanceDataPerContact>"
+        },
+        {
+            "name": "count",
+            "baseName": "count",
+            "type": "number"
+        },
+        {
+            "name": "loyaltyProgramId",
+            "baseName": "loyaltyProgramId",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return ContactBalancesResp.attributeTypeMap;
+    }
+}
+

package/model/contactErrorModel.ts

@@ -0,0 +1,63 @@
+/**
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |   | 422  | Error. Unprocessable Entity | 
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+export class ContactErrorModel {
+    /**
+    * Error code displayed in case of a failure
+    */
+    'code': ContactErrorModel.CodeEnum;
+    /**
+    * Readable message associated to the failure
+    */
+    'message': string;
+    /**
+    * Additional information about the error
+    */
+    'metadata'?: object;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "code",
+            "baseName": "code",
+            "type": "ContactErrorModel.CodeEnum"
+        },
+        {
+            "name": "message",
+            "baseName": "message",
+            "type": "string"
+        },
+        {
+            "name": "metadata",
+            "baseName": "metadata",
+            "type": "object"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return ContactErrorModel.attributeTypeMap;
+    }
+}
+
+export namespace ContactErrorModel {
+    export enum CodeEnum {
+        InvalidParameter = <any> 'invalid_parameter',
+        MissingParameter = <any> 'missing_parameter',
+        DocumentNotFound = <any> 'document_not_found',
+        AccountInProcess = <any> 'account_in_process',
+        DuplicateParameter = <any> 'duplicate_parameter',
+        MethodNotAllowed = <any> 'method_not_allowed',
+        OutOfRange = <any> 'out_of_range'
+    }
+}

package/model/conversationsMessage.ts

@@ -11,7 +11,12 @@
  */
 
 import { RequestFile } from './models';
+import { ConversationsMessageAttachmentsInner } from './conversationsMessageAttachmentsInner';
 import { ConversationsMessageFile } from './conversationsMessageFile';
+import { ConversationsMessageForwardedToSourceStatus } from './conversationsMessageForwardedToSourceStatus';
+import { ConversationsMessageFrom } from './conversationsMessageFrom';
+import { ConversationsMessageReplyTo } from './conversationsMessageReplyTo';
+import { ConversationsMessageToInner } from './conversationsMessageToInner';
 
 /**
 * a Conversations message
@@ -30,6 +35,10 @@ export class ConversationsMessage {
     */
     'text'?: string;
     /**
+    * The subject line of the email message (only for messages sent to email threads).
+    */
+    'subject'?: string;
+    /**
     * visitor’s ID
     */
     'visitorId'?: string;
@@ -50,10 +59,57 @@ export class ConversationsMessage {
     */
     'isPushed'?: boolean;
     /**
+    * `true` for automatic messages from “Targeted chats & triggers” and API (https://developers.brevo.com/docs/javascript-api-reference#sendautomessage)
+    */
+    'isTrigger'?: boolean;
+    /**
+    * `true` for missed and offline messages.
+    */
+    'isMissed'?: boolean;
+    /**
+    * `true` for unread agent’s messages in finished chats.
+    */
+    'isMissedByVisitor'?: boolean;
+    /**
+    * Only set if the agent has uploaded a profile picture.
+    */
+    'agentUserpic'?: string;
+    /**
     * In two-way integrations, messages sent via REST API can be marked with receivedFrom property and then filtered out when received in a webhook to avoid infinite loop.
     */
     'receivedFrom'?: string;
     'file'?: ConversationsMessageFile;
+    'from'?: ConversationsMessageFrom;
+    /**
+    * An array containing details of the recipients (applicable only to messages in email threads).
+    */
+    'to'?: Array<ConversationsMessageToInner>;
+    'replyTo'?: ConversationsMessageReplyTo;
+    /**
+    * An array containing details of the carbon copy (CC) recipients (applicable only to messages in email threads).
+    */
+    'cc'?: Array<ConversationsMessageToInner>;
+    /**
+    * An array containing details of the blind carbon copy (BCC) recipients (applicable only to messages in email threads).
+    */
+    'bcc'?: Array<ConversationsMessageToInner>;
+    /**
+    * The ID of the message assigned by the integration source.
+    */
+    'sourceMessageId'?: string;
+    'forwardedToSourceStatus'?: ConversationsMessageForwardedToSourceStatus;
+    /**
+    * Integration details.
+    */
+    'integrations'?: object;
+    /**
+    * `true` for automated messages generated by an AI bot.
+    */
+    'isBot'?: boolean;
+    /**
+    * An array of file attachments.
+    */
+    'attachments'?: Array<ConversationsMessageAttachmentsInner>;
 
     static discriminator: string | undefined = undefined;
 
@@ -73,6 +129,11 @@ export class ConversationsMessage {
             "baseName": "text",
             "type": "string"
         },
+        {
+            "name": "subject",
+            "baseName": "subject",
+            "type": "string"
+        },
         {
             "name": "visitorId",
             "baseName": "visitorId",
@@ -98,6 +159,26 @@ export class ConversationsMessage {
             "baseName": "isPushed",
             "type": "boolean"
         },
+        {
+            "name": "isTrigger",
+            "baseName": "isTrigger",
+            "type": "boolean"
+        },
+        {
+            "name": "isMissed",
+            "baseName": "isMissed",
+            "type": "boolean"
+        },
+        {
+            "name": "isMissedByVisitor",
+            "baseName": "isMissedByVisitor",
+            "type": "boolean"
+        },
+        {
+            "name": "agentUserpic",
+            "baseName": "agentUserpic",
+            "type": "string"
+        },
         {
             "name": "receivedFrom",
             "baseName": "receivedFrom",
@@ -107,6 +188,56 @@ export class ConversationsMessage {
             "name": "file",
             "baseName": "file",
             "type": "ConversationsMessageFile"
+        },
+        {
+            "name": "from",
+            "baseName": "from",
+            "type": "ConversationsMessageFrom"
+        },
+        {
+            "name": "to",
+            "baseName": "to",
+            "type": "Array<ConversationsMessageToInner>"
+        },
+        {
+            "name": "replyTo",
+            "baseName": "replyTo",
+            "type": "ConversationsMessageReplyTo"
+        },
+        {
+            "name": "cc",
+            "baseName": "cc",
+            "type": "Array<ConversationsMessageToInner>"
+        },
+        {
+            "name": "bcc",
+            "baseName": "bcc",
+            "type": "Array<ConversationsMessageToInner>"
+        },
+        {
+            "name": "sourceMessageId",
+            "baseName": "sourceMessageId",
+            "type": "string"
+        },
+        {
+            "name": "forwardedToSourceStatus",
+            "baseName": "forwardedToSourceStatus",
+            "type": "ConversationsMessageForwardedToSourceStatus"
+        },
+        {
+            "name": "integrations",
+            "baseName": "integrations",
+            "type": "object"
+        },
+        {
+            "name": "isBot",
+            "baseName": "isBot",
+            "type": "boolean"
+        },
+        {
+            "name": "attachments",
+            "baseName": "attachments",
+            "type": "Array<ConversationsMessageAttachmentsInner>"
         }    ];
 
     static getAttributeTypeMap() {