@getbrevo/brevo 2.2.0 → 2.3.0

package/model/getContactCampaignStatsUnsubscriptions.ts

@@ -11,18 +11,18 @@
  */
 
 import { RequestFile } from './models';
-import { GetContactCampaignStatsUnsubscriptionsAdminUnsubscriptionInner } from './getContactCampaignStatsUnsubscriptionsAdminUnsubscriptionInner';
-import { GetContactCampaignStatsUnsubscriptionsUserUnsubscriptionInner } from './getContactCampaignStatsUnsubscriptionsUserUnsubscriptionInner';
+import { GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsAdminUnsubscription } from './getExtendedContactDetailsAllOfStatisticsUnsubscriptionsAdminUnsubscription';
+import { GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsUserUnsubscription } from './getExtendedContactDetailsAllOfStatisticsUnsubscriptionsUserUnsubscription';
 
 export class GetContactCampaignStatsUnsubscriptions {
     /**
     * Contact has unsubscribed via the unsubscription link in the email
     */
-    'userUnsubscription': Array<GetContactCampaignStatsUnsubscriptionsUserUnsubscriptionInner>;
+    'userUnsubscription': Array<GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsUserUnsubscription>;
     /**
     * Contact has been unsubscribed from the administrator
     */
-    'adminUnsubscription': Array<GetContactCampaignStatsUnsubscriptionsAdminUnsubscriptionInner>;
+    'adminUnsubscription': Array<GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsAdminUnsubscription>;
 
     static discriminator: string | undefined = undefined;
 
@@ -30,12 +30,12 @@ export class GetContactCampaignStatsUnsubscriptions {
         {
             "name": "userUnsubscription",
             "baseName": "userUnsubscription",
-            "type": "Array<GetContactCampaignStatsUnsubscriptionsUserUnsubscriptionInner>"
+            "type": "Array<GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsUserUnsubscription>"
         },
         {
             "name": "adminUnsubscription",
             "baseName": "adminUnsubscription",
-            "type": "Array<GetContactCampaignStatsUnsubscriptionsAdminUnsubscriptionInner>"
+            "type": "Array<GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsAdminUnsubscription>"
         }    ];
 
     static getAttributeTypeMap() {

package/model/getCorporateInvitedUsersListUsersInnerFeatureAccess.ts

@@ -32,6 +32,26 @@ export class GetCorporateInvitedUsersListUsersInnerFeatureAccess {
     * Apps management accessiblity | Not available in ENTv2
     */
     'appsManagement'?: Array<string>;
+    /**
+    * Group creation, modification or deletion accessibility
+    */
+    'subOrganizationGroups'?: Array<string>;
+    /**
+    * Authorization to create sub-organization in the admin account. If the user creating the sub-organization, belongs to a group, the user must choose a group at the sub-organization creation.
+    */
+    'createSubOrganizations'?: Array<string>;
+    /**
+    * Authorization to manage and access sub-organizations in the admin account.
+    */
+    'manageSubOrganizations'?: Array<string>;
+    /**
+    * Analytics dashboard accessibility
+    */
+    'analytics'?: Array<string>;
+    /**
+    * Security page accessibility
+    */
+    'security'?: Array<string>;
 
     static discriminator: string | undefined = undefined;
 
@@ -55,6 +75,31 @@ export class GetCorporateInvitedUsersListUsersInnerFeatureAccess {
             "name": "appsManagement",
             "baseName": "apps_management",
             "type": "Array<string>"
+        },
+        {
+            "name": "subOrganizationGroups",
+            "baseName": "sub_organization_groups",
+            "type": "Array<string>"
+        },
+        {
+            "name": "createSubOrganizations",
+            "baseName": "create_sub_organizations",
+            "type": "Array<string>"
+        },
+        {
+            "name": "manageSubOrganizations",
+            "baseName": "manage_sub_organizations",
+            "type": "Array<string>"
+        },
+        {
+            "name": "analytics",
+            "baseName": "analytics",
+            "type": "Array<string>"
+        },
+        {
+            "name": "security",
+            "baseName": "security",
+            "type": "Array<string>"
         }    ];
 
     static getAttributeTypeMap() {

package/model/getCorporateUserPermissionFeatureAccess.ts

@@ -32,6 +32,26 @@ export class GetCorporateUserPermissionFeatureAccess {
     * Permission on apps management
     */
     'appsManagement'?: Array<string>;
+    /**
+    * Permission on groups
+    */
+    'subOrganizationGroups'?: Array<string>;
+    /**
+    * Permission on create sub-accounts
+    */
+    'createSubOrganizations'?: Array<string>;
+    /**
+    * Permission on manage sub-accounts
+    */
+    'manageSubOrganizations'?: Array<string>;
+    /**
+    * Permission on analytics
+    */
+    'analytics'?: Array<string>;
+    /**
+    * Permission on security
+    */
+    'security'?: Array<string>;
 
     static discriminator: string | undefined = undefined;
 
@@ -55,6 +75,31 @@ export class GetCorporateUserPermissionFeatureAccess {
             "name": "appsManagement",
             "baseName": "apps_management",
             "type": "Array<string>"
+        },
+        {
+            "name": "subOrganizationGroups",
+            "baseName": "sub_organization_groups",
+            "type": "Array<string>"
+        },
+        {
+            "name": "createSubOrganizations",
+            "baseName": "create_sub_organizations",
+            "type": "Array<string>"
+        },
+        {
+            "name": "manageSubOrganizations",
+            "baseName": "manage_sub_organizations",
+            "type": "Array<string>"
+        },
+        {
+            "name": "analytics",
+            "baseName": "analytics",
+            "type": "Array<string>"
+        },
+        {
+            "name": "security",
+            "baseName": "security",
+            "type": "Array<string>"
         }    ];
 
     static getAttributeTypeMap() {

package/model/getEmailCampaign.ts

@@ -11,9 +11,7 @@
  */
 
 import { RequestFile } from './models';
-import { GetCampaignRecipients } from './getCampaignRecipients';
 import { GetExtendedCampaignOverviewAllOfSender } from './getExtendedCampaignOverviewAllOfSender';
-import { GetExtendedCampaignStats } from './getExtendedCampaignStats';
 
 export class GetEmailCampaign {
     /**
@@ -149,8 +147,8 @@ export class GetEmailCampaign {
     * Total number of non-delivered campaigns for a particular campaign id.
     */
     'returnBounce'?: number;
-    'recipients': GetCampaignRecipients;
-    'statistics': GetExtendedCampaignStats;
+    'recipients': object;
+    'statistics': object;
 
     static discriminator: string | undefined = undefined;
 
@@ -328,12 +326,12 @@ export class GetEmailCampaign {
         {
             "name": "recipients",
             "baseName": "recipients",
-            "type": "GetCampaignRecipients"
+            "type": "object"
         },
         {
             "name": "statistics",
             "baseName": "statistics",
-            "type": "GetExtendedCampaignStats"
+            "type": "object"
         }    ];
 
     static getAttributeTypeMap() {

package/model/getExtendedCampaignStats.ts

@@ -16,6 +16,9 @@ import { GetDeviceBrowserStats } from './getDeviceBrowserStats';
 import { GetStatsByDevice } from './getStatsByDevice';
 
 export class GetExtendedCampaignStats {
+    /**
+    * Overall statistics of the campaign
+    */
     'globalStats': GetCampaignStats;
     /**
     * List-wise statistics of the campaign.

package/model/getOrdersOrdersInner.ts

@@ -12,6 +12,7 @@
 
 import { RequestFile } from './models';
 import { OrderBilling } from './orderBilling';
+import { OrderIdentifiers } from './orderIdentifiers';
 import { OrderProductsInner } from './orderProductsInner';
 
 export class GetOrdersOrdersInner {
@@ -35,17 +36,22 @@ export class GetOrdersOrdersInner {
     * 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.
+    * ID of store where the order is placed
     */
-    'email'?: string;
+    'storeId'?: string;
+    'identifiers'?: OrderIdentifiers;
+    'products': Array<OrderProductsInner>;
     'billing'?: OrderBilling;
     /**
     * Coupons applied to the order. Stored case insensitive.
     */
     'coupons'?: Array<string>;
     /**
+    * Meta data of order to store additional detal such as custom message, customer type, source.
+    */
+    'metaInfo'?: { [key: string]: object; };
+    /**
     * Contact ID for the order
     */
     'contactId'?: number;
@@ -78,16 +84,21 @@ export class GetOrdersOrdersInner {
             "baseName": "amount",
             "type": "number"
         },
+        {
+            "name": "storeId",
+            "baseName": "storeId",
+            "type": "string"
+        },
+        {
+            "name": "identifiers",
+            "baseName": "identifiers",
+            "type": "OrderIdentifiers"
+        },
         {
             "name": "products",
             "baseName": "products",
             "type": "Array<OrderProductsInner>"
         },
-        {
-            "name": "email",
-            "baseName": "email",
-            "type": "string"
-        },
         {
             "name": "billing",
             "baseName": "billing",
@@ -98,6 +109,11 @@ export class GetOrdersOrdersInner {
             "baseName": "coupons",
             "type": "Array<string>"
         },
+        {
+            "name": "metaInfo",
+            "baseName": "metaInfo",
+            "type": "{ [key: string]: object; }"
+        },
         {
             "name": "contactId",
             "baseName": "contact_id",

package/model/getSegment.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 GetSegment {
+    /**
+    * ID of the segment
+    */
+    'id': number;
+    /**
+    * Name of the Segment
+    */
+    'segmentName': string;
+    /**
+    * Name of the Segment Category
+    */
+    'categoryName': string;
+    /**
+    * Updation UTC date-time of the segment (YYYY-MM-DDTHH:mm:ss.SSSZ)
+    */
+    'updatedAt'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "number"
+        },
+        {
+            "name": "segmentName",
+            "baseName": "segmentName",
+            "type": "string"
+        },
+        {
+            "name": "categoryName",
+            "baseName": "categoryName",
+            "type": "string"
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GetSegment.attributeTypeMap;
+    }
+}
+

package/model/getSegments.ts

@@ -11,10 +11,10 @@
  */
 
 import { RequestFile } from './models';
-import { GetSegmentsSegments } from './getSegmentsSegments';
+import { GetSegment } from './getSegment';
 
 export class GetSegments {
-    'segments'?: GetSegmentsSegments;
+    'segments'?: Array<GetSegment>;
     /**
     * Number of Segments available in your account
     */
@@ -26,7 +26,7 @@ export class GetSegments {
         {
             "name": "segments",
             "baseName": "segments",
-            "type": "GetSegmentsSegments"
+            "type": "Array<GetSegment>"
         },
         {
             "name": "count",

package/model/getSmsCampaign.ts

@@ -11,8 +11,6 @@
  */
 
 import { RequestFile } from './models';
-import { GetCampaignRecipients } from './getCampaignRecipients';
-import { GetSmsCampaignStats } from './getSmsCampaignStats';
 
 export class GetSmsCampaign {
     /**
@@ -47,8 +45,8 @@ export class GetSmsCampaign {
     * UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
     */
     'modifiedAt': string;
-    'recipients': GetCampaignRecipients;
-    'statistics': GetSmsCampaignStats;
+    'recipients': object;
+    'statistics': object;
 
     static discriminator: string | undefined = undefined;
 
@@ -96,12 +94,12 @@ export class GetSmsCampaign {
         {
             "name": "recipients",
             "baseName": "recipients",
-            "type": "GetCampaignRecipients"
+            "type": "object"
         },
         {
             "name": "statistics",
             "baseName": "statistics",
-            "type": "GetSmsCampaignStats"
+            "type": "object"
         }    ];
 
     static getAttributeTypeMap() {

package/model/inviteAdminUserPrivilegesInner.ts

@@ -49,10 +49,19 @@ export namespace InviteAdminUserPrivilegesInner {
         MyPlan = <any> 'my_plan',
         Api = <any> 'api',
         UserManagement = <any> 'user_management',
-        AppManagement = <any> 'app_management'
+        AppManagement = <any> 'app_management',
+        SubOrganizationGroups = <any> 'sub_organization_groups',
+        CreateSubOrganizations = <any> 'create_sub_organizations',
+        ManageSubOrganizations = <any> 'manage_sub_organizations',
+        Analytics = <any> 'analytics',
+        Security = <any> 'security'
     }
     export enum PermissionsEnum {
         All = <any> 'all',
-        None = <any> 'none'
+        None = <any> 'none',
+        Create = <any> 'create',
+        EditDelete = <any> 'edit_delete',
+        DownloadData = <any> 'download_data',
+        CreateAlerts = <any> 'create_alerts'
     }
 }

package/model/inviteuserPrivilegesInner.ts

@@ -51,7 +51,6 @@ export namespace InviteuserPrivilegesInner {
         Contacts = <any> 'contacts',
         Templates = <any> 'templates',
         Workflows = <any> 'workflows',
-        FacebookAds = <any> 'facebook_ads',
         LandingPages = <any> 'landing_pages',
         TransactionalEmails = <any> 'transactional_emails',
         SmtpApi = <any> 'smtp_api',
@@ -79,8 +78,11 @@ 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',
+        CreateEditDeals = <any> 'create_edit_deals',
+        DeleteDeals = <any> 'delete_deals',
+        ManageOthersDealsTasks = <any> 'manage_others_deals_tasks',
+        ManageOwnedCompanies = <any> 'manage_owned_companies',
+        ManageOthersCompanies = <any> 'manage_others_companies',
         Reports = <any> 'reports',
         SendersManagement = <any> 'senders_management',
         DomainsManagement = <any> 'domains_management',

package/model/loyaltyProgram.ts

@@ -0,0 +1,139 @@
+/**
+ * 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 LoyaltyProgram {
+    /**
+    * Loyalty Program code count
+    */
+    'codeCount'?: number;
+    /**
+    * Loyalty Program creation date
+    */
+    'createdAt'?: string;
+    /**
+    * Loyalty Program description
+    */
+    'description'?: string;
+    /**
+    * string
+    */
+    'documentId'?: string;
+    /**
+    * Loyalty Program ID
+    */
+    'id'?: string;
+    /**
+    * Loyalty Program meta data
+    */
+    'meta'?: { [key: string]: object; };
+    /**
+    * Loyalty Program name
+    */
+    'name'?: string;
+    /**
+    * string
+    */
+    'pattern'?: string;
+    /**
+    * Loyalty Program state
+    */
+    'state'?: LoyaltyProgram.StateEnum;
+    /**
+    * Loyalty Program subscription generator ID
+    */
+    'subscriptionGeneratorId'?: string;
+    /**
+    * Loyalty Program subscription pool ID
+    */
+    'subscriptionPoolId'?: string;
+    /**
+    * Loyalty Program last modification date
+    */
+    'updatedAt'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "codeCount",
+            "baseName": "codeCount",
+            "type": "number"
+        },
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "string"
+        },
+        {
+            "name": "description",
+            "baseName": "description",
+            "type": "string"
+        },
+        {
+            "name": "documentId",
+            "baseName": "documentId",
+            "type": "string"
+        },
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "meta",
+            "baseName": "meta",
+            "type": "{ [key: string]: object; }"
+        },
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "pattern",
+            "baseName": "pattern",
+            "type": "string"
+        },
+        {
+            "name": "state",
+            "baseName": "state",
+            "type": "LoyaltyProgram.StateEnum"
+        },
+        {
+            "name": "subscriptionGeneratorId",
+            "baseName": "subscriptionGeneratorId",
+            "type": "string"
+        },
+        {
+            "name": "subscriptionPoolId",
+            "baseName": "subscriptionPoolId",
+            "type": "string"
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return LoyaltyProgram.attributeTypeMap;
+    }
+}
+
+export namespace LoyaltyProgram {
+    export enum StateEnum {
+        Inactive = <any> 'inactive',
+        Active = <any> 'active'
+    }
+}

package/model/loyaltyProgramPage.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  |   | 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 { LoyaltyProgram } from './loyaltyProgram';
+
+export class LoyaltyProgramPage {
+    /**
+    * Loyalty Program list
+    */
+    'items'?: Array<LoyaltyProgram>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "items",
+            "baseName": "items",
+            "type": "Array<LoyaltyProgram>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return LoyaltyProgramPage.attributeTypeMap;
+    }
+}
+

package/model/loyaltyProgramValidationError.ts

@@ -0,0 +1,52 @@
+/**
+ * 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 LoyaltyProgramValidationError {
+    /**
+    * Path of data that failed validation
+    */
+    'path'?: string;
+    /**
+    * Rule that failed validation
+    */
+    'rule'?: string;
+    /**
+    * Validation error message
+    */
+    'error'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "path",
+            "baseName": "path",
+            "type": "string"
+        },
+        {
+            "name": "rule",
+            "baseName": "rule",
+            "type": "string"
+        },
+        {
+            "name": "error",
+            "baseName": "error",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return LoyaltyProgramValidationError.attributeTypeMap;
+    }
+}
+