@getbrevo/brevo 2.2.0 → 2.3.0

package/model/createBalanceLimitPayload.ts

@@ -0,0 +1,98 @@
+/**
+ * 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';
+
+/**
+* Payload for setting transaction or amount-based limits on a balance.
+*/
+export class CreateBalanceLimitPayload {
+    /**
+    * Defines whether the limit applies to transaction count or amount.
+    */
+    'constraintType': CreateBalanceLimitPayload.ConstraintTypeEnum;
+    /**
+    * Unit of time for which the limit is applicable.
+    */
+    'durationUnit': CreateBalanceLimitPayload.DurationUnitEnum;
+    /**
+    * Number of time units for the balance limit.
+    */
+    'durationValue': number;
+    /**
+    * Determines if the limit resets on a rolling schedule.
+    */
+    'slidingSchedule'?: boolean;
+    /**
+    * Specifies whether the limit applies to credit or debit transactions.
+    */
+    'transactionType': CreateBalanceLimitPayload.TransactionTypeEnum;
+    /**
+    * Maximum allowed value for the specified constraint type.
+    */
+    'value': number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "constraintType",
+            "baseName": "constraintType",
+            "type": "CreateBalanceLimitPayload.ConstraintTypeEnum"
+        },
+        {
+            "name": "durationUnit",
+            "baseName": "durationUnit",
+            "type": "CreateBalanceLimitPayload.DurationUnitEnum"
+        },
+        {
+            "name": "durationValue",
+            "baseName": "durationValue",
+            "type": "number"
+        },
+        {
+            "name": "slidingSchedule",
+            "baseName": "slidingSchedule",
+            "type": "boolean"
+        },
+        {
+            "name": "transactionType",
+            "baseName": "transactionType",
+            "type": "CreateBalanceLimitPayload.TransactionTypeEnum"
+        },
+        {
+            "name": "value",
+            "baseName": "value",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateBalanceLimitPayload.attributeTypeMap;
+    }
+}
+
+export namespace CreateBalanceLimitPayload {
+    export enum ConstraintTypeEnum {
+        Transaction = <any> 'transaction',
+        Amount = <any> 'amount'
+    }
+    export enum DurationUnitEnum {
+        Day = <any> 'day',
+        Week = <any> 'week',
+        Month = <any> 'month',
+        Year = <any> 'year'
+    }
+    export enum TransactionTypeEnum {
+        Credit = <any> 'credit',
+        Debit = <any> 'debit'
+    }
+}

package/model/createBalancePayload.ts

@@ -0,0 +1,37 @@
+/**
+ * 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';
+
+/**
+* Payload for creating a new balance linked to a specific balance definition.
+*/
+export class CreateBalancePayload {
+    /**
+    * Unique identifier (UUID) of the balance definition associated with the new balance.
+    */
+    'balanceDefinitionId': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "balanceDefinitionId",
+            "baseName": "balanceDefinitionId",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateBalancePayload.attributeTypeMap;
+    }
+}
+

package/model/createContact.ts

@@ -14,7 +14,7 @@ import { RequestFile } from './models';
 
 export class CreateContact {
     /**
-    * Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"}
+    * Email address of the user. **Mandatory if \"ext_id\"  & \"SMS\" field is not passed.**
     */
     'email'?: string;
     /**
@@ -22,9 +22,9 @@ export class CreateContact {
     */
     'extId'?: string;
     /**
-    * Pass the set of attributes and their values. The attribute\'s parameter should be passed in capital letter while creating a contact. Values that don\'t match the attribute type (e.g. text or string in a date attribute) will be ignored.These attributes must be present in your Brevo account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"}
+    * Pass the set of attributes and their values. These attributes must be present in your Brevo account. For eg. {\'FNAME\':\'Elly\', \'LNAME\':\'Roger\', \'COUNTRIES\':[\'India\',\'China\']}
     */
-    'attributes'?: object;
+    'attributes'?: { [key: string]: object; };
     /**
     * Set this field to blacklist the contact for emails (emailBlacklisted = true)
     */
@@ -62,7 +62,7 @@ export class CreateContact {
         {
             "name": "attributes",
             "baseName": "attributes",
-            "type": "object"
+            "type": "{ [key: string]: object; }"
         },
         {
             "name": "emailBlacklisted",

package/model/createDoiContact.ts

@@ -18,9 +18,9 @@ export class CreateDoiContact {
     */
     'email': string;
     /**
-    * Pass the set of attributes and their values. These attributes must be present in your Brevo account. For eg. {\'FNAME\':\'Elly\', \'LNAME\':\'Roger\'}
+    * Pass the set of attributes and their values. These attributes must be present in your Brevo account. For eg. {\'FNAME\':\'Elly\', \'LNAME\':\'Roger\', \'COUNTRIES\':[\'India\',\'China\']}
     */
-    'attributes'?: object;
+    'attributes'?: { [key: string]: object; };
     /**
     * Lists under user account where contact should be added
     */
@@ -49,7 +49,7 @@ export class CreateDoiContact {
         {
             "name": "attributes",
             "baseName": "attributes",
-            "type": "object"
+            "type": "{ [key: string]: object; }"
         },
         {
             "name": "includeListIds",

package/model/createEmailCampaign.ts

@@ -11,6 +11,7 @@
  */
 
 import { RequestFile } from './models';
+import { CreateEmailCampaignEmailExpirationDate } from './createEmailCampaignEmailExpirationDate';
 import { CreateEmailCampaignRecipients } from './createEmailCampaignRecipients';
 import { CreateEmailCampaignSender } from './createEmailCampaignSender';
 
@@ -133,6 +134,7 @@ export class CreateEmailCampaign {
     * Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. If not entered, then the default update profile form will be used.
     */
     'updateFormId'?: string;
+    'emailExpirationDate'?: CreateEmailCampaignEmailExpirationDate;
 
     static discriminator: string | undefined = undefined;
 
@@ -291,6 +293,11 @@ export class CreateEmailCampaign {
             "name": "updateFormId",
             "baseName": "updateFormId",
             "type": "string"
+        },
+        {
+            "name": "emailExpirationDate",
+            "baseName": "emailExpirationDate",
+            "type": "CreateEmailCampaignEmailExpirationDate"
         }    ];
 
     static getAttributeTypeMap() {

package/model/createEmailCampaignEmailExpirationDate.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';
+
+/**
+* To reduce your carbon footprint, set an expiration date for your email. If supported, it will be automatically deleted from the recipient’s inbox, saving storage space and energy. Learn more about setting an email expiration date. For reference , ``https://help.brevo.com/hc/en-us/articles/4413566705298-Create-an-email-campaign``
+*/
+export class CreateEmailCampaignEmailExpirationDate {
+    /**
+    * Duration of the email expiry. maximum duration can be 3600 days or 480 weeks or 120 months.
+    */
+    'duration'?: number;
+    /**
+    * Date-time of the email expiration
+    */
+    'unit'?: CreateEmailCampaignEmailExpirationDate.UnitEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "duration",
+            "baseName": "duration",
+            "type": "number"
+        },
+        {
+            "name": "unit",
+            "baseName": "unit",
+            "type": "CreateEmailCampaignEmailExpirationDate.UnitEnum"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateEmailCampaignEmailExpirationDate.attributeTypeMap;
+    }
+}
+
+export namespace CreateEmailCampaignEmailExpirationDate {
+    export enum UnitEnum {
+        Days = <any> 'days',
+        Weeks = <any> 'weeks',
+        Months = <any> 'months'
+    }
+}

package/model/createEmailCampaignRecipients.ts

@@ -28,6 +28,10 @@ export class CreateEmailCampaignRecipients {
     * Mandatory if listIds are not used. Segment ids to send the campaign to.
     */
     'segmentIds'?: Array<number>;
+    /**
+    * Segment ids which have to be excluded from a campaign. 
+    */
+    'exclusionSegmentIds'?: Array<number>;
 
     static discriminator: string | undefined = undefined;
 
@@ -46,6 +50,11 @@ export class CreateEmailCampaignRecipients {
             "name": "segmentIds",
             "baseName": "segmentIds",
             "type": "Array<number>"
+        },
+        {
+            "name": "exclusionSegmentIds",
+            "baseName": "exclusionSegmentIds",
+            "type": "Array<number>"
         }    ];
 
     static getAttributeTypeMap() {

package/model/createLoyaltyProgramPayload.ts

@@ -0,0 +1,61 @@
+/**
+ * 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 CreateLoyaltyProgramPayload {
+    /**
+    * Optional description of the loyalty program (max 256 chars).
+    */
+    'description'?: string;
+    /**
+    * Optional unique document ID.
+    */
+    'documentId'?: string;
+    /**
+    * Optional metadata related to the loyalty program.
+    */
+    'meta'?: { [key: string]: object; };
+    /**
+    * Required name of the loyalty program (max 128 chars).
+    */
+    'name': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "description",
+            "baseName": "description",
+            "type": "string"
+        },
+        {
+            "name": "documentId",
+            "baseName": "documentId",
+            "type": "string"
+        },
+        {
+            "name": "meta",
+            "baseName": "meta",
+            "type": "{ [key: string]: object; }"
+        },
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateLoyaltyProgramPayload.attributeTypeMap;
+    }
+}
+

package/model/createOrderPayload.ts

@@ -0,0 +1,91 @@
+/**
+ * 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';
+
+/**
+* Payload for creating an order linked to a balance definition.
+*/
+export class CreateOrderPayload {
+    /**
+    * Order amount (must be non-zero).
+    */
+    'amount': number;
+    /**
+    * 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 specifying when the order is due.
+    */
+    'dueAt': string;
+    /**
+    * Optional RFC3339 timestamp defining order expiration.
+    */
+    'expiresAt'?: string;
+    /**
+    * Optional metadata associated with the order.
+    */
+    'meta'?: { [key: string]: any; };
+    /**
+    * Specifies the origin of the order (`engine` or `user`).
+    */
+    'source': 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": "dueAt",
+            "baseName": "dueAt",
+            "type": "string"
+        },
+        {
+            "name": "expiresAt",
+            "baseName": "expiresAt",
+            "type": "string"
+        },
+        {
+            "name": "meta",
+            "baseName": "meta",
+            "type": "{ [key: string]: any; }"
+        },
+        {
+            "name": "source",
+            "baseName": "source",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateOrderPayload.attributeTypeMap;
+    }
+}
+

package/model/createSubscriptionPayload.ts

@@ -0,0 +1,52 @@
+/**
+ * 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 CreateSubscriptionPayload {
+    /**
+    * Required contact ID; must be greater than 0.
+    */
+    'contactId': number;
+    /**
+    * Optional custom date-time format.
+    */
+    'creationDate'?: string;
+    /**
+    * Optional subscription ID (max length 64).
+    */
+    'loyaltySubscriptionId'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "contactId",
+            "baseName": "contactId",
+            "type": "number"
+        },
+        {
+            "name": "creationDate",
+            "baseName": "creationDate",
+            "type": "string"
+        },
+        {
+            "name": "loyaltySubscriptionId",
+            "baseName": "loyaltySubscriptionId",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateSubscriptionPayload.attributeTypeMap;
+    }
+}
+

package/model/createSubscriptionResponse.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 CreateSubscriptionResponse {
+    /**
+    * Organization ID
+    */
+    'organizationId'?: number;
+    /**
+    * Loyalty Program ID
+    */
+    'loyaltyProgramId'?: string;
+    /**
+    * Version ID
+    */
+    'versionId'?: number;
+    /**
+    * Contact ID
+    */
+    'contactId'?: number;
+    /**
+    * Loyalty Subscription ID
+    */
+    'loyaltySubscriptionId'?: string;
+    /**
+    * Subscription creation date
+    */
+    'createdAt'?: Date;
+    /**
+    * Subscription last modification date
+    */
+    'updatedAt'?: Date;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "organizationId",
+            "baseName": "organizationId",
+            "type": "number"
+        },
+        {
+            "name": "loyaltyProgramId",
+            "baseName": "loyaltyProgramId",
+            "type": "string"
+        },
+        {
+            "name": "versionId",
+            "baseName": "versionId",
+            "type": "number"
+        },
+        {
+            "name": "contactId",
+            "baseName": "contactId",
+            "type": "number"
+        },
+        {
+            "name": "loyaltySubscriptionId",
+            "baseName": "loyaltySubscriptionId",
+            "type": "string"
+        },
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "Date"
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "Date"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateSubscriptionResponse.attributeTypeMap;
+    }
+}
+

package/model/createTierGroupRequest.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';
+
+export class CreateTierGroupRequest {
+    /**
+    * Name of the tier group
+    */
+    'name': string;
+    /**
+    * Select real_time to upgrade tier on real time balance updates. Select membership_anniversary to upgrade tier on subscription anniversary. Select tier_anniversary to upgrade tier on tier anniversary.
+    */
+    'upgradeStrategy'?: CreateTierGroupRequest.UpgradeStrategyEnum = CreateTierGroupRequest.UpgradeStrategyEnum.RealTime;
+    /**
+    * Select real_time to downgrade tier on real time balance updates. Select membership_anniversary to downgrade tier on subscription anniversary. Select tier_anniversary to downgrade tier on tier anniversary.
+    */
+    'downgradeStrategy'?: CreateTierGroupRequest.DowngradeStrategyEnum = CreateTierGroupRequest.DowngradeStrategyEnum.RealTime;
+    /**
+    * Order of the tiers in the group in ascending order
+    */
+    'tierOrder'?: Array<string>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "upgradeStrategy",
+            "baseName": "upgradeStrategy",
+            "type": "CreateTierGroupRequest.UpgradeStrategyEnum"
+        },
+        {
+            "name": "downgradeStrategy",
+            "baseName": "downgradeStrategy",
+            "type": "CreateTierGroupRequest.DowngradeStrategyEnum"
+        },
+        {
+            "name": "tierOrder",
+            "baseName": "tierOrder",
+            "type": "Array<string>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateTierGroupRequest.attributeTypeMap;
+    }
+}
+
+export namespace CreateTierGroupRequest {
+    export enum UpgradeStrategyEnum {
+        RealTime = <any> 'real_time',
+        MembershipAnniversary = <any> 'membership_anniversary',
+        TierAnniversary = <any> 'tier_anniversary'
+    }
+    export enum DowngradeStrategyEnum {
+        RealTime = <any> 'real_time',
+        MembershipAnniversary = <any> 'membership_anniversary',
+        TierAnniversary = <any> 'tier_anniversary'
+    }
+}