@getbrevo/brevo 2.2.0 → 2.3.0

package/model/mainGetContactRewardsPayload.ts

@@ -0,0 +1,99 @@
+/**
+ * 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 { MainFilter } from './mainFilter';
+
+export class MainGetContactRewardsPayload {
+    /**
+    * Contact to attribute the reward
+    */
+    'contactId': number;
+    /**
+    * Number of documents per page
+    */
+    'limit'?: number;
+    /**
+    * Data to define the reward for that particular contact
+    */
+    'metadata'?: Array<MainFilter>;
+    /**
+    * Index of the first document in the page
+    */
+    'offset'?: number;
+    /**
+    * Unique identifier of the associated reward
+    */
+    'rewardId'?: string;
+    /**
+    * Sort the documents in the ascending or descending order
+    */
+    'sort'?: MainGetContactRewardsPayload.SortEnum;
+    /**
+    * Sort documents by field
+    */
+    'sortField'?: MainGetContactRewardsPayload.SortFieldEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "contactId",
+            "baseName": "contactId",
+            "type": "number"
+        },
+        {
+            "name": "limit",
+            "baseName": "limit",
+            "type": "number"
+        },
+        {
+            "name": "metadata",
+            "baseName": "metadata",
+            "type": "Array<MainFilter>"
+        },
+        {
+            "name": "offset",
+            "baseName": "offset",
+            "type": "number"
+        },
+        {
+            "name": "rewardId",
+            "baseName": "rewardId",
+            "type": "string"
+        },
+        {
+            "name": "sort",
+            "baseName": "sort",
+            "type": "MainGetContactRewardsPayload.SortEnum"
+        },
+        {
+            "name": "sortField",
+            "baseName": "sortField",
+            "type": "MainGetContactRewardsPayload.SortFieldEnum"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainGetContactRewardsPayload.attributeTypeMap;
+    }
+}
+
+export namespace MainGetContactRewardsPayload {
+    export enum SortEnum {
+        Asc = <any> 'asc',
+        Desc = <any> 'desc'
+    }
+    export enum SortFieldEnum {
+        UpdatedAt = <any> 'updatedAt',
+        CreatedAt = <any> 'createdAt'
+    }
+}

package/model/mainIdentifiersPayload.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 MainIdentifiersPayload {
+    /**
+    * External identifier for the order
+    */
+    'extId'?: string;
+    /**
+    * Identifier for the loyalty subscription
+    */
+    'loyaltySubscriptionId'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "extId",
+            "baseName": "ext_id",
+            "type": "string"
+        },
+        {
+            "name": "loyaltySubscriptionId",
+            "baseName": "loyalty_subscription_id",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainIdentifiersPayload.attributeTypeMap;
+    }
+}
+

package/model/mainLimit.ts

@@ -0,0 +1,97 @@
+/**
+ * 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 MainLimit {
+    /**
+    * Timestamp when the reward limit was created
+    */
+    'createdAt'?: Date;
+    /**
+    * Unit of time for the reward limit\'s availability (e.g., day/week/month/year).
+    */
+    'durationUnit'?: string;
+    /**
+    * Number of days/weeks/month/year for reward limit
+    */
+    'durationValue'?: number;
+    /**
+    * Value of the limit
+    */
+    'limitValue'?: number;
+    /**
+    * Unique identifier for the reward limit
+    */
+    'rewardLimitId'?: string;
+    /**
+    * Select true to calculate all redeems / attributions from previous value of selected durationUnit to current time
+    */
+    'slidingSchedule'?: boolean;
+    /**
+    * Type of reward
+    */
+    'type'?: string;
+    /**
+    * Timestamp when the reward limit was created
+    */
+    'updatedAt'?: Date;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "Date"
+        },
+        {
+            "name": "durationUnit",
+            "baseName": "durationUnit",
+            "type": "string"
+        },
+        {
+            "name": "durationValue",
+            "baseName": "durationValue",
+            "type": "number"
+        },
+        {
+            "name": "limitValue",
+            "baseName": "limitValue",
+            "type": "number"
+        },
+        {
+            "name": "rewardLimitId",
+            "baseName": "rewardLimitId",
+            "type": "string"
+        },
+        {
+            "name": "slidingSchedule",
+            "baseName": "slidingSchedule",
+            "type": "boolean"
+        },
+        {
+            "name": "type",
+            "baseName": "type",
+            "type": "string"
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "Date"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainLimit.attributeTypeMap;
+    }
+}
+

package/model/mainModelContactReward.ts

@@ -0,0 +1,115 @@
+/**
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |   | 422  | Error. Unprocessable Entity | 
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+export class MainModelContactReward {
+    /**
+    * Generated code
+    */
+    'code'?: string;
+    /**
+    * Timestamp when the reward limit was consumed
+    */
+    'consumedAt'?: string;
+    /**
+    * Timestamp when the reward limit was created
+    */
+    'createdAt'?: string;
+    /**
+    * Reward expiration date
+    */
+    'expirationDate'?: string;
+    /**
+    * Unique identifier for the contact
+    */
+    'id'?: string;
+    /**
+    * Additional data for the reward
+    */
+    'meta'?: { [key: string]: object; };
+    /**
+    * Unique identifier for the reward
+    */
+    'rewardId'?: string;
+    /**
+    * Unit of the balance selected in the reward definition
+    */
+    'unit'?: string;
+    /**
+    * Timestamp when the reward limit was updated
+    */
+    'updatedAt'?: string;
+    /**
+    * Value of the selected reward config
+    */
+    'value'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "code",
+            "baseName": "code",
+            "type": "string"
+        },
+        {
+            "name": "consumedAt",
+            "baseName": "consumedAt",
+            "type": "string"
+        },
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "string"
+        },
+        {
+            "name": "expirationDate",
+            "baseName": "expirationDate",
+            "type": "string"
+        },
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "meta",
+            "baseName": "meta",
+            "type": "{ [key: string]: object; }"
+        },
+        {
+            "name": "rewardId",
+            "baseName": "rewardId",
+            "type": "string"
+        },
+        {
+            "name": "unit",
+            "baseName": "unit",
+            "type": "string"
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "string"
+        },
+        {
+            "name": "value",
+            "baseName": "value",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainModelContactReward.attributeTypeMap;
+    }
+}
+

package/model/mainModelContactRewardsResp.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 { MainModelContactReward } from './mainModelContactReward';
+
+export class MainModelContactRewardsResp {
+    /**
+    * Contact id associated with the current reward
+    */
+    'contactId'?: number;
+    /**
+    * List of all the rewards for current contact
+    */
+    'contactRewards'?: Array<MainModelContactReward>;
+    /**
+    * Count of the rewards associated with the current contact
+    */
+    'count'?: number;
+    /**
+    * Loyalty Program Id for the contact
+    */
+    'loyaltyProgramId'?: string;
+    /**
+    * Loyalty Subscription Id for the contact
+    */
+    'loyaltySubscriptionId'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "contactId",
+            "baseName": "contactId",
+            "type": "number"
+        },
+        {
+            "name": "contactRewards",
+            "baseName": "contactRewards",
+            "type": "Array<MainModelContactReward>"
+        },
+        {
+            "name": "count",
+            "baseName": "count",
+            "type": "number"
+        },
+        {
+            "name": "loyaltyProgramId",
+            "baseName": "loyaltyProgramId",
+            "type": "string"
+        },
+        {
+            "name": "loyaltySubscriptionId",
+            "baseName": "loyaltySubscriptionId",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainModelContactRewardsResp.attributeTypeMap;
+    }
+}
+

package/model/mainNodeResponse.ts

@@ -0,0 +1,97 @@
+/**
+ * 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 MainNodeResponse {
+    /**
+    * array[object]
+    */
+    'args'?: Array<MainNodeResponse>;
+    /**
+    * Array values for rule definition
+    */
+    'array'?: Array<MainNodeResponse>;
+    /**
+    * Boolean values for rule definition
+    */
+    '_boolean'?: boolean;
+    /**
+    * Description for rule definition
+    */
+    'description'?: string;
+    /**
+    * Float values for rule definition
+    */
+    '_float'?: number;
+    /**
+    * int64
+    */
+    '_int'?: number;
+    /**
+    * Operator selected for rule definition
+    */
+    'op'?: string;
+    /**
+    * Boolean values for rule definition
+    */
+    'string'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "args",
+            "baseName": "args",
+            "type": "Array<MainNodeResponse>"
+        },
+        {
+            "name": "array",
+            "baseName": "array",
+            "type": "Array<MainNodeResponse>"
+        },
+        {
+            "name": "_boolean",
+            "baseName": "boolean",
+            "type": "boolean"
+        },
+        {
+            "name": "description",
+            "baseName": "description",
+            "type": "string"
+        },
+        {
+            "name": "_float",
+            "baseName": "float",
+            "type": "number"
+        },
+        {
+            "name": "_int",
+            "baseName": "int",
+            "type": "number"
+        },
+        {
+            "name": "op",
+            "baseName": "op",
+            "type": "string"
+        },
+        {
+            "name": "string",
+            "baseName": "string",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainNodeResponse.attributeTypeMap;
+    }
+}
+

package/model/mainOrderPayload.ts

@@ -0,0 +1,136 @@
+/**
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |   | 422  | Error. Unprocessable Entity | 
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+import { MainBillingPayload } from './mainBillingPayload';
+import { MainIdentifiersPayload } from './mainIdentifiersPayload';
+import { MainProductPayload } from './mainProductPayload';
+
+export class MainOrderPayload {
+    /**
+    * Total amount of the order
+    */
+    'amount'?: number;
+    /**
+    * Billing information for the order
+    */
+    'billing'?: MainBillingPayload;
+    /**
+    * Unique identifier for the contact
+    */
+    'contactId'?: number;
+    /**
+    * List of coupon codes applied to the order
+    */
+    'coupons'?: Array<string>;
+    /**
+    * Timestamp when the order was created
+    */
+    'createdAt'?: Date;
+    /**
+    * Email address associated with the order
+    */
+    'email'?: string;
+    /**
+    * Unique identifier for the order
+    */
+    'id'?: string;
+    /**
+    * Additional identifiers for the order
+    */
+    'identifiers'?: MainIdentifiersPayload;
+    /**
+    * List of products in the order
+    */
+    'products'?: Array<MainProductPayload>;
+    /**
+    * Current status of the order
+    */
+    'status'?: string;
+    /**
+    * Identifier for the store where the order was placed
+    */
+    'storeId'?: string;
+    /**
+    * Timestamp when the order was last updated
+    */
+    'updatedAt'?: Date;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "amount",
+            "baseName": "amount",
+            "type": "number"
+        },
+        {
+            "name": "billing",
+            "baseName": "billing",
+            "type": "MainBillingPayload"
+        },
+        {
+            "name": "contactId",
+            "baseName": "contact_id",
+            "type": "number"
+        },
+        {
+            "name": "coupons",
+            "baseName": "coupons",
+            "type": "Array<string>"
+        },
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "Date"
+        },
+        {
+            "name": "email",
+            "baseName": "email",
+            "type": "string"
+        },
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "identifiers",
+            "baseName": "identifiers",
+            "type": "MainIdentifiersPayload"
+        },
+        {
+            "name": "products",
+            "baseName": "products",
+            "type": "Array<MainProductPayload>"
+        },
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "string"
+        },
+        {
+            "name": "storeId",
+            "baseName": "storeId",
+            "type": "string"
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "Date"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainOrderPayload.attributeTypeMap;
+    }
+}
+