@getbrevo/brevo 5.0.0 → 5.0.1

package/dist/esm/api/resources/event/client/requests/CreateEventRequest.d.mts

@@ -31,26 +31,26 @@ export declare namespace CreateEventRequest {
      */
     interface Identifiers {
         /** Internal unique contact ID. When present, this takes priority over all other identifiers for event attribution and contact resolution. */
-        contact_id?: number;
+        contact_id?: number | undefined;
         /** Email Id associated with the event */
-        email_id?: string;
+        email_id?: string | undefined;
         /** ext_id associated with the event */
-        ext_id?: string;
+        ext_id?: string | undefined;
         /** landline_number associated with the event */
-        landline_number_id?: string;
+        landline_number_id?: string | undefined;
         /** SMS associated with the event */
-        phone_id?: string;
+        phone_id?: string | undefined;
         /** whatsapp associated with the event */
-        whatsapp_id?: string;
+        whatsapp_id?: string | undefined;
     }
     /**
      * Identifiers of the object record associated with this event. Ignored if the object type or identifier for this record does not exist on the account.
      */
     interface Object_ {
         /** Identifiers for the object. */
-        identifiers?: Object_.Identifiers;
+        identifiers?: Object_.Identifiers | undefined;
         /** Type of object (e.g., subscription, vehicle, etc.) */
-        type?: string;
+        type?: string | undefined;
     }
     namespace Object_ {
         /**
@@ -58,9 +58,9 @@ export declare namespace CreateEventRequest {
          */
         interface Identifiers {
             /** External object ID */
-            ext_id?: string;
+            ext_id?: string | undefined;
             /** Internal object ID */
-            id?: string;
+            id?: string | undefined;
         }
     }
 }

package/dist/esm/api/resources/event/exports.d.mts

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

package/dist/esm/api/resources/event/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { EventClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/event/index.d.mts

@@ -1 +1,2 @@
 export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/event/index.mjs

@@ -1 +1,2 @@
 export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/event/types/CreateBatchEventsRequestItem.d.mts

@@ -0,0 +1,59 @@
+export interface CreateBatchEventsRequestItem {
+    /** Properties defining the state of the contact associated to this event. Useful to update contact attributes defined in your contacts database while passing the event. For example: **"FIRSTNAME": "Jane" , "AGE": 37** */
+    contact_properties?: Record<string, CreateBatchEventsRequestItem.ContactProperties.Value> | undefined;
+    /** Timestamp of when the event occurred (e.g. "2024-01-24T17:39:57+01:00"). If no value is passed, the timestamp of the event creation is used. */
+    event_date?: string | undefined;
+    /** The name of the event that occurred. This is how you will find your event in Brevo. Limited to 255 characters, alphanumerical characters and - _ only. */
+    event_name: string;
+    /** Properties of the event. Top level properties and nested properties can be used to better segment contacts and personalise workflow conditions. The following field type are supported: string, number, boolean (true/false), date (Timestamp e.g. "2024-01-24T17:39:57+01:00"). Keys are limited to 255 characters, alphanumerical characters and - _ only. Size is limited to 50Kb. */
+    event_properties?: Record<string, CreateBatchEventsRequestItem.EventProperties.Value> | undefined;
+    /** Identifies the contact associated with the event. At least one identifier is required. */
+    identifiers: CreateBatchEventsRequestItem.Identifiers;
+    /** Identifiers of the object record associated with this event. Ignored if the object type or identifier for this record does not exist on the account. */
+    object?: CreateBatchEventsRequestItem.Object_ | undefined;
+}
+export declare namespace CreateBatchEventsRequestItem {
+    namespace ContactProperties {
+        type Value = string | number;
+    }
+    namespace EventProperties {
+        type Value = string | number | Record<string, unknown> | unknown[];
+    }
+    /**
+     * Identifies the contact associated with the event. At least one identifier is required.
+     */
+    interface Identifiers {
+        /** Internal unique contact ID. When present, this takes priority over all other identifiers for event attribution and contact resolution. */
+        contact_id?: number | undefined;
+        /** Email Id associated with the event */
+        email_id?: string | undefined;
+        /** ext_id associated with the event */
+        ext_id?: string | undefined;
+        /** landline_number associated with the event */
+        landline_number_id?: string | undefined;
+        /** SMS associated with the event */
+        phone_id?: string | undefined;
+        /** whatsapp associated with the event */
+        whatsapp_id?: string | undefined;
+    }
+    /**
+     * Identifiers of the object record associated with this event. Ignored if the object type or identifier for this record does not exist on the account.
+     */
+    interface Object_ {
+        /** Identifiers for the object. */
+        identifiers?: Object_.Identifiers | undefined;
+        /** Type of object (e.g., subscription, vehicle, etc.) */
+        type?: string | undefined;
+    }
+    namespace Object_ {
+        /**
+         * Identifiers for the object.
+         */
+        interface Identifiers {
+            /** External object ID */
+            ext_id?: string | undefined;
+            /** Internal object ID */
+            id?: string | undefined;
+        }
+    }
+}

package/dist/esm/api/resources/event/types/CreateBatchEventsRequestItem.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/event/types/index.d.mts

@@ -0,0 +1 @@
+export * from "./CreateBatchEventsRequestItem.mjs";

package/dist/esm/api/resources/event/types/index.mjs

@@ -0,0 +1 @@
+export * from "./CreateBatchEventsRequestItem.mjs";

package/dist/esm/api/resources/externalFeeds/client/requests/GetExternalFeedByUuidRequest.d.mts

@@ -1,14 +1,4 @@
 /**
- * @example
- *     {
- *         uuid: "b1c2d3e4-f5a6-47b8-89c0-d1e2f3a4b5c6"
- *     }
- *
- * @example
- *     {
- *         uuid: "b1c2d3e4-f5a6-47b8-89c0-d1e2f3a4b5c6"
- *     }
- *
  * @example
  *     {
  *         uuid: "b1c2d3e4-f5a6-47b8-89c0-d1e2f3a4b5c6"

package/dist/esm/api/resources/externalFeeds/exports.d.mts

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

package/dist/esm/api/resources/externalFeeds/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { ExternalFeedsClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/externalFeeds/types/GetAllExternalFeedsResponse.d.mts

@@ -19,11 +19,11 @@ export declare namespace GetAllExternalFeedsResponse {
             /** Authentication type for accessing the feed */
             authType: Item.AuthType;
             /** Username for basic authentication */
-            username?: string;
+            username?: string | undefined;
             /** Password for basic authentication */
-            password?: string;
+            password?: string | undefined;
             /** Token for token-based authentication */
-            token?: string;
+            token?: string | undefined;
             /** Maximum number of retry attempts for failed requests */
             maxRetries: number;
             /** Whether to cache the feed response */
@@ -31,7 +31,7 @@ export declare namespace GetAllExternalFeedsResponse {
             /** Whether this is an internal Brevo system feed */
             isInternal: boolean;
             /** Custom HTTP headers for the feed request */
-            headers?: Item.Headers.Item[] | null;
+            headers?: (Item.Headers.Item[] | null) | undefined;
             /** Feed creation timestamp */
             createdAt: string;
             /** Feed last modification timestamp */

package/dist/esm/api/resources/externalFeeds/types/GetExternalFeedByUuidResponse.d.mts

@@ -8,11 +8,11 @@ export interface GetExternalFeedByUuidResponse {
     /** Authentication type for accessing the feed */
     authType: GetExternalFeedByUuidResponse.AuthType;
     /** Username for basic authentication (null if not using basic auth) */
-    username?: string | null;
+    username?: (string | null) | undefined;
     /** Password for basic authentication (null if not using basic auth) */
-    password?: string | null;
+    password?: (string | null) | undefined;
     /** Token for token-based authentication (null if not using token auth) */
-    token?: string | null;
+    token?: (string | null) | undefined;
     /** Whether personalization is enabled for this feed */
     personalization: boolean;
     /** Default attribute name for personalization fallback (empty string if not set) */
@@ -20,7 +20,7 @@ export interface GetExternalFeedByUuidResponse {
     /** Default contact email for personalization fallback (empty string if not set) */
     defaultContact: string;
     /** Custom HTTP headers for the feed request */
-    headers?: GetExternalFeedByUuidResponse.Headers.Item[] | null;
+    headers?: (GetExternalFeedByUuidResponse.Headers.Item[] | null) | undefined;
     /** Maximum number of retry attempts for failed requests */
     maxRetries: number;
     /** Whether to cache the feed response */

package/dist/esm/api/resources/files/exports.d.mts

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

package/dist/esm/api/resources/files/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { FilesClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/files/types/GetCrmFilesIdResponse.d.mts

@@ -3,5 +3,5 @@
  */
 export interface GetCrmFilesIdResponse {
     /** A unique link to download the requested file. */
-    fileUrl?: string;
+    fileUrl?: string | undefined;
 }

package/dist/esm/api/resources/inboundParsing/client/Client.d.mts

@@ -40,6 +40,7 @@ export declare class InboundParsingClient {
     private __getInboundEmailEventsByUuid;
     /**
      * This endpoint will retrieve inbound attachment with download token.
+     *
      * @throws {@link Brevo.BadRequestError}
      * @throws {@link Brevo.NotFoundError}
      */

package/dist/esm/api/resources/inboundParsing/client/Client.mjs

@@ -132,6 +132,7 @@ export class InboundParsingClient {
     }
     /**
      * This endpoint will retrieve inbound attachment with download token.
+     *
      * @throws {@link Brevo.BadRequestError}
      * @throws {@link Brevo.NotFoundError}
      */

package/dist/esm/api/resources/inboundParsing/exports.d.mts

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

package/dist/esm/api/resources/inboundParsing/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { InboundParsingClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/inboundParsing/types/GetInboundEmailEventsByUuidResponse.d.mts

@@ -1,42 +1,42 @@
 export interface GetInboundEmailEventsByUuidResponse {
     /** List of attachments of the email. This will be present only after the processing is done. */
-    attachments?: GetInboundEmailEventsByUuidResponse.Attachments.Item[];
+    attachments?: GetInboundEmailEventsByUuidResponse.Attachments.Item[] | undefined;
     /** Date when email was delivered successfully to client_dev’s webhook */
-    deliveredAt?: string | null;
+    deliveredAt?: (string | null) | undefined;
     /** List of events/logs that describe the lifecycle of the email on SIB platform */
-    logs?: GetInboundEmailEventsByUuidResponse.Logs.Item[];
+    logs?: GetInboundEmailEventsByUuidResponse.Logs.Item[] | undefined;
     /** Value of the Message-ID header. This will be present only after the processing is done. */
-    messageId?: string;
+    messageId?: string | undefined;
     /** Date when email was received on SMTP relay */
-    receivedAt?: string;
+    receivedAt?: string | undefined;
     /** Recipient’s email address */
-    recipient?: string;
+    recipient?: string | undefined;
     /** Sender’s email address */
-    sender?: string;
+    sender?: string | undefined;
     /** Value of the Subject header. This will be present only after the processing is done. */
-    subject?: string;
+    subject?: string | undefined;
 }
 export declare namespace GetInboundEmailEventsByUuidResponse {
     type Attachments = Attachments.Item[];
     namespace Attachments {
         interface Item {
             /** value of the Content-ID header of the attachment. */
-            contentId?: string;
+            contentId?: string | undefined;
             /** size of the attachment in bytes */
-            contentLength?: number;
+            contentLength?: number | undefined;
             /** value of the Content-Type header of the attachment */
-            contentType?: string;
+            contentType?: string | undefined;
             /** filename specified in the Content-Disposition header of the attachment */
-            name?: string;
+            name?: string | undefined;
         }
     }
     type Logs = Logs.Item[];
     namespace Logs {
         interface Item {
             /** Date of the event */
-            date?: string;
+            date?: string | undefined;
             /** Type of the event */
-            type?: Item.Type;
+            type?: Item.Type | undefined;
         }
         namespace Item {
             /** Type of the event */

package/dist/esm/api/resources/inboundParsing/types/GetInboundEmailEventsResponse.d.mts

@@ -1,5 +1,5 @@
 export interface GetInboundEmailEventsResponse {
-    events?: GetInboundEmailEventsResponse.Events.Item[];
+    events?: GetInboundEmailEventsResponse.Events.Item[] | undefined;
 }
 export declare namespace GetInboundEmailEventsResponse {
     type Events = Events.Item[];

package/dist/esm/api/resources/index.d.mts

@@ -33,6 +33,7 @@ export * as emailCampaigns from "./emailCampaigns/index.mjs";
 export * from "./emailCampaigns/types/index.mjs";
 export * from "./event/client/requests/index.mjs";
 export * as event from "./event/index.mjs";
+export * from "./event/types/index.mjs";
 export * from "./externalFeeds/client/requests/index.mjs";
 export * as externalFeeds from "./externalFeeds/index.mjs";
 export * from "./externalFeeds/types/index.mjs";

package/dist/esm/api/resources/index.mjs

@@ -33,6 +33,7 @@ export * as emailCampaigns from "./emailCampaigns/index.mjs";
 export * from "./emailCampaigns/types/index.mjs";
 export * from "./event/client/requests/index.mjs";
 export * as event from "./event/index.mjs";
+export * from "./event/types/index.mjs";
 export * from "./externalFeeds/client/requests/index.mjs";
 export * as externalFeeds from "./externalFeeds/index.mjs";
 export * from "./externalFeeds/types/index.mjs";

package/dist/esm/api/resources/masterAccount/client/requests/InviteAdminUserRequest.d.mts

@@ -23,9 +23,9 @@ export declare namespace InviteAdminUserRequest {
          */
         interface Item {
             /** Feature name */
-            feature?: Item.Feature;
+            feature?: Item.Feature | undefined;
             /** Permissions for a given feature */
-            permissions?: Item.Permissions.Item[];
+            permissions?: Item.Permissions.Item[] | undefined;
         }
         namespace Item {
             /** Feature name */

package/dist/esm/api/resources/masterAccount/client/requests/PutCorporateSubAccountIdPlanRequest.d.mts

@@ -34,39 +34,39 @@ export declare namespace PutCorporateSubAccountIdPlanRequest {
          * Number of email credits | Pass the value -1 for unlimited
          * emails in ENTv2 only
          */
-        email?: number;
+        email?: number | undefined;
         /**
          * Number of externalFeeds credits, possible values are 0 or 1
          * |available in ENTv2 only
          */
-        externalFeeds?: number;
+        externalFeeds?: number | undefined;
         /**
          * Number of SMS credits | Pass the value -1 for unlimited SMS
          * in ENTv2 only
          */
-        sms?: number;
+        sms?: number | undefined;
         /**
          * Number of whatsapp credits | Pass the value -1 for unlimited
          * whatsapp in ENTv2 only
          */
-        whatsapp?: number;
+        whatsapp?: number | undefined;
         /**
          * Number of Push credits, possible value is 0 and -1 |
          * available in ENT-v2 only
          */
-        wpSubscribers?: number;
+        wpSubscribers?: number | undefined;
     }
     /**
      * Features details to update
      */
     interface Features {
         /** Number of inboxes / Not required on ENTv2 */
-        inbox?: number;
+        inbox?: number | undefined;
         /** Number of landing pages */
-        landingPage?: number;
+        landingPage?: number | undefined;
         /** Number of sales and service users | only available in ENT-V2 */
-        salesUsers?: number;
+        salesUsers?: number | undefined;
         /** Number of multi-users */
-        users?: number;
+        users?: number | undefined;
     }
 }

package/dist/esm/api/resources/masterAccount/client/requests/PutCorporateSubAccountsPlanRequest.d.mts

@@ -33,37 +33,37 @@ export declare namespace PutCorporateSubAccountsPlanRequest {
          * Number of email credits | Pass the value -1 for unlimited
          * emails in ENTv2 only
          */
-        email?: number;
+        email?: number | undefined;
         /**
          * Number of externalFeeds credits, possible values are 0 or 1
          * |available in ENTv2 only
          */
-        externalFeeds?: number;
+        externalFeeds?: number | undefined;
         /**
          * Number of SMS credits | Pass the value -1 for unlimited SMS
          * in ENTv2 only
          */
-        sms?: number;
+        sms?: number | undefined;
         /**
          * Number of whatsapp credits | Pass the value -1 for unlimited
          * whatsapp in ENTv2 only
          */
-        whatsapp?: number;
+        whatsapp?: number | undefined;
         /**
          * Number of Push credits, possible value is 0 and -1 |
          * available in ENT-v2 only
          */
-        wpSubscribers?: number;
+        wpSubscribers?: number | undefined;
     }
     /**
      * Features details to update
      */
     interface Features {
         /** Number of landing pages */
-        landingPage?: number;
+        landingPage?: number | undefined;
         /** Number of sales and service users | only available in ENT-V2 */
-        salesUsers?: number;
+        salesUsers?: number | undefined;
         /** Number of multi-users */
-        users?: number;
+        users?: number | undefined;
     }
 }

package/dist/esm/api/resources/masterAccount/client/requests/PutCorporateUserEmailPermissionsRequest.d.mts

@@ -48,9 +48,9 @@ export declare namespace PutCorporateUserEmailPermissionsRequest {
          */
         interface Item {
             /** feature name */
-            feature?: Item.Feature;
+            feature?: Item.Feature | undefined;
             /** Permission for the feature */
-            permissions?: Item.Permissions.Item[];
+            permissions?: Item.Permissions.Item[] | undefined;
         }
         namespace Item {
             /** feature name */

package/dist/esm/api/resources/masterAccount/exports.d.mts

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

package/dist/esm/api/resources/masterAccount/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { MasterAccountClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/masterAccount/types/GetCorporateGroupIdResponse.d.mts

@@ -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/esm/api/resources/masterAccount/types/GetCorporateInvitedUsersListResponse.d.mts

@@ -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/esm/api/resources/masterAccount/types/GetCorporateIpResponseItem.d.mts

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