@getbrevo/brevo 1.0.1 → 2.0.0-beta.2

package/model/createUpdateBatchCategory.ts

@@ -0,0 +1,44 @@
+/**
+ * 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  | 
+ *
+ * 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 { CreateUpdateCategories } from './createUpdateCategories';
+
+export class CreateUpdateBatchCategory {
+    /**
+    * array of categories objects
+    */
+    'categories': Array<CreateUpdateCategories>;
+    /**
+    * Facilitate to update the existing categories in the same request (updateEnabled = true)
+    */
+    'updateEnabled'?: boolean;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "categories",
+            "baseName": "categories",
+            "type": "Array<CreateUpdateCategories>"
+        },
+        {
+            "name": "updateEnabled",
+            "baseName": "updateEnabled",
+            "type": "boolean"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateUpdateBatchCategory.attributeTypeMap;
+    }
+}
+

package/model/createUpdateBatchCategoryModel.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  | 
+ *
+ * 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 CreateUpdateBatchCategoryModel {
+    /**
+    * Number of the new created categories
+    */
+    'createdCount'?: number;
+    /**
+    * Number of the existing categories updated
+    */
+    'updatedCount'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "createdCount",
+            "baseName": "createdCount",
+            "type": "number"
+        },
+        {
+            "name": "updatedCount",
+            "baseName": "updatedCount",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateUpdateBatchCategoryModel.attributeTypeMap;
+    }
+}
+

package/model/createUpdateBatchProducts.ts

@@ -0,0 +1,44 @@
+/**
+ * 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  | 
+ *
+ * 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 { CreateUpdateProducts } from './createUpdateProducts';
+
+export class CreateUpdateBatchProducts {
+    /**
+    * array of products objects
+    */
+    'products': Array<CreateUpdateProducts>;
+    /**
+    * Facilitate to update the existing categories in the same request (updateEnabled = true)
+    */
+    'updateEnabled'?: boolean;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "products",
+            "baseName": "products",
+            "type": "Array<CreateUpdateProducts>"
+        },
+        {
+            "name": "updateEnabled",
+            "baseName": "updateEnabled",
+            "type": "boolean"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateUpdateBatchProducts.attributeTypeMap;
+    }
+}
+

package/model/createUpdateBatchProductsModel.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  | 
+ *
+ * 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 CreateUpdateBatchProductsModel {
+    /**
+    * Number of the new created products
+    */
+    'createdCount'?: number;
+    /**
+    * Number of the existing products updated
+    */
+    'updatedCount'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "createdCount",
+            "baseName": "createdCount",
+            "type": "number"
+        },
+        {
+            "name": "updatedCount",
+            "baseName": "updatedCount",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateUpdateBatchProductsModel.attributeTypeMap;
+    }
+}
+

package/model/createUpdateCategories.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  | 
+ *
+ * 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 CreateUpdateCategories {
+    /**
+    * Unique Category ID as saved in the shop 
+    */
+    'id': string;
+    /**
+    * **Mandatory in case of creation**. Name of the Category, as displayed in the shop 
+    */
+    'name'?: string;
+    /**
+    * URL to the category
+    */
+    'url'?: string;
+    /**
+    * UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop\'s database
+    */
+    'deletedAt'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "url",
+            "baseName": "url",
+            "type": "string"
+        },
+        {
+            "name": "deletedAt",
+            "baseName": "deletedAt",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateUpdateCategories.attributeTypeMap;
+    }
+}
+

package/model/createUpdateCategory.ts

@@ -0,0 +1,70 @@
+/**
+ * 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  | 
+ *
+ * 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 CreateUpdateCategory {
+    /**
+    * Unique Category ID as saved in the shop 
+    */
+    'id': string;
+    /**
+    * **Mandatory in case of creation**. Name of the Category, as displayed in the shop 
+    */
+    'name'?: string;
+    /**
+    * URL to the category
+    */
+    'url'?: string;
+    /**
+    * Facilitate to update the existing category in the same request (updateEnabled = true)
+    */
+    'updateEnabled'?: boolean = false;
+    /**
+    * UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop\'s database
+    */
+    'deletedAt'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "url",
+            "baseName": "url",
+            "type": "string"
+        },
+        {
+            "name": "updateEnabled",
+            "baseName": "updateEnabled",
+            "type": "boolean"
+        },
+        {
+            "name": "deletedAt",
+            "baseName": "deletedAt",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateUpdateCategory.attributeTypeMap;
+    }
+}
+

package/model/createUpdateContactModel.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  | 
+ *
+ * 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 CreateUpdateContactModel {
+    /**
+    * ID of the contact when a new contact is created
+    */
+    'id'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateUpdateContactModel.attributeTypeMap;
+    }
+}
+

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

package/model/createUpdateProduct.ts

@@ -0,0 +1,124 @@
+/**
+ * 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  | 
+ *
+ * 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 CreateUpdateProduct {
+    /**
+    * Product ID for which you requested the details
+    */
+    'id': string;
+    /**
+    * Mandatory in case of creation**. Name of the product for which you requested the details
+    */
+    'name': string;
+    /**
+    * URL to the product
+    */
+    'url'?: string;
+    /**
+    * Absolute URL to the cover image of the product
+    */
+    'imageUrl'?: string;
+    /**
+    * Product identifier from the shop
+    */
+    'sku'?: string;
+    /**
+    * Price of the product
+    */
+    'price'?: number;
+    /**
+    * Category ID-s of the product
+    */
+    'categories'?: Array<string>;
+    /**
+    * Parent product id of the product
+    */
+    'parentId'?: string;
+    /**
+    * Meta data of product such as description, vendor, producer, stock level. The size of cumulative metaInfo shall not exceed **1000 KB**. Maximum length of metaInfo object can be 10.
+    */
+    'metaInfo'?: { [key: string]: string; };
+    /**
+    * Facilitate to update the existing category in the same request (updateEnabled = true)
+    */
+    'updateEnabled'?: boolean = false;
+    /**
+    * UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop\'s database
+    */
+    'deletedAt'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "url",
+            "baseName": "url",
+            "type": "string"
+        },
+        {
+            "name": "imageUrl",
+            "baseName": "imageUrl",
+            "type": "string"
+        },
+        {
+            "name": "sku",
+            "baseName": "sku",
+            "type": "string"
+        },
+        {
+            "name": "price",
+            "baseName": "price",
+            "type": "number"
+        },
+        {
+            "name": "categories",
+            "baseName": "categories",
+            "type": "Array<string>"
+        },
+        {
+            "name": "parentId",
+            "baseName": "parentId",
+            "type": "string"
+        },
+        {
+            "name": "metaInfo",
+            "baseName": "metaInfo",
+            "type": "{ [key: string]: string; }"
+        },
+        {
+            "name": "updateEnabled",
+            "baseName": "updateEnabled",
+            "type": "boolean"
+        },
+        {
+            "name": "deletedAt",
+            "baseName": "deletedAt",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateUpdateProduct.attributeTypeMap;
+    }
+}
+

package/model/createUpdateProducts.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  | 
+ *
+ * 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 CreateUpdateProducts {
+    /**
+    * Product ID for which you requested the details
+    */
+    'id': string;
+    /**
+    * Mandatory in case of creation**. Name of the product for which you requested the details
+    */
+    'name': string;
+    /**
+    * URL to the product
+    */
+    'url'?: string;
+    /**
+    * Absolute URL to the cover image of the product
+    */
+    'imageUrl'?: string;
+    /**
+    * Product identifier from the shop
+    */
+    'sku'?: string;
+    /**
+    * Price of the product
+    */
+    'price'?: number;
+    /**
+    * Category ID-s of the product
+    */
+    'categories'?: Array<string>;
+    /**
+    * Parent product id of the product
+    */
+    'parentId'?: string;
+    /**
+    * Meta data of product such as description, vendor, producer, stock level. The size of cumulative metaInfo shall not exceed **1000 KB**. Maximum length of metaInfo object can be 10.
+    */
+    'metaInfo'?: { [key: string]: string; };
+    /**
+    * UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop\'s database
+    */
+    'deletedAt'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "url",
+            "baseName": "url",
+            "type": "string"
+        },
+        {
+            "name": "imageUrl",
+            "baseName": "imageUrl",
+            "type": "string"
+        },
+        {
+            "name": "sku",
+            "baseName": "sku",
+            "type": "string"
+        },
+        {
+            "name": "price",
+            "baseName": "price",
+            "type": "number"
+        },
+        {
+            "name": "categories",
+            "baseName": "categories",
+            "type": "Array<string>"
+        },
+        {
+            "name": "parentId",
+            "baseName": "parentId",
+            "type": "string"
+        },
+        {
+            "name": "metaInfo",
+            "baseName": "metaInfo",
+            "type": "{ [key: string]: string; }"
+        },
+        {
+            "name": "deletedAt",
+            "baseName": "deletedAt",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateUpdateProducts.attributeTypeMap;
+    }
+}
+