@getbrevo/brevo 5.0.0 → 5.0.3

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

@@ -22,19 +22,11 @@ export declare class WhatsAppCampaignsClient {
     getWhatsAppCampaigns(request?: Brevo.GetWhatsAppCampaignsRequest, requestOptions?: WhatsAppCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetWhatsAppCampaignsResponse>;
     private __getWhatsAppCampaigns;
     /**
-     * <Note>
-     * You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
-     *
-     * [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
-     * </Note>
-     *
-     * <Note>
-     * This API requires the List and Segment ids as recipients in Body params. You can use the below Contact endpoints to get the required information.
-     *
+     * <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+     * [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
+     * <Note>This API requires the List and Segment ids as recipients in Body params.You can use the below Contact endpoints to get the required information.
      * [Get all the Lists](https://developers.brevo.com/reference/getlists-1)
-     *
-     * [Get all the Segments](https://developers.brevo.com/reference/getsegments)
-     * </Note>
+     * [Get all the Segments](https://developers.brevo.com/reference/getsegments)</Note>
      *
      * @param {Brevo.CreateWhatsAppCampaignRequest} request
      * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -52,11 +44,8 @@ export declare class WhatsAppCampaignsClient {
     createWhatsAppCampaign(request: Brevo.CreateWhatsAppCampaignRequest, requestOptions?: WhatsAppCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateWhatsAppCampaignResponse>;
     private __createWhatsAppCampaign;
     /**
-     * <Note>
-     * You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
-     *
-     * [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
-     * </Note>
+     * <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+     * [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
      *
      * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -68,11 +57,8 @@ export declare class WhatsAppCampaignsClient {
     getWhatsAppConfig(requestOptions?: WhatsAppCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetWhatsAppConfigResponse>;
     private __getWhatsAppConfig;
     /**
-     * <Note>
-     * You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
-     *
-     * [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
-     * </Note>
+     * <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+     * [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
      *
      * @param {Brevo.CreateWhatsAppTemplateRequest} request
      * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -101,11 +87,8 @@ export declare class WhatsAppCampaignsClient {
     getWhatsAppTemplates(request?: Brevo.GetWhatsAppTemplatesRequest, requestOptions?: WhatsAppCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetWhatsAppTemplatesResponse>;
     private __getWhatsAppTemplates;
     /**
-     * <Note>
-     * You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
-     *
-     * [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
-     * </Note>
+     * <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+     * [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
      *
      * @param {Brevo.SendWhatsAppTemplateApprovalRequest} request
      * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -120,11 +103,11 @@ export declare class WhatsAppCampaignsClient {
     sendWhatsAppTemplateApproval(request: Brevo.SendWhatsAppTemplateApprovalRequest, requestOptions?: WhatsAppCampaignsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __sendWhatsAppTemplateApproval;
     /**
-     * <Note>
-     * You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
-     *
-     * [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
-     * </Note>
+     * <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+     * [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
+     * <Note>This API requires the List and Segment ids as recipients in Body params.You can use the below Contact endpoints to get the required information.
+     * [Get all the Lists](https://developers.brevo.com/reference/getlists-1)
+     * [Get all the Segments](https://developers.brevo.com/reference/getsegments)</Note>
      *
      * @param {Brevo.GetWhatsAppCampaignRequest} request
      * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -140,19 +123,11 @@ export declare class WhatsAppCampaignsClient {
     getWhatsAppCampaign(request: Brevo.GetWhatsAppCampaignRequest, requestOptions?: WhatsAppCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetWhatsAppCampaignResponse>;
     private __getWhatsAppCampaign;
     /**
-     * <Note>
-     * You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
-     *
-     * [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
-     * </Note>
-     *
-     * <Note>
-     * This API requires the List and Segment ids as recipients in Body params. You can use the below Contact endpoints to get the required information.
-     *
+     * <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+     * [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
+     * <Note>This API requires the List and Segment ids as recipients in Body params.You can use the below Contact endpoints to get the required information.
      * [Get all the Lists](https://developers.brevo.com/reference/getlists-1)
-     *
-     * [Get all the Segments](https://developers.brevo.com/reference/getsegments)
-     * </Note>
+     * [Get all the Segments](https://developers.brevo.com/reference/getsegments)</Note>
      *
      * @param {Brevo.UpdateWhatsAppCampaignRequest} request
      * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -85,19 +85,11 @@ export class WhatsAppCampaignsClient {
         });
     }
     /**
-     * <Note>
-     * You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
-     *
-     * [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
-     * </Note>
-     *
-     * <Note>
-     * This API requires the List and Segment ids as recipients in Body params. You can use the below Contact endpoints to get the required information.
-     *
+     * <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+     * [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
+     * <Note>This API requires the List and Segment ids as recipients in Body params.You can use the below Contact endpoints to get the required information.
      * [Get all the Lists](https://developers.brevo.com/reference/getlists-1)
-     *
-     * [Get all the Segments](https://developers.brevo.com/reference/getsegments)
-     * </Note>
+     * [Get all the Segments](https://developers.brevo.com/reference/getsegments)</Note>
      *
      * @param {Brevo.CreateWhatsAppCampaignRequest} request
      * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -153,11 +145,8 @@ export class WhatsAppCampaignsClient {
         });
     }
     /**
-     * <Note>
-     * You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
-     *
-     * [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
-     * </Note>
+     * <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+     * [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
      *
      * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -204,11 +193,8 @@ export class WhatsAppCampaignsClient {
         });
     }
     /**
-     * <Note>
-     * You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
-     *
-     * [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
-     * </Note>
+     * <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+     * [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
      *
      * @param {Brevo.CreateWhatsAppTemplateRequest} request
      * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -319,11 +305,8 @@ export class WhatsAppCampaignsClient {
         });
     }
     /**
-     * <Note>
-     * You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
-     *
-     * [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
-     * </Note>
+     * <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+     * [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
      *
      * @param {Brevo.SendWhatsAppTemplateApprovalRequest} request
      * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -374,11 +357,11 @@ export class WhatsAppCampaignsClient {
         });
     }
     /**
-     * <Note>
-     * You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
-     *
-     * [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
-     * </Note>
+     * <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+     * [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
+     * <Note>This API requires the List and Segment ids as recipients in Body params.You can use the below Contact endpoints to get the required information.
+     * [Get all the Lists](https://developers.brevo.com/reference/getlists-1)
+     * [Get all the Segments](https://developers.brevo.com/reference/getsegments)</Note>
      *
      * @param {Brevo.GetWhatsAppCampaignRequest} request
      * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -432,19 +415,11 @@ export class WhatsAppCampaignsClient {
         });
     }
     /**
-     * <Note>
-     * You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
-     *
-     * [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
-     * </Note>
-     *
-     * <Note>
-     * This API requires the List and Segment ids as recipients in Body params. You can use the below Contact endpoints to get the required information.
-     *
+     * <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+     * [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
+     * <Note>This API requires the List and Segment ids as recipients in Body params.You can use the below Contact endpoints to get the required information.
      * [Get all the Lists](https://developers.brevo.com/reference/getlists-1)
-     *
-     * [Get all the Segments](https://developers.brevo.com/reference/getsegments)
-     * </Note>
+     * [Get all the Segments](https://developers.brevo.com/reference/getsegments)</Note>
      *
      * @param {Brevo.UpdateWhatsAppCampaignRequest} request
      * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/api/resources/whatsAppCampaigns/client/requests/CreateWhatsAppCampaignRequest.d.mts

@@ -23,10 +23,10 @@ export declare namespace CreateWhatsAppCampaignRequest {
      */
     interface Recipients {
         /** List ids to exclude from the campaign */
-        excludedListIds?: number[];
+        excludedListIds?: number[] | undefined;
         /** **Mandatory if scheduledAt is not empty**. List Ids to send the campaign to */
-        listIds?: number[];
+        listIds?: number[] | undefined;
         /** **Mandatory if listIds are not used**. Segment ids to send the campaign to. */
-        segments?: number[];
+        segments?: number[] | undefined;
     }
 }

package/dist/esm/api/resources/whatsAppCampaigns/client/requests/UpdateWhatsAppCampaignRequest.d.mts

@@ -28,10 +28,10 @@ export declare namespace UpdateWhatsAppCampaignRequest {
      */
     interface Recipients {
         /** List ids to exclude from the campaign */
-        excludedListIds?: number[];
+        excludedListIds?: number[] | undefined;
         /** **Mandatory if scheduledAt is not empty**. List Ids to send the campaign to */
-        listIds?: number[];
+        listIds?: number[] | undefined;
         /** **Mandatory if listIds are not used**. Segment ids to send the campaign to. */
-        segments?: number[];
+        segments?: number[] | undefined;
     }
 }

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

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

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

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

package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignResponse.d.mts

@@ -11,10 +11,10 @@ export interface GetWhatsAppCampaignResponse {
     /** UTC date-time of last modification of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) */
     modifiedAt: string;
     /** UTC date-time on which WhatsApp campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format */
-    scheduledAt?: string;
+    scheduledAt?: string | undefined;
     /** Sender of the WhatsApp Campaign */
     senderNumber: string;
-    stats?: Brevo.WhatsappCampStats;
+    stats?: Brevo.WhatsappCampStats | undefined;
     template: GetWhatsAppCampaignResponse.Template;
 }
 export declare namespace GetWhatsAppCampaignResponse {
@@ -32,30 +32,30 @@ export declare namespace GetWhatsAppCampaignResponse {
     type CampaignStatus = (typeof CampaignStatus)[keyof typeof CampaignStatus];
     interface Template {
         /** array of variables item variables */
-        body_variables?: Brevo.VariablesItems[];
-        button_type?: string;
+        body_variables?: Brevo.VariablesItems[] | undefined;
+        button_type?: string | undefined;
         /** description of the template */
-        category?: string;
+        category?: string | undefined;
         /** array of component item objects */
-        components?: Template.Components.Item[];
-        contains_button?: boolean;
-        display_header?: boolean;
+        components?: Template.Components.Item[] | undefined;
+        contains_button?: boolean | undefined;
+        display_header?: boolean | undefined;
         /** type of header */
-        header_type?: string;
+        header_type?: string | undefined;
         /** array of variables item object */
-        header_variables?: Brevo.VariablesItems[];
-        hide_footer?: boolean;
+        header_variables?: Brevo.VariablesItems[] | undefined;
+        hide_footer?: boolean | undefined;
         /** language of the template */
-        language?: string;
+        language?: string | undefined;
         /** name of the template */
-        name?: string;
+        name?: string | undefined;
     }
     namespace Template {
         type Components = Components.Item[];
         namespace Components {
             interface Item {
-                text?: string;
-                type?: string;
+                text?: string | undefined;
+                type?: string | undefined;
             }
         }
     }

package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignsResponse.d.mts

@@ -1,8 +1,8 @@
 import type * as Brevo from "../../../index.mjs";
 export interface GetWhatsAppCampaignsResponse {
-    campaigns?: GetWhatsAppCampaignsResponse.Campaigns.Item[];
+    campaigns?: GetWhatsAppCampaignsResponse.Campaigns.Item[] | undefined;
     /** Number of WhatsApp campaigns retrieved */
-    count?: number;
+    count?: number | undefined;
 }
 export declare namespace GetWhatsAppCampaignsResponse {
     type Campaigns = Campaigns.Item[];
@@ -15,18 +15,18 @@ export declare namespace GetWhatsAppCampaignsResponse {
             /** Creation UTC date-time of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) */
             createdAt: string;
             /** Error Reason associated with the WhatsApp campaign sending */
-            errorReason?: string;
+            errorReason?: string | undefined;
             /** ID of the WhatsApp Campaign */
             id: number;
             /** Count of invalidated contacts */
-            invalidatedContacts?: number;
+            invalidatedContacts?: number | undefined;
             /** UTC date-time of last modification of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) */
             modifiedAt: string;
             /** Read percentage of the the whatsapp campaign created */
-            readPercentage?: number;
+            readPercentage?: number | undefined;
             /** UTC date-time on which WhatsApp campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format */
             scheduledAt: string;
-            stats?: Brevo.WhatsappCampStats;
+            stats?: Brevo.WhatsappCampStats | undefined;
             /** Id of the WhatsApp template */
             templateId: string;
         }

package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppConfigResponse.d.mts

@@ -1,16 +1,16 @@
 export interface GetWhatsAppConfigResponse {
     /** Verification status information of the Business account */
-    businessStatus?: string;
+    businessStatus?: string | undefined;
     /** Status of the name associated with WhatsApp Phone number */
-    phoneNumberNameStatus?: GetWhatsAppConfigResponse.PhoneNumberNameStatus;
+    phoneNumberNameStatus?: GetWhatsAppConfigResponse.PhoneNumberNameStatus | undefined;
     /** Quality status of phone number associated with WhatsApp account. There are three quality ratings. example - **High (GREEN) , Medium (YELLOW) and Low(RED)** */
-    phoneNumberQuality?: GetWhatsAppConfigResponse.PhoneNumberQuality;
+    phoneNumberQuality?: GetWhatsAppConfigResponse.PhoneNumberQuality | undefined;
     /** Sending limit of the WhatsApp account */
-    sendingLimit?: string;
+    sendingLimit?: string | undefined;
     /** Id of the WhatsApp business account */
-    whatsappBusinessAccountId?: string;
+    whatsappBusinessAccountId?: string | undefined;
     /** Status information related to WhatsApp Api account */
-    whatsappBusinessAccountStatus?: GetWhatsAppConfigResponse.WhatsappBusinessAccountStatus;
+    whatsappBusinessAccountStatus?: GetWhatsAppConfigResponse.WhatsappBusinessAccountStatus | undefined;
 }
 export declare namespace GetWhatsAppConfigResponse {
     /** Status of the name associated with WhatsApp Phone number */

package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppTemplatesResponse.d.mts

@@ -1,7 +1,7 @@
 export interface GetWhatsAppTemplatesResponse {
     /** Number of whatsApp templates retrieved */
-    count?: number;
-    templates?: GetWhatsAppTemplatesResponse.Templates.Item[];
+    count?: number | undefined;
+    templates?: GetWhatsAppTemplatesResponse.Templates.Item[] | undefined;
 }
 export declare namespace GetWhatsAppTemplatesResponse {
     type Templates = Templates.Item[];
@@ -12,7 +12,7 @@ export declare namespace GetWhatsAppTemplatesResponse {
             /** Creation UTC date-time of the whatsApp template (YYYY-MM-DDTHH:mm:ss.SSSZ) */
             createdAt: string;
             /** Error reason in the template creation */
-            errorReason?: string;
+            errorReason?: string | undefined;
             /** ID of the whatsApp template */
             id: number;
             /** Language in which template exists */

package/dist/esm/api/types/BalanceDefinition.d.mts

@@ -1,44 +1,44 @@
 export interface BalanceDefinition {
     /** startOfPeriod depicts the balancy expiry on start of day/week/month/year. endOfPeriod depicts the balancy expiry on end of day/week/month/year */
-    balanceAvailabilityDurationModifier?: BalanceDefinition.BalanceAvailabilityDurationModifier;
+    balanceAvailabilityDurationModifier?: BalanceDefinition.BalanceAvailabilityDurationModifier | undefined;
     /** Unit of time for the balance's availability (e.g., day/week/month/year). */
-    balanceAvailabilityDurationUnit?: string;
+    balanceAvailabilityDurationUnit?: string | undefined;
     /** Number of days/weeks/month/year for balance expiry */
-    balanceAvailabilityDurationValue?: number;
+    balanceAvailabilityDurationValue?: number | undefined;
     /** Date when the balance expires and can no longer be used, in dd/mm format. The balance will be expired when this date appears next in the calendar and only one of balanceExpirationDate or balance availability fields can be used. */
-    balanceExpirationDate?: string;
+    balanceExpirationDate?: string | undefined;
     /** Partial enables partial credit of balance if maximum balance limit is reaching. Strict enables rejection of transaction if it will breach the max credit amount limit. */
-    balanceOptionAmountOvertakingStrategy?: string;
+    balanceOptionAmountOvertakingStrategy?: string | undefined;
     /** Rounding strategy for credit transactions. */
-    balanceOptionCreditRounding?: string;
+    balanceOptionCreditRounding?: string | undefined;
     /** Rounding strategy for debit transactions. */
-    balanceOptionDebitRounding?: string;
+    balanceOptionDebitRounding?: string | undefined;
     /** Timestamp of balance definition creation. */
-    createdAt?: string;
+    createdAt?: string | undefined;
     /** Timestamp of balance definition deletion (nullable). */
-    deletedAt?: string;
+    deletedAt?: string | undefined;
     /** Short description of the balance definition. */
-    description?: string;
+    description?: string | undefined;
     /** Unique identifier for the balance definition. */
-    id?: string;
+    id?: string | undefined;
     /** Optional image reference URL. */
-    imageRef?: string;
+    imageRef?: string | undefined;
     /** Maximum allowable balance. */
-    maxAmount?: number;
+    maxAmount?: number | undefined;
     /** Max credit allowed per operation. */
-    maxCreditAmountLimit?: number;
+    maxCreditAmountLimit?: number | undefined;
     /** Max debit allowed per operation. */
-    maxDebitAmountLimit?: number;
+    maxDebitAmountLimit?: number | undefined;
     /** Additional metadata for the balance definition. */
-    meta?: Record<string, unknown>;
+    meta?: Record<string, unknown> | undefined;
     /** Minimum allowable balance. */
-    minAmount?: number;
+    minAmount?: number | undefined;
     /** Name of the balance definition. */
-    name?: string;
+    name?: string | undefined;
     /** Unit of balance (e.g., points, currency). */
-    unit?: string;
+    unit?: string | undefined;
     /** Timestamp of the last update. */
-    updatedAt?: string;
+    updatedAt?: string | undefined;
 }
 export declare namespace BalanceDefinition {
     /** startOfPeriod depicts the balancy expiry on start of day/week/month/year. endOfPeriod depicts the balancy expiry on end of day/week/month/year */

package/dist/esm/api/types/BalanceLimit.d.mts

@@ -1,22 +1,22 @@
 export interface BalanceLimit {
     /** balance definition ID */
-    balanceDefinitionId?: string;
+    balanceDefinitionId?: string | undefined;
     /** Defines the type of constraint (e.g., transaction-based or amount-based). */
-    constraintType?: string;
+    constraintType?: string | undefined;
     /** Timestamp of when the balance limit was created. */
     createdAt: string;
     /** Time unit for the balance limit (day, week, month, year). */
-    durationUnit?: string;
+    durationUnit?: string | undefined;
     /** Number of time units the balance limit applies to. */
-    durationValue?: number;
+    durationValue?: number | undefined;
     /** Unique identifier for the balance limit. */
-    id?: string;
+    id?: string | undefined;
     /** Indicates if the limit resets periodically based on a sliding schedule. */
-    slidingSchedule?: boolean;
+    slidingSchedule?: boolean | undefined;
     /** Specifies whether the limit applies to credit or debit transactions. */
-    transactionType?: string;
+    transactionType?: string | undefined;
     /** Timestamp of the last update to the balance limit. */
     updatedAt: string;
     /** The maximum allowed value for the defined constraint. */
-    value?: number;
+    value?: number | undefined;
 }

package/dist/esm/api/types/BatchAcceptedResponse.d.mts

@@ -0,0 +1,9 @@
+/**
+ * Response returned when all events in the batch are accepted for async processing
+ */
+export interface BatchAcceptedResponse {
+    /** Confirmation message indicating the batch was accepted */
+    message: string;
+    /** Number of events queued for processing */
+    count: number;
+}

package/dist/esm/api/types/BatchAcceptedResponse.mjs

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

package/dist/esm/api/types/BatchEventsResponse.d.mts

@@ -0,0 +1,26 @@
+/**
+ * Response returned when a batch of events is processed
+ */
+export interface BatchEventsResponse {
+    /** Status of the batch request */
+    status: string;
+    /** Total number of events submitted in the batch */
+    total_events: number;
+    /** Number of events that were successfully processed */
+    successful_events: number;
+    /** Number of events that failed to be processed */
+    failed_events: number;
+    /** List of errors for the failed events */
+    errors: BatchEventsResponse.Errors.Item[];
+}
+export declare namespace BatchEventsResponse {
+    type Errors = Errors.Item[];
+    namespace Errors {
+        interface Item {
+            /** Index positions (0-based) of the events that caused the error */
+            eventIndex?: number[] | undefined;
+            /** Description of the error */
+            message?: string | undefined;
+        }
+    }
+}

package/dist/esm/api/types/BatchEventsResponse.mjs

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

package/dist/esm/api/types/Company.d.mts

@@ -3,11 +3,11 @@
  */
 export interface Company {
     /** Company attributes with values */
-    attributes?: Record<string, unknown>;
+    attributes?: Record<string, unknown> | undefined;
     /** Unique company id */
-    id?: string;
+    id?: string | undefined;
     /** Contact ids for contacts linked to this company */
-    linkedContactsIds?: number[];
+    linkedContactsIds?: number[] | undefined;
     /** Deals ids for companies linked to this company */
-    linkedDealsIds?: string[];
+    linkedDealsIds?: string[] | undefined;
 }

package/dist/esm/api/types/ContactErrorModel.d.mts

@@ -4,7 +4,7 @@ export interface ContactErrorModel {
     /** Readable message associated to the failure */
     message: string;
     /** Additional information about the error */
-    metadata?: Record<string, unknown>;
+    metadata?: Record<string, unknown> | undefined;
 }
 export declare namespace ContactErrorModel {
     /** Error code displayed in case of a failure */