rcs-js 2.0.1 → 2.0.3-rc.1

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

@@ -0,0 +1,39 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * RCS message containing cards, each with its own title, subtitle, and/or buttons. Quick replies can also be added. <br>
+ *
+ * See [supported file types](https://app.pinnacle.sh/supported-file-types?type=RCS-CARD).
+ */
+export interface MessageEventRcsCardsContent {
+    /** Message type identifier. */
+    type: "RCS_CARDS";
+    /**
+     * Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
+     * To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint.
+     */
+    id: string;
+    /** Collection of cards attached to the message. */
+    cards: MessageEventRcsCardsContent.Cards.Item[];
+    /** List of interactive quick reply buttons in the message. */
+    quickReplies: Pinnacle.RichButton[];
+}
+export declare namespace MessageEventRcsCardsContent {
+    type Cards = Cards.Item[];
+    namespace Cards {
+        /**
+         * Individual card containing title, optional media, and action buttons.
+         */
+        interface Item {
+            /** Action buttons attached to the card. */
+            buttons: Pinnacle.RichButton[];
+            media?: Pinnacle.RcsMediaDetailsContent;
+            /** Secondary text displayed below the title for additional context. */
+            subtitle?: string;
+            /** Title displayed on the card. */
+            title: string;
+        }
+    }
+}

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

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Location sharing event data received when a user responds to a `requestUserLocation` button and shares their current location.
+ *
+ * This event contains the geographic coordinates (latitude/longitude) and human-readable address of the location the user chose to share. Use this data to process location-based requests or provide location-specific services.
+ */
+export interface MessageEventRcsLocationData extends Pinnacle.LocationShareAction {
+    /** Message type identifier. */
+    type: "RCS_LOCATION_DATA";
+    /**
+     * Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
+     * To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint.
+     */
+    id: string;
+}

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * RCS message containing a media file with optional quick reply buttons. <br>
+ *
+ * See [supported file types](https://app.pinnacle.sh/supported-file-types?type=RCS-MEDIA).
+ */
+export interface MessageEventRcsMediaContent {
+    /** Message type identifier. */
+    type: "RCS_MEDIA";
+    /**
+     * Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
+     * To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint.
+     */
+    id: string;
+    /** URL of the media file. */
+    media: string;
+    /** List of interactive quick reply buttons in the message. */
+    quickReplies: Pinnacle.RichButton[];
+}

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

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * RCS message containing longer text content with optional quick reply buttons.
+ */
+export interface MessageEventRcsTextContent {
+    /** Message type identifier. */
+    type: "RCS_TEXT";
+    /**
+     * Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
+     * To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint.
+     */
+    id: string;
+    /** List of interactive quick reply buttons in the message. */
+    quickReplies: Pinnacle.RichButton[];
+    /** Text content of the RCS message. */
+    text: string;
+}

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

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * SMS message containing plain text only.
+ */
+export interface MessageEventSmsContent {
+    /** Message type identifier. */
+    type: "SMS";
+    /**
+     * Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
+     * To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint.
+     */
+    id: string;
+    /** Message content. */
+    text: string;
+}

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Paginated list of messages in a conversation.
+ */
+export interface MessageList {
+    /** Array of messages in the conversation. */
+    messages: Pinnacle.MessageWithReaction[];
+    /** Indicates if more messages are available beyond the current page. */
+    hasMore: boolean;
+    /** Total number of messages in the conversation. */
+    count: number;
+}

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

@@ -0,0 +1,27 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Message with additional conversation-specific fields including direction and reaction.
+ */
+export interface MessageWithReaction extends Pinnacle.Message {
+    /** Direction of the message flow. */
+    direction: MessageWithReaction.Direction;
+    /**
+     * Unicode emoji reaction attached to this message. <br>
+     *
+     * Null indicates no reaction has been added.
+     */
+    reaction: string | null;
+}
+export declare namespace MessageWithReaction {
+    /**
+     * Direction of the message flow.
+     */
+    type Direction = "INBOUND" | "OUTBOUND";
+    const Direction: {
+        readonly Inbound: "INBOUND";
+        readonly Outbound: "OUTBOUND";
+    };
+}

package/dist/cjs/api/types/MessageWithReaction.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.MessageWithReaction = void 0;
+var MessageWithReaction;
+(function (MessageWithReaction) {
+    MessageWithReaction.Direction = {
+        Inbound: "INBOUND",
+        Outbound: "OUTBOUND",
+    };
+})(MessageWithReaction || (exports.MessageWithReaction = MessageWithReaction = {}));

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

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface NotFoundErrorBody {
+    error?: string;
+}

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Configure how your RCS message is sent and tracked.
+ */
+export interface Options {
+    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;
+    /**
+     * Validate your message for any unsupported files. <br>
+     *
+     * If failed, errors will be thrown and the message will not send.
+     */
+    validate?: boolean;
+}

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

@@ -5,10 +5,39 @@
  * Button that opens a URL when tapped by the recipient.
  */
 export interface RcsButtonOpenUrl {
-    /** Optional additional data to attach to this button. */
-    metadata?: string;
+    /**
+     * Controls how the URL is displayed when the button is tapped.
+     *
+     * **Default behavior:** If not specified, the URL opens in the device's default browser. If you're sending deeplinks, you should use this mode as it will open the deeplink in the native app if it is installed.
+     *
+     * **Available modes in order of size:**
+     * - `HALF` — Half-screen webview overlay
+     * - `TALL` — Tall webview overlay
+     * - `FULL` — Full-screen webview
+     */
+    webviewMode?: RcsButtonOpenUrl.WebviewMode;
     /** The URL to open when the button is tapped. Must be a valid HTTP or HTTPS URL. */
     payload: string;
     /** Display text for the button. */
     title: string;
+    /** Optional additional data to attach to this button. */
+    metadata?: string;
+}
+export declare namespace RcsButtonOpenUrl {
+    /**
+     * Controls how the URL is displayed when the button is tapped.
+     *
+     * **Default behavior:** If not specified, the URL opens in the device's default browser. If you're sending deeplinks, you should use this mode as it will open the deeplink in the native app if it is installed.
+     *
+     * **Available modes in order of size:**
+     * - `HALF` — Half-screen webview overlay
+     * - `TALL` — Tall webview overlay
+     * - `FULL` — Full-screen webview
+     */
+    type WebviewMode = "HALF" | "TALL" | "FULL";
+    const WebviewMode: {
+        readonly Half: "HALF";
+        readonly Tall: "TALL";
+        readonly Full: "FULL";
+    };
 }

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

@@ -3,3 +3,12 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.RcsButtonOpenUrl = void 0;
+var RcsButtonOpenUrl;
+(function (RcsButtonOpenUrl) {
+    RcsButtonOpenUrl.WebviewMode = {
+        Half: "HALF",
+        Tall: "TALL",
+        Full: "FULL",
+    };
+})(RcsButtonOpenUrl || (exports.RcsButtonOpenUrl = RcsButtonOpenUrl = {}));

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

@@ -5,12 +5,18 @@
  * Button that shares a specific location with the recipient when tapped.
  */
 export interface RcsButtonSendLocation {
+    /**
+     * Optional name or label for the location that will be displayed in the map app (e.g., "Central Park", "Home Office").
+     *
+     * If not provided, the button title will be used as the location name.
+     */
+    name?: string;
     /** 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;
+    /** Optional additional data to attach to this button. */
+    metadata?: string;
 }
 export declare namespace RcsButtonSendLocation {
     /**

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

@@ -6,7 +6,7 @@ export interface RcsCampaign {
     /** Agent configured to the campaign. */
     agent?: RcsCampaign.Agent;
     /** Unique identifier for the campaign. */
-    campaignId?: number;
+    campaignId?: string;
     /** 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;
     /** List of what the agent might say to users. */

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

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

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

@@ -2,8 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface ReactionResult {
-    /** ID of the message. */
-    messageId: number;
-    /** Unique identifier for the reaction. */
-    reactionMessageId: number;
+    /** Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. */
+    messageId: string;
+    /** Unique identifier of the message with the reaction. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. */
+    reactionMessageId: string;
 }

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

@@ -2,5 +2,55 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Pinnacle from "../index.js";
-export interface RichCardsMessage extends Pinnacle.RcsBase, Pinnacle.RcsCards {
+export interface RichCardsMessage extends Pinnacle.RcsCards {
+    options?: RichCardsMessage.Options;
+    /** Your RCS agent ID which must be prefixed with 'agent_'. */
+    from: string;
+    /** Recipient's phone number in E.164 format. */
+    to: string;
+}
+export declare namespace RichCardsMessage {
+    interface Options extends Pinnacle.Options {
+        /**
+         * Configure standalone card layout options for enhanced visual presentation.
+         *
+         * > **⚠️ Important Restriction**
+         * >
+         * > This option is **only valid for single card messages**. Using it with multiple cards will cause the request to fail with a validation error.
+         */
+        standalone_card?: Options.StandaloneCard;
+    }
+    namespace Options {
+        /**
+         * Configure standalone card layout options for enhanced visual presentation.
+         *
+         * > **⚠️ Important Restriction**
+         * >
+         * > This option is **only valid for single card messages**. Using it with multiple cards will cause the request to fail with a validation error.
+         */
+        interface StandaloneCard {
+            /** The orientation of the standalone card. */
+            orientation?: StandaloneCard.Orientation;
+            /** The alignment of the image in the standalone card. */
+            image_alignment?: StandaloneCard.ImageAlignment;
+        }
+        namespace StandaloneCard {
+            /**
+             * The orientation of the standalone card.
+             */
+            type Orientation = "HORIZONTAL" | "VERTICAL";
+            const Orientation: {
+                readonly Horizontal: "HORIZONTAL";
+                readonly Vertical: "VERTICAL";
+            };
+            /**
+             * The alignment of the image in the standalone card.
+             */
+            type ImageAlignment = "LEFT" | "RIGHT";
+            const ImageAlignment: {
+                readonly Left: "LEFT";
+                readonly Right: "RIGHT";
+            };
+        }
+    }
 }

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

@@ -3,3 +3,21 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.RichCardsMessage = void 0;
+var RichCardsMessage;
+(function (RichCardsMessage) {
+    let Options;
+    (function (Options) {
+        let StandaloneCard;
+        (function (StandaloneCard) {
+            StandaloneCard.Orientation = {
+                Horizontal: "HORIZONTAL",
+                Vertical: "VERTICAL",
+            };
+            StandaloneCard.ImageAlignment = {
+                Left: "LEFT",
+                Right: "RIGHT",
+            };
+        })(StandaloneCard = Options.StandaloneCard || (Options.StandaloneCard = {}));
+    })(Options = RichCardsMessage.Options || (RichCardsMessage.Options = {}));
+})(RichCardsMessage || (exports.RichCardsMessage = RichCardsMessage = {}));

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

@@ -2,8 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface ScheduledMessaage {
-    /** Unique identifier for the scheduled send. */
-    scheduleId: number;
+    /** Unique identifier for the scheduled send. This identifier is a string that always begins with the prefix `msg_sched_`, for example: `msg_sched_1234567890`. */
+    scheduleId: string;
     /** Configuration for the scheduled message. */
     config: ScheduledMessaage.Config;
 }

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Response schema confirming the typing indicator was sent.
+ */
+export interface SendTypingIndicatorResponse {
+    /** Indicates whether the typing indicator was successfully sent. */
+    success: boolean;
+    /** The RCS agent that sent the typing indicator. */
+    agentId: string;
+    /** The recipient's phone number that received the typing indicator. */
+    recipient: string;
+    /** Timestamp when the typing indicator was started (ISO 8601 format). */
+    startedAt: string;
+    /**
+     * Timestamp when the typing indicator will automatically expire (ISO 8601 format). <br>
+     *
+     * This is typically one minute after `startedAt` unless a message is sent first.
+     */
+    endedAt: string;
+}

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

@@ -2,8 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface SentMmsDetails {
-    /** Array of unique identifiers for the sent MMS messages. */
-    messageIds: number[];
+    /** Array of unique identifiers for the sent MMS messages. This identifiers are strings that always begin with the prefix `msg_`, for example: `msg_1234567890`. */
+    messageIds: string[];
     /** Total number of segments used across the message. */
     segments: number;
     /** Total cost of sending the message. */

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

@@ -2,8 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface SentRcsDetails {
-    /** Unique identifier for the sent MMS messages. */
-    messageIds?: number;
+    /** Unique identifier for the sent RCS message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. */
+    messageId: string;
     /** Total number of segments used across the message. */
     segments: number;
     /** Total cost of sending the message. */

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

@@ -2,8 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface SentSmsDetails {
-    /** Unique identifier for the sent message. */
-    messageId: number;
+    /** Unique identifier for the sent message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. */
+    messageId: string;
     /** Details about how the message was segmented for sending. */
     segments: SentSmsDetails.Segments;
     /** Total cost of sending the message. */

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

@@ -3,8 +3,8 @@
  */
 import * as Pinnacle from "../index.js";
 export interface TollFreeCampaign {
-    /** Unique identifier for the campaign. */
-    campaignId?: number;
+    /** Unique identifier for the campaign. Must begin with the prefix `tf_`. */
+    campaignId?: string;
     monthlyVolume?: Pinnacle.MessageVolumeEnum;
     /** Display name of the campaign. */
     name?: string;

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

@@ -12,8 +12,8 @@ export interface TollFreeCampaignStatus {
      * These errors may request additional information or point out erroneous and/or missing fields.
      */
     error?: string;
-    /** Id of the toll-free campaign. */
-    id: number;
+    /** The unique identifier of the toll-free campaign. This identifier is a string that always begins with the prefix `tf_`, for example: `tf_1234567890`. */
+    id: string;
     /**
      * Status of phone numbers that are being attached to this campaign. <br>
      *

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

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

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

@@ -20,5 +20,11 @@ export declare namespace UploadResults {
          * Null indicates that `download.expiresAt` was not provided and the expiration time is defaulted to one hour after uploading.
          */
         expiresAt: string | null;
+        /**
+         * Deletion date for the file in ISO 8601 format. After this date, the file will be automatically deleted from our storage.<br>
+         *
+         * If this field is not provided, the file will not be deleted. You can still schedule deletion or delete the file manually in the Storage page in the dashboard.
+         */
+        deleteAt?: string | null;
     }
 }

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

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

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

@@ -3,8 +3,8 @@
  */
 import * as Pinnacle from "../index.js";
 export interface Vcard {
-    /** Unique identifier for the contact. */
-    id?: number;
+    /** The unique identifier of the contact. This identifier is a string that always begins with the prefix `cc_`, for example: `cc_1234567890`. */
+    id?: string;
     /** Full display name for the vCard. */
     formattedName?: string;
     /** Structured name components. */

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

@@ -2,8 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface VcardResource {
-    /** Contact's id */
-    id?: number;
+    /** The unique identifier of the contact. This identifier is a string that always begins with the prefix `cc_`, for example: `cc_1234567890`. */
+    id?: string;
     /**
      * Presigned download url to download vCard data. <br>
      *