@getbrevo/brevo 2.2.0 → 2.3.0

package/model/mainRewardPageObj.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 MainRewardPageObj {
+    /**
+    * Timestamp for when this reward was created
+    */
+    'createdAt'?: Date;
+    /**
+    * Timestamp for when this reward attributed was ended
+    */
+    'endDate'?: Date;
+    /**
+    * Unique identifier for the reward
+    */
+    'id'?: string;
+    /**
+    * Loyalty Program to which current reward is associated to
+    */
+    'loyaltyProgramId'?: string;
+    /**
+    * Name of the reward
+    */
+    'name'?: string;
+    /**
+    * Public image of the reward
+    */
+    'publicImage'?: string;
+    /**
+    * Timestamp for when this reward attributed was started
+    */
+    'startDate'?: Date;
+    /**
+    * State of the reward
+    */
+    'state'?: string;
+    /**
+    * Timestamp for when this reward attributed was updated
+    */
+    'updatedAt'?: Date;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "Date"
+        },
+        {
+            "name": "endDate",
+            "baseName": "endDate",
+            "type": "Date"
+        },
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "loyaltyProgramId",
+            "baseName": "loyaltyProgramId",
+            "type": "string"
+        },
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "publicImage",
+            "baseName": "publicImage",
+            "type": "string"
+        },
+        {
+            "name": "startDate",
+            "baseName": "startDate",
+            "type": "Date"
+        },
+        {
+            "name": "state",
+            "baseName": "state",
+            "type": "string"
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "Date"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainRewardPageObj.attributeTypeMap;
+    }
+}
+

package/model/mainRewardValidate.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 MainRewardValidate {
+    /**
+    * Boolean Value to authorize a reward or not
+    */
+    'authorize'?: boolean;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "authorize",
+            "baseName": "authorize",
+            "type": "boolean"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainRewardValidate.attributeTypeMap;
+    }
+}
+

package/model/mainRule.ts

@@ -0,0 +1,145 @@
+/**
+ * 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 { MainRuleConditionResponse } from './mainRuleConditionResponse';
+import { MainRuleEventResponse } from './mainRuleEventResponse';
+import { MainRuleResultResponse } from './mainRuleResultResponse';
+
+export class MainRule {
+    /**
+    * Selected rule condition
+    */
+    'condition'?: MainRuleConditionResponse;
+    /**
+    * Timestamp when the rule was created
+    */
+    'createdAt'?: string;
+    /**
+    * Description of the rule
+    */
+    'description'?: string;
+    /**
+    * Selected event in the rule
+    */
+    'event'?: MainRuleEventResponse;
+    /**
+    * Metric to identify if its an internal rule or not
+    */
+    'isInternal'?: boolean;
+    /**
+    * Loyalty Program id of which current rule is associated
+    */
+    'loyaltyProgramId'?: string;
+    /**
+    * Loyalty Version id to which current rule is associated
+    */
+    'loyaltyVersionId'?: number;
+    /**
+    * Additional data to define the rule
+    */
+    'meta'?: { [key: string]: any; };
+    /**
+    * Rule name
+    */
+    'name'?: string;
+    /**
+    * Results fo the rule definition
+    */
+    'results'?: Array<MainRuleResultResponse>;
+    /**
+    * Unique identifier for the rule
+    */
+    'ruleId'?: string;
+    /**
+    * Type of the rule
+    */
+    'ruleType'?: string;
+    /**
+    * Timestamp when the rule was updated
+    */
+    'updatedAt'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "condition",
+            "baseName": "condition",
+            "type": "MainRuleConditionResponse"
+        },
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "string"
+        },
+        {
+            "name": "description",
+            "baseName": "description",
+            "type": "string"
+        },
+        {
+            "name": "event",
+            "baseName": "event",
+            "type": "MainRuleEventResponse"
+        },
+        {
+            "name": "isInternal",
+            "baseName": "isInternal",
+            "type": "boolean"
+        },
+        {
+            "name": "loyaltyProgramId",
+            "baseName": "loyaltyProgramId",
+            "type": "string"
+        },
+        {
+            "name": "loyaltyVersionId",
+            "baseName": "loyaltyVersionId",
+            "type": "number"
+        },
+        {
+            "name": "meta",
+            "baseName": "meta",
+            "type": "{ [key: string]: any; }"
+        },
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "results",
+            "baseName": "results",
+            "type": "Array<MainRuleResultResponse>"
+        },
+        {
+            "name": "ruleId",
+            "baseName": "ruleId",
+            "type": "string"
+        },
+        {
+            "name": "ruleType",
+            "baseName": "ruleType",
+            "type": "string"
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainRule.attributeTypeMap;
+    }
+}
+

package/model/mainRuleConditionResponse.ts

@@ -0,0 +1,71 @@
+/**
+ * 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 { MainValueResponse } from './mainValueResponse';
+
+export class MainRuleConditionResponse {
+    /**
+    * Metric to indicate AND between rules
+    */
+    'and'?: Array<MainRuleConditionResponse>;
+    /**
+    * Conditon of the rule
+    */
+    'lhs'?: MainValueResponse;
+    /**
+    * Selected operator for the rule
+    */
+    'op'?: string;
+    /**
+    * Metric to indicate OR between rules
+    */
+    'or'?: Array<MainRuleConditionResponse>;
+    /**
+    * Action of the rule
+    */
+    'rhs'?: MainValueResponse;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "and",
+            "baseName": "and",
+            "type": "Array<MainRuleConditionResponse>"
+        },
+        {
+            "name": "lhs",
+            "baseName": "lhs",
+            "type": "MainValueResponse"
+        },
+        {
+            "name": "op",
+            "baseName": "op",
+            "type": "string"
+        },
+        {
+            "name": "or",
+            "baseName": "or",
+            "type": "Array<MainRuleConditionResponse>"
+        },
+        {
+            "name": "rhs",
+            "baseName": "rhs",
+            "type": "MainValueResponse"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainRuleConditionResponse.attributeTypeMap;
+    }
+}
+

package/model/mainRuleEventResponse.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 MainRuleEventResponse {
+    /**
+    * Name of the event
+    */
+    'name'?: string;
+    /**
+    * Source of the event
+    */
+    'source'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "source",
+            "baseName": "source",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainRuleEventResponse.attributeTypeMap;
+    }
+}
+

package/model/mainRuleResultResponse.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 { MainResultParameterResponse } from './mainResultParameterResponse';
+
+export class MainRuleResultResponse {
+    /**
+    * Action for the defined rule
+    */
+    'action'?: string;
+    /**
+    * Parameters to define the reward
+    */
+    'parameters'?: Array<MainResultParameterResponse>;
+    /**
+    * Selected service to define the reward
+    */
+    'service'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "action",
+            "baseName": "action",
+            "type": "string"
+        },
+        {
+            "name": "parameters",
+            "baseName": "parameters",
+            "type": "Array<MainResultParameterResponse>"
+        },
+        {
+            "name": "service",
+            "baseName": "service",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainRuleResultResponse.attributeTypeMap;
+    }
+}
+

package/model/mainValidateRewardPayload.ts

@@ -0,0 +1,79 @@
+/**
+ * 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 MainValidateRewardPayload {
+    /**
+    * Unique identifier for the attributed reward
+    */
+    'attributedRewardId'?: string;
+    /**
+    * Validation code for the reward
+    */
+    'code'?: string;
+    /**
+    * Unique identifier for the contact
+    */
+    'contactId'?: number;
+    /**
+    * Identifier for the loyalty subscription
+    */
+    'loyaltySubscriptionId'?: string;
+    /**
+    * Identifier for the point of sale
+    */
+    'pointOfSellId'?: string;
+    /**
+    * Unique identifier for the reward
+    */
+    'rewardId'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "attributedRewardId",
+            "baseName": "attributedRewardId",
+            "type": "string"
+        },
+        {
+            "name": "code",
+            "baseName": "code",
+            "type": "string"
+        },
+        {
+            "name": "contactId",
+            "baseName": "contactId",
+            "type": "number"
+        },
+        {
+            "name": "loyaltySubscriptionId",
+            "baseName": "loyaltySubscriptionId",
+            "type": "string"
+        },
+        {
+            "name": "pointOfSellId",
+            "baseName": "pointOfSellId",
+            "type": "string"
+        },
+        {
+            "name": "rewardId",
+            "baseName": "rewardId",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainValidateRewardPayload.attributeTypeMap;
+    }
+}
+

package/model/mainValueResponse.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';
+import { MainNodeResponse } from './mainNodeResponse';
+
+export class MainValueResponse {
+    /**
+    * Array values to define the rule
+    */
+    'array'?: Array<MainValueResponse>;
+    /**
+    * Boolean values for rule definition
+    */
+    '_boolean'?: boolean;
+    /**
+    * string
+    */
+    'contactProperty'?: string;
+    /**
+    * Selected date for rule definition
+    */
+    'date'?: string;
+    /**
+    * Selected event property for rule definition
+    */
+    'eventProperty'?: string;
+    /**
+    * Created expression for rule definition
+    */
+    'expression'?: MainNodeResponse;
+    /**
+    * Boolean values for rule definition
+    */
+    'number'?: number;
+    /**
+    * String values for rule definition
+    */
+    'string'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "array",
+            "baseName": "array",
+            "type": "Array<MainValueResponse>"
+        },
+        {
+            "name": "_boolean",
+            "baseName": "boolean",
+            "type": "boolean"
+        },
+        {
+            "name": "contactProperty",
+            "baseName": "contactProperty",
+            "type": "string"
+        },
+        {
+            "name": "date",
+            "baseName": "date",
+            "type": "string"
+        },
+        {
+            "name": "eventProperty",
+            "baseName": "eventProperty",
+            "type": "string"
+        },
+        {
+            "name": "expression",
+            "baseName": "expression",
+            "type": "MainNodeResponse"
+        },
+        {
+            "name": "number",
+            "baseName": "number",
+            "type": "number"
+        },
+        {
+            "name": "string",
+            "baseName": "string",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainValueResponse.attributeTypeMap;
+    }
+}
+

package/model/mainVoucherRevokePayload.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 MainVoucherRevokePayload {
+    /**
+    * List of attributed reward identifiers to be revoked
+    */
+    'attributedRewardIds': Array<string>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "attributedRewardIds",
+            "baseName": "attributedRewardIds",
+            "type": "Array<string>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainVoucherRevokePayload.attributeTypeMap;
+    }
+}
+