@getbrevo/brevo 2.0.0-beta.4 → 2.1.1

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

package/model/inviteuserPrivilegesInner.ts

@@ -54,11 +54,13 @@ export namespace InviteuserPrivilegesInner {
         FacebookAds = <any> 'facebook_ads',
         LandingPages = <any> 'landing_pages',
         TransactionalEmails = <any> 'transactional_emails',
-        ApiKeys = <any> 'api_keys',
+        SmtpApi = <any> 'smtp_api',
         UserManagement = <any> 'user_management',
         SalesPlatform = <any> 'sales_platform',
         Phone = <any> 'phone',
-        Conversations = <any> 'conversations'
+        Conversations = <any> 'conversations',
+        SendersDomainsDedicatedIps = <any> 'senders_domains_dedicated_ips',
+        PushNotifications = <any> 'push_notifications'
     }
     export enum PermissionsEnum {
         CreateEditDelete = <any> 'create_edit_delete',
@@ -77,6 +79,16 @@ export namespace InviteuserPrivilegesInner {
         Access = <any> 'access',
         Assign = <any> 'assign',
         Configure = <any> 'configure',
+        ManageOwnedDealsTasksCompanies = <any> 'manage_owned_deals_tasks_companies',
+        ManageOthersDealsTasksCompanies = <any> 'manage_others_deals_tasks_companies',
+        Reports = <any> 'reports',
+        SendersManagement = <any> 'senders_management',
+        DomainsManagement = <any> 'domains_management',
+        DedicatedIpsManagement = <any> 'dedicated_ips_management',
+        Send = <any> 'send',
+        Smtp = <any> 'smtp',
+        ApiKeys = <any> 'api_keys',
+        AuthorizedIps = <any> 'authorized_ips',
         None = <any> 'none'
     }
 }

package/model/masterDetailsResponsePlanInfoFeaturesInner.ts

@@ -26,10 +26,18 @@ export class MasterDetailsResponsePlanInfoFeaturesInner {
     */
     'quantity'?: number;
     /**
+    * Quantity with overages provided in the plan (only applicable on ENTv2)
+    */
+    'quantityWithOverages'?: number;
+    /**
     * Quantity consumed by master
     */
     'used'?: number;
     /**
+    * Quantity consumed by sub-organizations over the admin plan limit (only applicable on ENTv2)
+    */
+    'usedOverages'?: number;
+    /**
     * Quantity remaining in the plan
     */
     'remaining'?: number;
@@ -52,11 +60,21 @@ export class MasterDetailsResponsePlanInfoFeaturesInner {
             "baseName": "quantity",
             "type": "number"
         },
+        {
+            "name": "quantityWithOverages",
+            "baseName": "quantityWithOverages",
+            "type": "number"
+        },
         {
             "name": "used",
             "baseName": "used",
             "type": "number"
         },
+        {
+            "name": "usedOverages",
+            "baseName": "usedOverages",
+            "type": "number"
+        },
         {
             "name": "remaining",
             "baseName": "remaining",