@getbrevo/brevo 5.0.0 → 5.0.1

package/dist/cjs/api/resources/companies/client/requests/index.d.ts

@@ -1,8 +1,10 @@
 export type { DeleteCompaniesIdRequest } from "./DeleteCompaniesIdRequest.js";
+export type { DeleteCrmAttributesIdRequest } from "./DeleteCrmAttributesIdRequest.js";
 export type { GetCompaniesIdRequest } from "./GetCompaniesIdRequest.js";
 export type { GetCompaniesRequest } from "./GetCompaniesRequest.js";
 export type { PatchCompaniesIdRequest } from "./PatchCompaniesIdRequest.js";
 export type { PatchCompaniesLinkUnlinkIdRequest } from "./PatchCompaniesLinkUnlinkIdRequest.js";
+export { PatchCrmAttributesIdRequest } from "./PatchCrmAttributesIdRequest.js";
 export type { PostCompaniesImportRequest } from "./PostCompaniesImportRequest.js";
 export type { PostCompaniesRequest } from "./PostCompaniesRequest.js";
 export { PostCrmAttributesRequest } from "./PostCrmAttributesRequest.js";

package/dist/cjs/api/resources/companies/client/requests/index.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PostCrmAttributesRequest = void 0;
+exports.PostCrmAttributesRequest = exports.PatchCrmAttributesIdRequest = void 0;
+var PatchCrmAttributesIdRequest_js_1 = require("./PatchCrmAttributesIdRequest.js");
+Object.defineProperty(exports, "PatchCrmAttributesIdRequest", { enumerable: true, get: function () { return PatchCrmAttributesIdRequest_js_1.PatchCrmAttributesIdRequest; } });
 var PostCrmAttributesRequest_js_1 = require("./PostCrmAttributesRequest.js");
 Object.defineProperty(exports, "PostCrmAttributesRequest", { enumerable: true, get: function () { return PostCrmAttributesRequest_js_1.PostCrmAttributesRequest; } });

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

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

package/dist/cjs/api/resources/companies/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.CompaniesClient = void 0;
+var Client_js_1 = require("./client/Client.js");
+Object.defineProperty(exports, "CompaniesClient", { enumerable: true, get: function () { return Client_js_1.CompaniesClient; } });
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/companies/types/GetCompaniesResponse.d.ts

@@ -4,5 +4,5 @@ import type * as Brevo from "../../../index.js";
  */
 export interface GetCompaniesResponse {
     /** List of companies */
-    items?: Brevo.Company[];
+    items?: Brevo.Company[] | undefined;
 }

package/dist/cjs/api/resources/companies/types/GetCrmAttributesCompaniesResponseItem.d.ts

@@ -2,9 +2,9 @@
  * List of attributes
  */
 export interface GetCrmAttributesCompaniesResponseItem {
-    attributeOptions?: Record<string, unknown>[];
-    attributeTypeName?: string;
-    internalName?: string;
-    isRequired?: boolean;
-    label?: string;
+    attributeOptions?: Record<string, unknown>[] | undefined;
+    attributeTypeName?: string | undefined;
+    internalName?: string | undefined;
+    isRequired?: boolean | undefined;
+    label?: string | undefined;
 }

package/dist/cjs/api/resources/companies/types/PostCompaniesImportResponse.d.ts

@@ -1,4 +1,4 @@
 export interface PostCompaniesImportResponse {
     /** The ID of the import process */
-    processId?: number;
+    processId?: number | undefined;
 }

package/dist/cjs/api/resources/contacts/client/Client.d.ts

@@ -11,14 +11,6 @@ export declare class ContactsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<ContactsClient.Options>;
     constructor(options: ContactsClient.Options);
     /**
-     * <Note title="Follow this format when passing a SMS phone number as an attribute">
-     * Accepted Number Formats
-     *
-     * 91xxxxxxxxxx
-     * +91xxxxxxxxxx
-     * 0091xxxxxxxxxx
-     * </Note>
-     *
      * @param {Brevo.GetContactsRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -31,6 +23,8 @@ export declare class ContactsClient {
     getContacts(request?: Brevo.GetContactsRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetContacts>;
     private __getContacts;
     /**
+     * <Note>Follow this format when passing a "SMS" phone number as an attribute.
+     * Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx</Note>
      * Creates new contacts on Brevo. Contacts can be created by passing either - <br><br> 1. email address of the contact (email_id),  <br> 2. phone number of the contact (to be passed as "SMS" field in "attributes" along with proper country code), For example- {"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"} <br> 3. ext_id <br>
      *
      * @param {Brevo.CreateContactRequest} request
@@ -124,9 +118,7 @@ export declare class ContactsClient {
     updateBatchContacts(request?: Brevo.UpdateBatchContactsRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __updateBatchContacts;
     /**
-     * <Note title="How to use attributes param?">
-     * attributes param in this endpoint is an object containing key-value pairs where values can be either a string, integer, array, or boolean. You can create key-value pairs with these four datatypes. When a value is an array, it should be an array of strings.
-     * </Note>
+     * <Note title="How to use attributes param?">attributes param in this endpoint is an object containing key-value pairs where values can be either a string, integer, array, or boolean. You can create key-value pairs with these four datatypes. When a value is an array, it should be an array of strings.</Note>
      *
      * @param {Brevo.CreateDoiContactRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -160,17 +152,11 @@ export declare class ContactsClient {
     requestContactExport(request: Brevo.RequestContactExportRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<Brevo.RequestContactExportResponse>;
     private __requestContactExport;
     /**
-     * <Note>
-     * Ongoing changes for this endpoint
-     *
+     * <Note>Ongoing changes for this endpoint
      * We're dropping support for the response attributes totalSubscribers and totalBlacklisted.
-     *
      * These are non breaking changes.
-     *
      * The default value for the attributes will be 0.
-     *
-     * The uniqueSubscribers field is deprecated
-     * </Note>
+     * The uniqueSubscribers field is deprecated</Note>
      *
      * @param {Brevo.GetFoldersRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -194,13 +180,9 @@ export declare class ContactsClient {
     createFolder(request: Brevo.CreateUpdateFolder, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateFolderResponse>;
     private __createFolder;
     /**
-     * <Note>
-     * Ongoing changes for this endpoint.
-     *
+     * <Note>Ongoing changes for this endpoint.
      * We're dropping support for the response attributes totalSubscribers and totalBlacklisted.
-     *
-     * These are non breaking changes. The default value for the attributes will be 0.
-     * </Note>
+     * These are non breaking changes. The default value for the attributes will be 0.</Note>
      *
      * @param {Brevo.GetFolderRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -245,13 +227,9 @@ export declare class ContactsClient {
     deleteFolder(request: Brevo.DeleteFolderRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteFolder;
     /**
-     * <Note>
-     * Ongoing changes for this endpoint.
-     *
+     * <Note>Ongoing changes for this endpoint.
      * We're dropping support for the response attributes totalSubscribers and totalBlacklisted.
-     *
-     * These are non breaking changes. The default value for the attributes will be 0.
-     * </Note>
+     * These are non breaking changes. The default value for the attributes will be 0.</Note>
      *
      * @param {Brevo.GetFolderListsRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -280,13 +258,9 @@ export declare class ContactsClient {
     importContacts(request?: Brevo.ImportContactsRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<Brevo.ImportContactsResponse>;
     private __importContacts;
     /**
-     * <Note>
-     * Ongoing changes for this endpoint.
-     *
+     * <Note>Ongoing changes for this endpoint.
      * We're dropping support for the response attributes totalSubscribers and totalBlacklisted.
-     *
-     * These are non breaking changes. The default value for the attributes will be 0.
-     * </Note>
+     * These are non breaking changes. The default value for the attributes will be 0.</Note>
      *
      * @param {Brevo.GetListsRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -454,14 +428,8 @@ export declare class ContactsClient {
     getSegments(request?: Brevo.GetSegmentsRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetSegmentsResponse>;
     private __getSegments;
     /**
-     * <Note title="Follow this format when passing a SMS phone number as an attribute">
-     * Accepted Number Formats
-     *
-     * 91xxxxxxxxxx
-     * +91xxxxxxxxxx
-     * 0091xxxxxxxxxx
-     * </Note>
-     *
+     * <Note>Follow this format when passing a "SMS" phone number as an attribute.
+     * Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx</Note>
      * There are 2 ways to get a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={} <br> <br> Option 1 only works if identifierType is email_id (for EMAIL), phone_id (for SMS) or contact_id (for ID of the contact),where you can directly pass the value of EMAIL, SMS and ID of the contact.   <br><br> Option 2 works for all identifierType, use email_id for EMAIL attribute, phone_id for SMS attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute <br><br>Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats ``https://developers.brevo.com/reference/contacts-7#getcontactstats`` endpoint with the appropriate date ranges.
      *
      * @param {Brevo.GetContactInfoRequest} request
@@ -478,6 +446,8 @@ export declare class ContactsClient {
     getContactInfo(request: Brevo.GetContactInfoRequest, requestOptions?: ContactsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetContactInfoResponse>;
     private __getContactInfo;
     /**
+     * <Note>Follow this format when passing a "SMS" phone number as an attribute.
+     * Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx</Note>
      * There are 2 ways to update a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={} <br> <br> Option 1 only works if identifierType is email_id (for EMAIL) or contact_id (for ID of the contact),where you can directly pass the value of EMAIL and ID of the contact.   <br><br> Option 2 works for all identifierType, use email_id for EMAIL attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE attribute
      *
      * @param {Brevo.UpdateContactRequest} request

package/dist/cjs/api/resources/contacts/client/Client.js

@@ -67,14 +67,6 @@ class ContactsClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
-     * <Note title="Follow this format when passing a SMS phone number as an attribute">
-     * Accepted Number Formats
-     *
-     * 91xxxxxxxxxx
-     * +91xxxxxxxxxx
-     * 0091xxxxxxxxxx
-     * </Note>
-     *
      * @param {Brevo.GetContactsRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -135,6 +127,8 @@ class ContactsClient {
         });
     }
     /**
+     * <Note>Follow this format when passing a "SMS" phone number as an attribute.
+     * Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx</Note>
      * Creates new contacts on Brevo. Contacts can be created by passing either - <br><br> 1. email address of the contact (email_id),  <br> 2. phone number of the contact (to be passed as "SMS" field in "attributes" along with proper country code), For example- {"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"} <br> 3. ext_id <br>
      *
      * @param {Brevo.CreateContactRequest} request
@@ -492,9 +486,7 @@ class ContactsClient {
         });
     }
     /**
-     * <Note title="How to use attributes param?">
-     * attributes param in this endpoint is an object containing key-value pairs where values can be either a string, integer, array, or boolean. You can create key-value pairs with these four datatypes. When a value is an array, it should be an array of strings.
-     * </Note>
+     * <Note title="How to use attributes param?">attributes param in this endpoint is an object containing key-value pairs where values can be either a string, integer, array, or boolean. You can create key-value pairs with these four datatypes. When a value is an array, it should be an array of strings.</Note>
      *
      * @param {Brevo.CreateDoiContactRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -606,17 +598,11 @@ class ContactsClient {
         });
     }
     /**
-     * <Note>
-     * Ongoing changes for this endpoint
-     *
+     * <Note>Ongoing changes for this endpoint
      * We're dropping support for the response attributes totalSubscribers and totalBlacklisted.
-     *
      * These are non breaking changes.
-     *
      * The default value for the attributes will be 0.
-     *
-     * The uniqueSubscribers field is deprecated
-     * </Note>
+     * The uniqueSubscribers field is deprecated</Note>
      *
      * @param {Brevo.GetFoldersRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -719,13 +705,9 @@ class ContactsClient {
         });
     }
     /**
-     * <Note>
-     * Ongoing changes for this endpoint.
-     *
+     * <Note>Ongoing changes for this endpoint.
      * We're dropping support for the response attributes totalSubscribers and totalBlacklisted.
-     *
-     * These are non breaking changes. The default value for the attributes will be 0.
-     * </Note>
+     * These are non breaking changes. The default value for the attributes will be 0.</Note>
      *
      * @param {Brevo.GetFolderRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -887,13 +869,9 @@ class ContactsClient {
         });
     }
     /**
-     * <Note>
-     * Ongoing changes for this endpoint.
-     *
+     * <Note>Ongoing changes for this endpoint.
      * We're dropping support for the response attributes totalSubscribers and totalBlacklisted.
-     *
-     * These are non breaking changes. The default value for the attributes will be 0.
-     * </Note>
+     * These are non breaking changes. The default value for the attributes will be 0.</Note>
      *
      * @param {Brevo.GetFolderListsRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -1003,13 +981,9 @@ class ContactsClient {
         });
     }
     /**
-     * <Note>
-     * Ongoing changes for this endpoint.
-     *
+     * <Note>Ongoing changes for this endpoint.
      * We're dropping support for the response attributes totalSubscribers and totalBlacklisted.
-     *
-     * These are non breaking changes. The default value for the attributes will be 0.
-     * </Note>
+     * These are non breaking changes. The default value for the attributes will be 0.</Note>
      *
      * @param {Brevo.GetListsRequest} request
      * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -1544,14 +1518,8 @@ class ContactsClient {
         });
     }
     /**
-     * <Note title="Follow this format when passing a SMS phone number as an attribute">
-     * Accepted Number Formats
-     *
-     * 91xxxxxxxxxx
-     * +91xxxxxxxxxx
-     * 0091xxxxxxxxxx
-     * </Note>
-     *
+     * <Note>Follow this format when passing a "SMS" phone number as an attribute.
+     * Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx</Note>
      * There are 2 ways to get a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={} <br> <br> Option 1 only works if identifierType is email_id (for EMAIL), phone_id (for SMS) or contact_id (for ID of the contact),where you can directly pass the value of EMAIL, SMS and ID of the contact.   <br><br> Option 2 works for all identifierType, use email_id for EMAIL attribute, phone_id for SMS attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute <br><br>Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats ``https://developers.brevo.com/reference/contacts-7#getcontactstats`` endpoint with the appropriate date ranges.
      *
      * @param {Brevo.GetContactInfoRequest} request
@@ -1611,6 +1579,8 @@ class ContactsClient {
         });
     }
     /**
+     * <Note>Follow this format when passing a "SMS" phone number as an attribute.
+     * Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx</Note>
      * There are 2 ways to update a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={} <br> <br> Option 1 only works if identifierType is email_id (for EMAIL) or contact_id (for ID of the contact),where you can directly pass the value of EMAIL and ID of the contact.   <br><br> Option 2 works for all identifierType, use email_id for EMAIL attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE attribute
      *
      * @param {Brevo.UpdateContactRequest} request

package/dist/cjs/api/resources/contacts/client/requests/AddContactToListRequest.d.ts

@@ -23,30 +23,6 @@ import type * as Brevo from "../../../../index.js";
  *             ids: [1, 2]
  *         }
  *     }
- *
- * @example
- *     {
- *         listId: 1000000,
- *         body: {
- *             emails: ["jeff32@example.com", "jim56@example.com"]
- *         }
- *     }
- *
- * @example
- *     {
- *         listId: 1000000,
- *         body: {
- *             emails: ["jeff32@example.com", "jim56@example.com"]
- *         }
- *     }
- *
- * @example
- *     {
- *         listId: 1000000,
- *         body: {
- *             emails: ["jeff32@example.com", "jim56@example.com"]
- *         }
- *     }
  */
 export interface AddContactToListRequest {
     /** Id of the list */

package/dist/cjs/api/resources/contacts/client/requests/ImportContactsRequest.d.ts

@@ -31,8 +31,8 @@ export declare namespace ImportContactsRequest {
     namespace JsonBody {
         interface Item {
             /** List of attributes to be imported */
-            attributes?: Record<string, unknown>;
-            email?: string;
+            attributes?: Record<string, unknown> | undefined;
+            email?: string | undefined;
         }
     }
     /**
@@ -40,8 +40,8 @@ export declare namespace ImportContactsRequest {
      */
     interface NewList {
         /** Id of the folder where this new list shall be created. **Mandatory if listName is not empty** */
-        folderId?: number;
+        folderId?: number | undefined;
         /** List with listName will be created first and users will be imported in it. **Mandatory if listIds is empty**. */
-        listName?: string;
+        listName?: string | undefined;
     }
 }

package/dist/cjs/api/resources/contacts/client/requests/RemoveContactFromListRequest.d.ts

@@ -31,38 +31,6 @@ import type * as Brevo from "../../../../index.js";
  *             ids: [1, 2]
  *         }
  *     }
- *
- * @example
- *     {
- *         listId: 1000000,
- *         body: {
- *             all: true
- *         }
- *     }
- *
- * @example
- *     {
- *         listId: 1000000,
- *         body: {
- *             all: true
- *         }
- *     }
- *
- * @example
- *     {
- *         listId: 1000000,
- *         body: {
- *             all: true
- *         }
- *     }
- *
- * @example
- *     {
- *         listId: 1000000,
- *         body: {
- *             all: true
- *         }
- *     }
  */
 export interface RemoveContactFromListRequest {
     /** Id of the list */

package/dist/cjs/api/resources/contacts/client/requests/RequestContactExportRequest.d.ts

@@ -28,19 +28,19 @@ export declare namespace RequestContactExportRequest {
      */
     interface CustomContactFilter {
         /** **Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed.** This will export the contacts on the basis of provided action applied on contacts as per the list id. * **allContacts** - Fetch the list of all contacts for a particular list. * **subscribed & unsubscribed** - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * **unsubscribedPerList** - Fetch the list of contacts that are unsubscribed from a particular list only. */
-        actionForContacts?: CustomContactFilter.ActionForContacts;
+        actionForContacts?: CustomContactFilter.ActionForContacts | undefined;
         /** **Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed.** This will export the contacts on the basis of provided action applied on email campaigns. * **openers & nonOpeners** - emailCampaignId is mandatory. Fetch the list of readers / non-readers for a particular email campaign. * **clickers & nonClickers** - emailCampaignId is mandatory. Fetch the list of clickers / non-clickers for a particular email campaign. * **unsubscribed** - emailCampaignId is mandatory. Fetch the list of all unsubscribed (blacklisted via any means) contacts for a particular email campaign. * **hardBounces & softBounces** - emailCampaignId is optional. Fetch the list of hard bounces / soft bounces for a particular / all email campaign(s). */
-        actionForEmailCampaigns?: CustomContactFilter.ActionForEmailCampaigns;
+        actionForEmailCampaigns?: CustomContactFilter.ActionForEmailCampaigns | undefined;
         /** **Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed.** This will export the contacts on the basis of provided action applied on sms campaigns. * **unsubscribed** - Fetch the list of all unsubscribed (blacklisted via any means) contacts for all / particular sms campaigns. * **hardBounces & softBounces** - Fetch the list of hard bounces / soft bounces for all / particular sms campaigns. */
-        actionForSmsCampaigns?: CustomContactFilter.ActionForSmsCampaigns;
+        actionForSmsCampaigns?: CustomContactFilter.ActionForSmsCampaigns | undefined;
         /** Considered only if **actionForEmailCampaigns** is passed, ignored otherwise. **Mandatory if action is one of the following - openers, nonOpeners, clickers, nonClickers, unsubscribed.** The id of the email campaign for which the corresponding action shall be applied in the filter. */
-        emailCampaignId?: number;
+        emailCampaignId?: number | undefined;
         /** ID of the list. This is mandatory if actionForContacts is specified and segmentId is not provided. Either segmentId or listId must be included. */
-        listId?: number;
+        listId?: number | undefined;
         /** ID of the segment. This is mandatory if actionForContacts is specified and listId is not provided. Either segmentId or listId must be included. */
-        segmentId?: number;
+        segmentId?: number | undefined;
         /** Considered only if **actionForSmsCampaigns** is passed, ignored otherwise. The id of sms campaign for which the corresponding action shall be applied in the filter. */
-        smsCampaignId?: number;
+        smsCampaignId?: number | undefined;
     }
     namespace CustomContactFilter {
         /** **Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed.** This will export the contacts on the basis of provided action applied on contacts as per the list id. * **allContacts** - Fetch the list of all contacts for a particular list. * **subscribed & unsubscribed** - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * **unsubscribedPerList** - Fetch the list of contacts that are unsubscribed from a particular list only. */

package/dist/cjs/api/resources/contacts/client/requests/UpdateBatchContactsRequest.d.ts

@@ -11,25 +11,25 @@ export declare namespace UpdateBatchContactsRequest {
     namespace Contacts {
         interface Item {
             /** Pass the set of attributes to be updated. **These attributes must be present in your account**. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, **{ "EMAIL":"newemail@domain.com", "FNAME":"Ellie", "LNAME":"Roger"}**. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in **SMS** field should be passed with proper country code. For example: **{"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"}** */
-            attributes?: Record<string, unknown>;
+            attributes?: Record<string, unknown> | undefined;
             /** Email address of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) */
-            email?: string;
+            email?: string | undefined;
             /** Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) */
-            emailBlacklisted?: boolean;
+            emailBlacklisted?: boolean | undefined;
             /** Pass your own Id to update ext_id of a contact. */
-            ext_id?: string;
+            ext_id?: string | undefined;
             /** id of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) */
-            id?: number;
+            id?: number | undefined;
             /** Ids of the lists to add the contact to */
-            listIds?: number[];
+            listIds?: number[] | undefined;
             /** SMS of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) */
-            sms?: string;
+            sms?: string | undefined;
             /** Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) */
-            smsBlacklisted?: boolean;
+            smsBlacklisted?: boolean | undefined;
             /** transactional email forbidden sender for contact. Use only for email Contact */
-            smtpBlacklistSender?: string[];
+            smtpBlacklistSender?: string[] | undefined;
             /** Ids of the lists to remove the contact from */
-            unlinkListIds?: number[];
+            unlinkListIds?: number[] | undefined;
         }
     }
 }

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

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

package/dist/cjs/api/resources/contacts/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.ContactsClient = void 0;
+var Client_js_1 = require("./client/Client.js");
+Object.defineProperty(exports, "ContactsClient", { enumerable: true, get: function () { return Client_js_1.ContactsClient; } });
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/contacts/types/CreateContactResponse.d.ts

@@ -1,4 +1,4 @@
 export interface CreateContactResponse {
     /** ID of the contact when a new contact is created */
-    id?: number;
+    id?: number | undefined;
 }

package/dist/cjs/api/resources/contacts/types/GetAttributesResponse.d.ts

@@ -7,17 +7,17 @@ export declare namespace GetAttributesResponse {
     namespace Attributes {
         interface Item {
             /** Calculated value formula */
-            calculatedValue?: string;
+            calculatedValue?: string | undefined;
             /** Category of the attribute */
             category: Item.Category;
             /** Parameter only available for "category" type attributes. */
-            enumeration?: Item.Enumeration.Item[];
+            enumeration?: Item.Enumeration.Item[] | undefined;
             /** Parameter only available for "multiple-choice" type attributes. */
-            multiCategoryOptions?: string[];
+            multiCategoryOptions?: string[] | undefined;
             /** Name of the attribute */
             name: string;
             /** Type of the attribute */
-            type?: Item.Type;
+            type?: Item.Type | undefined;
         }
         namespace Item {
             /** Category of the attribute */

package/dist/cjs/api/resources/contacts/types/GetContactInfoResponse.d.ts

@@ -4,13 +4,13 @@ export interface GetContactInfoResponse {
     /** Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) */
     createdAt: string;
     /** Email address of the contact for which you requested the details */
-    email?: string;
+    email?: string | undefined;
     /** Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) */
     emailBlacklisted: boolean;
     /** ID of the contact for which you requested the details */
     id: number;
     listIds: number[];
-    listUnsubscribed?: number[];
+    listUnsubscribed?: number[] | undefined;
     /** Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) */
     modifiedAt: string;
     /** Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) */
@@ -28,23 +28,23 @@ export declare namespace GetContactInfoResponse {
      */
     interface Statistics {
         /** Listing of the clicks generated by the contact */
-        clicked?: Statistics.Clicked.Item[];
+        clicked?: Statistics.Clicked.Item[] | undefined;
         /** Listing of the complaints generated by the contact */
-        complaints?: Statistics.Complaints.Item[];
+        complaints?: Statistics.Complaints.Item[] | undefined;
         /** Listing of the delivered campaign for the contact */
-        delivered?: Statistics.Delivered.Item[];
+        delivered?: Statistics.Delivered.Item[] | undefined;
         /** Listing of the hardbounes generated by the contact */
-        hardBounces?: Statistics.HardBounces.Item[];
+        hardBounces?: Statistics.HardBounces.Item[] | undefined;
         /** Listing of the sent campaign for the contact */
-        messagesSent?: Statistics.MessagesSent.Item[];
+        messagesSent?: Statistics.MessagesSent.Item[] | undefined;
         /** Listing of the openings generated by the contact */
-        opened?: Statistics.Opened.Item[];
+        opened?: Statistics.Opened.Item[] | undefined;
         /** Listing of the softbounes generated by the contact */
-        softBounces?: Statistics.SoftBounces.Item[];
+        softBounces?: Statistics.SoftBounces.Item[] | undefined;
         /** Listing of the transactional attributes for the contact */
-        transacAttributes?: Statistics.TransacAttributes.Item[];
+        transacAttributes?: Statistics.TransacAttributes.Item[] | undefined;
         /** Listing of the unsubscription for the contact */
-        unsubscriptions?: Statistics.Unsubscriptions;
+        unsubscriptions?: Statistics.Unsubscriptions | undefined;
     }
     namespace Statistics {
         type Clicked = Clicked.Item[];
@@ -149,7 +149,7 @@ export declare namespace GetContactInfoResponse {
                     /** UTC date-time of the event */
                     eventTime: string;
                     /** IP from which the user has been unsubscribed */
-                    ip?: string;
+                    ip?: string | undefined;
                 }
             }
             type UserUnsubscription = UserUnsubscription.Item[];
@@ -160,7 +160,7 @@ export declare namespace GetContactInfoResponse {
                     /** UTC date-time of the event */
                     eventTime: string;
                     /** IP from which the user has unsubscribed */
-                    ip?: string;
+                    ip?: string | undefined;
                 }
             }
         }