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

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

@@ -0,0 +1,62 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * 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. This identifier is a string that always begins with the prefix `conv_`, for example: `conv_1234567890`. <br><br>
+         * To get more conversation details, use the [POST /conversations/get](/api-reference/conversations/get) endpoint.
+         */
+        id: string;
+        /** 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. 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;
+        content: Pinnacle.MessageContent;
+    }
+}

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

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/ProfileStatusEnum.d.ts

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

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

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

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

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

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

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

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

@@ -6,7 +6,9 @@ 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. */
     expectedAgentResponses?: string[];
     /** Legal documentation links. */
@@ -25,8 +27,6 @@ export declare namespace RcsCampaign {
     interface Agent {
         /** Name of the agent. */
         name?: 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;
         /** Description of the agent. */
         description?: string;
         /** Color of the agent's buttons. */
@@ -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/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/RcsCapabilitiesResult.d.ts

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

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

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

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

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

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

@@ -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/cjs/api/types/RefreshedFile.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/{Rcs.d.ts → RichMessage.d.ts}

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

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

@@ -11,6 +11,6 @@ export declare namespace ShortenedUrl {
         /** Destination URL that your shortened link redirects to. */
         to: string;
         /** Expiration date for your shortened link in ISO 8601 format, or null if it's permanent. */
-        expiresAt?: string | null;
+        expiresAt: string | null;
     }
 }

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/TollFreeCampaignWithExtendedBrandAndStatus.d.ts

@@ -11,7 +11,6 @@ export interface TollFreeCampaignWithExtendedBrandAndStatus extends Pinnacle.Tol
      * `INCOMPLETE`: Has not been submitted.<br>
      * `PENDING`: Currently being reviewed.<br>
      * `VERIFIED`: Verified and good to go.<br>
-     * `UNVERIFIED`: No longer verified due to an update in the brand details.<br>
      * `VETTED`: Brand has been vetted by an external provider and has received vetting scores.
      */
     status: Pinnacle.ProfileStatusEnum;

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

@@ -19,6 +19,6 @@ 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;
+        expiresAt: string | null;
     }
 }

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

@@ -0,0 +1,27 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Represents an event triggered by a user such as when they start typing.
+ */
+export interface UserEvent {
+    /** Type of user event. */
+    type: "USER.TYPING";
+    /** Timestamp when the user event started in ISO 8601 format. */
+    startedAt: string;
+    /** Conversation metadata containing the conversation ID, sender, and recipient information. */
+    conversation: UserEvent.Conversation;
+}
+export declare namespace UserEvent {
+    /**
+     * 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;
+        /** Phone number of the user who triggered the event. */
+        from: string;
+        /** Agent ID that the user is interacting with. */
+        to: string;
+    }
+}

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

@@ -26,7 +26,7 @@ export declare namespace VCardData {
              *
              * Null indicates that it is permanent.
              */
-            expiresAt?: string | null;
+            expiresAt: 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. */