@getbrevo/brevo 2.2.0 → 2.3.0

package/model/subAccountUpdatePlanRequestCredits.ts

@@ -17,17 +17,25 @@ import { RequestFile } from './models';
 */
 export class SubAccountUpdatePlanRequestCredits {
     /**
-    * Number of email credits
+    * Number of email credits | Pass the value -1 for unlimited emails in ENTv2 only
     */
     'email'?: number;
     /**
-    * Number of SMS credits | available in ENT-v2 only
+    * Number of SMS credits | Pass the value -1 for unlimited SMS in ENTv2 only
     */
     'sms'?: number;
     /**
     * Number of Push credits, possible value is 0 and -1 | available in ENT-v2 only
     */
     'wpSubscribers'?: number;
+    /**
+    * Number of externalFeeds credits, possible values are 0 or 1 |available in ENTv2 only
+    */
+    'externalFeeds'?: number;
+    /**
+    * Number of whatsapp credits | Pass the value -1 for unlimited whatsapp in ENTv2 only
+    */
+    'whatsapp'?: number;
 
     static discriminator: string | undefined = undefined;
 
@@ -46,6 +54,16 @@ export class SubAccountUpdatePlanRequestCredits {
             "name": "wpSubscribers",
             "baseName": "wpSubscribers",
             "type": "number"
+        },
+        {
+            "name": "externalFeeds",
+            "baseName": "externalFeeds",
+            "type": "number"
+        },
+        {
+            "name": "whatsapp",
+            "baseName": "whatsapp",
+            "type": "number"
         }    ];
 
     static getAttributeTypeMap() {

package/model/subAccountUpdatePlanRequestFeatures.ts

@@ -21,13 +21,17 @@ export class SubAccountUpdatePlanRequestFeatures {
     */
     'users'?: number;
     /**
-    * Number of landing pages / Not required on ENTv2
+    * Number of landing pages
     */
     'landingPage'?: number;
     /**
     * Number of inboxes / Not required on ENTv2
     */
     'inbox'?: number;
+    /**
+    * Number of sales users
+    */
+    'salesUsers'?: number;
 
     static discriminator: string | undefined = undefined;
 
@@ -46,6 +50,11 @@ export class SubAccountUpdatePlanRequestFeatures {
             "name": "inbox",
             "baseName": "inbox",
             "type": "number"
+        },
+        {
+            "name": "salesUsers",
+            "baseName": "salesUsers",
+            "type": "number"
         }    ];
 
     static getAttributeTypeMap() {

package/model/subAccountsUpdatePlanRequest.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 { SubAccountsUpdatePlanRequestCredits } from './subAccountsUpdatePlanRequestCredits';
+import { SubAccountsUpdatePlanRequestFeatures } from './subAccountsUpdatePlanRequestFeatures';
+
+/**
+* Details of the plan to be changed
+*/
+export class SubAccountsUpdatePlanRequest {
+    /**
+    * List of sub-account ids
+    */
+    'subAccountIds'?: Array<number>;
+    'credits'?: SubAccountsUpdatePlanRequestCredits;
+    'features'?: SubAccountsUpdatePlanRequestFeatures;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "subAccountIds",
+            "baseName": "subAccountIds",
+            "type": "Array<number>"
+        },
+        {
+            "name": "credits",
+            "baseName": "credits",
+            "type": "SubAccountsUpdatePlanRequestCredits"
+        },
+        {
+            "name": "features",
+            "baseName": "features",
+            "type": "SubAccountsUpdatePlanRequestFeatures"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SubAccountsUpdatePlanRequest.attributeTypeMap;
+    }
+}
+

package/model/subAccountsUpdatePlanRequestCredits.ts

@@ -0,0 +1,73 @@
+/**
+ * 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';
+
+/**
+* Credit details to update
+*/
+export class SubAccountsUpdatePlanRequestCredits {
+    /**
+    * Number of email credits | Pass the value -1 for unlimited emails in ENTv2 only
+    */
+    'email'?: number;
+    /**
+    * Number of SMS credits | Pass the value -1 for unlimited SMS in ENTv2 only
+    */
+    'sms'?: number;
+    /**
+    * Number of Push credits, possible value is 0 and -1 | available in ENTv2 only
+    */
+    'wpSubscribers'?: number;
+    /**
+    * Number of externalFeeds credits, possible values are 0 or 1 |available in ENTv2 only
+    */
+    'externalFeeds'?: number;
+    /**
+    * Number of whatsapp credits | Pass the value -1 for unlimited whatsapp in ENTv2 only
+    */
+    'whatsapp'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "email",
+            "baseName": "email",
+            "type": "number"
+        },
+        {
+            "name": "sms",
+            "baseName": "sms",
+            "type": "number"
+        },
+        {
+            "name": "wpSubscribers",
+            "baseName": "wpSubscribers",
+            "type": "number"
+        },
+        {
+            "name": "externalFeeds",
+            "baseName": "externalFeeds",
+            "type": "number"
+        },
+        {
+            "name": "whatsapp",
+            "baseName": "whatsapp",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SubAccountsUpdatePlanRequestCredits.attributeTypeMap;
+    }
+}
+

package/model/subAccountsUpdatePlanRequestFeatures.ts

@@ -0,0 +1,55 @@
+/**
+ * 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';
+
+/**
+* Features details to update
+*/
+export class SubAccountsUpdatePlanRequestFeatures {
+    /**
+    * Number of multi-users
+    */
+    'users'?: number;
+    /**
+    * Number of landing pages
+    */
+    'landingPage'?: number;
+    /**
+    * Number of sales users
+    */
+    'salesUsers'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "users",
+            "baseName": "users",
+            "type": "number"
+        },
+        {
+            "name": "landingPage",
+            "baseName": "landingPage",
+            "type": "number"
+        },
+        {
+            "name": "salesUsers",
+            "baseName": "salesUsers",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SubAccountsUpdatePlanRequestFeatures.attributeTypeMap;
+    }
+}
+

package/model/subscription.ts

@@ -0,0 +1,88 @@
+/**
+ * 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 Subscription {
+    /**
+    * Unique identifier of the contact.
+    */
+    'contactId'?: number;
+    /**
+    * Timestamp when the subscription was created.
+    */
+    'createdAt'?: string;
+    /**
+    * Unique identifier of the loyalty program.
+    */
+    'loyaltyProgramId'?: string;
+    /**
+    * Unique identifier of the subscription.
+    */
+    'loyaltySubscriptionId'?: string;
+    /**
+    * Unique identifier of the organization.
+    */
+    'organizationId'?: number;
+    /**
+    * Timestamp when the subscription was last updated.
+    */
+    'updatedAt'?: string;
+    /**
+    * Version number of the subscription.
+    */
+    'versionId'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "contactId",
+            "baseName": "contactId",
+            "type": "number"
+        },
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "string"
+        },
+        {
+            "name": "loyaltyProgramId",
+            "baseName": "loyaltyProgramId",
+            "type": "string"
+        },
+        {
+            "name": "loyaltySubscriptionId",
+            "baseName": "loyaltySubscriptionId",
+            "type": "string"
+        },
+        {
+            "name": "organizationId",
+            "baseName": "organizationId",
+            "type": "number"
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "string"
+        },
+        {
+            "name": "versionId",
+            "baseName": "versionId",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return Subscription.attributeTypeMap;
+    }
+}
+

package/model/subscriptionAggregateBalance.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 SubscriptionAggregateBalance {
+    /**
+    * Unique identifier for the balance definition).
+    */
+    'balanceDefinitionId'?: string;
+    /**
+    * The amount of the balance.
+    */
+    'value'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "balanceDefinitionId",
+            "baseName": "balanceDefinitionId",
+            "type": "string"
+        },
+        {
+            "name": "value",
+            "baseName": "value",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SubscriptionAggregateBalance.attributeTypeMap;
+    }
+}
+

package/model/subscriptionAttributedReward.ts

@@ -0,0 +1,106 @@
+/**
+ * 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 SubscriptionAttributedReward {
+    /**
+    * Reward code assigned to the contact.
+    */
+    'code'?: string;
+    /**
+    * Unique identifier of the contact.
+    */
+    'contactId'?: number;
+    /**
+    * Timestamp when the reward was created.
+    */
+    'createdAt'?: string;
+    /**
+    * Expiration date of the reward.
+    */
+    'expirationDate'?: string;
+    /**
+    * Unique identifier of the reward.
+    */
+    'id'?: string;
+    /**
+    * Unique identifier of the loyalty program.
+    */
+    'loyaltyProgramId'?: string;
+    /**
+    * Additional metadata related to the reward.
+    */
+    'meta'?: { [key: string]: object; };
+    /**
+    * Unique identifier of the reward definition.
+    */
+    'rewardId'?: string;
+    /**
+    * Timestamp when the reward was last updated.
+    */
+    'updatedAt'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "code",
+            "baseName": "code",
+            "type": "string"
+        },
+        {
+            "name": "contactId",
+            "baseName": "contactId",
+            "type": "number"
+        },
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "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]: object; }"
+        },
+        {
+            "name": "rewardId",
+            "baseName": "rewardId",
+            "type": "string"
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SubscriptionAttributedReward.attributeTypeMap;
+    }
+}
+

package/model/subscriptionBalances.ts

@@ -0,0 +1,53 @@
+/**
+ * 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 { SubscriptionAggregateBalance } from './subscriptionAggregateBalance';
+
+export class SubscriptionBalances {
+    /**
+    * List of balance details associated with the contact.
+    */
+    'balances'?: Array<SubscriptionAggregateBalance>;
+    /**
+    * Unique identifier of the contact.
+    */
+    'contactId'?: number;
+    /**
+    * Unique identifier of the loyalty program.
+    */
+    'loyaltyProgramId'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "balances",
+            "baseName": "balances",
+            "type": "Array<SubscriptionAggregateBalance>"
+        },
+        {
+            "name": "contactId",
+            "baseName": "contactId",
+            "type": "number"
+        },
+        {
+            "name": "loyaltyProgramId",
+            "baseName": "loyaltyProgramId",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SubscriptionBalances.attributeTypeMap;
+    }
+}
+

package/model/subscriptionHandlerInfo.ts

@@ -0,0 +1,65 @@
+/**
+ * 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 { MemberContact } from './memberContact';
+import { SubscriptionAttributedReward } from './subscriptionAttributedReward';
+import { SubscriptionBalances } from './subscriptionBalances';
+import { SubscriptionTier } from './subscriptionTier';
+
+export class SubscriptionHandlerInfo {
+    /**
+    * Balance details for the subscription.
+    */
+    'balance'?: SubscriptionBalances;
+    /**
+    * List of members associated with the subscription.
+    */
+    'members'?: Array<MemberContact>;
+    /**
+    * List of rewards associated with the subscription.
+    */
+    'reward'?: Array<SubscriptionAttributedReward>;
+    /**
+    * List of tier assignments for the subscription.
+    */
+    'tier'?: Array<SubscriptionTier>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "balance",
+            "baseName": "balance",
+            "type": "SubscriptionBalances"
+        },
+        {
+            "name": "members",
+            "baseName": "members",
+            "type": "Array<MemberContact>"
+        },
+        {
+            "name": "reward",
+            "baseName": "reward",
+            "type": "Array<SubscriptionAttributedReward>"
+        },
+        {
+            "name": "tier",
+            "baseName": "tier",
+            "type": "Array<SubscriptionTier>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SubscriptionHandlerInfo.attributeTypeMap;
+    }
+}
+