@getbrevo/brevo 2.0.0-beta.4 → 2.1.1

package/model/getCorporateInvitedUsersList.ts

@@ -0,0 +1,35 @@
+/**
+ * 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 { GetCorporateInvitedUsersListUsersInner } from './getCorporateInvitedUsersListUsersInner';
+
+export class GetCorporateInvitedUsersList {
+    /**
+    * Get invited users list
+    */
+    'users'?: Array<GetCorporateInvitedUsersListUsersInner>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "users",
+            "baseName": "users",
+            "type": "Array<GetCorporateInvitedUsersListUsersInner>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GetCorporateInvitedUsersList.attributeTypeMap;
+    }
+}
+

package/model/getCorporateInvitedUsersListUsersInner.ts

@@ -0,0 +1,66 @@
+/**
+ * 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 { GetCorporateInvitedUsersListUsersInnerFeatureAccess } from './getCorporateInvitedUsersListUsersInnerFeatureAccess';
+import { GetCorporateInvitedUsersListUsersInnerGroups } from './getCorporateInvitedUsersListUsersInnerGroups';
+
+export class GetCorporateInvitedUsersListUsersInner {
+    'groups': GetCorporateInvitedUsersListUsersInnerGroups;
+    /**
+    * Email address of the user.
+    */
+    'email': string;
+    /**
+    * Flag for indicating is user owner of the organization.
+    */
+    'isOwner': string;
+    /**
+    * Status of the invited user.
+    */
+    'status': string;
+    'featureAccess': GetCorporateInvitedUsersListUsersInnerFeatureAccess;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "groups",
+            "baseName": "groups",
+            "type": "GetCorporateInvitedUsersListUsersInnerGroups"
+        },
+        {
+            "name": "email",
+            "baseName": "email",
+            "type": "string"
+        },
+        {
+            "name": "isOwner",
+            "baseName": "is_owner",
+            "type": "string"
+        },
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "string"
+        },
+        {
+            "name": "featureAccess",
+            "baseName": "feature_access",
+            "type": "GetCorporateInvitedUsersListUsersInnerFeatureAccess"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GetCorporateInvitedUsersListUsersInner.attributeTypeMap;
+    }
+}
+

package/model/getCorporateInvitedUsersListUsersInnerFeatureAccess.ts

@@ -0,0 +1,64 @@
+/**
+ * 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';
+
+/**
+* Feature accessiblity given to the user. (Required only if status is active)
+*/
+export class GetCorporateInvitedUsersListUsersInnerFeatureAccess {
+    /**
+    * User management accessiblity.
+    */
+    'userManagement'?: Array<string>;
+    /**
+    * Api keys accessiblity.
+    */
+    'apiKeys'?: Array<string>;
+    /**
+    * My plan accessiblity.
+    */
+    'myPlan'?: Array<string>;
+    /**
+    * Apps management accessiblity | Not available in ENTv2
+    */
+    'appsManagement'?: Array<string>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "userManagement",
+            "baseName": "user_management",
+            "type": "Array<string>"
+        },
+        {
+            "name": "apiKeys",
+            "baseName": "api_keys",
+            "type": "Array<string>"
+        },
+        {
+            "name": "myPlan",
+            "baseName": "my_plan",
+            "type": "Array<string>"
+        },
+        {
+            "name": "appsManagement",
+            "baseName": "apps_management",
+            "type": "Array<string>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GetCorporateInvitedUsersListUsersInnerFeatureAccess.attributeTypeMap;
+    }
+}
+

package/model/getCorporateInvitedUsersListUsersInnerGroups.ts

@@ -0,0 +1,46 @@
+/**
+ * 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';
+
+/**
+* Admin user groups list
+*/
+export class GetCorporateInvitedUsersListUsersInnerGroups {
+    /**
+    * group id
+    */
+    'id'?: string;
+    /**
+    * group name
+    */
+    'name'?: 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"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GetCorporateInvitedUsersListUsersInnerGroups.attributeTypeMap;
+    }
+}
+

package/model/getCorporateUserPermission.ts

@@ -0,0 +1,60 @@
+/**
+ * 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 { GetCorporateUserPermissionFeatureAccess } from './getCorporateUserPermissionFeatureAccess';
+import { GetCorporateUserPermissionGroupsInner } from './getCorporateUserPermissionGroupsInner';
+
+/**
+* Check admin user permissions
+*/
+export class GetCorporateUserPermission {
+    /**
+    * Email address of the user.
+    */
+    'email': string;
+    /**
+    * Status of the invited user.
+    */
+    'status': string;
+    'groups': Array<GetCorporateUserPermissionGroupsInner>;
+    'featureAccess': GetCorporateUserPermissionFeatureAccess;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "email",
+            "baseName": "email",
+            "type": "string"
+        },
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "string"
+        },
+        {
+            "name": "groups",
+            "baseName": "groups",
+            "type": "Array<GetCorporateUserPermissionGroupsInner>"
+        },
+        {
+            "name": "featureAccess",
+            "baseName": "feature_access",
+            "type": "GetCorporateUserPermissionFeatureAccess"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GetCorporateUserPermission.attributeTypeMap;
+    }
+}
+

package/model/getCorporateUserPermissionFeatureAccess.ts

@@ -0,0 +1,64 @@
+/**
+ * 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';
+
+/**
+* Granular feature permissions given to the user.
+*/
+export class GetCorporateUserPermissionFeatureAccess {
+    /**
+    * Permission on api keys
+    */
+    'apiKeys'?: Array<string>;
+    /**
+    * Permission on my plan
+    */
+    'myPlan'?: Array<string>;
+    /**
+    * Permission on user management
+    */
+    'userManagement'?: Array<string>;
+    /**
+    * Permission on apps management
+    */
+    'appsManagement'?: Array<string>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "apiKeys",
+            "baseName": "api_keys",
+            "type": "Array<string>"
+        },
+        {
+            "name": "myPlan",
+            "baseName": "my_plan",
+            "type": "Array<string>"
+        },
+        {
+            "name": "userManagement",
+            "baseName": "user_management",
+            "type": "Array<string>"
+        },
+        {
+            "name": "appsManagement",
+            "baseName": "apps_management",
+            "type": "Array<string>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GetCorporateUserPermissionFeatureAccess.attributeTypeMap;
+    }
+}
+

package/model/getCorporateUserPermissionGroupsInner.ts

@@ -0,0 +1,46 @@
+/**
+ * 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';
+
+/**
+* Groups details
+*/
+export class GetCorporateUserPermissionGroupsInner {
+    /**
+    * group identifier
+    */
+    'id'?: string;
+    /**
+    * Group name
+    */
+    'name'?: 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"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GetCorporateUserPermissionGroupsInner.attributeTypeMap;
+    }
+}
+

package/model/getCouponCollection.ts

@@ -14,29 +14,41 @@ import { RequestFile } from './models';
 
 export class GetCouponCollection {
     /**
-    * The id of the collection
+    * The id of the collection.
     */
     'id': string;
     /**
-    * The name of the collection
+    * The name of the collection.
     */
     'name': string;
     /**
-    * The default coupon of the collection
+    * The default coupon of the collection.
     */
     'defaultCoupon': string;
     /**
-    * Datetime on which the collection was created
+    * Datetime on which the collection was created.
     */
     'createdAt': Date;
     /**
-    * Total coupons in the collection
+    * Total number of coupons in the collection.
     */
     'totalCoupons': number;
     /**
-    * Not sent coupons in the collection
+    * Number of coupons that have not been sent yet.
     */
     'remainingCoupons': number;
+    /**
+    * Expiration date for the coupon collection in RFC3339 format.
+    */
+    'expirationDate'?: Date;
+    /**
+    * If present, an email notification is going to be sent the defined amount of days before the expiration date.
+    */
+    'remainingDaysAlert'?: number;
+    /**
+    * If present, an email notification is going to be sent when the total number of available coupons falls below the defined threshold.
+    */
+    'remainingCouponsAlert'?: number;
 
     static discriminator: string | undefined = undefined;
 
@@ -70,6 +82,21 @@ export class GetCouponCollection {
             "name": "remainingCoupons",
             "baseName": "remainingCoupons",
             "type": "number"
+        },
+        {
+            "name": "expirationDate",
+            "baseName": "expirationDate",
+            "type": "Date"
+        },
+        {
+            "name": "remainingDaysAlert",
+            "baseName": "remainingDaysAlert",
+            "type": "number"
+        },
+        {
+            "name": "remainingCouponsAlert",
+            "baseName": "remainingCouponsAlert",
+            "type": "number"
         }    ];
 
     static getAttributeTypeMap() {

package/model/getExtendedContactDetails.ts

@@ -17,7 +17,7 @@ export class GetExtendedContactDetails {
     /**
     * Email address of the contact for which you requested the details
     */
-    'email': string;
+    'email'?: string;
     /**
     * ID of the contact for which you requested the details
     */

package/model/getOrders.ts

@@ -0,0 +1,41 @@
+/**
+ * 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 { GetOrdersOrdersInner } from './getOrdersOrdersInner';
+
+export class GetOrders {
+    'orders'?: Array<GetOrdersOrdersInner>;
+    /**
+    * Number of orders
+    */
+    'count'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "orders",
+            "baseName": "orders",
+            "type": "Array<GetOrdersOrdersInner>"
+        },
+        {
+            "name": "count",
+            "baseName": "count",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GetOrders.attributeTypeMap;
+    }
+}
+

package/model/getOrdersOrdersInner.ts

@@ -0,0 +1,111 @@
+/**
+ * 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 { OrderBilling } from './orderBilling';
+import { OrderProductsInner } from './orderProductsInner';
+
+export class GetOrdersOrdersInner {
+    /**
+    * Unique ID of the order.
+    */
+    'id': string;
+    /**
+    * Event occurrence UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when order is actually created.
+    */
+    'createdAt': string;
+    /**
+    * Event updated UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when the status of the order is actually changed/updated.
+    */
+    'updatedAt': string;
+    /**
+    * State of the order.
+    */
+    'status': string;
+    /**
+    * Total amount of the order, including all shipping expenses, tax and the price of items.
+    */
+    'amount': number;
+    'products': Array<OrderProductsInner>;
+    /**
+    * Email of the contact, Mandatory if \"phone\" field is not passed in \"billing\" parameter.
+    */
+    'email'?: string;
+    'billing'?: OrderBilling;
+    /**
+    * Coupons applied to the order. Stored case insensitive.
+    */
+    'coupons'?: Array<string>;
+    /**
+    * Contact ID for the order
+    */
+    'contactId'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "string"
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "string"
+        },
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "string"
+        },
+        {
+            "name": "amount",
+            "baseName": "amount",
+            "type": "number"
+        },
+        {
+            "name": "products",
+            "baseName": "products",
+            "type": "Array<OrderProductsInner>"
+        },
+        {
+            "name": "email",
+            "baseName": "email",
+            "type": "string"
+        },
+        {
+            "name": "billing",
+            "baseName": "billing",
+            "type": "OrderBilling"
+        },
+        {
+            "name": "coupons",
+            "baseName": "coupons",
+            "type": "Array<string>"
+        },
+        {
+            "name": "contactId",
+            "baseName": "contact_id",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GetOrdersOrdersInner.attributeTypeMap;
+    }
+}
+