rcs-js 2.0.1 → 2.0.3

package/dist/esm/api/resources/status/resources/get/client/Client.d.mts

@@ -32,7 +32,7 @@ export declare class Get {
     /**
      * Retrieve a brand's status.
      *
-     * @param {number} brandId - ID of the brand.
+     * @param {string} brandId - The unique identifier of the brand you want to retrieve the status for. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -42,14 +42,14 @@ export declare class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.brand(28)
+     *     await client.status.get.brand("b_1234567890")
      */
-    brand(brandId: number, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.BrandStatus>;
+    brand(brandId: string, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.BrandStatus>;
     private __brand;
     /**
      * Retrieve a toll-free campaign's status.
      *
-     * @param {number} campaignId - ID of the toll-free campaign.
+     * @param {string} campaignId - The unique identifier of the toll-free campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `tf_`, for example: `tf_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -59,14 +59,14 @@ export declare class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.tollFree(28)
+     *     await client.status.get.tollFree("tf_1234567890")
      */
-    tollFree(campaignId: number, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.TollFreeCampaignStatus>;
+    tollFree(campaignId: string, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.TollFreeCampaignStatus>;
     private __tollFree;
     /**
      * Retrieve a 10DLC campaign's status.
      *
-     * @param {number} campaignId - ID of the 10DLC campaign.
+     * @param {string} campaignId - The unique identifier of the 10DLC campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -76,14 +76,14 @@ export declare class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.dlc(28)
+     *     await client.status.get.dlc("dlc_1234567890")
      */
-    dlc(campaignId: number, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.DlcCampaignStatus>;
+    dlc(campaignId: string, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.DlcCampaignStatus>;
     private __dlc;
     /**
      * Retrieve a RCS campaign's status.
      *
-     * @param {number} campaignId - ID of the campaign.
+     * @param {string} campaignId - The unique identifier of the RCS campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `rcs_`, for example: `rcs_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -93,9 +93,9 @@ export declare class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.rcs(28)
+     *     await client.status.get.rcs("rcs_1234567890")
      */
-    rcs(campaignId: number, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsCampaignStatus>;
+    rcs(campaignId: string, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsCampaignStatus>;
     private __rcs;
     /**
      * Retrieve a phone number's order status and campaign attachment status. <br>

package/dist/esm/api/resources/status/resources/get/client/Client.mjs

@@ -22,7 +22,7 @@ export class Get {
     /**
      * Retrieve a brand's status.
      *
-     * @param {number} brandId - ID of the brand.
+     * @param {string} brandId - The unique identifier of the brand you want to retrieve the status for. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -32,7 +32,7 @@ export class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.brand(28)
+     *     await client.status.get.brand("b_1234567890")
      */
     brand(brandId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__brand(brandId, requestOptions));
@@ -93,7 +93,7 @@ export class Get {
     /**
      * Retrieve a toll-free campaign's status.
      *
-     * @param {number} campaignId - ID of the toll-free campaign.
+     * @param {string} campaignId - The unique identifier of the toll-free campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `tf_`, for example: `tf_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -103,7 +103,7 @@ export class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.tollFree(28)
+     *     await client.status.get.tollFree("tf_1234567890")
      */
     tollFree(campaignId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__tollFree(campaignId, requestOptions));
@@ -164,7 +164,7 @@ export class Get {
     /**
      * Retrieve a 10DLC campaign's status.
      *
-     * @param {number} campaignId - ID of the 10DLC campaign.
+     * @param {string} campaignId - The unique identifier of the 10DLC campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -174,7 +174,7 @@ export class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.dlc(28)
+     *     await client.status.get.dlc("dlc_1234567890")
      */
     dlc(campaignId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__dlc(campaignId, requestOptions));
@@ -235,7 +235,7 @@ export class Get {
     /**
      * Retrieve a RCS campaign's status.
      *
-     * @param {number} campaignId - ID of the campaign.
+     * @param {string} campaignId - The unique identifier of the RCS campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `rcs_`, for example: `rcs_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -245,7 +245,7 @@ export class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.rcs(28)
+     *     await client.status.get.rcs("rcs_1234567890")
      */
     rcs(campaignId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__rcs(campaignId, requestOptions));

package/dist/esm/api/resources/tools/resources/contactCard/client/Client.d.mts

@@ -41,7 +41,7 @@ export declare class ContactCard {
      *
      * @example
      *     await client.tools.contactCard.get({
-     *         id: 33
+     *         id: "cc_1234567890"
      *     })
      */
     get(request: Pinnacle.tools.GetVcardParams, requestOptions?: ContactCard.RequestOptions): core.HttpResponsePromise<Pinnacle.VCardData>;
@@ -58,7 +58,7 @@ export declare class ContactCard {
      *
      * @example
      *     await client.tools.contactCard.upsert({
-     *         id: 34,
+     *         id: "cc_1234567890",
      *         formattedName: "Jane Smith",
      *         name: {
      *             familyName: "Smith",

package/dist/esm/api/resources/tools/resources/contactCard/client/Client.mjs

@@ -31,7 +31,7 @@ export class ContactCard {
      *
      * @example
      *     await client.tools.contactCard.get({
-     *         id: 33
+     *         id: "cc_1234567890"
      *     })
      */
     get(request, requestOptions) {
@@ -101,7 +101,7 @@ export class ContactCard {
      *
      * @example
      *     await client.tools.contactCard.upsert({
-     *         id: 34,
+     *         id: "cc_1234567890",
      *         formattedName: "Jane Smith",
      *         name: {
      *             familyName: "Smith",

package/dist/esm/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.d.mts

@@ -4,12 +4,12 @@
 /**
  * @example
  *     {
- *         id: 33
+ *         id: "cc_1234567890"
  *     }
  */
 export interface GetVcardParams {
-    /** ID of your 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;
     options?: GetVcardParams.Options;
 }
 export declare namespace GetVcardParams {

package/dist/esm/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.d.mts

@@ -5,7 +5,7 @@ import * as Pinnacle from "../../../../../../index.mjs";
 /**
  * @example
  *     {
- *         id: 34,
+ *         id: "cc_1234567890",
  *         formattedName: "Jane Smith",
  *         name: {
  *             familyName: "Smith",

package/dist/esm/api/resources/tools/resources/file/client/Client.d.mts

@@ -45,6 +45,7 @@ export declare class File_ {
      *         size: 1024,
      *         name: "test.jpg",
      *         options: {
+     *             deleteAt: "2025-12-31T23:59:59Z",
      *             download: {
      *                 expiresAt: "2025-06-30T12:00:00.000Z"
      *             }
@@ -69,7 +70,7 @@ export declare class File_ {
      *
      * @example
      *     await client.tools.file.refresh({
-     *         uris: ["https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken", "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2", "icons/3/test.jpg", "invalid/url", "https://google.com"]
+     *         urls: ["https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken", "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2", "invalid/url", "https://google.com"]
      *     })
      */
     refresh(request: Pinnacle.tools.RefreshFileParams, requestOptions?: File_.RequestOptions): core.HttpResponsePromise<Pinnacle.RefreshedFile[]>;

package/dist/esm/api/resources/tools/resources/file/client/Client.mjs

@@ -35,6 +35,7 @@ export class File_ {
      *         size: 1024,
      *         name: "test.jpg",
      *         options: {
+     *             deleteAt: "2025-12-31T23:59:59Z",
      *             download: {
      *                 expiresAt: "2025-06-30T12:00:00.000Z"
      *             }
@@ -112,7 +113,7 @@ export class File_ {
      *
      * @example
      *     await client.tools.file.refresh({
-     *         uris: ["https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken", "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2", "icons/3/test.jpg", "invalid/url", "https://google.com"]
+     *         urls: ["https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken", "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2", "invalid/url", "https://google.com"]
      *     })
      */
     refresh(request, requestOptions) {

package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.mts

@@ -4,18 +4,10 @@
 /**
  * @example
  *     {
- *         uris: ["https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken", "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2", "icons/3/test.jpg", "invalid/url", "https://google.com"]
+ *         urls: ["https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken", "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2", "invalid/url", "https://google.com"]
  *     }
  */
 export interface RefreshFileParams {
-    /**
-     * Array of file URIs to refresh for extended access. <br>
-     *
-     * Accepted formats:
-     * - **Full presigned URLs**: `https://server.trypinnacle.app/storage/v1/object/sign/...`
-     * - **Short URIs**: `{BUCKET}/${TEAM_ID}/...` (e.g., `vault/3/document.pdf`)
-     *
-     * Invalid or external URLs will be returned unchanged in the response.
-     */
-    uris: string[];
+    /** Array of file URLs to refresh for extended access. Provided URLs must be presigned URLs (i.e. `https://server.trypinnacle.app/storage/v1/object/sign/...`). Invalid or external URLs will be returned unchanged in the response. */
+    urls: string[];
 }

package/dist/esm/api/resources/tools/resources/file/client/requests/UploadFileParams.d.mts

@@ -8,6 +8,7 @@
  *         size: 1024,
  *         name: "test.jpg",
  *         options: {
+ *             deleteAt: "2025-12-31T23:59:59Z",
  *             download: {
  *                 expiresAt: "2025-06-30T12:00:00.000Z"
  *             }
@@ -37,6 +38,12 @@ export declare namespace UploadFileParams {
      * Additional configurations for your file.
      */
     interface Options {
+        /**
+         * Set a deletion date for your 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;
         /** Configure download settings for your uploaded file. */
         download?: Options.Download;
     }

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

@@ -10,7 +10,7 @@ export type AttachWebhookParams =
 /**
  * Attach a webhook you’ve already created in your account to this phone number. */
 {
-    webhookId: number;
+    webhookId: string;
     event: Pinnacle.WebhookEventEnum | null;
 }
 /**

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

@@ -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/esm/api/types/AutofillCampaignParams.d.mts

@@ -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/esm/api/types/AutofillDlcCampaignResponse.d.mts

@@ -5,10 +5,10 @@ import * as Pinnacle from "../index.mjs";
 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. */

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

@@ -8,8 +8,8 @@ import * as Pinnacle from "../index.mjs";
 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/esm/api/types/ButtonClickedData.d.mts

@@ -8,8 +8,8 @@ import * as Pinnacle from "../index.mjs";
 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;
+    /** ID of the message this button was sent in, 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 {
     /**

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

@@ -6,7 +6,12 @@ import * as Pinnacle from "../index.mjs";
  * 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/esm/api/types/ConfiguredWebhook.d.mts

@@ -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/esm/api/types/Contact.d.mts

@@ -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/esm/api/types/ContactId.d.mts

@@ -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/esm/api/types/Conversation.d.mts

@@ -6,16 +6,16 @@ import * as Pinnacle from "../index.mjs";
  * 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. */
+    /** 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;
     /**
@@ -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/esm/api/types/ConversationList.d.mts

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

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

@@ -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/esm/api/types/DetachedWebhookInfo.d.mts

@@ -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/esm/api/types/DlcCampaignStatus.d.mts

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

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

@@ -10,8 +10,8 @@ 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. */

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

@@ -5,8 +5,8 @@ import * as Pinnacle from "../index.mjs";
 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;
     /**

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

@@ -13,8 +13,8 @@ export interface ExtendedRcsCampaign {
     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. */

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

@@ -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/esm/api/types/LinkClickEvent.d.mts

@@ -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/esm/api/types/Message.d.mts

@@ -22,8 +22,8 @@ export interface Message {
      * Null indicates no errors.
      */
     error: string | null;
-    /** Unique identifier of the message. */
-    id: number;
+    /** 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;

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

@@ -22,16 +22,18 @@ export interface MessageEvent {
      * Null if not yet delivered or for inbound messages.
      */
     deliveredAt?: string | null;
-    /** Message details including ID and content. */
-    message: MessageEvent.Message;
+    message: Pinnacle.MessageEventContent;
 }
 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;
+        /**
+         * 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. */
@@ -45,12 +47,4 @@ export declare namespace MessageEvent {
         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;
-    }
 }