@getbrevo/brevo 5.0.3 → 6.0.1

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

@@ -9,9 +9,9 @@ export interface GetCampaignStats {
     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 */
+    /** 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 */
+    /** Number of hard bounces for the campaign */
     hardBounces: number;
     /** List Id of email campaign (only in case of get email campaign(s)(not for global stats)) */
     listId?: number | undefined;
@@ -23,9 +23,9 @@ export interface GetCampaignStats {
     sent: number;
     /** Number of softbounce for the campaign */
     softBounces: number;
-    /** Recipients without any privacy protection option enabled in their email client_dev */
+    /** Recipients without any privacy protection option enabled in their email email client */
     trackableViews: number;
-    /** Rate of recipients without any privacy protection option enabled in their email client_dev */
+    /** 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;

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

@@ -15,6 +15,8 @@ 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;
 }
 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 = {}));

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

@@ -2,18 +2,20 @@
  * Note Details
  */
 export interface Note {
-    /** Account details of user which created the note */
-    authorId?: Record<string, unknown> | undefined;
+    /** Unique note Id */
+    id?: string | undefined;
+    /** Content of the note. Supports HTML for rich text formatting. Supported tags include: `<p>` (paragraph), `<b>` / `<strong>` (bold), `<i>` / `<em>` (italic), `<u>` (underline), `<br>` (line break), `<a href="...">` (labelled hyperlink). Example labelled link: `<a href="https://example.com">Link text</a>`. */
+    text: string;
     /** Contact ids linked to a note */
     contactIds?: number[] | undefined;
-    /** Note created date/time */
-    createdAt?: string | undefined;
+    /** Company ids linked to a note */
+    companyIds?: string[] | undefined;
     /** Deal ids linked to a note */
     dealIds?: string[] | undefined;
-    /** Unique note Id */
-    id?: string | undefined;
-    /** Text content of a note */
-    text: string;
+    /** Account details of user which created the note */
+    authorId?: Record<string, unknown> | undefined;
+    /** Note created date/time */
+    createdAt?: string | undefined;
     /** Note updated date/time */
     updatedAt?: string | undefined;
 }

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

@@ -8,6 +8,6 @@ export interface NoteData {
     contactIds?: number[] | undefined;
     /** Deal Ids linked to a note */
     dealIds?: string[] | undefined;
-    /** Text content of a note */
+    /** Content of the note. Supports HTML for rich text formatting. Supported tags include: `<p>` (paragraph), `<b>` / `<strong>` (bold), `<i>` / `<em>` (italic), `<u>` (underline), `<br>` (line break), `<a href="...">` (labelled hyperlink). Example labelled link: `<a href="https://example.com">Link text</a>`. */
     text: string;
 }

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

@@ -11,7 +11,7 @@ export interface Order {
     id: string;
     /** Identifies the contact associated with the order. */
     identifiers?: Order.Identifiers | undefined;
-    /** Meta data of order to store additional detal such as custom message, customer type, source. */
+    /** Meta data of order to store additional detail such as custom message, customer type, source. */
     metaInfo?: Record<string, Order.MetaInfo.Value> | undefined;
     products: Order.Products.Item[];
     /** State of the order. */

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

@@ -1,19 +1,19 @@
 /**
- * List of stages
+ * Pipeline details with stages
  */
 export interface Pipeline {
     /** Pipeline id */
     pipeline?: string | undefined;
     /** Pipeline Name */
     pipeline_name?: string | undefined;
-    /** List of stages */
+    /** List of pipeline stages */
     stages?: Pipeline.Stages.Item[] | undefined;
 }
 export declare namespace Pipeline {
     type Stages = Stages.Item[];
     namespace Stages {
         /**
-         * List of stages
+         * Stage details
          */
         interface Item {
             /** Stage id */

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

@@ -1,11 +1,11 @@
 export interface SendTransacSms {
     /** A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.** */
     organisationPrefix?: string | undefined;
-    /** Mobile number to send SMS with the country code */
+    /** Mobile number to send SMS with the country code. Must contain between 6 and 15 digits, optionally prefixed with '+'. */
     recipient: string;
-    /** Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** */
+    /** Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters.** Alphanumeric sender names (up to 11 characters) must contain only letters and digits. Numeric sender names (12-15 characters) must contain only digits. */
     sender: string;
-    /** Tag of the message */
+    /** Tag of the message. Can be a single string or an array of strings (maximum 10 tags). Each tag must be a non-empty string. */
     tag?: SendTransacSms.Tag | undefined;
     /** Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. */
     type?: SendTransacSms.Type | undefined;
@@ -13,6 +13,8 @@ export interface SendTransacSms {
     unicodeEnabled?: boolean | undefined;
     /** Webhook to call for each event triggered by the message (delivered etc.) */
     webUrl?: string | undefined;
+    /** Pass the set of attributes to customize the template. For example, {"FNAME":"Joe", "LNAME":"Doe"}. These are the placeholder variables in the template that will be replaced with the corresponding values passed in the params object. Applicable only if `templateId` is used. */
+    params?: Record<string, unknown> | undefined;
     /** Template ID to send SMS with the template. When provided, overrides the content parameter. Mandatory if 'content' is not passed. */
     templateId?: number | undefined;
     /** Content of the message. If more than **160 characters** long, will be sent as multiple text messages. Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed. */
@@ -20,18 +22,9 @@ export interface SendTransacSms {
 }
 export declare namespace SendTransacSms {
     /**
-     * Tag of the message
+     * Tag of the message. Can be a single string or an array of strings (maximum 10 tags). Each tag must be a non-empty string.
      */
-    interface Tag {
-        /** A tag can be a string or an array of strings. */
-        field?: Tag.Field | undefined;
-    }
-    namespace Tag {
-        /**
-         * A tag can be a string or an array of strings.
-         */
-        type Field = string | string[];
-    }
+    type Tag = string | string[];
     /** Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. */
     const Type: {
         readonly Transactional: "transactional";

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

@@ -2,16 +2,28 @@
  * Task Details
  */
 export interface Task {
-    /** Companies ids for companies a task is linked to */
-    companiesIds?: string[] | undefined;
-    /** Contact ids for contacts linked to this task */
-    contactsIds?: number[] | undefined;
-    /** Deal ids for deals a task is linked to */
-    dealsIds?: string[] | undefined;
     /** Unique task id */
     id?: string | undefined;
-    /** Name of task */
-    name: string;
     /** Id for type of task e.g Call / Email / Meeting etc. */
     taskTypeId: string;
+    /** Name of task */
+    name: string;
+    /** Companies ids for companies a task is linked to */
+    companiesIds?: string[] | undefined;
+    /** Deal ids for deals a task is linked to */
+    dealsIds?: string[] | undefined;
+    /** Contact ids for contacts linked to this task */
+    contactsIds?: number[] | undefined;
+    /** Account id of the user assigned to this task */
+    assignToId?: string | undefined;
+    /** Task due date and time */
+    date: string;
+    /** Notes added to a task */
+    notes?: string | undefined;
+    /** Whether the task is marked as done */
+    done?: boolean | undefined;
+    /** Task creation date/time */
+    createdAt?: string | undefined;
+    /** Task last update date/time */
+    updatedAt?: string | undefined;
 }

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

@@ -15,6 +15,10 @@ export interface TierGroup {
     updatedAt?: string | undefined;
     /** Select real_time to upgrade tier on real time balance updates. Select membership_anniversary to upgrade tier on subscription anniversary. Select tier_anniversary to upgrade tier on tier anniversary. */
     upgradeStrategy?: TierGroup.UpgradeStrategy | undefined;
+    /** Schedule configuration for tier upgrades. */
+    upgradeSchedule?: TierGroup.UpgradeSchedule | undefined;
+    /** Schedule configuration for tier downgrades. */
+    downgradeSchedule?: TierGroup.DowngradeSchedule | undefined;
 }
 export declare namespace TierGroup {
     /** Select real_time to downgrade tier on real time balance updates. Select membership_anniversary to downgrade tier on subscription anniversary. Select tier_anniversary to downgrade tier on tier anniversary. */
@@ -31,4 +35,66 @@ export declare namespace TierGroup {
         readonly TierAnniversary: "tier_anniversary";
     };
     type UpgradeStrategy = (typeof UpgradeStrategy)[keyof typeof UpgradeStrategy];
+    /**
+     * Schedule configuration for tier upgrades.
+     */
+    interface UpgradeSchedule {
+        /** Schedule strategy type. */
+        strategy?: string | undefined;
+        /** Duration value for the schedule. */
+        durationValue?: number | undefined;
+        /** Duration unit for the schedule. */
+        durationUnit?: UpgradeSchedule.DurationUnit | undefined;
+        /** Modifier for the duration. */
+        durationModifier?: UpgradeSchedule.DurationModifier | undefined;
+        /** Scheduled date in DD/MM format. */
+        scheduledDate?: string | undefined;
+    }
+    namespace UpgradeSchedule {
+        /** Duration unit for the schedule. */
+        const DurationUnit: {
+            readonly Day: "day";
+            readonly Week: "week";
+            readonly Month: "month";
+            readonly Year: "year";
+        };
+        type DurationUnit = (typeof DurationUnit)[keyof typeof DurationUnit];
+        /** Modifier for the duration. */
+        const DurationModifier: {
+            readonly StartOfPeriod: "start_of_period";
+            readonly EndOfPeriod: "end_of_period";
+        };
+        type DurationModifier = (typeof DurationModifier)[keyof typeof DurationModifier];
+    }
+    /**
+     * Schedule configuration for tier downgrades.
+     */
+    interface DowngradeSchedule {
+        /** Schedule strategy type. */
+        strategy?: string | undefined;
+        /** Duration value for the schedule. */
+        durationValue?: number | undefined;
+        /** Duration unit for the schedule. */
+        durationUnit?: DowngradeSchedule.DurationUnit | undefined;
+        /** Modifier for the duration. */
+        durationModifier?: DowngradeSchedule.DurationModifier | undefined;
+        /** Scheduled date in DD/MM format. */
+        scheduledDate?: string | undefined;
+    }
+    namespace DowngradeSchedule {
+        /** Duration unit for the schedule. */
+        const DurationUnit: {
+            readonly Day: "day";
+            readonly Week: "week";
+            readonly Month: "month";
+            readonly Year: "year";
+        };
+        type DurationUnit = (typeof DurationUnit)[keyof typeof DurationUnit];
+        /** Modifier for the duration. */
+        const DurationModifier: {
+            readonly StartOfPeriod: "start_of_period";
+            readonly EndOfPeriod: "end_of_period";
+        };
+        type DurationModifier = (typeof DurationModifier)[keyof typeof DurationModifier];
+    }
 }

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

@@ -16,4 +16,34 @@ var TierGroup;
         MembershipAnniversary: "membership_anniversary",
         TierAnniversary: "tier_anniversary",
     };
+    let UpgradeSchedule;
+    (function (UpgradeSchedule) {
+        /** Duration unit for the schedule. */
+        UpgradeSchedule.DurationUnit = {
+            Day: "day",
+            Week: "week",
+            Month: "month",
+            Year: "year",
+        };
+        /** Modifier for the duration. */
+        UpgradeSchedule.DurationModifier = {
+            StartOfPeriod: "start_of_period",
+            EndOfPeriod: "end_of_period",
+        };
+    })(UpgradeSchedule = TierGroup.UpgradeSchedule || (TierGroup.UpgradeSchedule = {}));
+    let DowngradeSchedule;
+    (function (DowngradeSchedule) {
+        /** Duration unit for the schedule. */
+        DowngradeSchedule.DurationUnit = {
+            Day: "day",
+            Week: "week",
+            Month: "month",
+            Year: "year",
+        };
+        /** Modifier for the duration. */
+        DowngradeSchedule.DurationModifier = {
+            StartOfPeriod: "start_of_period",
+            EndOfPeriod: "end_of_period",
+        };
+    })(DowngradeSchedule = TierGroup.DowngradeSchedule || (TierGroup.DowngradeSchedule = {}));
 })(TierGroup || (exports.TierGroup = TierGroup = {}));