rcs-js 2.0.0-rc.10 → 2.0.0-rc.12

package/dist/esm/api/types/ButtonClickedData.d.mts

@@ -0,0 +1,56 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+/**
+ * Unified data structure for button click events.
+ */
+export interface ButtonClickedData {
+    /** Information about the button that was clicked. */
+    button: ButtonClickedData.Button;
+    /** ID of the message this button was attached to, or null if not available. To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint. */
+    messageId?: number | null;
+}
+export declare namespace ButtonClickedData {
+    /**
+     * Information about the button that was clicked.
+     */
+    interface Button {
+        /**
+         * Type of button clicked.
+         * - `CARD` for card buttons,
+         * - `QUICK_REPLY` for quick replies.
+         * - `null` if we cannot determine the button type. This is a rare edge case and is mainly here for backward compatibility.
+         */
+        type?: Button.Type | null;
+        /** Raw button data. Contains the entire button that was clicked by the user. In rare cases where we cannot determine the exact button, this will return only the button title. */
+        raw: Button.Raw;
+        /** Extracted payload from the button's `payload` field, if provided. Provides quick access to any payload that was attached to the button. */
+        payload?: string | null;
+        /** Additional metadata attached to the button's `metadata` field, if provided. */
+        metadata?: string | null;
+    }
+    namespace Button {
+        /**
+         * Type of button clicked.
+         * - `CARD` for card buttons,
+         * - `QUICK_REPLY` for quick replies.
+         * - `null` if we cannot determine the button type. This is a rare edge case and is mainly here for backward compatibility.
+         */
+        type Type = "CARD" | "QUICK_REPLY";
+        const Type: {
+            readonly Card: "CARD";
+            readonly QuickReply: "QUICK_REPLY";
+        };
+        /**
+         * Raw button data. Contains the entire button that was clicked by the user. In rare cases where we cannot determine the exact button, this will return only the button title.
+         */
+        type Raw = 
+        /**
+         * Full button object if we can determine the exact button. */
+        Pinnacle.RichButton
+        /**
+         * Button title if we cannot determine the exact button. This is a rare edge case and is mainly here for backward compatibility. */
+         | string;
+    }
+}

package/dist/esm/api/types/ButtonClickedData.mjs

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export var ButtonClickedData;
+(function (ButtonClickedData) {
+    let Button;
+    (function (Button) {
+        Button.Type = {
+            Card: "CARD",
+            QuickReply: "QUICK_REPLY",
+        };
+    })(Button = ButtonClickedData.Button || (ButtonClickedData.Button = {}));
+})(ButtonClickedData || (ButtonClickedData = {}));

package/dist/esm/api/types/ConversationList.d.mts

@@ -5,10 +5,10 @@ import * as Pinnacle from "../index.mjs";
 /**
  * Response for list conversation.
  */
-export interface ConversationList {
-    /** Total number of conversations matching the filter. */
+export type ConversationList = {
+    error?: string | undefined;
+} | {
     count: number;
     conversations: Pinnacle.Conversation[];
-    /** Indicates if more conversations are available beyond the current page. */
     hasMore: boolean;
-}
+};

package/dist/esm/api/types/CreateUrlOptions.d.mts

@@ -5,7 +5,7 @@ export interface CreateUrlOptions {
     /**
      * Expiration date in ISO 8601 format for the shortened URL. <br>
      *
-     * If omitted, then a permalink is generated instead.
+     * If omitted, then a permalink is generated instead. Short permalinks contain a 30-digit link id. Short links with an expiration date contain a 8-digit link id.
      */
     expiresAt?: string | null;
 }

package/dist/esm/api/types/DlcCampaignStatus.d.mts

@@ -24,7 +24,7 @@ export interface DlcCampaignStatus {
      */
     status: Pinnacle.ProfileStatusEnum;
     /**
-     * Status of toll free numbers that are being attached to this campaign. <br>
+     * Status of local long code numbers that are being attached to this campaign. <br>
      *
      * Note that phone numbers can only be attached to `VERIFIED` campaigns via the [attach campaign endpoint](../phone-numbers/attach-campaign).
      */
@@ -32,7 +32,7 @@ export interface DlcCampaignStatus {
 }
 export declare namespace DlcCampaignStatus {
     /**
-     * Status of toll free numbers that are being attached to this campaign. <br>
+     * Status of local long code numbers that are being attached to this campaign. <br>
      *
      * Note that phone numbers can only be attached to `VERIFIED` campaigns via the [attach campaign endpoint](../phone-numbers/attach-campaign).
      */

package/dist/esm/api/types/DlcCampaignWithExtendedBrandAndStatus.d.mts

@@ -15,7 +15,7 @@ export interface DlcCampaignWithExtendedBrandAndStatus {
     /** Description of the campaign. */
     description?: string;
     /** Keyword response configuration. */
-    keywords?: DlcCampaignWithExtendedBrandAndStatus.Keywords;
+    keywords: DlcCampaignWithExtendedBrandAndStatus.Keywords;
     /** Legal documentation links. */
     links?: DlcCampaignWithExtendedBrandAndStatus.Links;
     /** Describe the flow of how users will opt in to this campaign. */
@@ -23,16 +23,19 @@ export interface DlcCampaignWithExtendedBrandAndStatus {
     /** Display name of the campaign. */
     name?: string;
     /** Campaign configuration options. */
-    options?: DlcCampaignWithExtendedBrandAndStatus.Options;
+    options: DlcCampaignWithExtendedBrandAndStatus.Options;
     /** Example messages for the campaign. */
     sampleMessages?: string[];
     /**
-     * Current review status of the campaign.<br>
+     * Current review status of the campaign. <br>
      *
-     * `INCOMPLETE`: Not submitted.<br>
-     * `IN REVIEW`: Being reviewed by carriers.<br>
-     * `VERIFIED`: Approved and ready to send messages.<br>
-     * `FAILED`: Issues and errors related to the campaign's details.<br>
+     * `INCOMPLETE`: Not submitted. <br>
+     *
+     * `IN REVIEW`: Being reviewed by carriers. <br>
+     *
+     * `VERIFIED`: Approved and ready to send messages. <br>
+     *
+     * `FAILED`: Issues and errors related to the campaign's details.
      */
     status: Pinnacle.ProfileStatusEnum;
     /** Use case for the campaign. */
@@ -58,14 +61,14 @@ export declare namespace DlcCampaignWithExtendedBrandAndStatus {
             /** Response message for help keywords. */
             message?: string;
             /** Keywords that trigger help response. */
-            values?: string[];
+            values: string[];
         }
         /**
          * Opt-in keyword settings.
          */
         interface OptIn {
             /** Response message for opt-in keywords. */
-            message: string;
+            message?: string;
             /** Keywords that trigger opt-in. */
             values: string[];
         }
@@ -74,7 +77,7 @@ export declare namespace DlcCampaignWithExtendedBrandAndStatus {
          */
         interface OptOut {
             /** Response message for opt-out keywords. */
-            message: string;
+            message?: string;
             /** Keywords that trigger opt-out. */
             values: string[];
         }

package/dist/esm/api/types/ExtendedBrand.d.mts

@@ -10,11 +10,14 @@ export interface ExtendedBrand extends Pinnacle.OptionalBrandInfo {
     /** Indicates if this brand is archived. */
     isArchived: boolean;
     /**
-     * Current review status of the campaign.<br>
+     * Current review status of the campaign. <br>
+     *
+     * `INCOMPLETE`: Not submitted. <br>
+     *
+     * `IN REVIEW`: Being reviewed by carriers. <br>
+     *
+     * `VERIFIED`: Approved and ready to send messages. <br>
      *
-     * `INCOMPLETE`: Not submitted.<br>
-     * `IN REVIEW`: Being reviewed by carriers.<br>
-     * `VERIFIED`: Approved and ready to send messages.<br>
      * `FAILED`: Issues and errors related to the campaign's details.
      */
     status: Pinnacle.BrandStatusEnum;

package/dist/esm/api/types/ExtendedRcsCampaign.d.mts

@@ -14,17 +14,18 @@ export interface ExtendedRcsCampaign {
     /** Indicates whether the brand has provided an attestation. */
     brandAttestation: boolean;
     /** Unique identifier for the campaign. */
-    campaignId: number;
+    campaignId?: number;
     /** List of what the agent might say to users. */
     expectedAgentResponses?: string[];
     /** Legal documentation links. */
-    links: ExtendedRcsCampaign.Links;
+    links?: ExtendedRcsCampaign.Links;
+    status: Pinnacle.ProfileStatusEnum;
     /** Opt-in configuration. */
-    optIn: ExtendedRcsCampaign.OptIn;
+    optIn?: ExtendedRcsCampaign.OptIn;
     /** Opt-out configuration. */
-    optOut: ExtendedRcsCampaign.OptOut;
+    optOut?: ExtendedRcsCampaign.OptOut;
     /** Use case classification for the campaign. */
-    useCase: ExtendedRcsCampaign.UseCase;
+    useCase?: ExtendedRcsCampaign.UseCase;
 }
 export declare namespace ExtendedRcsCampaign {
     /**
@@ -36,17 +37,17 @@ export declare namespace ExtendedRcsCampaign {
         /** Description of the agent. */
         description?: string;
         /** List of emails. */
-        emails?: Agent.Emails.Item[];
-        /** Link to the agent's hero. */
+        emails: Agent.Emails.Item[];
+        /** Link to the agent's hero. Hero must be an image file with dimensions 1440x448px. */
         heroUrl?: string;
-        /** Link to the agent's icon. */
+        /** Link to the agent's icon. Icon must be an image file with dimensions 224x224px. */
         iconUrl?: string;
         /** Name of the agent. */
         name?: string;
         /** List of phone numbers. */
-        phones?: Agent.Phones.Item[];
+        phones: Agent.Phones.Item[];
         /** List of urls. */
-        websites?: Agent.Websites.Item[];
+        websites: Agent.Websites.Item[];
     }
     namespace Agent {
         type Emails = Emails.Item[];

package/dist/esm/api/types/MessageContent.d.mts

@@ -18,5 +18,5 @@ Pinnacle.SmsContent
  * Message that contains richer content (longer text, higher quality media, cards, buttons, and quick replies) from an RCS agent. */
  | Pinnacle.RcsContent
 /**
- * Message that represents when a user clicks on a RCS button or quick reply that was previously sent. */
- | Pinnacle.InboundButton;
+ * Message that represents when a user clicks on a RCS button or quick reply. */
+ | Pinnacle.ButtonClicked;

package/dist/esm/api/types/MessageEvent.d.mts

@@ -0,0 +1,56 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+/**
+ * Represents an incoming message or message status update received via webhook.
+ */
+export interface MessageEvent {
+    /** Type of webhook event. MESSAGE.STATUS for message status updates or MESSAGE.RECEIVED for inbound messages. */
+    type: Pinnacle.WebhookEventEnum;
+    /** Conversation metadata containing the conversation ID, sender, and recipient information. */
+    conversation: MessageEvent.Conversation;
+    status: Pinnacle.MessageStatusEnum;
+    /** Direction of the message flow. */
+    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 delivered in ISO 8601 format.
+     * Null if not yet delivered or for inbound messages.
+     */
+    deliveredAt?: string | null;
+    /** Message details including ID and content. */
+    message: MessageEvent.Message;
+}
+export declare namespace MessageEvent {
+    /**
+     * Conversation metadata containing the conversation ID, sender, and recipient information.
+     */
+    interface Conversation {
+        /** Unique identifier for the conversation. To get more conversation details, use the [POST /conversations/get](/api-reference/conversations/get) endpoint. */
+        id: number;
+        /** Sender's phone number or agent ID. */
+        from: string;
+        /** Recipient's phone number. */
+        to: string;
+    }
+    /**
+     * Direction of the message flow.
+     */
+    type Direction = "INBOUND" | "OUTBOUND";
+    const Direction: {
+        readonly Inbound: "INBOUND";
+        readonly Outbound: "OUTBOUND";
+    };
+    /**
+     * Message details including ID and content.
+     */
+    interface Message {
+        /** Unique identifier of the message. To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint. */
+        id: number;
+        content: Pinnacle.MessageContent;
+    }
+}

package/dist/esm/api/types/MessageEvent.mjs

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export var MessageEvent;
+(function (MessageEvent) {
+    MessageEvent.Direction = {
+        Inbound: "INBOUND",
+        Outbound: "OUTBOUND",
+    };
+})(MessageEvent || (MessageEvent = {}));

package/dist/esm/api/types/ProfileStatusEnum.d.mts

@@ -2,11 +2,14 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 /**
- * Current review status of the campaign.
+ * Current review status of the campaign. <br>
+ *
+ * `INCOMPLETE`: Not submitted. <br>
+ *
+ * `IN REVIEW`: Being reviewed by carriers. <br>
+ *
+ * `VERIFIED`: Approved and ready to send messages.<br>
  *
- * `INCOMPLETE`: Not submitted.
- * `IN REVIEW`: Being reviewed by carriers.
- * `VERIFIED`: Approved and ready to send messages.
  * `FAILED`: Issues and errors related to the campaign's details.
  */
 export type ProfileStatusEnum = "INCOMPLETE" | "IN REVIEW" | "VERIFIED" | "FAILED";

package/dist/esm/api/types/RcsBase.d.mts

@@ -19,6 +19,8 @@ export declare namespace RcsBase {
         /** 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;
         /**
          * Validate your message for any unsupported files. <br>
          *

package/dist/esm/api/types/RcsButtonCall.d.mts

@@ -5,6 +5,8 @@
  * Button that initiates a phone call when tapped by the recipient.
  */
 export interface RcsButtonCall {
+    /** Optional additional data to attach to this button. */
+    metadata?: string;
     /** Phone number to call in E.164 format */
     payload: string;
     /** Display text for the button. */

package/dist/esm/api/types/RcsButtonOpenUrl.d.mts

@@ -5,6 +5,8 @@
  * Button that opens a URL when tapped by the recipient.
  */
 export interface RcsButtonOpenUrl {
+    /** Optional additional data to attach to this button. */
+    metadata?: string;
     /** The URL to open when the button is tapped. Must be a valid HTTP or HTTPS URL. */
     payload: string;
     /** Display text for the button. */

package/dist/esm/api/types/RcsButtonRequestUserLocation.d.mts

@@ -5,6 +5,8 @@
  * Button that prompts the recipient to share their current location.
  */
 export interface RcsButtonRequestUserLocation {
+    /** Optional additional data to attach to this button. */
+    metadata?: string;
     /** Display text for the button. */
     title: string;
 }

package/dist/esm/api/types/RcsButtonScheduleEvent.d.mts

@@ -13,6 +13,8 @@ export interface RcsButtonScheduleEvent {
     eventStartTime: string;
     /** Title of the event. */
     eventTitle: string;
+    /** Optional additional data to attach to this button. */
+    metadata?: string;
     /** Display text for the button. */
     title: string;
 }

package/dist/esm/api/types/RcsButtonSendLocation.d.mts

@@ -7,6 +7,8 @@
 export interface RcsButtonSendLocation {
     /** Geographic coordinates of the location to share. */
     latLong: RcsButtonSendLocation.LatLong;
+    /** Optional additional data to attach to this button. */
+    metadata?: string;
     /** Display text for the button. */
     title: string;
 }

package/dist/esm/api/types/RcsButtonTrigger.d.mts

@@ -5,8 +5,8 @@
  * Button that sends custom data back to your application when tapped by the recipient.
  */
 export interface RcsButtonTrigger {
-    /** Additional data attached to the button interaction. */
-    metadata: string;
+    /** Optional additional data to attach to this button. */
+    metadata?: string;
     /** Custom data sent to your webhook when the button is tapped. Use this to identify the user's choice. */
     payload: string;
     /** Display text for the button. */

package/dist/esm/api/types/RcsCampaign.d.mts

@@ -37,9 +37,9 @@ export declare namespace RcsCampaign {
         phones?: Agent.Phones.Item[];
         /** List of urls. */
         websites?: Agent.Websites.Item[];
-        /** Link to the agent's hero. */
+        /** Link to the agent's hero. Hero must be an image file with dimensions 1440x448px. */
         heroUrl?: string;
-        /** Link to the agent's icon. */
+        /** Link to the agent's icon. Icon must be an image file with dimensions 224x224px. */
         iconUrl?: string;
     }
     namespace Agent {

package/dist/esm/api/types/RcsCapabilitiesResult.d.mts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+/**
+ * Response containing RCS capabilities for requested phone numbers
+ */
+export type RcsCapabilitiesResult = Record<string, (Pinnacle.RcsCapability | null) | undefined>;

package/dist/esm/api/types/RcsCapabilitiesResult.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/RcsCapability.d.mts

@@ -0,0 +1,36 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * RCS capabilities for a phone number
+ */
+export interface RcsCapability {
+    cards: RcsCapability.Cards;
+    /** Supported button action types inside the rich cards or quick replies. Each key is a button action type that defines a specific button type in the Pinnacle API. */
+    actions: RcsCapability.Actions;
+}
+export declare namespace RcsCapability {
+    interface Cards {
+        /** Whether the phone number supports standalone rich cards (`cards.length == 1`) */
+        standalone: boolean;
+        /** Whether the phone number supports carousel rich cards */
+        carousel: boolean;
+    }
+    /**
+     * Supported button action types inside the rich cards or quick replies. Each key is a button action type that defines a specific button type in the Pinnacle API.
+     */
+    interface Actions {
+        /** Buttons that open URLs are supported */
+        openUrl: boolean;
+        /** Buttons that make phone calls are supported */
+        call: boolean;
+        /** Buttons that trigger actions are supported */
+        trigger: boolean;
+        /** Buttons that request user location are supported */
+        requestUserLocation: boolean;
+        /** Buttons are supported */
+        scheduleEvent: boolean;
+        /** Buttons that send location are supported */
+        sendLocation: boolean;
+    }
+}

package/dist/esm/api/types/RcsCapability.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/RcsLinkResult.d.mts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Response containing the generated RCS service id and/or url. You can always create a link with the service id that is returned.
+ * To create a link follow the format: sms://{PHONE_NUMBER}?service_id={SERVICE_ID}&body={URL_ENCODED_BODY}
+ */
+export interface RcsLinkResult {
+    /** The generated RCS link URL. If no phone number is provided, no url will be generated. */
+    url?: string;
+    /** The service ID used for the link */
+    serviceId: string;
+}

package/dist/esm/api/types/RcsLinkResult.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/RcsValidateContent.d.mts

@@ -12,6 +12,7 @@ Pinnacle.RcsTextContent
  * See [supported media types](https://app.pinnacle.sh/supported-file-types?type=RCS-MEDIA). */
  | {
     media: string;
+    quickReplies: Pinnacle.RichButton[];
 }
 /**
  * Message containing cards, each with its own title, subtitle, and/or buttons. Quick replies can also be added. <br>

package/dist/esm/api/types/RcsWhitelistResponse.d.mts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Response indicating success of whitelisting operation
+ */
+export interface RcsWhitelistResponse {
+    /** Whether the whitelisting operation was successful */
+    success: boolean;
+}

package/dist/esm/api/types/RcsWhitelistResponse.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/RefreshedFile.d.mts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface RefreshedFile {
+    /** The original file URI that was provided in the request. */
+    original: string;
+    /** The new refreshed presigned URL that expires in one hour. */
+    refreshed: string;
+}

package/dist/esm/api/types/RefreshedFile.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/{Rcs.d.mts → RichMessage.d.mts}

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Pinnacle from "../index.mjs";
-export type Rcs = 
+export type RichMessage = 
 /**
  * Send a text RCS message with optional quick reply buttons. */
 Pinnacle.RichTextMessage

package/dist/esm/api/types/RichMessage.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/index.d.mts

@@ -59,9 +59,9 @@ export * from "./RcsMediaDetailsContent.mjs";
 export * from "./RcsMediaContent.mjs";
 export * from "./RcsCardsContent.mjs";
 export * from "./RcsContent.mjs";
-export * from "./ClickAction.mjs";
+export * from "./ButtonClickedData.mjs";
 export * from "./LocationShareAction.mjs";
-export * from "./InboundButton.mjs";
+export * from "./ButtonClicked.mjs";
 export * from "./MessageContent.mjs";
 export * from "./MessageMethodEnum.mjs";
 export * from "./MessageStatusEnum.mjs";
@@ -78,7 +78,7 @@ export * from "./RichTextMessage.mjs";
 export * from "./RichMediaMessage.mjs";
 export * from "./RcsCards.mjs";
 export * from "./RichCardsMessage.mjs";
-export * from "./Rcs.mjs";
+export * from "./RichMessage.mjs";
 export * from "./SentRcsDetails.mjs";
 export * from "./SmsValidationResult.mjs";
 export * from "./MmsValidationResult.mjs";
@@ -102,6 +102,10 @@ export * from "./DetachedWebhookInfo.mjs";
 export * from "./MessagingProfileEnum.mjs";
 export * from "./AttachedPhoneNumberResult.mjs";
 export * from "./DetachedPhoneNumberResult.mjs";
+export * from "./RcsCapability.mjs";
+export * from "./RcsCapabilitiesResult.mjs";
+export * from "./RcsWhitelistResponse.mjs";
+export * from "./RcsLinkResult.mjs";
 export * from "./BrandStatus.mjs";
 export * from "./TollFreeStatusEnum.mjs";
 export * from "./TollFreeCampaignStatus.mjs";
@@ -115,6 +119,7 @@ export * from "./ShortenedUrl.mjs";
 export * from "./LinkClickEvent.mjs";
 export * from "./ShortenedUrlWithClickData.mjs";
 export * from "./UploadResults.mjs";
+export * from "./RefreshedFile.mjs";
 export * from "./VcardAddress.mjs";
 export * from "./VcardPhone.mjs";
 export * from "./VcardEmail.mjs";
@@ -124,3 +129,4 @@ export * from "./VCardData.mjs";
 export * from "./VcardResource.mjs";
 export * from "./Webhooks.mjs";
 export * from "./WebhookResult.mjs";
+export * from "./MessageEvent.mjs";