rcs-js 2.0.13 → 2.0.14

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

@@ -0,0 +1,94 @@
+export interface AgentSummary {
+    /** Unique identifier for the agent. */
+    agentId: string;
+    /** Type of the agent. */
+    agentType: AgentSummary.AgentType;
+    /** Service ID associated with the agent. */
+    serviceId?: string | null;
+    /** Per-carrier launch status for the agent. */
+    carrierLaunches?: AgentSummary.CarrierLaunches | null;
+    /** Agent configuration details. */
+    config?: AgentSummary.Config | null;
+    /** ISO 8601 timestamp of when the agent was created. */
+    createdAt: string;
+    /** ISO 8601 timestamp of when the agent was last updated. */
+    updatedAt: string;
+}
+export declare namespace AgentSummary {
+    /** Type of the agent. */
+    const AgentType: {
+        readonly Production: "PRODUCTION";
+        readonly Test: "TEST";
+    };
+    type AgentType = (typeof AgentType)[keyof typeof AgentType];
+    /**
+     * Per-carrier launch status for the agent.
+     */
+    interface CarrierLaunches {
+        /** Launch status for AT&T. null = not requested, false = pending, true = launched. */
+        ATT?: boolean | null;
+        /** Launch status for other carriers. null = not requested, false = pending, true = launched. */
+        OTHERS?: boolean | null;
+        /** Launch status for T-Mobile. null = not requested, false = pending, true = launched. */
+        TMOBILE?: boolean | null;
+        /** Launch status for Verizon. null = not requested, false = pending, true = launched. */
+        VERIZON?: boolean | null;
+    }
+    /**
+     * Agent configuration details.
+     */
+    interface Config {
+        /** Display name of the agent (max 40 characters). */
+        name?: string;
+        /** Description of the agent (max 100 characters). */
+        description?: string;
+        /** Hex color code for the agent. */
+        color?: string;
+        websites?: Config.Websites.Item[];
+        phones?: Config.Phones.Item[];
+        emails?: Config.Emails.Item[];
+        /** Logo image URL. */
+        iconUrl?: string | null;
+        /** Hero image URL. */
+        heroUrl?: string | null;
+        /** Privacy policy URL. */
+        privacyUrl?: string | null;
+        /** Terms of service URL. */
+        termsUrl?: string | null;
+        /** Whether the agent supports two-way conversation. */
+        isConversational?: boolean | null;
+        /** Use case for the agent. */
+        agentUseCase?: Config.AgentUseCase | null;
+    }
+    namespace Config {
+        type Websites = Websites.Item[];
+        namespace Websites {
+            interface Item {
+                url?: string;
+                label?: string;
+            }
+        }
+        type Phones = Phones.Item[];
+        namespace Phones {
+            interface Item {
+                phone?: string;
+                label?: string;
+            }
+        }
+        type Emails = Emails.Item[];
+        namespace Emails {
+            interface Item {
+                email?: string;
+                label?: string;
+            }
+        }
+        /** Use case for the agent. */
+        const AgentUseCase: {
+            readonly Transactional: "TRANSACTIONAL";
+            readonly Promotional: "PROMOTIONAL";
+            readonly Otp: "OTP";
+            readonly MultiUse: "MULTI_USE";
+        };
+        type AgentUseCase = (typeof AgentUseCase)[keyof typeof AgentUseCase];
+    }
+}

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

@@ -0,0 +1,22 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentSummary = void 0;
+var AgentSummary;
+(function (AgentSummary) {
+    /** Type of the agent. */
+    AgentSummary.AgentType = {
+        Production: "PRODUCTION",
+        Test: "TEST",
+    };
+    let Config;
+    (function (Config) {
+        /** Use case for the agent. */
+        Config.AgentUseCase = {
+            Transactional: "TRANSACTIONAL",
+            Promotional: "PROMOTIONAL",
+            Otp: "OTP",
+            MultiUse: "MULTI_USE",
+        };
+    })(Config = AgentSummary.Config || (AgentSummary.Config = {}));
+})(AgentSummary || (exports.AgentSummary = AgentSummary = {}));

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

@@ -0,0 +1,15 @@
+/**
+ * The primary use case for the RCS agent. This helps carriers understand the purpose of the agent during review.
+ *
+ * - `TRANSACTIONAL` — Order confirmations, shipping updates, appointment reminders, and similar transactional notifications.
+ * - `PROMOTIONAL` — Marketing messages, offers, discounts, and promotional content.
+ * - `OTP` — One-time passwords and verification codes.
+ * - `MULTI_USE` — A combination of transactional, promotional, and/or OTP messaging.
+ */
+export declare const AgentUseCase: {
+    readonly Transactional: "TRANSACTIONAL";
+    readonly Promotional: "PROMOTIONAL";
+    readonly Otp: "OTP";
+    readonly MultiUse: "MULTI_USE";
+};
+export type AgentUseCase = (typeof AgentUseCase)[keyof typeof AgentUseCase];

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

@@ -0,0 +1,18 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentUseCase = void 0;
+/**
+ * The primary use case for the RCS agent. This helps carriers understand the purpose of the agent during review.
+ *
+ * - `TRANSACTIONAL` — Order confirmations, shipping updates, appointment reminders, and similar transactional notifications.
+ * - `PROMOTIONAL` — Marketing messages, offers, discounts, and promotional content.
+ * - `OTP` — One-time passwords and verification codes.
+ * - `MULTI_USE` — A combination of transactional, promotional, and/or OTP messaging.
+ */
+exports.AgentUseCase = {
+    Transactional: "TRANSACTIONAL",
+    Promotional: "PROMOTIONAL",
+    Otp: "OTP",
+    MultiUse: "MULTI_USE",
+};

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

@@ -0,0 +1,9 @@
+/**
+ * A website contact entry for the RCS agent's contact information.
+ */
+export interface AgentWebsiteEntry {
+    /** A valid URL for the website. */
+    url: string;
+    /** Display label for the website (e.g., "Website", "Help Center"). */
+    label: string;
+}

package/dist/cjs/api/types/AgentWebsiteEntry.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/AudienceSummary.d.ts

@@ -0,0 +1,12 @@
+export interface AudienceSummary {
+    /** Audience public ID. This identifier is a string that always begins with the prefix `aud_`, for example: `aud_abc123`. */
+    id: string;
+    /** Audience name. */
+    name: string;
+    /** Audience description. */
+    description: string;
+    /** ISO 8601 timestamp of when the audience was created. */
+    createdAt: string;
+    /** ISO 8601 timestamp of when the audience was last updated. */
+    updatedAt: string;
+}

package/dist/cjs/api/types/AudienceSummary.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/BlastDetails.d.ts

@@ -12,6 +12,6 @@ export interface BlastDetails {
     totalMessages: number;
     /** Total number of message segments across all messages. */
     totalSegments: number;
-    /** Total estimated cost of the blast. Calculated by multiplying the number of segments by the number of messages by the unit cost. */
+    /** Total cost of the blast. For RCS blasts with a fallback configured, this reflects the actual mix of RCS and SMS/MMS pricing based on each recipient's RCS capability. For more details check the [Transactions page](https://app.pinnacle.sh/dashboard/settings/billing/transactions) and the [Audiences page](https://app.pinnacle.sh/dashboard/audiences) to see blasts. */
     totalCost: number;
 }

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

@@ -0,0 +1,27 @@
+export interface BlastSummary {
+    /** Unique identifier for the blast. */
+    id: string;
+    /** Audience ID associated with this blast. */
+    audienceId: string;
+    /** Type of the blast message. */
+    type: BlastSummary.Type;
+    /** Sender identifiers (phone numbers or agent IDs) used for the blast. */
+    senders: string[];
+    /** Message content sent in the blast. */
+    content: Record<string, unknown>;
+    /** Blast options configuration. */
+    options: Record<string, unknown> | null;
+    /** Fallback message configuration, if any. */
+    fallback: Record<string, unknown> | null;
+    /** ISO 8601 timestamp of when the blast was created. */
+    createdAt: string;
+}
+export declare namespace BlastSummary {
+    /** Type of the blast message. */
+    const Type: {
+        readonly Sms: "SMS";
+        readonly Mms: "MMS";
+        readonly Rcs: "RCS";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

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

@@ -0,0 +1,13 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlastSummary = void 0;
+var BlastSummary;
+(function (BlastSummary) {
+    /** Type of the blast message. */
+    BlastSummary.Type = {
+        Sms: "SMS",
+        Mms: "MMS",
+        Rcs: "RCS",
+    };
+})(BlastSummary || (exports.BlastSummary = BlastSummary = {}));

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

@@ -0,0 +1,12 @@
+/**
+ * Launch status for a carrier.
+ * - `NOT_LAUNCHED` — No launch requested.
+ * - `PENDING` — Launch pending.
+ * - `LAUNCHED` — Launched.
+ */
+export declare const CarrierLaunchStatus: {
+    readonly NotLaunched: "NOT_LAUNCHED";
+    readonly Pending: "PENDING";
+    readonly Launched: "LAUNCHED";
+};
+export type CarrierLaunchStatus = (typeof CarrierLaunchStatus)[keyof typeof CarrierLaunchStatus];

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

@@ -0,0 +1,15 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CarrierLaunchStatus = void 0;
+/**
+ * Launch status for a carrier.
+ * - `NOT_LAUNCHED` — No launch requested.
+ * - `PENDING` — Launch pending.
+ * - `LAUNCHED` — Launched.
+ */
+exports.CarrierLaunchStatus = {
+    NotLaunched: "NOT_LAUNCHED",
+    Pending: "PENDING",
+    Launched: "LAUNCHED",
+};

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

@@ -0,0 +1,14 @@
+import type * as Pinnacle from "../index.js";
+/**
+ * Per-carrier launch status.
+ */
+export interface CarrierLaunches {
+    /** AT&T launch status. */
+    ATT: Pinnacle.CarrierLaunchStatus;
+    /** T-Mobile launch status. */
+    TMOBILE: Pinnacle.CarrierLaunchStatus;
+    /** Verizon launch status. */
+    VERIZON: Pinnacle.CarrierLaunchStatus;
+    /** Other carriers launch status. */
+    OTHERS: Pinnacle.CarrierLaunchStatus;
+}

package/dist/cjs/api/types/CarrierLaunches.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/DlcCampaignSummary.d.ts

@@ -0,0 +1,26 @@
+export interface DlcCampaignSummary {
+    /** Unique identifier for the 10DLC campaign. */
+    campaignId: string;
+    /** Name of the campaign. */
+    name?: string;
+    /** Current status of the campaign. */
+    status: DlcCampaignSummary.Status;
+    /** Brand ID associated with this campaign. */
+    brandId?: string;
+    /** Primary use case for this campaign. */
+    useCase?: string;
+    /** ISO 8601 timestamp of when the campaign was created. */
+    createdAt: string;
+    /** ISO 8601 timestamp of when the campaign was last updated. */
+    updatedAt: string;
+}
+export declare namespace DlcCampaignSummary {
+    /** Current status of the campaign. */
+    const Status: {
+        readonly Incomplete: "INCOMPLETE";
+        readonly InReview: "IN REVIEW";
+        readonly Verified: "VERIFIED";
+        readonly Failed: "FAILED";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

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

@@ -0,0 +1,14 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DlcCampaignSummary = void 0;
+var DlcCampaignSummary;
+(function (DlcCampaignSummary) {
+    /** Current status of the campaign. */
+    DlcCampaignSummary.Status = {
+        Incomplete: "INCOMPLETE",
+        InReview: "IN REVIEW",
+        Verified: "VERIFIED",
+        Failed: "FAILED",
+    };
+})(DlcCampaignSummary || (exports.DlcCampaignSummary = DlcCampaignSummary = {}));

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

@@ -1,16 +1,17 @@
 /**
  * SMS/MMS fallback message to send if the RCS message fails to deliver.
  *
- * When a recipient's device doesn't support RCS or the RCS message cannot be delivered, this fallback message will be sent as SMS or MMS instead. The fallback is sent from the specified phone number.
+ * When a recipient's device doesn't support RCS, this fallback message will be sent as SMS or MMS instead. The fallback is sent from the specified phone number.
  *
  * > **Note:** At least one of `text` or `mediaUrls` must be provided. Fallback messages require a verified `from` phone number with SMS/MMS sending capabilities.
- * > **Note:** You will not be charged for the fallback message, only the original RCS message will be charged.
+ *
+ * > **Billing:** You will be charged the standard SMS or MMS rate for the fallback message. The original RCS message will not be charged if the fallback is sent instead.
  */
 export interface FallbackMessage {
     /**
      * Phone number to send the fallback message from in E.164 format.
      *
-     * Must be a verified phone number with SMS/MMS sending capabilities. Sandbox numbers cannot be used for fallbacks. The phone number must be connected an active toll-free or 10DLC campaign.
+     * Must be a verified phone number with SMS/MMS sending capabilities. Sandbox numbers cannot be used for fallbacks. The phone number must be connected to an active toll-free or 10DLC campaign.
      */
     from: string;
     /**
@@ -18,7 +19,7 @@ export interface FallbackMessage {
      *
      * At least one of `text` or `mediaUrls` must be provided.
      *
-     * > **Note:** If text exceeds 3072 characters, the fallback will be sent as MMS instead of SMS.
+     * If `mediaUrls` is empty and the text fits within SMS segment limits, the fallback will be sent as SMS. Otherwise, it will be sent as MMS. You will only be billed for the message sent.
      */
     text?: string;
     /**
@@ -26,7 +27,7 @@ export interface FallbackMessage {
      *
      * See [supported media types](https://app.pinnacle.sh/supported-file-types?type=MMS).
      *
-     * If provided, the fallback will be sent as MMS. Otherwise, it will be sent as SMS (unless text exceeds 3072 characters). At least one of `text` or `mediaUrls` must be provided.
+     * If provided, the fallback will be sent as MMS. Otherwise, it will be sent as SMS (if text fits within segment limits). At least one of `text` or `mediaUrls` must be provided.
      */
     mediaUrls?: string[];
 }

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

@@ -0,0 +1,10 @@
+export interface LinkSummary {
+    /** The full shortened URL (e.g. https://pncl.to/abc123). */
+    from: string;
+    /** Destination URL that the shortened link redirects to. */
+    to: string;
+    /** Expiration date in ISO 8601 format, or null if permanent. */
+    expiresAt?: string | null;
+    /** ISO 8601 timestamp of when the link was created. */
+    createdAt: string;
+}

package/dist/cjs/api/types/LinkSummary.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/ListAgentsResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Pinnacle from "../index.js";
+export interface ListAgentsResponse {
+    data: Pinnacle.AgentSummary[];
+    hasMore: boolean;
+    count: number;
+}

package/dist/cjs/api/types/ListAgentsResponse.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/ListAudiencesResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Pinnacle from "../index.js";
+export interface ListAudiencesResponse {
+    data: Pinnacle.AudienceSummary[];
+    hasMore: boolean;
+    count: number;
+}

package/dist/cjs/api/types/ListAudiencesResponse.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/ListBlastsResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Pinnacle from "../index.js";
+export interface ListBlastsResponse {
+    data: Pinnacle.BlastSummary[];
+    hasMore: boolean;
+    count: number;
+}

package/dist/cjs/api/types/ListBlastsResponse.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/ListBrandsResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Pinnacle from "../index.js";
+export interface ListBrandsResponse {
+    data: Pinnacle.ExtendedBrand[];
+    hasMore: boolean;
+    count: number;
+}

package/dist/cjs/api/types/ListBrandsResponse.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/ListContactsResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Pinnacle from "../index.js";
+export interface ListContactsResponse {
+    data: Pinnacle.Contact[];
+    hasMore: boolean;
+    count: number;
+}

package/dist/cjs/api/types/ListContactsResponse.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/ListDlcCampaignsResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Pinnacle from "../index.js";
+export interface ListDlcCampaignsResponse {
+    data: Pinnacle.DlcCampaignSummary[];
+    hasMore: boolean;
+    count: number;
+}

package/dist/cjs/api/types/ListDlcCampaignsResponse.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/ListLinksResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Pinnacle from "../index.js";
+export interface ListLinksResponse {
+    data: Pinnacle.LinkSummary[];
+    hasMore: boolean;
+    count: number;
+}

package/dist/cjs/api/types/ListLinksResponse.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/ListMessagesResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Pinnacle from "../index.js";
+export interface ListMessagesResponse {
+    data: Pinnacle.MessageSummary[];
+    hasMore: boolean;
+    count: number;
+}

package/dist/cjs/api/types/ListMessagesResponse.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/ListPhoneNumbersResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Pinnacle from "../index.js";
+export interface ListPhoneNumbersResponse {
+    data: Pinnacle.OwnedPhoneNumber[];
+    hasMore: boolean;
+    count: number;
+}

package/dist/cjs/api/types/ListPhoneNumbersResponse.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/ListRcsCampaignsResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Pinnacle from "../index.js";
+export interface ListRcsCampaignsResponse {
+    data: Pinnacle.RcsCampaignSummary[];
+    hasMore: boolean;
+    count: number;
+}

package/dist/cjs/api/types/ListRcsCampaignsResponse.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/ListScheduledMessagesResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Pinnacle from "../index.js";
+export interface ListScheduledMessagesResponse {
+    data: Pinnacle.ScheduledMessageSummary[];
+    hasMore: boolean;
+    count: number;
+}

package/dist/cjs/api/types/ListScheduledMessagesResponse.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/ListTestNumbersResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Pinnacle from "../index.js";
+export interface ListTestNumbersResponse {
+    data: Pinnacle.WhitelistedNumberSummary[];
+    hasMore: boolean;
+    count: number;
+}

package/dist/cjs/api/types/ListTestNumbersResponse.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/ListTollFreeCampaignsResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Pinnacle from "../index.js";
+export interface ListTollFreeCampaignsResponse {
+    data: Pinnacle.TollFreeCampaignSummary[];
+    hasMore: boolean;
+    count: number;
+}

package/dist/cjs/api/types/ListTollFreeCampaignsResponse.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/ListWebhooksResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Pinnacle from "../index.js";
+export interface ListWebhooksResponse {
+    data: Pinnacle.WebhookSummary[];
+    hasMore: boolean;
+    count: number;
+}

package/dist/cjs/api/types/ListWebhooksResponse.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/Message.d.ts

@@ -19,14 +19,6 @@ export interface Message {
      * Null indicates no errors.
      */
     error: string | null;
-    /**
-     * The fallback SMS/MMS message configuration for this RCS message.
-     *
-     * Null indicates no fallback was configured for this message. Only applicable for RCS messages.
-     *
-     * The original RCS message with have status `FALLBACK_SENT` when the fallback message was sent instead.
-     */
-    fallback?: Pinnacle.FallbackMessage | null;
     /** Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. */
     id: string;
     method: Pinnacle.MessageMethodEnum;