@getbrevo/brevo 5.0.4 → 6.0.2

package/dist/cjs/api/types/ConsentGroup.d.ts

@@ -0,0 +1,29 @@
+/**
+ * A consent group representing a category of contact opt-in/opt-out preferences.
+ */
+export interface ConsentGroup {
+    /** Unique identifier for the consent group */
+    id: number;
+    /** Display name of the consent group */
+    name: string;
+    /** Optional description of the consent group */
+    description?: string | undefined;
+    /** Controls how contacts are added to the group. `manual` — contacts are added explicitly via the API. `automatic` — contacts are added automatically at signup. */
+    signupMode: ConsentGroup.SignupMode;
+    /** Number of contacts currently in this consent group */
+    contactsCount: number;
+    /** Whether this is a system-created default consent group */
+    isDefault: boolean;
+    /** UTC date-time when the consent group was created (YYYY-MM-DDTHH:mm:ss.SSSZ) */
+    createdAt: string;
+    /** UTC date-time when the consent group was last updated (YYYY-MM-DDTHH:mm:ss.SSSZ) */
+    updatedAt: string;
+}
+export declare namespace ConsentGroup {
+    /** Controls how contacts are added to the group. `manual` — contacts are added explicitly via the API. `automatic` — contacts are added automatically at signup. */
+    const SignupMode: {
+        readonly Manual: "manual";
+        readonly Automatic: "automatic";
+    };
+    type SignupMode = (typeof SignupMode)[keyof typeof SignupMode];
+}

package/dist/cjs/api/types/ConsentGroup.js

@@ -0,0 +1,12 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConsentGroup = void 0;
+var ConsentGroup;
+(function (ConsentGroup) {
+    /** Controls how contacts are added to the group. `manual` — contacts are added explicitly via the API. `automatic` — contacts are added automatically at signup. */
+    ConsentGroup.SignupMode = {
+        Manual: "manual",
+        Automatic: "automatic",
+    };
+})(ConsentGroup || (exports.ConsentGroup = ConsentGroup = {}));

package/dist/cjs/api/types/ConsentGroupItem.d.ts

@@ -0,0 +1,17 @@
+/**
+ * A contact's membership status in a single consent group.
+ */
+export interface ConsentGroupItem {
+    /** ID of the consent group */
+    id: number;
+    /** The contact's subscription status within this consent group */
+    status: ConsentGroupItem.Status;
+}
+export declare namespace ConsentGroupItem {
+    /** The contact's subscription status within this consent group */
+    const Status: {
+        readonly Subscribed: "subscribed";
+        readonly Unsubscribed: "unsubscribed";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/cjs/api/types/ConsentGroupItem.js

@@ -0,0 +1,12 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConsentGroupItem = void 0;
+var ConsentGroupItem;
+(function (ConsentGroupItem) {
+    /** The contact's subscription status within this consent group */
+    ConsentGroupItem.Status = {
+        Subscribed: "subscribed",
+        Unsubscribed: "unsubscribed",
+    };
+})(ConsentGroupItem || (exports.ConsentGroupItem = ConsentGroupItem = {}));

package/dist/cjs/api/types/ConsentGroupsListResponse.d.ts

@@ -0,0 +1,14 @@
+import type * as Brevo from "../index.js";
+/**
+ * Paginated list of consent groups.
+ */
+export interface ConsentGroupsListResponse {
+    /** List of consent groups matching the filter */
+    consentGroups: Brevo.ConsentGroup[];
+    /** Total number of consent groups matching the filter */
+    total: number;
+    /** Maximum number of results returned */
+    limit: number;
+    /** Number of results skipped */
+    offset: number;
+}

package/dist/cjs/api/types/ConsentGroupsListResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ConversationsMessage.d.ts

@@ -53,6 +53,14 @@ export interface ConversationsMessage {
     to?: ConversationsMessage.To.Item[] | undefined;
     /** `"agent"` for agents’ messages, `"visitor"` for visitors’ messages. */
     type?: ConversationsMessage.Type | undefined;
+    /** ‘`true` if the message was sent via JavaScript API.’ */
+    isSentViaJsApi?: boolean | undefined;
+    /** The type of message content (e.g. for integration-specific message types). */
+    messageType?: string | undefined;
+    /** ‘`true` if the message is a forwarded message.’ */
+    isForward?: boolean | undefined;
+    /** Source information for the message. */
+    source?: Record<string, unknown> | undefined;
     /** visitor’s ID */
     visitorId?: string | undefined;
 }
@@ -61,17 +69,38 @@ export declare namespace ConversationsMessage {
     namespace Attachments {
         interface Item {
             /** The name of the file. */
-            fileName?: string | undefined;
-            /** The ID of the inline file. */
-            inlineId?: string | undefined;
+            name?: string | undefined;
+            /** The URL of the file. */
+            link?: string | undefined;
+            /** The MIME type of the file. */
+            mimeType?: string | undefined;
             /** `true` for images. */
             isImage?: boolean | undefined;
+            /** `true` for sticker files. */
+            isSticker?: boolean | undefined;
             /** `true` for inline files. */
-            isInline?: string | undefined;
+            isInline?: boolean | undefined;
+            /** The ID of the inline file. */
+            inlineId?: string | undefined;
             /** The size of the file in bytes. */
             size?: number | undefined;
-            /** The URL of the file. */
-            url?: string | undefined;
+            /** Image information (only present for image files). */
+            imageInfo?: Item.ImageInfo | undefined;
+            /** Whether the file extension is allowed for download. */
+            isAllowedFileType?: boolean | undefined;
+        }
+        namespace Item {
+            /**
+             * Image information (only present for image files).
+             */
+            interface ImageInfo {
+                /** Width of the image in pixels. */
+                width?: number | undefined;
+                /** Height of the image in pixels. */
+                height?: number | undefined;
+                /** URL of the image preview. */
+                previewLink?: string | undefined;
+            }
         }
     }
     type Bcc = Bcc.Item[];
@@ -89,28 +118,38 @@ export declare namespace ConversationsMessage {
         }
     }
     interface File_ {
-        /** Name of the file */
-        filename?: string | undefined;
-        /** image info is passed in case the file is an image */
-        imageInfo?: File_.ImageInfo | undefined;
-        /** Whether the file is an image */
+        /** Name of the file. */
+        name?: string | undefined;
+        /** URL of the file. */
+        link?: string | undefined;
+        /** MIME type of the file. */
+        mimeType?: string | undefined;
+        /** Whether the file is an image. */
         isImage?: boolean | undefined;
-        /** Size in bytes */
+        /** Whether the file is a sticker. */
+        isSticker?: boolean | undefined;
+        /** Whether the file is inline. */
+        isInline?: boolean | undefined;
+        /** The ID of the inline file. */
+        inlineId?: string | undefined;
+        /** Size in bytes. */
         size?: number | undefined;
-        /** URL of the file */
-        url?: string | undefined;
+        /** Image info, present when the file is an image. */
+        imageInfo?: File_.ImageInfo | undefined;
+        /** Whether the file extension is allowed for download. */
+        isAllowedFileType?: boolean | undefined;
     }
     namespace File_ {
         /**
-         * image info is passed in case the file is an image
+         * Image info, present when the file is an image.
          */
         interface ImageInfo {
-            /** height of the image */
-            height?: number | undefined;
-            /** URL of the preview */
-            previewUrl?: string | undefined;
-            /** Width of the image */
+            /** Width of the image in pixels. */
             width?: number | undefined;
+            /** Height of the image in pixels. */
+            height?: number | undefined;
+            /** URL of the image preview. */
+            previewLink?: string | undefined;
         }
     }
     /**

package/dist/cjs/api/types/Deal.d.ts

@@ -2,12 +2,12 @@
  * Deal Details
  */
 export interface Deal {
-    /** Deal attributes with values */
-    attributes?: Record<string, unknown> | undefined;
     /** Unique deal id */
     id?: string | undefined;
-    /** Companies ids for companies linked to this deal */
-    linkedCompaniesIds?: string[] | undefined;
+    /** Deal attributes with values */
+    attributes?: Record<string, unknown> | undefined;
     /** Contact ids for contacts linked to this deal */
     linkedContactsIds?: number[] | undefined;
+    /** Companies ids for companies linked to this deal */
+    linkedCompaniesIds?: string[] | undefined;
 }

package/dist/cjs/api/types/FileData.d.ts

@@ -2,18 +2,20 @@
  * File data that is uploaded
  */
 export interface FileData {
+    /** Unique file id */
+    id?: string | undefined;
+    /** Name of uploaded file */
+    name?: string | undefined;
     /** Account id of user which created the file */
     authorId?: string | undefined;
-    /** Company id linked to a file */
-    companyId?: string | undefined;
     /** Contact id of contact on which file is uploaded */
     contactId?: number | undefined;
-    /** File created date/time */
-    createdAt?: string | undefined;
     /** Deal id linked to a file */
     dealId?: string | undefined;
-    /** Name of uploaded file */
-    name?: string | undefined;
+    /** Company id linked to a file */
+    companyId?: string | undefined;
     /** Size of file in bytes */
     size?: number | undefined;
+    /** File created date/time */
+    createdAt?: string | undefined;
 }

package/dist/cjs/api/types/GetCampaignRecipients.d.ts

@@ -1,4 +1,8 @@
 export interface GetCampaignRecipients {
+    /** Segment IDs excluded from the campaign */
+    excludedSegments?: number[] | undefined;
     exclusionLists: number[];
     lists: number[];
+    /** Segment IDs included in the campaign */
+    segments?: number[] | undefined;
 }

package/dist/cjs/api/types/GetCampaignStats.d.ts

@@ -2,17 +2,17 @@ export interface GetCampaignStats {
     /** Numbers of times your email has been opened automatically through Apple MPP. */
     appleMppOpens: number | null;
     /** Number of total clicks for the campaign */
-    clickers: number;
+    clickers: number | null;
     /** Number of complaints (Spam reports) for the campaign */
-    complaints: number;
+    complaints: number | null;
     /** Number of deferred emails for the campaign */
     deferred?: number | undefined;
     /** Number of delivered emails for the campaign */
-    delivered: number;
-    /** Rate of recipients without any privacy protection option enabled in their email client_dev, applied to all delivered emails */
+    delivered: number | null;
+    /** Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails */
     estimatedViews?: number | undefined;
-    /** Number of harbounce for the campaign */
-    hardBounces: number;
+    /** Number of hard bounces for the campaign */
+    hardBounces: number | null;
     /** List Id of email campaign (only in case of get email campaign(s)(not for global stats)) */
     listId?: number | undefined;
     /** Percentage of recipients who open the email out of your total number of recipients. Depending on your Campaign settings, they may include Apple MPP opens. */
@@ -20,19 +20,19 @@ export interface GetCampaignStats {
     /** Total number of non-delivered campaigns for a particular campaign id. */
     returnBounce?: number | undefined;
     /** Number of sent emails for the campaign */
-    sent: number;
+    sent: number | null;
     /** Number of softbounce for the campaign */
-    softBounces: number;
-    /** Recipients without any privacy protection option enabled in their email client_dev */
-    trackableViews: number;
-    /** Rate of recipients without any privacy protection option enabled in their email client_dev */
+    softBounces: number | null;
+    /** Recipients without any privacy protection option enabled in their email email client */
+    trackableViews: number | null;
+    /** Rate of recipients without any privacy protection option enabled in their email client */
     trackableViewsRate?: number | undefined;
     /** Number of unique clicks for the campaign */
-    uniqueClicks: number;
+    uniqueClicks: number | null;
     /** Number of unique openings for the campaign */
-    uniqueViews: number;
+    uniqueViews: number | null;
     /** Number of unsubscription for the campaign */
-    unsubscriptions: number;
+    unsubscriptions: number | null;
     /** Number of openings for the campaign */
-    viewed: number;
+    viewed: number | null;
 }

package/dist/cjs/api/types/GetContactDetails.d.ts

@@ -1,3 +1,4 @@
+import type * as Brevo from "../index.js";
 export interface GetContactDetails {
     /** Set of attributes of the contact */
     attributes: GetContactDetails.Attributes;
@@ -15,6 +16,10 @@ export interface GetContactDetails {
     modifiedAt: string;
     /** Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) */
     smsBlacklisted: boolean;
+    /** Blacklist status for WhatsApp campaigns (true=blacklisted, false=not blacklisted) */
+    whatsappBlacklisted: boolean;
+    /** Consent groups the contact belongs to, with their subscription status. Only present when the Consent Groups feature is enabled for your account. */
+    consentGroups?: Brevo.ConsentGroupItem[] | undefined;
 }
 export declare namespace GetContactDetails {
     /**

package/dist/cjs/api/types/GetEventsList.d.ts

@@ -19,8 +19,6 @@ export declare namespace GetEventsList {
             event_name?: string | undefined;
             /** Filter ID of the event */
             event_filter_id?: string | undefined;
-            /** Source of the event */
-            source?: string | undefined;
             /** Object type associated with the event */
             object_type?: string | undefined;
             /** Event-level custom properties */

package/dist/cjs/api/types/GetExtendedCampaignOverview.d.ts

@@ -29,8 +29,12 @@ export interface GetExtendedCampaignOverview {
     winnerCriteria?: string | undefined;
     /** The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` */
     winnerDelay?: number | undefined;
+    /** URL of the attachment file associated with the campaign. Empty string if no attachment is present. */
+    attachmentUrl?: string | undefined;
     /** Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) */
     createdAt: string;
+    /** Expiration date configuration for the email campaign, if set. Contains the duration and unit of the email expiry. */
+    emailExpirationDate?: GetExtendedCampaignOverview.EmailExpirationDate | undefined;
     /** Footer of the campaign */
     footer: string;
     /** Header of the campaign */
@@ -52,7 +56,7 @@ export interface GetExtendedCampaignOverview {
     sender: GetExtendedCampaignOverview.Sender;
     /** Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' */
     sentDate?: string | undefined;
-    /** Link to share the campaign on social medias */
+    /** Link to share the campaign on social media. For trigger campaigns, this returns a descriptive message instead of a URL. For classic campaigns that have not been sent, this also returns a descriptive message. */
     shareLink?: string | undefined;
     /** Tag of the campaign */
     tag?: string | undefined;
@@ -62,12 +66,13 @@ export interface GetExtendedCampaignOverview {
     testSent: boolean;
     /** Customisation of the "to" field of the campaign */
     toField?: string | undefined;
-    /** utm parameter associated with campaign */
+    /** The utm_campaign value associated with the campaign. Only present if a UTM campaign value was set. */
     utmCampaignValue?: string | undefined;
-    /** utm id active */
-    utmIDActive?: boolean | undefined;
+    /** The campaign ID used as utm_id parameter. Only present if UTM campaign tracking with ID is enabled. */
+    utmID?: number | undefined;
+    /** The utm_medium value. Set to "EMAIL" when UTM campaign tracking is enabled. */
     utmMedium?: string | undefined;
-    /** source of utm */
+    /** The utm_source value. Set to "Brevo" when UTM campaign tracking is enabled. */
     utmSource?: string | undefined;
 }
 export declare namespace GetExtendedCampaignOverview {
@@ -90,6 +95,24 @@ export declare namespace GetExtendedCampaignOverview {
         readonly Trigger: "trigger";
     };
     type Type = (typeof Type)[keyof typeof Type];
+    /**
+     * Expiration date configuration for the email campaign, if set. Contains the duration and unit of the email expiry.
+     */
+    interface EmailExpirationDate {
+        /** Duration of the email expiry */
+        duration?: number | undefined;
+        /** Unit of the duration */
+        unit?: EmailExpirationDate.Unit | undefined;
+    }
+    namespace EmailExpirationDate {
+        /** Unit of the duration */
+        const Unit: {
+            readonly Days: "days";
+            readonly Weeks: "weeks";
+            readonly Months: "months";
+        };
+        type Unit = (typeof Unit)[keyof typeof Unit];
+    }
     interface Sender {
         /** Sender email of the campaign */
         email?: string | undefined;

package/dist/cjs/api/types/GetExtendedCampaignOverview.js

@@ -21,4 +21,13 @@ var GetExtendedCampaignOverview;
         Classic: "classic",
         Trigger: "trigger",
     };
+    let EmailExpirationDate;
+    (function (EmailExpirationDate) {
+        /** Unit of the duration */
+        EmailExpirationDate.Unit = {
+            Days: "days",
+            Weeks: "weeks",
+            Months: "months",
+        };
+    })(EmailExpirationDate = GetExtendedCampaignOverview.EmailExpirationDate || (GetExtendedCampaignOverview.EmailExpirationDate = {}));
 })(GetExtendedCampaignOverview || (exports.GetExtendedCampaignOverview = GetExtendedCampaignOverview = {}));

package/dist/cjs/api/types/GetExtendedCampaignStats.d.ts

@@ -4,21 +4,19 @@ export interface GetExtendedCampaignStats {
     campaignStats: Brevo.GetCampaignStats[];
     /** Overall statistics of the campaign */
     globalStats: Brevo.GetCampaignStats;
-    /** Statistics about the number of clicks for the links */
-    linksStats: GetExtendedCampaignStats.LinksStats;
+    /** Statistics about the number of clicks for each link in the campaign. Keys are the link URLs, values are click counts. Only populated when the `statistics` query parameter is set to `linksStats`. */
+    linksStats: Record<string, number>;
     /** Number of clicks on mirror link */
     mirrorClick: number;
-    /** Number of remaning emails to send */
+    /** Number of remaining emails to send */
     remaining: number;
-    statsByBrowser: Record<string, Brevo.GetDeviceBrowserStats>;
-    statsByDevice: GetExtendedCampaignStats.StatsByDevice;
-    statsByDomain: Record<string, Brevo.GetCampaignStats>;
+    /** Statistics of the campaign grouped by browser. Only available when retrieving a single campaign with the `statistics` query parameter set to `statsByBrowser`. */
+    statsByBrowser?: Record<string, Brevo.GetDeviceBrowserStats> | undefined;
+    statsByDevice?: GetExtendedCampaignStats.StatsByDevice | undefined;
+    /** Statistics of the campaign grouped by email domain. Only populated when the `statistics` query parameter is set to `statsByDomain`. */
+    statsByDomain?: Record<string, Brevo.GetCampaignStats> | undefined;
 }
 export declare namespace GetExtendedCampaignStats {
-    /**
-     * Statistics about the number of clicks for the links
-     */
-    type LinksStats = {};
     interface StatsByDevice {
         /** Statistics of the campaign on the basis of desktop devices */
         desktop?: Record<string, Brevo.GetDeviceBrowserStats> | undefined;

package/dist/cjs/api/types/GetProductDetails.d.ts

@@ -11,7 +11,7 @@ export interface GetProductDetails {
     id: string;
     /** Absolute URL to the cover image of the product */
     imageUrl?: string | undefined;
-    /** Product get deleted from the shop's database but not from Brevo */
+    /** Product deleted from the shop's database but not from Brevo */
     isDeleted?: boolean | undefined;
     /** Meta data of product such as description, vendor, producer, stock level, etc. */
     metaInfo?: Record<string, unknown> | undefined;
@@ -23,6 +23,8 @@ export interface GetProductDetails {
     parentId?: string | undefined;
     /** Price of the product */
     price?: number | undefined;
+    /** Alternative price of the product */
+    alternativePrice?: number | undefined;
     /** S3 url of original image */
     s3Original?: string | undefined;
     /** S3 thumbnail url of original image in 120x120 dimension for analytics section */

package/dist/cjs/api/types/GetSmsCampaignOverview.d.ts

@@ -9,12 +9,18 @@ export interface GetSmsCampaignOverview {
     modifiedAt: string;
     /** Name of the SMS Campaign */
     name: string;
-    /** UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format */
+    /** A recognizable prefix added as the Brand Name before the message content. Empty string if not set. */
+    organisationPrefix?: string | undefined;
+    /** UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format. Empty string if not scheduled. */
     scheduledAt?: string | undefined;
     /** Sender of the SMS Campaign */
     sender: string;
+    /** UTC date-time on which the SMS campaign was sent (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if the campaign status is 'sent'. */
+    sentDate?: string | undefined;
     /** Status of the SMS Campaign */
     status: GetSmsCampaignOverview.Status;
+    /** Instructions to unsubscribe from future communications. Empty string if not set. */
+    unsubscribeInstruction?: string | undefined;
 }
 export declare namespace GetSmsCampaignOverview {
     /** Status of the SMS Campaign */

package/dist/cjs/api/types/GetSmtpTemplateOverview.d.ts

@@ -24,6 +24,8 @@ export interface GetSmtpTemplateOverview {
     testSent: boolean;
     /** Customisation of the "to" field for the template */
     toField: string;
+    /** Custom template identifier, if one was assigned during template creation. Only present when the template has a custom ID. */
+    customTemplateId?: string | undefined;
 }
 export declare namespace GetSmtpTemplateOverview {
     interface Sender {
@@ -31,7 +33,7 @@ export declare namespace GetSmtpTemplateOverview {
         email?: string | undefined;
         /** Sender id of the template */
         id?: string | undefined;
-        /** From email for the template */
+        /** Sender name for the template */
         name?: string | undefined;
     }
 }

package/dist/cjs/api/types/GetWebhook.d.ts

@@ -6,8 +6,6 @@ export interface GetWebhook {
      * true
      */
     batched?: boolean | undefined;
-    /** channel of webhook */
-    channel?: GetWebhook.Channel | undefined;
     /** Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) */
     createdAt: string;
     /** Description of the webhook */
@@ -18,22 +16,19 @@ export interface GetWebhook {
     id: number;
     /** Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) */
     modifiedAt: string;
-    /** Type of webhook (marketing or transactional) */
+    /** Type of webhook (marketing, transactional, or inbound) */
     type: GetWebhook.Type;
+    /** Inbound domain of the webhook, only returned for inbound type webhooks */
+    domain?: string | undefined;
     /** URL of the webhook */
     url: string;
 }
 export declare namespace GetWebhook {
-    /** channel of webhook */
-    const Channel: {
-        readonly Sms: "sms";
-        readonly Email: "email";
-    };
-    type Channel = (typeof Channel)[keyof typeof Channel];
-    /** Type of webhook (marketing or transactional) */
+    /** Type of webhook (marketing, transactional, or inbound) */
     const Type: {
         readonly Marketing: "marketing";
         readonly Transactional: "transactional";
+        readonly Inbound: "inbound";
     };
     type Type = (typeof Type)[keyof typeof Type];
 }

package/dist/cjs/api/types/GetWebhook.js

@@ -4,14 +4,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GetWebhook = void 0;
 var GetWebhook;
 (function (GetWebhook) {
-    /** channel of webhook */
-    GetWebhook.Channel = {
-        Sms: "sms",
-        Email: "email",
-    };
-    /** Type of webhook (marketing or transactional) */
+    /** Type of webhook (marketing, transactional, or inbound) */
     GetWebhook.Type = {
         Marketing: "marketing",
         Transactional: "transactional",
+        Inbound: "inbound",
     };
 })(GetWebhook || (exports.GetWebhook = GetWebhook = {}));

package/dist/cjs/api/types/LoyaltyProgram.d.ts

@@ -1,34 +1,37 @@
 export interface LoyaltyProgram {
-    /** Loyalty Program code count */
-    codeCount?: number | undefined;
-    /** Loyalty Program creation date */
-    createdAt?: string | undefined;
-    /** Loyalty Program description */
-    description?: string | undefined;
-    /** string */
-    documentId?: string | undefined;
-    /** Loyalty Program ID */
+    /** Loyalty Program unique identifier. */
     id?: string | undefined;
-    /** Loyalty Program meta data */
-    meta?: Record<string, unknown> | undefined;
-    /** Loyalty Program name */
+    /** Loyalty Program name. */
     name?: string | undefined;
-    /** string */
-    pattern?: string | undefined;
-    /** Loyalty Program state */
+    /** Loyalty Program description. */
+    description?: string | undefined;
+    /** Loyalty Program metadata. */
+    meta?: Record<string, unknown> | undefined;
+    /** Current state of the loyalty program. */
     state?: LoyaltyProgram.State | undefined;
-    /** Loyalty Program subscription generator ID */
-    subscriptionGeneratorId?: string | undefined;
-    /** Loyalty Program subscription pool ID */
+    /** Loyalty Program subscription pool ID. */
     subscriptionPoolId?: string | undefined;
-    /** Loyalty Program last modification date */
+    /** Loyalty Program subscription generator ID. */
+    subscriptionGeneratorId?: string | undefined;
+    /** Subscription code pattern. */
+    pattern?: string | undefined;
+    /** Number of available subscription codes. */
+    codeCount?: number | undefined;
+    /** Associated document identifier. */
+    documentId?: string | undefined;
+    /** Contact attribute name used for birthday tracking. */
+    birthdayAttribute?: string | undefined;
+    /** Timestamp when the loyalty program was created. */
+    createdAt?: string | undefined;
+    /** Timestamp when the loyalty program was last modified. */
     updatedAt?: string | undefined;
 }
 export declare namespace LoyaltyProgram {
-    /** Loyalty Program state */
+    /** Current state of the loyalty program. */
     const State: {
         readonly Inactive: "inactive";
         readonly Active: "active";
+        readonly Draft: "draft";
     };
     type State = (typeof State)[keyof typeof State];
 }

package/dist/cjs/api/types/LoyaltyProgram.js

@@ -4,9 +4,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LoyaltyProgram = void 0;
 var LoyaltyProgram;
 (function (LoyaltyProgram) {
-    /** Loyalty Program state */
+    /** Current state of the loyalty program. */
     LoyaltyProgram.State = {
         Inactive: "inactive",
         Active: "active",
+        Draft: "draft",
     };
 })(LoyaltyProgram || (exports.LoyaltyProgram = LoyaltyProgram = {}));