@getbrevo/brevo 2.2.0 → 2.3.0

package/model/loyaltyTierPage.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 { Tier } from './tier';
+
+export class LoyaltyTierPage {
+    'items'?: Array<Tier>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "items",
+            "baseName": "items",
+            "type": "Array<Tier>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return LoyaltyTierPage.attributeTypeMap;
+    }
+}
+

package/model/mainAttributeRewardPayload.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 MainAttributeRewardPayload {
+    /**
+    * Value of the selected reward config
+    */
+    'value'?: number;
+    /**
+    * Code generated to attribute reward to a contact
+    */
+    'code'?: string;
+    /**
+    * Contact to attribute the reward
+    */
+    'contactId'?: number;
+    /**
+    * Reward expiration date
+    */
+    'expirationDate'?: string;
+    /**
+    * One of contactId or loyaltySubscriptionId is required
+    */
+    'loyaltySubscriptionId'?: string;
+    /**
+    * Offer meta information (key/value object)
+    */
+    'meta'?: { [key: string]: object; };
+    /**
+    * Reward id
+    */
+    'rewardId': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "value",
+            "baseName": "value",
+            "type": "number"
+        },
+        {
+            "name": "code",
+            "baseName": "code",
+            "type": "string"
+        },
+        {
+            "name": "contactId",
+            "baseName": "contactId",
+            "type": "number"
+        },
+        {
+            "name": "expirationDate",
+            "baseName": "expirationDate",
+            "type": "string"
+        },
+        {
+            "name": "loyaltySubscriptionId",
+            "baseName": "loyaltySubscriptionId",
+            "type": "string"
+        },
+        {
+            "name": "meta",
+            "baseName": "meta",
+            "type": "{ [key: string]: object; }"
+        },
+        {
+            "name": "rewardId",
+            "baseName": "rewardId",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainAttributeRewardPayload.attributeTypeMap;
+    }
+}
+

package/model/mainBillingPayload.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 MainBillingPayload {
+    /**
+    * Address of the user
+    */
+    'address'?: string;
+    /**
+    * City of the user
+    */
+    'city'?: string;
+    /**
+    * Country code of the user
+    */
+    'countryCode'?: string;
+    /**
+    * Payment method opted by the user
+    */
+    'paymentMethod'?: string;
+    /**
+    * Phone number of the user
+    */
+    'phone'?: number;
+    /**
+    * Postal Code of user\'s locations
+    */
+    'postCode'?: number;
+    /**
+    * Region where user resides
+    */
+    'region'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "address",
+            "baseName": "address",
+            "type": "string"
+        },
+        {
+            "name": "city",
+            "baseName": "city",
+            "type": "string"
+        },
+        {
+            "name": "countryCode",
+            "baseName": "countryCode",
+            "type": "string"
+        },
+        {
+            "name": "paymentMethod",
+            "baseName": "paymentMethod",
+            "type": "string"
+        },
+        {
+            "name": "phone",
+            "baseName": "phone",
+            "type": "number"
+        },
+        {
+            "name": "postCode",
+            "baseName": "postCode",
+            "type": "number"
+        },
+        {
+            "name": "region",
+            "baseName": "region",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainBillingPayload.attributeTypeMap;
+    }
+}
+

package/model/mainCodeCountHttpResponse.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 MainCodeCountHttpResponse {
+    /**
+    * Number of codes
+    */
+    'count'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "count",
+            "baseName": "count",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainCodeCountHttpResponse.attributeTypeMap;
+    }
+}
+

package/model/mainCreateRedeemPayload.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 { MainOrderPayload } from './mainOrderPayload';
+
+export class MainCreateRedeemPayload {
+    /**
+    * Unique identifier for the attributed reward
+    */
+    'attributedRewardId'?: string;
+    /**
+    * Redemption code for the reward
+    */
+    'code'?: string;
+    /**
+    * Unique identifier for the contact
+    */
+    'contactId'?: number;
+    /**
+    * Identifier for the loyalty subscription
+    */
+    'loyaltySubscriptionId'?: string;
+    /**
+    * Additional metadata associated with the redeem request
+    */
+    'meta'?: { [key: string]: object; };
+    /**
+    * Order details for the redemption
+    */
+    'order'?: MainOrderPayload;
+    /**
+    * Unique identifier for the reward
+    */
+    'rewardId'?: string;
+    /**
+    * Time to live in seconds for the redemption request
+    */
+    'ttl'?: number;
+
+    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": "meta",
+            "baseName": "meta",
+            "type": "{ [key: string]: object; }"
+        },
+        {
+            "name": "order",
+            "baseName": "order",
+            "type": "MainOrderPayload"
+        },
+        {
+            "name": "rewardId",
+            "baseName": "rewardId",
+            "type": "string"
+        },
+        {
+            "name": "ttl",
+            "baseName": "ttl",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainCreateRedeemPayload.attributeTypeMap;
+    }
+}
+

package/model/mainCreateRewardPayload.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 MainCreateRewardPayload {
+    /**
+    * Internal name of the reward
+    */
+    'name': string;
+    /**
+    * Public facing description of the reward
+    */
+    'publicDescription'?: string;
+    /**
+    * URL of the public image for the reward
+    */
+    'publicImage'?: string;
+    /**
+    * Public facing name of the reward
+    */
+    'publicName'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "publicDescription",
+            "baseName": "publicDescription",
+            "type": "string"
+        },
+        {
+            "name": "publicImage",
+            "baseName": "publicImage",
+            "type": "string"
+        },
+        {
+            "name": "publicName",
+            "baseName": "publicName",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainCreateRewardPayload.attributeTypeMap;
+    }
+}
+

package/model/mainCreateRewardResponse.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 MainCreateRewardResponse {
+    /**
+    * Timestamp when the reward was created
+    */
+    'createdAt'?: Date;
+    /**
+    * Unique identifier for the reward
+    */
+    'id'?: string;
+    /**
+    * Id of the loyalty program to which the current reward belongs to
+    */
+    'loyaltyProgramId'?: string;
+    /**
+    * Name of the reward
+    */
+    'name'?: string;
+    /**
+    * Public description for the reward
+    */
+    'publicDescription'?: string;
+    /**
+    * Public Image for the reward
+    */
+    'publicImage'?: string;
+    /**
+    * Public name for the reward
+    */
+    'publicName'?: string;
+    /**
+    * Timestamp for when this reward was last updated.
+    */
+    'updatedAt'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "Date"
+        },
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "loyaltyProgramId",
+            "baseName": "loyaltyProgramId",
+            "type": "string"
+        },
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "publicDescription",
+            "baseName": "publicDescription",
+            "type": "string"
+        },
+        {
+            "name": "publicImage",
+            "baseName": "publicImage",
+            "type": "string"
+        },
+        {
+            "name": "publicName",
+            "baseName": "publicName",
+            "type": "string"
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainCreateRewardResponse.attributeTypeMap;
+    }
+}
+

package/model/mainErrorResponse.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 MainErrorResponse {
+    /**
+    * Error message indicating what went wrong
+    */
+    'message'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "message",
+            "baseName": "message",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainErrorResponse.attributeTypeMap;
+    }
+}
+

package/model/mainFilter.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 MainFilter {
+    /**
+    * Metadata key
+    */
+    'metadataKey': string;
+    /**
+    * Metadata value
+    */
+    'metadataValue': object;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "metadataKey",
+            "baseName": "metadata.key",
+            "type": "string"
+        },
+        {
+            "name": "metadataValue",
+            "baseName": "metadata.value",
+            "type": "object"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainFilter.attributeTypeMap;
+    }
+}
+

package/model/mainGenerator.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 MainGenerator {
+    /**
+    * Timestamp when the reward was created
+    */
+    'createdAt'?: string;
+    /**
+    * Public facing description of the reward
+    */
+    'description'?: string;
+    /**
+    * Unique identifier for the reward
+    */
+    'id'?: string;
+    /**
+    * Name of the reward
+    */
+    'name'?: string;
+    /**
+    * Generated pattern
+    */
+    'pattern'?: string;
+    /**
+    * Timestamp when the reward was created
+    */
+    'updatedAt'?: Date;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "string"
+        },
+        {
+            "name": "description",
+            "baseName": "description",
+            "type": "string"
+        },
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "pattern",
+            "baseName": "pattern",
+            "type": "string"
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "Date"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MainGenerator.attributeTypeMap;
+    }
+}
+