rcs-js 2.0.13 → 2.0.14

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

@@ -12,8 +12,11 @@ export interface MessageEvent {
     direction: MessageEvent.Direction;
     /** Number of segments for this message. */
     segments: number;
-    /** Timestamp when the message was sent in ISO 8601 format. */
-    sentAt: string;
+    /**
+     * Timestamp when the message was sent in ISO 8601 format.
+     * Null if the message has not been sent yet.
+     */
+    sentAt: string | null;
     /**
      * Timestamp when the message was delivered in ISO 8601 format.
      * Null if not yet delivered or for inbound messages.
@@ -21,11 +24,17 @@ export interface MessageEvent {
     deliveredAt?: string | null;
     message: Pinnacle.MessageEventContent;
     /**
-     * Details of the fallback SMS/MMS message that was sent instead of the original RCS message.
+     * The unique identifier of the original RCS message that this fallback SMS/MMS was sent on behalf of. Always begins with the prefix `msg_`.
      *
-     * This field is only present when the message `status` is `FALLBACK_SENT`, indicating the original RCS message could not be delivered and a fallback message was sent instead.
+     * Only present on webhook events for fallback SMS/MMS messages. Use this to link the fallback back to the RCS message that could not be delivered. The `message.id` field on this event refers to the actual SMS/MMS that was sent — `originalMessageId` refers to the RCS message it replaced.
      *
-     * Use this information to track which fallback messages were sent and their content.
+     * Null when the message is not a fallback.
+     */
+    originalMessageId?: string | null;
+    /**
+     * Details of the fallback SMS/MMS message(s) that were actually sent to the recipient instead of the original RCS message.
+     *
+     * Only present when the message `status` is `FALLBACK_SENT`. The `message.id` on this event refers to the original RCS message that could not be delivered. The `fallbackMessage.ids` contain the identifiers of the actual SMS/MMS messages that were sent.
      */
     fallbackMessage?: MessageEvent.FallbackMessage | null;
 }
@@ -51,19 +60,17 @@ export declare namespace MessageEvent {
     };
     type Direction = (typeof Direction)[keyof typeof Direction];
     /**
-     * Details of the fallback SMS/MMS message that was sent instead of the original RCS message.
-     *
-     * This field is only present when the message `status` is `FALLBACK_SENT`, indicating the original RCS message could not be delivered and a fallback message was sent instead.
+     * Details of the fallback SMS/MMS message(s) that were actually sent to the recipient instead of the original RCS message.
      *
-     * Use this information to track which fallback messages were sent and their content.
+     * Only present when the message `status` is `FALLBACK_SENT`. The `message.id` on this event refers to the original RCS message that could not be delivered. The `fallbackMessage.ids` contain the identifiers of the actual SMS/MMS messages that were sent.
      */
     interface FallbackMessage {
         /**
-         * Unique identifier of the fallback message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
-         * To get the full message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint.
+         * Unique identifiers of the actual SMS/MMS message(s) that were sent as the fallback. Each identifier always begins with the prefix `msg_`. Multiple IDs indicate the fallback was split into multiple SMS/MMS messages. <br><br>
+         * These are the messages that were actually delivered to the recipient. To get their full details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint.
          */
-        id: string;
-        /** Type of the fallback message sent. */
+        ids: string[];
+        /** Delivery protocol of the fallback message that was sent. */
         type: FallbackMessage.Type;
         /** Phone number the fallback message was sent from in E.164 format. */
         from: string;
@@ -75,7 +82,7 @@ export declare namespace MessageEvent {
         mediaUrls?: string[];
     }
     namespace FallbackMessage {
-        /** Type of the fallback message sent. */
+        /** Delivery protocol of the fallback message that was sent. */
         const Type: {
             readonly Sms: "SMS";
             readonly Mms: "MMS";

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

@@ -11,7 +11,7 @@ var MessageEvent;
     };
     let FallbackMessage;
     (function (FallbackMessage) {
-        /** Type of the fallback message sent. */
+        /** Delivery protocol of the fallback message that was sent. */
         FallbackMessage.Type = {
             Sms: "SMS",
             Mms: "MMS",

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

@@ -4,7 +4,7 @@ import type * as Pinnacle from "../index.js";
  */
 export interface MessageList {
     /** Array of messages in the conversation. */
-    messages: Pinnacle.MessageWithReaction[];
+    messages: Pinnacle.MessageWithReactions[];
     /** Indicates if more messages are available beyond the current page. */
     hasMore: boolean;
     /** Total number of messages in the conversation. */

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

@@ -0,0 +1,71 @@
+export interface MessageSummary {
+    /** Unique identifier for the message. */
+    id: string;
+    /** Current status of the message. */
+    status: MessageSummary.Status;
+    /** Direction of the message. */
+    direction: MessageSummary.Direction;
+    /** Protocol type of the message. */
+    type: MessageSummary.Type;
+    /** Method used to send the message. */
+    method: MessageSummary.Method;
+    /** Number of segments in the message. */
+    numSegments: number;
+    /** Cost of the message. */
+    cost: number | null;
+    /** Sender phone number (E.164) or RCS agent ID. */
+    from: string | null;
+    /** Recipient phone number in E.164 format. */
+    to: string | null;
+    /** Message content (SMS text, MMS media, or RCS rich content). */
+    content: Record<string, unknown>;
+    /** Error details if the message failed. */
+    error: Record<string, unknown> | null;
+    /** Whether this is a test message. */
+    isTest: boolean;
+    /** ID of the blast this message belongs to, if any. */
+    blastId: string | null;
+    /** ISO 8601 timestamp of when the message was sent. */
+    sentAt: string | null;
+    /** ISO 8601 timestamp of when the message was delivered. */
+    deliveredAt: string | null;
+    /** ISO 8601 timestamp of when the message was created. */
+    createdAt: string;
+    /** ISO 8601 timestamp of when the message was last updated. */
+    updatedAt: string;
+}
+export declare namespace MessageSummary {
+    /** Current status of the message. */
+    const Status: {
+        readonly Pending: "PENDING";
+        readonly Sent: "SENT";
+        readonly SendFailed: "SEND_FAILED";
+        readonly Delivered: "DELIVERED";
+        readonly DeliveryFailed: "DELIVERY_FAILED";
+        readonly Received: "RECEIVED";
+        readonly Read: "READ";
+        readonly Queued: "QUEUED";
+        readonly FallbackSent: "FALLBACK_SENT";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+    /** Direction of the message. */
+    const Direction: {
+        readonly Inbound: "INBOUND";
+        readonly Outbound: "OUTBOUND";
+    };
+    type Direction = (typeof Direction)[keyof typeof Direction];
+    /** Protocol type of the message. */
+    const Type: {
+        readonly Sms: "SMS";
+        readonly Mms: "MMS";
+        readonly Rcs: "RCS";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+    /** Method used to send the message. */
+    const Method: {
+        readonly Api: "API";
+        readonly Sdk: "SDK";
+        readonly Other: "OTHER";
+    };
+    type Method = (typeof Method)[keyof typeof Method];
+}

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

@@ -0,0 +1,36 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageSummary = void 0;
+var MessageSummary;
+(function (MessageSummary) {
+    /** Current status of the message. */
+    MessageSummary.Status = {
+        Pending: "PENDING",
+        Sent: "SENT",
+        SendFailed: "SEND_FAILED",
+        Delivered: "DELIVERED",
+        DeliveryFailed: "DELIVERY_FAILED",
+        Received: "RECEIVED",
+        Read: "READ",
+        Queued: "QUEUED",
+        FallbackSent: "FALLBACK_SENT",
+    };
+    /** Direction of the message. */
+    MessageSummary.Direction = {
+        Inbound: "INBOUND",
+        Outbound: "OUTBOUND",
+    };
+    /** Protocol type of the message. */
+    MessageSummary.Type = {
+        Sms: "SMS",
+        Mms: "MMS",
+        Rcs: "RCS",
+    };
+    /** Method used to send the message. */
+    MessageSummary.Method = {
+        Api: "API",
+        Sdk: "SDK",
+        Other: "OTHER",
+    };
+})(MessageSummary || (exports.MessageSummary = MessageSummary = {}));

package/dist/cjs/api/types/{MessageWithReaction.d.ts → MessageWithReactions.d.ts}

@@ -1,18 +1,18 @@
 import type * as Pinnacle from "../index.js";
 /**
- * Message with additional conversation-specific fields including direction and reaction.
+ * Message with additional conversation-specific fields including direction and reactions.
  */
-export interface MessageWithReaction extends Pinnacle.Message {
+export interface MessageWithReactions extends Pinnacle.Message {
     /** Direction of the message flow. */
-    direction: MessageWithReaction.Direction;
+    direction: MessageWithReactions.Direction;
     /**
-     * Unicode emoji reaction attached to this message. <br>
+     * Array of unicode emoji reactions attached to this message. <br>
      *
-     * Null indicates no reaction has been added.
+     * Empty array indicates no reactions have been added.
      */
-    reaction: string | null;
+    reactions: string[];
 }
-export declare namespace MessageWithReaction {
+export declare namespace MessageWithReactions {
     /** Direction of the message flow. */
     const Direction: {
         readonly Inbound: "INBOUND";

package/dist/cjs/api/types/{MessageWithReaction.js → MessageWithReactions.js}

@@ -1,12 +1,12 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MessageWithReaction = void 0;
-var MessageWithReaction;
-(function (MessageWithReaction) {
+exports.MessageWithReactions = void 0;
+var MessageWithReactions;
+(function (MessageWithReactions) {
     /** Direction of the message flow. */
-    MessageWithReaction.Direction = {
+    MessageWithReactions.Direction = {
         Inbound: "INBOUND",
         Outbound: "OUTBOUND",
     };
-})(MessageWithReaction || (exports.MessageWithReaction = MessageWithReaction = {}));
+})(MessageWithReactions || (exports.MessageWithReactions = MessageWithReactions = {}));

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

@@ -0,0 +1,14 @@
+export interface OwnedPhoneNumber {
+    /** Phone number in E.164 format. */
+    number: string;
+    /** Whether SMS messaging is enabled. */
+    sms: boolean;
+    /** Whether MMS messaging is enabled. */
+    mms: boolean;
+    /** Whether voice calling is enabled. */
+    voice: boolean;
+    /** Whether this is a sandbox phone number. */
+    isSandbox: boolean;
+    /** ISO 8601 timestamp of when the phone number was added. */
+    createdAt: string;
+}

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

@@ -0,0 +1,81 @@
+/**
+ * The configuration details of an RCS agent, as returned by the GET endpoint.
+ */
+export interface RcsAgentDetails {
+    /** Display name of the agent. */
+    name?: string;
+    /** Description of the agent. */
+    description?: string;
+    /** URL to the agent's logo image. */
+    iconUrl?: string | null;
+    /** URL to the agent's hero banner image. */
+    heroUrl?: string | null;
+    /** The agent's brand color hex code. */
+    color?: string;
+    /** Contact phone numbers for the agent. */
+    phones?: RcsAgentDetails.Phones.Item[];
+    /** Contact email addresses for the agent. */
+    emails?: RcsAgentDetails.Emails.Item[];
+    /** Website links for the agent. */
+    websites?: RcsAgentDetails.Websites.Item[];
+    /** URL to the agent's privacy policy. */
+    privacyUrl?: string | null;
+    /** URL to the agent's terms and conditions. */
+    termsUrl?: string | null;
+    /**
+     * Whether the agent supports two-way conversations. `true` for agents that respond
+     * to user messages, `false` for send-only agents (e.g., notifications).
+     */
+    isConversational?: boolean | null;
+    /**
+     * The primary use case for the RCS agent.
+     * - `TRANSACTIONAL` — Order confirmations, shipping updates, appointment reminders.
+     * - `PROMOTIONAL` — Marketing messages, offers, discounts.
+     * - `OTP` — One-time passwords and verification codes.
+     * - `MULTI_USE` — A combination of transactional, promotional, and/or OTP messaging.
+     */
+    agentUseCase?: RcsAgentDetails.AgentUseCase | null;
+}
+export declare namespace RcsAgentDetails {
+    type Phones = Phones.Item[];
+    namespace Phones {
+        interface Item {
+            /** Phone number in E.164 format. */
+            phone?: string;
+            /** Display label for the phone number. */
+            label?: string;
+        }
+    }
+    type Emails = Emails.Item[];
+    namespace Emails {
+        interface Item {
+            /** Email address. */
+            email?: string;
+            /** Display label for the email. */
+            label?: string;
+        }
+    }
+    type Websites = Websites.Item[];
+    namespace Websites {
+        interface Item {
+            /** Website URL. */
+            url?: string;
+            /** Display label for the website. */
+            label?: string;
+        }
+    }
+    /**
+     * The primary use case for the RCS agent.
+     * - `TRANSACTIONAL` — Order confirmations, shipping updates, appointment reminders.
+     * - `PROMOTIONAL` — Marketing messages, offers, discounts.
+     * - `OTP` — One-time passwords and verification codes.
+     * - `MULTI_USE` — A combination of transactional, promotional, and/or OTP messaging.
+     */
+    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/RcsAgentDetails.js

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

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

@@ -0,0 +1,17 @@
+import type * as Pinnacle from "../index.js";
+/**
+ * Response containing details of an RCS agent.
+ */
+export interface RcsAgentResponse {
+    /** The unique agent ID, prefixed with `agent_`. */
+    id: string;
+    /**
+     * The agent type.
+     * - `TEST` — A test agent for development and testing with whitelisted numbers only.
+     */
+    type: "TEST";
+    /** The RCS service ID assigned to this agent. */
+    serviceId: string;
+    carrierLaunches: Pinnacle.CarrierLaunches;
+    details: Pinnacle.RcsAgentDetails;
+}

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

@@ -0,0 +1,28 @@
+export interface RcsCampaignSummary {
+    /** Unique identifier for the RCS campaign. */
+    campaignId: string;
+    /** Name of the campaign. */
+    name?: string;
+    /** Current status of the campaign. */
+    status: RcsCampaignSummary.Status;
+    /** Brand ID associated with this campaign. */
+    brandId?: string;
+    /** Primary use case for this campaign. */
+    useCase?: string;
+    /** RCS agent ID associated with this campaign. */
+    agentId?: 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 RcsCampaignSummary {
+    /** 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/RcsCampaignSummary.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.RcsCampaignSummary = void 0;
+var RcsCampaignSummary;
+(function (RcsCampaignSummary) {
+    /** Current status of the campaign. */
+    RcsCampaignSummary.Status = {
+        Incomplete: "INCOMPLETE",
+        InReview: "IN REVIEW",
+        Verified: "VERIFIED",
+        Failed: "FAILED",
+    };
+})(RcsCampaignSummary || (exports.RcsCampaignSummary = RcsCampaignSummary = {}));

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

@@ -0,0 +1,13 @@
+/**
+ * Status of a whitelisted phone number for RCS testing.
+ *
+ * - `PENDING` — The tester invite has been sent but the recipient has not yet accepted or rejected it.
+ * - `ACCEPTED` — The recipient accepted the tester invite and can send/receive messages with the test agent.
+ * - `REJECTED` — The recipient rejected the tester invite or the invite could not be delivered.
+ */
+export declare const RcsWhitelistStatus: {
+    readonly Pending: "PENDING";
+    readonly Accepted: "ACCEPTED";
+    readonly Rejected: "REJECTED";
+};
+export type RcsWhitelistStatus = (typeof RcsWhitelistStatus)[keyof typeof RcsWhitelistStatus];

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

@@ -0,0 +1,16 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RcsWhitelistStatus = void 0;
+/**
+ * Status of a whitelisted phone number for RCS testing.
+ *
+ * - `PENDING` — The tester invite has been sent but the recipient has not yet accepted or rejected it.
+ * - `ACCEPTED` — The recipient accepted the tester invite and can send/receive messages with the test agent.
+ * - `REJECTED` — The recipient rejected the tester invite or the invite could not be delivered.
+ */
+exports.RcsWhitelistStatus = {
+    Pending: "PENDING",
+    Accepted: "ACCEPTED",
+    Rejected: "REJECTED",
+};

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

@@ -0,0 +1,29 @@
+export interface ScheduledMessageSummary {
+    /** Unique identifier for the scheduled message. */
+    id: string;
+    /** ISO 8601 timestamp of when the message is scheduled to be sent. */
+    sendAt: string | null;
+    /** Current status of the scheduled message. */
+    status: ScheduledMessageSummary.Status;
+    /** Cron expression for recurring schedules. */
+    recurrence: string | null;
+    /** Timezone for the schedule (e.g. "America/New_York"). */
+    timezone: string | null;
+    /** ISO 8601 end date for recurring schedules. */
+    endDate: string | null;
+    /** The scheduled message payload. */
+    payload: Record<string, unknown>;
+    /** ISO 8601 timestamp of when the schedule was created. */
+    createdAt: string;
+    /** ISO 8601 timestamp of when the schedule was last updated. */
+    updatedAt: string;
+}
+export declare namespace ScheduledMessageSummary {
+    /** Current status of the scheduled message. */
+    const Status: {
+        readonly Active: "ACTIVE";
+        readonly Cancelled: "CANCELLED";
+        readonly Failed: "FAILED";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/cjs/api/types/ScheduledMessageSummary.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.ScheduledMessageSummary = void 0;
+var ScheduledMessageSummary;
+(function (ScheduledMessageSummary) {
+    /** Current status of the scheduled message. */
+    ScheduledMessageSummary.Status = {
+        Active: "ACTIVE",
+        Cancelled: "CANCELLED",
+        Failed: "FAILED",
+    };
+})(ScheduledMessageSummary || (exports.ScheduledMessageSummary = ScheduledMessageSummary = {}));

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

@@ -4,8 +4,6 @@ import type * as Pinnacle from "../index.js";
  */
 export interface SendRichMessageOptions {
     schedule?: Pinnacle.MessageSchedule;
-    /** Send via the test agent to whitelisted test devices. Useful for development and debugging. */
-    test_mode?: boolean;
     tracking?: Pinnacle.Tracking;
     /** Media files and card media will be transcoded to a supported RCS format. This adds a small delay to sending the message. Ignored for rich text messages. */
     transcode?: boolean;

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

@@ -0,0 +1,10 @@
+import type * as Pinnacle from "../index.js";
+/**
+ * Returned when a fallback is configured and the recipient does not support RCS. The API checks RCS capabilities at send time. If the recipient's device doesn't support RCS, the fallback MMS is sent instead. You will also receive a `FALLBACK_SENT` webhook event for the original RCS message.
+ */
+export interface SentRichMessageFallbackMms extends Pinnacle.SentMmsDetails {
+    /** Indicates that the fallback MMS was sent because the recipient does not support RCS. */
+    fallbackSent: boolean;
+    /** Unique identifier of the original RCS message that triggered this fallback. Always begins with the prefix `msg_`. This is the RCS message that could not be delivered — the `messageIds` field on this response refers to the actual MMS message(s) that were sent as the fallback. */
+    originalMessageId: string;
+}

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

@@ -0,0 +1,10 @@
+import type * as Pinnacle from "../index.js";
+/**
+ * Returned when a fallback is configured and the recipient does not support RCS. The API checks RCS capabilities at send time. If the recipient's device doesn't support RCS, the fallback SMS is sent instead. You will also receive a `FALLBACK_SENT` webhook event for the original RCS message.
+ */
+export interface SentRichMessageFallbackSms extends Pinnacle.SentSmsDetails {
+    /** Indicates that the fallback SMS was sent because the recipient does not support RCS. */
+    fallbackSent: boolean;
+    /** Unique identifier of the original RCS message that triggered this fallback. Always begins with the prefix `msg_`. This is the RCS message that could not be delivered — the `messageId` field on this response refers to the actual SMS that was sent as the fallback. */
+    originalMessageId: string;
+}

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

@@ -0,0 +1,19 @@
+import type * as Pinnacle from "../index.js";
+/**
+ * Response returned after creating or updating a test agent.
+ */
+export interface TestAgentResponse {
+    /**
+     * The unique agent ID. Use this ID when sending messages, whitelisting numbers,
+     * and performing other agent operations. Always prefixed with `agent_`.
+     */
+    id: string;
+    /** The type of the agent. Test agents always have type `TEST`. */
+    type: "TEST";
+    /**
+     * The RCS service ID assigned to this agent by the carrier network. Used internally
+     * for routing messages. You can use this to construct RCS deep links manually.
+     */
+    serviceId: string;
+    details: Pinnacle.RcsAgentDetails;
+}

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

@@ -0,0 +1,7 @@
+import type * as Pinnacle from "../index.js";
+/**
+ * Response containing the whitelist status of a phone number.
+ */
+export interface TestAgentWhitelistResponse {
+    status: Pinnacle.RcsWhitelistStatus;
+}

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

@@ -0,0 +1,26 @@
+export interface TollFreeCampaignSummary {
+    /** Unique identifier for the toll-free campaign. */
+    campaignId: string;
+    /** Name of the campaign. */
+    name?: string;
+    /** Current status of the campaign. */
+    status: TollFreeCampaignSummary.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 TollFreeCampaignSummary {
+    /** 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/TollFreeCampaignSummary.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.TollFreeCampaignSummary = void 0;
+var TollFreeCampaignSummary;
+(function (TollFreeCampaignSummary) {
+    /** Current status of the campaign. */
+    TollFreeCampaignSummary.Status = {
+        Incomplete: "INCOMPLETE",
+        InReview: "IN REVIEW",
+        Verified: "VERIFIED",
+        Failed: "FAILED",
+    };
+})(TollFreeCampaignSummary || (exports.TollFreeCampaignSummary = TollFreeCampaignSummary = {}));