@getbrevo/brevo 2.0.0-beta.2 → 2.1.0

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;
+    }
+}
+

package/model/getPaymentRequest.ts

@@ -0,0 +1,80 @@
+/**
+ * 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 { Cart } from './cart';
+import { Configuration } from './configuration';
+import { Notification } from './notification';
+
+export class GetPaymentRequest {
+    /**
+    * Reference of the payment request, it will appear on the payment page. 
+    */
+    'reference': string;
+    /**
+    * Status of the payment request.
+    */
+    'status': GetPaymentRequest.StatusEnum;
+    'configuration'?: Configuration;
+    /**
+    * Brevo ID of the contact requested to pay. 
+    */
+    'contactId'?: number;
+    'cart': Cart;
+    'notification': Notification;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "reference",
+            "baseName": "reference",
+            "type": "string"
+        },
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "GetPaymentRequest.StatusEnum"
+        },
+        {
+            "name": "configuration",
+            "baseName": "configuration",
+            "type": "Configuration"
+        },
+        {
+            "name": "contactId",
+            "baseName": "contactId",
+            "type": "number"
+        },
+        {
+            "name": "cart",
+            "baseName": "cart",
+            "type": "Cart"
+        },
+        {
+            "name": "notification",
+            "baseName": "notification",
+            "type": "Notification"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GetPaymentRequest.attributeTypeMap;
+    }
+}
+
+export namespace GetPaymentRequest {
+    export enum StatusEnum {
+        Created = <any> 'created',
+        Sent = <any> 'sent',
+        ReminderSentPaid = <any> 'reminderSent - paid'
+    }
+}

package/model/getSubAccountGroups200ResponseInner.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 GetSubAccountGroups200ResponseInner {
+    /**
+    * Unique id of the group
+    */
+    'id'?: string;
+    /**
+    * The name of the group of sub-accounts
+    */
+    'groupName'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "groupName",
+            "baseName": "groupName",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GetSubAccountGroups200ResponseInner.attributeTypeMap;
+    }
+}
+

package/model/getWebhook.ts

@@ -11,6 +11,8 @@
  */
 
 import { RequestFile } from './models';
+import { GetWebhookAuth } from './getWebhookAuth';
+import { GetWebhookHeadersInner } from './getWebhookHeadersInner';
 
 export class GetWebhook {
     /**
@@ -38,6 +40,15 @@ export class GetWebhook {
     * Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)
     */
     'modifiedAt': string;
+    /**
+    * To send batched webhooks
+    */
+    'batched'?: boolean;
+    'auth'?: GetWebhookAuth;
+    /**
+    * Custom headers to be send with webhooks
+    */
+    'headers'?: Array<GetWebhookHeadersInner>;
 
     static discriminator: string | undefined = undefined;
 
@@ -76,6 +87,21 @@ export class GetWebhook {
             "name": "modifiedAt",
             "baseName": "modifiedAt",
             "type": "string"
+        },
+        {
+            "name": "batched",
+            "baseName": "batched",
+            "type": "boolean"
+        },
+        {
+            "name": "auth",
+            "baseName": "auth",
+            "type": "GetWebhookAuth"
+        },
+        {
+            "name": "headers",
+            "baseName": "headers",
+            "type": "Array<GetWebhookHeadersInner>"
         }    ];
 
     static getAttributeTypeMap() {

package/model/getWebhookAuth.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';
+
+/**
+* Add authentication on webhook url
+*/
+export class GetWebhookAuth {
+    /**
+    * Type of authentication
+    */
+    'type'?: string;
+    /**
+    * Webhook authentication token
+    */
+    'token'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "type",
+            "baseName": "type",
+            "type": "string"
+        },
+        {
+            "name": "token",
+            "baseName": "token",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GetWebhookAuth.attributeTypeMap;
+    }
+}
+

package/model/getWebhookHeadersInner.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 GetWebhookHeadersInner {
+    /**
+    * Header key name
+    */
+    'key'?: string;
+    /**
+    * Header value
+    */
+    'value'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "key",
+            "baseName": "key",
+            "type": "string"
+        },
+        {
+            "name": "value",
+            "baseName": "value",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GetWebhookHeadersInner.attributeTypeMap;
+    }
+}
+

package/model/inviteAdminUser.ts

@@ -0,0 +1,59 @@
+/**
+ * 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 { InviteAdminUserPrivilegesInner } from './inviteAdminUserPrivilegesInner';
+
+export class InviteAdminUser {
+    /**
+    * Email address for the organization
+    */
+    'email': string;
+    /**
+    * All access to the features
+    */
+    'allFeaturesAccess': boolean;
+    /**
+    * Ids of Group
+    */
+    'groupIds'?: Array<string>;
+    'privileges': Array<InviteAdminUserPrivilegesInner>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "email",
+            "baseName": "email",
+            "type": "string"
+        },
+        {
+            "name": "allFeaturesAccess",
+            "baseName": "all_features_access",
+            "type": "boolean"
+        },
+        {
+            "name": "groupIds",
+            "baseName": "groupIds",
+            "type": "Array<string>"
+        },
+        {
+            "name": "privileges",
+            "baseName": "privileges",
+            "type": "Array<InviteAdminUserPrivilegesInner>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return InviteAdminUser.attributeTypeMap;
+    }
+}
+

package/model/inviteAdminUserPrivilegesInner.ts

@@ -0,0 +1,58 @@
+/**
+ * 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';
+
+/**
+* Privileges given to the user
+*/
+export class InviteAdminUserPrivilegesInner {
+    /**
+    * Feature name
+    */
+    'feature'?: InviteAdminUserPrivilegesInner.FeatureEnum;
+    /**
+    * Permissions for a given feature
+    */
+    'permissions'?: Array<InviteAdminUserPrivilegesInner.PermissionsEnum>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "feature",
+            "baseName": "feature",
+            "type": "InviteAdminUserPrivilegesInner.FeatureEnum"
+        },
+        {
+            "name": "permissions",
+            "baseName": "permissions",
+            "type": "Array<InviteAdminUserPrivilegesInner.PermissionsEnum>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return InviteAdminUserPrivilegesInner.attributeTypeMap;
+    }
+}
+
+export namespace InviteAdminUserPrivilegesInner {
+    export enum FeatureEnum {
+        MyPlan = <any> 'my_plan',
+        Api = <any> 'api',
+        UserManagement = <any> 'user_management',
+        AppManagement = <any> 'app_management'
+    }
+    export enum PermissionsEnum {
+        All = <any> 'all',
+        None = <any> 'none'
+    }
+}