@getbrevo/brevo 2.2.0 → 2.3.0

package/model/tierRequestAccessConditionsInner.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 TierRequestAccessConditionsInner {
+    /**
+    * Balance definition identifier for accessing the tier
+    */
+    'balanceDefinitionId'?: string;
+    /**
+    * Minimum value required to access the tier
+    */
+    'minimumValue'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "balanceDefinitionId",
+            "baseName": "balanceDefinitionId",
+            "type": "string"
+        },
+        {
+            "name": "minimumValue",
+            "baseName": "minimumValue",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return TierRequestAccessConditionsInner.attributeTypeMap;
+    }
+}
+

package/model/tierRequestPutPayload.ts

@@ -0,0 +1,57 @@
+/**
+ * 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 { TierRequestAccessConditionsInner } from './tierRequestAccessConditionsInner';
+import { TierRequestTierRewardsInner } from './tierRequestTierRewardsInner';
+
+export class TierRequestPutPayload {
+    /**
+    * Name of the tier to be created
+    */
+    'name': string;
+    /**
+    * Image of the tier
+    */
+    'imageRef'?: string;
+    'accessConditions': Array<TierRequestAccessConditionsInner>;
+    'tierRewards': Array<TierRequestTierRewardsInner>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "imageRef",
+            "baseName": "imageRef",
+            "type": "string"
+        },
+        {
+            "name": "accessConditions",
+            "baseName": "accessConditions",
+            "type": "Array<TierRequestAccessConditionsInner>"
+        },
+        {
+            "name": "tierRewards",
+            "baseName": "tierRewards",
+            "type": "Array<TierRequestTierRewardsInner>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return TierRequestPutPayload.attributeTypeMap;
+    }
+}
+

package/model/tierRequestTierRewardsInner.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 TierRequestTierRewardsInner {
+    /**
+    * Reward unique identifier
+    */
+    'rewardId'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "rewardId",
+            "baseName": "rewardId",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return TierRequestTierRewardsInner.attributeTypeMap;
+    }
+}
+

package/model/tierTierRewardsInner.ts

@@ -0,0 +1,46 @@
+/**
+ * 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 TierTierRewardsInner {
+    /**
+    * Reward to be attributed on tier assignment
+    */
+    'rewardId'?: string;
+    'createdAt'?: Date;
+    'updatedAt'?: Date;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "rewardId",
+            "baseName": "rewardId",
+            "type": "string"
+        },
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "Date"
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "Date"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return TierTierRewardsInner.attributeTypeMap;
+    }
+}
+

package/model/transaction.ts

@@ -0,0 +1,163 @@
+/**
+ * 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 a transaction involving a balance, including status and timestamps.
+*/
+export class Transaction {
+    /**
+    * The transaction amount.
+    */
+    'amount'?: number;
+    /**
+    * Unique identifier (UUID) of the associated balance definition.
+    */
+    'balanceDefinitionId'?: string;
+    /**
+    * Timestamp when the transaction was canceled (nullable).
+    */
+    'cancelledAt'?: string;
+    /**
+    * Timestamp when the transaction was completed (nullable).
+    */
+    'completedAt'?: string;
+    /**
+    * Unique identifier of the contact associated with the transaction.
+    */
+    'contactId'?: number;
+    /**
+    * Timestamp when the transaction was created.
+    */
+    'createdAt'?: string;
+    /**
+    * Optional timestamp indicating when the transaction event occurred.
+    */
+    'eventTime'?: string;
+    /**
+    * Expiry date of the transaction (nullable).
+    */
+    'expirationDate'?: string;
+    /**
+    * Unique identifier (UUID) of the transaction.
+    */
+    'id'?: string;
+    /**
+    * Unique identifier (UUID) of the associated loyalty program.
+    */
+    'loyaltyProgramId'?: string;
+    /**
+    * Optional metadata associated with the transaction.
+    */
+    'meta'?: { [key: string]: any; };
+    /**
+    * Reason for rejection if the transaction was declined (nullable).
+    */
+    'rejectReason'?: string;
+    /**
+    * Timestamp when the transaction was rejected (nullable).
+    */
+    'rejectedAt'?: string;
+    /**
+    * The current status of the transaction (e.g., pending, completed, rejected).
+    */
+    'status'?: string;
+    /**
+    * Timestamp when the transaction was last updated.
+    */
+    '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": "cancelledAt",
+            "baseName": "cancelledAt",
+            "type": "string"
+        },
+        {
+            "name": "completedAt",
+            "baseName": "completedAt",
+            "type": "string"
+        },
+        {
+            "name": "contactId",
+            "baseName": "contactId",
+            "type": "number"
+        },
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "string"
+        },
+        {
+            "name": "eventTime",
+            "baseName": "eventTime",
+            "type": "string"
+        },
+        {
+            "name": "expirationDate",
+            "baseName": "expirationDate",
+            "type": "string"
+        },
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "loyaltyProgramId",
+            "baseName": "loyaltyProgramId",
+            "type": "string"
+        },
+        {
+            "name": "meta",
+            "baseName": "meta",
+            "type": "{ [key: string]: any; }"
+        },
+        {
+            "name": "rejectReason",
+            "baseName": "rejectReason",
+            "type": "string"
+        },
+        {
+            "name": "rejectedAt",
+            "baseName": "rejectedAt",
+            "type": "string"
+        },
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "string"
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return Transaction.attributeTypeMap;
+    }
+}
+

package/model/transactionHistory.ts

@@ -0,0 +1,118 @@
+/**
+ * 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 a record of a past transaction, including status and key timestamps.
+*/
+export class TransactionHistory {
+    /**
+    * The transaction amount.
+    */
+    'amount'?: number;
+    /**
+    * Expiration date of the balance associated with this transaction.
+    */
+    'balanceExpirationDate'?: string;
+    /**
+    * Timestamp when the transaction was canceled, if applicable.
+    */
+    'cancelledAt'?: string;
+    /**
+    * Timestamp when the transaction was successfully completed.
+    */
+    'completedAt'?: string;
+    /**
+    * Timestamp when the transaction was initiated.
+    */
+    'createdAt'?: string;
+    /**
+    * Unique identifier of the transaction.
+    */
+    'id'?: string;
+    /**
+    * Optional metadata associated with the transaction.
+    */
+    'meta'?: { [key: string]: any; };
+    /**
+    * Reason for rejection, if the transaction was declined.
+    */
+    'rejectReason'?: string;
+    /**
+    * Timestamp when the transaction was rejected.
+    */
+    'rejectedAt'?: string;
+    /**
+    * Current status of the transaction (e.g., pending, completed, rejected).
+    */
+    'status'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "amount",
+            "baseName": "amount",
+            "type": "number"
+        },
+        {
+            "name": "balanceExpirationDate",
+            "baseName": "balanceExpirationDate",
+            "type": "string"
+        },
+        {
+            "name": "cancelledAt",
+            "baseName": "cancelledAt",
+            "type": "string"
+        },
+        {
+            "name": "completedAt",
+            "baseName": "completedAt",
+            "type": "string"
+        },
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "string"
+        },
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "meta",
+            "baseName": "meta",
+            "type": "{ [key: string]: any; }"
+        },
+        {
+            "name": "rejectReason",
+            "baseName": "rejectReason",
+            "type": "string"
+        },
+        {
+            "name": "rejectedAt",
+            "baseName": "rejectedAt",
+            "type": "string"
+        },
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return TransactionHistory.attributeTypeMap;
+    }
+}
+

package/model/transactionHistoryResp.ts

@@ -0,0 +1,74 @@
+/**
+ * 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 { TransactionHistory } from './transactionHistory';
+
+/**
+* Response containing transaction history details for a specific balance and contact.
+*/
+export class TransactionHistoryResp {
+    /**
+    * Unique identifier of the associated balance definition.
+    */
+    'balanceDefinitionId'?: string;
+    /**
+    * Unique identifier of the contact related to the transactions.
+    */
+    'contactId'?: number;
+    /**
+    * Total number of transactions in the history.
+    */
+    'count'?: number;
+    /**
+    * Unique identifier of the associated loyalty program.
+    */
+    'loyaltyProgramId'?: string;
+    /**
+    * List of past transactions associated with the balance.
+    */
+    'transactionHistory'?: Array<TransactionHistory>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "balanceDefinitionId",
+            "baseName": "balanceDefinitionId",
+            "type": "string"
+        },
+        {
+            "name": "contactId",
+            "baseName": "contactId",
+            "type": "number"
+        },
+        {
+            "name": "count",
+            "baseName": "count",
+            "type": "number"
+        },
+        {
+            "name": "loyaltyProgramId",
+            "baseName": "loyaltyProgramId",
+            "type": "string"
+        },
+        {
+            "name": "transactionHistory",
+            "baseName": "transactionHistory",
+            "type": "Array<TransactionHistory>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return TransactionHistoryResp.attributeTypeMap;
+    }
+}
+

package/model/unauthorizedResponse.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 UnauthorizedResponse {
+    /**
+    * Request Authentication Failed
+    */
+    'error'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "error",
+            "baseName": "error",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return UnauthorizedResponse.attributeTypeMap;
+    }
+}
+

package/model/updateAttribute.ts

@@ -19,9 +19,13 @@ export class UpdateAttribute {
     */
     'value'?: string;
     /**
-    * List of the values and labels that the attribute can take. Use only if the attribute\'s category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}]
+    * List of the values and labels that the attribute can take. Use only if the attribute\'s category is \"category\". None of the category options can exceed max 200 characters. For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}]
     */
     'enumeration'?: Array<UpdateAttributeEnumerationInner>;
+    /**
+    * Use this option to add multiple-choice attributes options only if the attribute\'s category is \"normal\". **This option is specifically designed for updating multiple-choice attributes. None of the multicategory options can exceed max 200 characters **. For example: **[\"USA\",\"INDIA\"]** 
+    */
+    'multiCategoryOptions'?: Array<string>;
 
     static discriminator: string | undefined = undefined;
 
@@ -35,6 +39,11 @@ export class UpdateAttribute {
             "name": "enumeration",
             "baseName": "enumeration",
             "type": "Array<UpdateAttributeEnumerationInner>"
+        },
+        {
+            "name": "multiCategoryOptions",
+            "baseName": "multiCategoryOptions",
+            "type": "Array<string>"
         }    ];
 
     static getAttributeTypeMap() {