@getbrevo/brevo 4.0.1 → 5.0.1

package/dist/cjs/api/resources/masterAccount/exports.d.ts

@@ -0,0 +1,2 @@
+export { MasterAccountClient } from "./client/Client.js";
+export * from "./client/index.js";

package/dist/cjs/api/resources/masterAccount/exports.js

@@ -0,0 +1,21 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MasterAccountClient = void 0;
+var Client_js_1 = require("./client/Client.js");
+Object.defineProperty(exports, "MasterAccountClient", { enumerable: true, get: function () { return Client_js_1.MasterAccountClient; } });
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/masterAccount/types/GetCorporateGroupIdResponse.d.ts

@@ -1,37 +1,37 @@
 export interface GetCorporateGroupIdResponse {
-    group?: GetCorporateGroupIdResponse.Group;
-    "sub-accounts"?: GetCorporateGroupIdResponse.SubAccounts.Item[];
-    users?: GetCorporateGroupIdResponse.Users.Item[];
+    group?: GetCorporateGroupIdResponse.Group | undefined;
+    "sub-accounts"?: GetCorporateGroupIdResponse.SubAccounts.Item[] | undefined;
+    users?: GetCorporateGroupIdResponse.Users.Item[] | undefined;
 }
 export declare namespace GetCorporateGroupIdResponse {
     interface Group {
         /** Group creation date */
-        createdAt?: string;
+        createdAt?: string | undefined;
         /** Name of the group */
-        groupName?: string;
+        groupName?: string | undefined;
         /** Group id */
-        id?: string;
+        id?: string | undefined;
     }
     type SubAccounts = SubAccounts.Item[];
     namespace SubAccounts {
         interface Item {
             /** Name of the sub-account organzation */
-            companyName?: string;
+            companyName?: string | undefined;
             /** Creation date of the sub-account organzation */
-            createdAt?: string;
+            createdAt?: string | undefined;
             /** Id of the sub-account organzation */
-            id?: number;
+            id?: number | undefined;
         }
     }
     type Users = Users.Item[];
     namespace Users {
         interface Item {
             /** Email address of the user */
-            email?: string;
+            email?: string | undefined;
             /** First name of the user */
-            firstName?: string;
+            firstName?: string | undefined;
             /** Last name of the user */
-            lastName?: string;
+            lastName?: string | undefined;
         }
     }
 }

package/dist/cjs/api/resources/masterAccount/types/GetCorporateInvitedUsersListResponse.d.ts

@@ -1,6 +1,6 @@
 export interface GetCorporateInvitedUsersListResponse {
     /** Get invited users list */
-    users?: GetCorporateInvitedUsersListResponse.Users.Item[];
+    users?: GetCorporateInvitedUsersListResponse.Users.Item[] | undefined;
 }
 export declare namespace GetCorporateInvitedUsersListResponse {
     type Users = Users.Item[];
@@ -27,44 +27,44 @@ export declare namespace GetCorporateInvitedUsersListResponse {
              */
             interface FeatureAccess {
                 /** Analytics dashboard accessibility */
-                analytics?: string[];
+                analytics?: string[] | undefined;
                 /** Api keys accessiblity. */
-                api_keys?: string[];
+                api_keys?: string[] | undefined;
                 /**
                  * Apps management accessiblity | Not available in
                  * ENTv2
                  */
-                apps_management?: string[];
+                apps_management?: string[] | undefined;
                 /**
                  * 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.
                  */
-                create_sub_organizations?: string[];
+                create_sub_organizations?: string[] | undefined;
                 /**
                  * Authorization to manage and access sub-organizations
                  * in the admin account.
                  */
-                manage_sub_organizations?: string[];
+                manage_sub_organizations?: string[] | undefined;
                 /** My plan accessiblity. */
-                my_plan?: string[];
+                my_plan?: string[] | undefined;
                 /**
                  * Group creation, modification or deletion
                  * accessibility
                  */
-                sub_organization_groups?: string[];
+                sub_organization_groups?: string[] | undefined;
                 /** User management accessiblity. */
-                user_management?: string[];
+                user_management?: string[] | undefined;
             }
             /**
              * Admin user groups list
              */
             interface Groups {
                 /** group id */
-                id?: string;
+                id?: string | undefined;
                 /** group name */
-                name?: string;
+                name?: string | undefined;
             }
         }
     }

package/dist/cjs/api/resources/masterAccount/types/GetCorporateIpResponseItem.d.ts

@@ -1,5 +1,5 @@
 export interface GetCorporateIpResponseItem {
-    domain?: string;
-    ip?: string;
-    transactional?: boolean;
+    domain?: string | undefined;
+    ip?: string | undefined;
+    transactional?: boolean | undefined;
 }

package/dist/cjs/api/resources/masterAccount/types/GetCorporateMasterAccountResponse.d.ts

@@ -1,18 +1,18 @@
 export interface GetCorporateMasterAccountResponse {
     /** Billing details of the master account organization */
-    billingInfo?: GetCorporateMasterAccountResponse.BillingInfo;
+    billingInfo?: GetCorporateMasterAccountResponse.BillingInfo | undefined;
     /** Company name of master account organization */
-    companyName?: string;
+    companyName?: string | undefined;
     /** Currency code of the master account organization */
-    currencyCode?: string;
+    currencyCode?: string | undefined;
     /** Email id of master account */
-    email?: string;
+    email?: string | undefined;
     /** Unique identifier of the master account organization */
-    id?: number;
+    id?: number | undefined;
     /** Plan details */
-    planInfo?: GetCorporateMasterAccountResponse.PlanInfo;
+    planInfo?: GetCorporateMasterAccountResponse.PlanInfo | undefined;
     /** Timezone of the master account organization */
-    timezone?: string;
+    timezone?: string | undefined;
 }
 export declare namespace GetCorporateMasterAccountResponse {
     /**
@@ -20,13 +20,13 @@ export declare namespace GetCorporateMasterAccountResponse {
      */
     interface BillingInfo {
         /** Billing address of master account */
-        address?: BillingInfo.Address;
+        address?: BillingInfo.Address | undefined;
         /** Company name of master account */
-        companyName?: string;
+        companyName?: string | undefined;
         /** Billing email id of master account */
-        email?: string;
+        email?: string | undefined;
         /** Billing name of master account holder */
-        name?: BillingInfo.Name;
+        name?: BillingInfo.Name | undefined;
     }
     namespace BillingInfo {
         /**
@@ -34,24 +34,24 @@ export declare namespace GetCorporateMasterAccountResponse {
          */
         interface Address {
             /** Country code */
-            countryCode?: string;
+            countryCode?: string | undefined;
             /** Locality */
-            locality?: string;
+            locality?: string | undefined;
             /** Postal code */
-            postalCode?: string;
+            postalCode?: string | undefined;
             /** State code */
-            stateCode?: string;
+            stateCode?: string | undefined;
             /** Street address */
-            streetAddress?: string;
+            streetAddress?: string | undefined;
         }
         /**
          * Billing name of master account holder
          */
         interface Name {
             /** Last name for billing */
-            familyName?: string;
+            familyName?: string | undefined;
             /** First name for billing */
-            givenName?: string;
+            givenName?: string | undefined;
         }
     }
     /**
@@ -59,42 +59,42 @@ export declare namespace GetCorporateMasterAccountResponse {
      */
     interface PlanInfo {
         /** Plan currency */
-        currencyCode?: string;
+        currencyCode?: string | undefined;
         /** List of provided features in the plan */
-        features?: PlanInfo.Features.Item[];
+        features?: PlanInfo.Features.Item[] | undefined;
         /** Timestamp of next billing date */
-        nextBillingAt?: number;
+        nextBillingAt?: number | undefined;
         /** Plan period type */
-        planPeriod?: PlanInfo.PlanPeriod;
+        planPeriod?: PlanInfo.PlanPeriod | undefined;
         /** Plan amount */
-        price?: number;
+        price?: number | undefined;
         /** Number of sub-accounts */
-        subAccounts?: number;
+        subAccounts?: number | undefined;
     }
     namespace PlanInfo {
         type Features = Features.Item[];
         namespace Features {
             interface Item {
                 /** Name of the feature */
-                name?: string;
+                name?: string | undefined;
                 /** Quantity provided in the plan */
-                quantity?: number;
+                quantity?: number | undefined;
                 /**
                  * Quantity with overages provided in the plan (only
                  * applicable on ENTv2)
                  */
-                quantityWithOverages?: number;
+                quantityWithOverages?: number | undefined;
                 /** Quantity remaining in the plan */
-                remaining?: number;
+                remaining?: number | undefined;
                 /** Unit value of the feature */
-                unitValue?: string;
+                unitValue?: string | undefined;
                 /** Quantity consumed by master */
-                used?: number;
+                used?: number | undefined;
                 /**
                  * Quantity consumed by sub-organizations over the
                  * admin plan limit (only applicable on ENTv2)
                  */
-                usedOverages?: number;
+                usedOverages?: number | undefined;
             }
         }
         /** Plan period type */

package/dist/cjs/api/resources/masterAccount/types/GetCorporateSubAccountIdResponse.d.ts

@@ -1,23 +1,23 @@
 export interface GetCorporateSubAccountIdResponse {
     /** Sub-account company name */
-    companyName?: string;
+    companyName?: string | undefined;
     /** Email id of the sub-account organization */
-    email?: string;
+    email?: string | undefined;
     /** List of groups associated with the sub-account */
-    groups?: GetCorporateSubAccountIdResponse.Groups.Item[];
+    groups?: GetCorporateSubAccountIdResponse.Groups.Item[] | undefined;
     /** Name of the sub-account user */
-    name?: string;
+    name?: string | undefined;
     /** Sub-account plan details */
-    planInfo?: GetCorporateSubAccountIdResponse.PlanInfo;
+    planInfo?: GetCorporateSubAccountIdResponse.PlanInfo | undefined;
 }
 export declare namespace GetCorporateSubAccountIdResponse {
     type Groups = Groups.Item[];
     namespace Groups {
         interface Item {
             /** Group id */
-            id?: string;
+            id?: string | undefined;
             /** Name of the group */
-            name?: string;
+            name?: string | undefined;
         }
     }
     /**
@@ -25,11 +25,11 @@ export declare namespace GetCorporateSubAccountIdResponse {
      */
     interface PlanInfo {
         /** Credits quota and remaining credits on the sub-account */
-        credits?: PlanInfo.Credits;
+        credits?: PlanInfo.Credits | undefined;
         /** Features available on the sub-account */
-        features?: PlanInfo.Features;
+        features?: PlanInfo.Features | undefined;
         /** type of the plan */
-        planType?: string;
+        planType?: string | undefined;
     }
     namespace PlanInfo {
         /**
@@ -37,15 +37,15 @@ export declare namespace GetCorporateSubAccountIdResponse {
          */
         interface Credits {
             /** Email credits remaining on the sub-account */
-            emails?: Credits.Emails;
+            emails?: Credits.Emails | undefined;
             /** externalFeeds credits remaining on the sub-account */
-            externalFeeds?: Credits.ExternalFeeds;
+            externalFeeds?: Credits.ExternalFeeds | undefined;
             /** SMS credits remaining on the sub-account */
-            sms?: Credits.Sms;
+            sms?: Credits.Sms | undefined;
             /** Whatsapp credits remaining on the sub-account */
-            whatsapp?: Credits.Whatsapp;
+            whatsapp?: Credits.Whatsapp | undefined;
             /** Push credits remaining on the sub-account */
-            wpSubscribers?: Credits.WpSubscribers;
+            wpSubscribers?: Credits.WpSubscribers | undefined;
         }
         namespace Credits {
             /**
@@ -53,9 +53,9 @@ export declare namespace GetCorporateSubAccountIdResponse {
              */
             interface Emails {
                 /** Quantity of email messaging limits provided */
-                quantity?: number;
+                quantity?: number | undefined;
                 /** Available email messaging limits for use */
-                remaining?: number;
+                remaining?: number | undefined;
             }
             /**
              * externalFeeds credits remaining on the sub-account
@@ -65,36 +65,36 @@ export declare namespace GetCorporateSubAccountIdResponse {
                  * Quantity of externalFeeds messaging limits
                  * provided
                  */
-                quantity?: number;
+                quantity?: number | undefined;
                 /** Available externalFeeds messaging limits for use */
-                remaining?: number;
+                remaining?: number | undefined;
             }
             /**
              * SMS credits remaining on the sub-account
              */
             interface Sms {
                 /** Quantity of SMS messaging limits provided */
-                quantity?: number;
+                quantity?: number | undefined;
                 /** Available SMS messaging limits for use */
-                remaining?: number;
+                remaining?: number | undefined;
             }
             /**
              * Whatsapp credits remaining on the sub-account
              */
             interface Whatsapp {
                 /** Quantity of whatsapp messaging limits provided */
-                quantity?: number;
+                quantity?: number | undefined;
                 /** Available whatsapp messaging limits for use */
-                remaining?: number;
+                remaining?: number | undefined;
             }
             /**
              * Push credits remaining on the sub-account
              */
             interface WpSubscribers {
                 /** Quantity of Push sending limits provided */
-                quantity?: number;
+                quantity?: number | undefined;
                 /** Available Push sending limits for use */
-                remaining?: number;
+                remaining?: number | undefined;
             }
         }
         /**
@@ -102,16 +102,16 @@ export declare namespace GetCorporateSubAccountIdResponse {
          */
         interface Features {
             /** Inbox details / Not applicable on ENTv2 */
-            inbox?: Features.Inbox;
+            inbox?: Features.Inbox | undefined;
             /** Landing page details / Not applicable on ENTv2 */
-            landingPage?: Features.LandingPage;
+            landingPage?: Features.LandingPage | undefined;
             /**
              * Sales and service users to use phone, sales and
              * conversations
              */
-            salesUsers?: Features.SalesUsers;
+            salesUsers?: Features.SalesUsers | undefined;
             /** Marketing users to manage the marketing channels */
-            users?: Features.Users;
+            users?: Features.Users | undefined;
         }
         namespace Features {
             /**
@@ -119,18 +119,18 @@ export declare namespace GetCorporateSubAccountIdResponse {
              */
             interface Inbox {
                 /** Quantity of inbox provided */
-                quantity?: number;
+                quantity?: number | undefined;
                 /** Available inboxes for use */
-                remaining?: number;
+                remaining?: number | undefined;
             }
             /**
              * Landing page details / Not applicable on ENTv2
              */
             interface LandingPage {
                 /** Quantity of landing pages provided */
-                quantity?: number;
+                quantity?: number | undefined;
                 /** Available landing pages for use */
-                remaining?: number;
+                remaining?: number | undefined;
             }
             /**
              * Sales and service users to use phone, sales and
@@ -138,18 +138,18 @@ export declare namespace GetCorporateSubAccountIdResponse {
              */
             interface SalesUsers {
                 /** Quantity of sales users provided */
-                quantity?: number;
+                quantity?: number | undefined;
                 /** Available sales users for use */
-                remaining?: number;
+                remaining?: number | undefined;
             }
             /**
              * Marketing users to manage the marketing channels
              */
             interface Users {
                 /** Quantity of marketing users provided */
-                quantity?: number;
+                quantity?: number | undefined;
                 /** Available marketing users for use */
-                remaining?: number;
+                remaining?: number | undefined;
             }
         }
     }

package/dist/cjs/api/resources/masterAccount/types/GetCorporateSubAccountResponse.d.ts

@@ -1,7 +1,7 @@
 export interface GetCorporateSubAccountResponse {
     /** Total number of subaccounts */
-    count?: number;
-    subAccounts?: GetCorporateSubAccountResponse.SubAccounts.Item[];
+    count?: number | undefined;
+    subAccounts?: GetCorporateSubAccountResponse.SubAccounts.Item[] | undefined;
 }
 export declare namespace GetCorporateSubAccountResponse {
     type SubAccounts = SubAccounts.Item[];
@@ -23,9 +23,9 @@ export declare namespace GetCorporateSubAccountResponse {
             namespace Groups {
                 interface Item {
                     /** Group identifier */
-                    id?: string;
+                    id?: string | undefined;
                     /** Name of the group */
-                    name?: string;
+                    name?: string | undefined;
                 }
             }
         }

package/dist/cjs/api/resources/masterAccount/types/GetCorporateUserPermissionResponse.d.ts

@@ -16,21 +16,21 @@ export declare namespace GetCorporateUserPermissionResponse {
      */
     interface FeatureAccess {
         /** Permission on analytics */
-        analytics?: string[];
+        analytics?: string[] | undefined;
         /** Permission on api keys */
-        api_keys?: string[];
+        api_keys?: string[] | undefined;
         /** Permission on apps management */
-        apps_management?: string[];
+        apps_management?: string[] | undefined;
         /** Permission on create sub-accounts */
-        create_sub_organizations?: string[];
+        create_sub_organizations?: string[] | undefined;
         /** Permission on manage sub-accounts */
-        manage_sub_organizations?: string[];
+        manage_sub_organizations?: string[] | undefined;
         /** Permission on my plan */
-        my_plan?: string[];
+        my_plan?: string[] | undefined;
         /** Permission on groups */
-        sub_organization_groups?: string[];
+        sub_organization_groups?: string[] | undefined;
         /** Permission on user management */
-        user_management?: string[];
+        user_management?: string[] | undefined;
     }
     type Groups = Groups.Item[];
     namespace Groups {
@@ -39,9 +39,9 @@ export declare namespace GetCorporateUserPermissionResponse {
          */
         interface Item {
             /** group identifier */
-            id?: string;
+            id?: string | undefined;
             /** Group name */
-            name?: string;
+            name?: string | undefined;
         }
     }
 }

package/dist/cjs/api/resources/masterAccount/types/GetSubAccountGroupsResponseItem.d.ts

@@ -1,6 +1,6 @@
 export interface GetSubAccountGroupsResponseItem {
     /** The name of the group of sub-accounts */
-    groupName?: string;
+    groupName?: string | undefined;
     /** Unique id of the group */
-    id?: string;
+    id?: string | undefined;
 }

package/dist/cjs/api/resources/masterAccount/types/InviteAdminUserResponse.d.ts

@@ -1,3 +1,3 @@
 export interface InviteAdminUserResponse {
-    id?: string;
+    id?: string | undefined;
 }

package/dist/cjs/api/resources/masterAccount/types/PostCorporateGroupResponse.d.ts

@@ -1,3 +1,3 @@
 export interface PostCorporateGroupResponse {
-    id?: string;
+    id?: string | undefined;
 }

package/dist/cjs/api/resources/masterAccount/types/PutCorporateUserInvitationActionEmailResponse.d.ts

@@ -1,4 +1,4 @@
 export interface PutCorporateUserInvitationActionEmailResponse {
     /** Action success message */
-    message?: string;
+    message?: string | undefined;
 }

package/dist/cjs/api/resources/notes/exports.d.ts

@@ -0,0 +1,2 @@
+export { NotesClient } from "./client/Client.js";
+export * from "./client/index.js";

package/dist/cjs/api/resources/notes/exports.js

@@ -0,0 +1,21 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotesClient = void 0;
+var Client_js_1 = require("./client/Client.js");
+Object.defineProperty(exports, "NotesClient", { enumerable: true, get: function () { return Client_js_1.NotesClient; } });
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/notes/types/PostCrmNotesResponse.d.ts

@@ -3,5 +3,5 @@
  */
 export interface PostCrmNotesResponse {
     /** Unique note Id */
-    id?: string;
+    id?: string | undefined;
 }

package/dist/cjs/api/resources/payments/exports.d.ts

@@ -0,0 +1,2 @@
+export { PaymentsClient } from "./client/Client.js";
+export * from "./client/index.js";

package/dist/cjs/api/resources/payments/exports.js

@@ -0,0 +1,21 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaymentsClient = void 0;
+var Client_js_1 = require("./client/Client.js");
+Object.defineProperty(exports, "PaymentsClient", { enumerable: true, get: function () { return Client_js_1.PaymentsClient; } });
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/payments/types/CreatePaymentRequestResponse.d.ts

@@ -2,5 +2,5 @@ export interface CreatePaymentRequestResponse {
     /** ID of the object created */
     id: number;
     /** URL of the payment request created */
-    url?: string;
+    url?: string | undefined;
 }

package/dist/cjs/api/resources/payments/types/GetPaymentRequestResponse.d.ts

@@ -1,12 +1,12 @@
 import type * as Brevo from "../../../index.js";
 export interface GetPaymentRequestResponse {
     cart: Brevo.Cart;
-    configuration?: Brevo.Configuration;
+    configuration?: Brevo.Configuration | undefined;
     /** Brevo ID of the contact requested to pay. */
-    contactId?: number;
+    contactId?: number | undefined;
     notification: Brevo.Notification;
     /** number of reminders sent. */
-    numberOfRemindersSent?: number;
+    numberOfRemindersSent?: number | undefined;
     /** Reference of the payment request, it will appear on the payment page. */
     reference: string;
     /** Status of the payment request. */