rcs-js 2.0.0-rc.9 → 2.0.1-rc.1

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

@@ -22,8 +22,8 @@ export declare namespace AttachedPhoneNumberResult {
              * Campaign that the phone is now attached to.
              */
             interface Campaign {
-                /** Id of the campaign. */
-                id: number;
+                /** Id of the campaign. For `TOLL_FREE` campaigns, it will begin with the prefix `tf_`, for example: `tf_1234567890`. For `10DLC` campaigns, it will begin with the prefix `dlc_`, for example: `dlc_1234567890`. */
+                id: string;
                 /** Campaign's name. */
                 name: string;
                 type: Pinnacle.MessagingProfileEnum;

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

@@ -4,6 +4,11 @@
 export interface AutofillCampaignParams {
     /** Any additional information you want to provide. */
     additionalInfo?: string;
-    /** Campaign ID. */
-    campaignId?: number;
+    /**
+     * Unique identifier for the campaign.
+     * - When autofilling 10DLC campaigns, it must begin with the prefix `dlc_` (e.g., `dlc_1234567890`)
+     * - When autofilling Toll-Free campaigns, it must begin with the prefix `tf_` (e.g., `tf_1234567890`)
+     * - When autofilling RCS campaigns, it must begin with the prefix `rcs_` (e.g., `rcs_1234567890`)
+     */
+    campaignId?: string;
 }

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

@@ -5,10 +5,10 @@ import * as Pinnacle from "../index.js";
 export interface AutofillDlcCampaignResponse {
     /** Whether the campaign renews automatically. */
     autoRenew: boolean;
-    /** Brand id. */
-    brand?: number;
-    /** Unique identifier for the campaign. */
-    campaignId?: number;
+    /** Brand id. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */
+    brand?: string;
+    /** Unique identifier for the campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`. */
+    campaignId?: string;
     /** Description of the campaign. */
     description?: string;
     /** Keyword response configuration. */
@@ -32,11 +32,11 @@ export declare namespace AutofillDlcCampaignResponse {
      */
     interface Keywords {
         /** Help keyword settings. */
-        HELP?: Keywords.Help;
+        HELP: Keywords.Help;
         /** Opt-in keyword settings. */
-        OPT_IN?: Keywords.OptIn;
+        OPT_IN: Keywords.OptIn;
         /** Opt-out keyword settings. */
-        OPT_OUT?: Keywords.OptOut;
+        OPT_OUT: Keywords.OptOut;
     }
     namespace Keywords {
         /**
@@ -46,14 +46,14 @@ export declare namespace AutofillDlcCampaignResponse {
             /** 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[];
         }
@@ -64,7 +64,7 @@ export declare namespace AutofillDlcCampaignResponse {
             /** Response message for opt-out keywords. */
             message?: string;
             /** Keywords that trigger opt-out. */
-            values?: string[];
+            values: string[];
         }
     }
     /**
@@ -81,17 +81,17 @@ export declare namespace AutofillDlcCampaignResponse {
      */
     interface Options {
         /** Whether the campaign uses affiliate marketing. */
-        affiliateMarketing?: boolean;
+        affiliateMarketing: boolean;
         /** Whether the campaign is age-gated. */
-        ageGated?: boolean;
+        ageGated: boolean;
         /** Whether the campaign involves direct lending. */
-        directLending?: boolean;
+        directLending: boolean;
         /** Link embedded in campaign message. */
         embeddedLink?: string;
         /** Whether messages include phone numbers. */
-        embeddedPhone?: boolean;
+        embeddedPhone: boolean;
         /** Whether the campaign uses number pooling. */
-        numberPooling?: boolean;
+        numberPooling: boolean;
     }
     /**
      * Use case for the campaign.

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

@@ -8,8 +8,8 @@ import * as Pinnacle from "../index.js";
 export interface BrandStatus {
     /** List of errors that occurred. */
     errors: string[];
-    /** Id of the brand. */
-    id: number;
+    /** The unique identifier of the brand. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */
+    id: string;
     /**
      * Current review status of the brand. <br>
      *

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+export type ButtonClicked = 
+/**
+ * Data about a button that was clicked. */
+Pinnacle.ButtonClickedData
+/**
+ * User provided location. Occurs when recipient responds to `requestUserLocation` button and shares a location. */
+ | Pinnacle.LocationShareAction;

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

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

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

@@ -0,0 +1,58 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * 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: string | 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;
+        /** Number of times the button has been clicked. */
+        clicks: number;
+    }
+    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/cjs/api/types/ButtonClickedData.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.ButtonClickedData = void 0;
+var ButtonClickedData;
+(function (ButtonClickedData) {
+    let Button;
+    (function (Button) {
+        Button.Type = {
+            Card: "CARD",
+            QuickReply: "QUICK_REPLY",
+        };
+    })(Button = ButtonClickedData.Button || (ButtonClickedData.Button = {}));
+})(ButtonClickedData || (exports.ButtonClickedData = ButtonClickedData = {}));

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

@@ -6,7 +6,12 @@ import * as Pinnacle from "../index.js";
  * Information about the campaign associated with a conversation
  */
 export interface CampaignQuery {
-    /** Unique identifier for the campaign */
+    /**
+     * Unique identifier for the campaign. This identifier is a string that begins with the prefix:
+     * - TOLL_FREE: `tf_` (e.g., `tf_1234567890`)
+     * - 10DLC: `dlc_` (e.g., `dlc_1234567890`)
+     * - RCS: `rcs_` (e.g., `rcs_1234567890`)
+     */
     id: string;
     type: Pinnacle.CampaignEnum;
 }

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

@@ -19,8 +19,8 @@ export declare namespace ConfiguredWebhook {
      * Detailed information about the attached webhook.
      */
     interface Webhook {
-        /** Unique identifier of the webhook within the account. */
-        id: number;
+        /** Unique identifier of the webhook within the account. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`. */
+        id: string;
         /** Name of the webhook. */
         name: string;
         /** The HTTPS endpoint URL where webhook events will be sent as HTTP POST requests. */

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

@@ -6,8 +6,8 @@ export interface Contact {
     description?: string;
     /** Contact's email address, if available. */
     email?: string;
-    /** Unique ID of the contact. */
-    id: number;
+    /** Unique ID of the contact. This identifier is a string that always begins with the prefix `co_`, for example: `co_1234567890`. */
+    id: string;
     /** Full name of the contact, if available. */
     name?: string;
     /** Contact's phone number in E.164 format. */

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

@@ -2,6 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface ContactId {
-    /** Unique ID of the created contact. */
-    id: number;
+    /** Unique ID of the created contact. This identifier is a string that always begins with the prefix `co_`, for example: `co_1234567890`. */
+    id: string;
 }

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

@@ -6,16 +6,16 @@ import * as Pinnacle from "../index.js";
  * Conversation that was found.
  */
 export interface Conversation {
-    /** Identifier for the brand associated with this conversation. */
-    brandId?: number | null;
-    /** Campaign information if this conversation is part of a marketing campaign. */
-    campaign?: Pinnacle.CampaignQuery | null;
+    /** The unique identifier of the brand associated with this conversation. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */
+    brandId: string | null;
+    /** Campaign information if this conversation is part of a marketing campaign. This is an object that contains the campaign ID and type. */
+    campaign: Pinnacle.CampaignQuery | null;
     /** Contact information for the recipient in a conversation. */
     contact: Conversation.Contact;
     /** ISO 8601 timestamp when the conversation was created. */
     createdAt: string;
-    /** Unique identifier for the conversation. */
-    id: number;
+    /** Unique identifier for the conversation. This identifier is a string that always begins with the prefix `conv_`, for example: `conv_1234567890`. */
+    id: string;
     /** Free-form notes or comments about the conversation. */
     notes: string;
     /**
@@ -24,7 +24,7 @@ export interface Conversation {
      * - An RCS agent with ID and name
      * - `null` if no sender is associated
      */
-    sender?: Conversation.Sender | null;
+    sender: Conversation.Sender | null;
     /** ISO 8601 timestamp when the conversation was last updated. */
     updatedAt: string;
 }
@@ -33,8 +33,8 @@ export declare namespace Conversation {
      * Contact information for the recipient in a conversation.
      */
     interface Contact {
-        /** Unique identifier for the contact. */
-        id: number;
+        /** Unique ID of the contact. This identifier is a string that always begins with the prefix `co_`, for example: `co_1234567890`. */
+        id: string;
         /** The contact's phone number in E.164 format. */
         phoneNumber: string;
     }

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

@@ -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/cjs/api/types/DetachedPhoneNumberResult.d.ts

@@ -22,8 +22,8 @@ export declare namespace DetachedPhoneNumberResult {
              * Campaign that the phone is now detached from.
              */
             interface Campaign {
-                /** Id of the campaign. */
-                id: number;
+                /** Id of the campaign. For `TOLL_FREE` campaigns, it will begin with the prefix `tf_`, for example: `tf_1234567890`. For `10DLC` campaigns, it will begin with the prefix `dlc_`, for example: `dlc_1234567890`. */
+                id: string;
                 /** Campaign's name. */
                 name: string;
                 type: Pinnacle.MessagingProfileEnum;

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

@@ -4,8 +4,8 @@
 export interface DetachedWebhookInfo {
     /** Confirmation message. */
     message: string;
-    /** ID of the detached webhook. */
-    webhookId: number;
+    /** Unique identifier of the webhook within the account. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`. */
+    webhookId: string;
     /** Phone number the webhook was detached from in E.164 format. */
     phoneNumber: string;
 }

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

@@ -12,8 +12,8 @@ export interface DlcCampaignStatus {
      * These errors may request additional information or point out erroneous and/or missing fields.
      */
     error: string;
-    /** Id of the DLC campaign. */
-    id: number;
+    /** The unique identifier of the 10DLC campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`. */
+    id: string;
     /**
      * Current review status of the DLC campaign. <br>
      *
@@ -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/cjs/api/types/DlcCampaignWithExtendedBrandAndStatus.d.ts

@@ -10,12 +10,12 @@ export interface DlcCampaignWithExtendedBrandAndStatus {
     autoRenew: boolean;
     /** Brand associated with this campaign. */
     brand: Pinnacle.ExtendedBrand;
-    /** Unique identifier for the campaign. */
-    campaignId?: number;
+    /** Unique identifier for the campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`. */
+    campaignId?: string;
     /** 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/cjs/api/types/EnhancedContactItem.d.ts

@@ -18,7 +18,7 @@ export interface EnhancedContactItem {
      * LinkedIn profile URL if available and publicly accessible.
      * Null if no LinkedIn profile is found or accessible.
      */
-    linkedin?: string | null;
+    linkedin: string | null;
     /** Full name of the contact person associated with this profile. */
     name: string;
 }

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

@@ -5,17 +5,24 @@ import * as Pinnacle from "../index.js";
 export interface ExtendedBrand extends Pinnacle.OptionalBrandInfo {
     /** ISO 8601 formatted timestamp of when this brand was added to our system. */
     createdAt: string;
-    /** The brand's ID. */
-    id: number;
+    /** The brand's ID. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */
+    id: string;
     /** Indicates if this brand is archived. */
     isArchived: boolean;
     /**
-     * Current review status of the campaign.<br>
+     * Current review status of the brand. <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.
+     * `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>
+     *
+     * `VETTED`: Has undergone additional vetting by a third party service post the brand being verified. Your brand will be assigned a trust score, with higher trust scores having higher message volumes. <br>
+     *
+     * `UNVERIFIED`: Brand details have been updated, and the brand will need to undergo re-verification.
      */
     status: Pinnacle.BrandStatusEnum;
     /** ISO 8601 formatted timestamp of when this brand was last updated. */

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

@@ -4,9 +4,9 @@
 import * as Pinnacle from "../index.js";
 export interface ExtendedBrandWithVetting extends Pinnacle.ExtendedBrand {
     /** ISO 8601 formatted timestamp of the last TCR vetting. */
-    lastTcrVettingDate?: string | null;
+    lastTcrVettingDate: string | null;
     /** Feedback from The Campaign Registry if TCR vetting was performed. */
-    tcrFeedback?: Pinnacle.VettingFeedback[] | null;
+    tcrFeedback: Pinnacle.VettingFeedback[] | null;
     /** History of all external vetting attempts for this brand. */
     vettingHistory: Pinnacle.VettingHistory[];
 }

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

@@ -9,20 +9,23 @@ export interface ExtendedRcsCampaign {
     agentId: string;
     /** Brand associated with this campaign. */
     brand: Pinnacle.ExtendedBrand;
+    /** Link to document verifying the brand's name. This may be the certificate of incorporation, business license, or other relevant document. You can typically find this on the Secretary of State website. */
+    brandVerificationUrl?: string;
     /** Indicates whether the brand has provided an attestation. */
     brandAttestation: boolean;
-    /** Unique identifier for the campaign. */
-    campaignId: number;
+    /** Unique identifier for the campaign. This identifier is a string that always begins with the prefix `rcs_`, for example: `rcs_1234567890`. */
+    campaignId?: string;
     /** 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 {
     /**
@@ -34,19 +37,17 @@ export declare namespace ExtendedRcsCampaign {
         /** Description of the agent. */
         description?: string;
         /** List of emails. */
-        emails?: Agent.Emails.Item[];
-        /** Link to document verifying the brand's name. This may be the certificate of incorporation, business license, or other relevant document. You can typically find this on the Secretary of State website. */
-        brandVerificationUrl?: string;
-        /** 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/cjs/api/types/GetConversationParams.d.ts

@@ -8,7 +8,7 @@ export type GetConversationParams =
 /**
  * Retrieve conversation information by ID. */
 {
-    id: number;
+    id: string;
 }
 /**
  * Retrieve conversation information by sender and recipient. */

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

@@ -36,8 +36,6 @@ export interface LinkClickEvent {
     fingerprint_id?: string | null;
     /** Google Click Identifier. */
     gclid?: string | null;
-    /** Unique identifier for the click event. */
-    id: number;
     /** IP address of the visitor (may be anonymized). */
     ip_address?: string | null;
     /** Chain of IP addresses for proxied requests. */
@@ -48,8 +46,6 @@ export interface LinkClickEvent {
     latency_ms?: number | null;
     /** Geographic latitude. */
     latitude?: number | null;
-    /** ID of your shortened URL. */
-    link_id: number;
     /** Geographic longitude. */
     longitude?: number | null;
     /** Additional metadata as JSON object. */

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

@@ -9,21 +9,21 @@ export interface Message {
      *
      * Null means the message incurred no cost or has not been charged yet.
      */
-    cost?: number | null;
+    cost: number | null;
     /**
      * Timestamp indicating when the message was successfully delivered to the recipient. <br>
      *
      * Null indicates the message has not yet been delivered.
      */
-    deliveredAt?: string | null;
+    deliveredAt: string | null;
     /**
      * Detailed explanation of any errors that occurred while delivering the message. <br>
      *
      * Null indicates no errors.
      */
-    error?: string | null;
-    /** Unique identifier of the message. */
-    id: number;
+    error: string | 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;
     /** Number of segments the message was split into for delivery. */
     numSegments: number;
@@ -36,7 +36,7 @@ export interface Message {
      *
      * Null indicates the message is still in the queue.
      */
-    sentAt?: string | null;
+    sentAt: string | null;
     status: Pinnacle.MessageStatusEnum;
     type: Pinnacle.MessageProtocolEnum;
 }

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

@@ -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;