rcs-js 2.0.0 → 2.0.1-rc.1

package/dist/cjs/api/resources/index.js

@@ -36,14 +36,15 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tools = exports.status = exports.webhooks = exports.rcs = exports.conversations = exports.contacts = exports.brands = exports.messages = exports.campaigns = exports.phoneNumbers = void 0;
+exports.tools = exports.status = exports.webhooks = exports.rcs = exports.contacts = exports.brands = exports.messages = exports.campaigns = exports.phoneNumbers = exports.conversations = void 0;
+exports.conversations = __importStar(require("./conversations/index.js"));
+__exportStar(require("./conversations/types/index.js"), exports);
 exports.phoneNumbers = __importStar(require("./phoneNumbers/index.js"));
 __exportStar(require("./phoneNumbers/types/index.js"), exports);
 exports.campaigns = __importStar(require("./campaigns/index.js"));
 exports.messages = __importStar(require("./messages/index.js"));
 exports.brands = __importStar(require("./brands/index.js"));
 exports.contacts = __importStar(require("./contacts/index.js"));
-exports.conversations = __importStar(require("./conversations/index.js"));
 exports.rcs = __importStar(require("./rcs/index.js"));
 exports.webhooks = __importStar(require("./webhooks/index.js"));
 exports.status = __importStar(require("./status/index.js"));

package/dist/cjs/api/resources/messages/client/Client.d.ts

@@ -41,7 +41,7 @@ export declare class Messages {
     /**
      * Retrieve a previously sent message.
      *
-     * @param {number} id - Unique identifier of the message.
+     * @param {string} id - Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`.
      * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -50,9 +50,9 @@ export declare class Messages {
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.messages.get(1240)
+     *     await client.messages.get("msg_1234567890")
      */
-    get(id: number, requestOptions?: Messages.RequestOptions): core.HttpResponsePromise<Pinnacle.Message>;
+    get(id: string, requestOptions?: Messages.RequestOptions): core.HttpResponsePromise<Pinnacle.Message>;
     private __get;
     /**
      * Add or remove an emoji reaction to a previously sent message.
@@ -69,7 +69,7 @@ export declare class Messages {
      *
      * @example
      *     await client.messages.react({
-     *         messageId: 1410,
+     *         messageId: "msg_1234567890",
      *         options: {
      *             force: true
      *         },

package/dist/cjs/api/resources/messages/client/Client.js

@@ -73,7 +73,7 @@ class Messages {
     /**
      * Retrieve a previously sent message.
      *
-     * @param {number} id - Unique identifier of the message.
+     * @param {string} id - Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`.
      * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -82,7 +82,7 @@ class Messages {
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.messages.get(1240)
+     *     await client.messages.get("msg_1234567890")
      */
     get(id, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__get(id, requestOptions));
@@ -153,7 +153,7 @@ class Messages {
      *
      * @example
      *     await client.messages.react({
-     *         messageId: 1410,
+     *         messageId: "msg_1234567890",
      *         options: {
      *             force: true
      *         },

package/dist/cjs/api/resources/messages/client/requests/ReactMessageParams.d.ts

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         messageId: 1410,
+ *         messageId: "msg_1234567890",
  *         options: {
  *             force: true
  *         },
@@ -12,8 +12,8 @@
  *     }
  */
 export interface ReactMessageParams {
-    /** Unique identifier of the message. */
-    messageId: number;
+    /** Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. */
+    messageId: string;
     options?: ReactMessageParams.Options;
     /**
      * Unicode emoji to add. <br>

package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.d.ts

@@ -45,7 +45,7 @@ export declare class Campaign {
      *     await client.phoneNumbers.campaign.attach({
      *         phones: ["+14155550123", "+14155559876", "+14155550111"],
      *         campaignType: "TOLL_FREE",
-     *         campaignId: 101
+     *         campaignId: "tf_1234567890"
      *     })
      */
     attach(request: Pinnacle.phoneNumbers.AttachCampaignParams, requestOptions?: Campaign.RequestOptions): core.HttpResponsePromise<Pinnacle.AttachedPhoneNumberResult>;

package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.js

@@ -71,7 +71,7 @@ class Campaign {
      *     await client.phoneNumbers.campaign.attach({
      *         phones: ["+14155550123", "+14155559876", "+14155550111"],
      *         campaignType: "TOLL_FREE",
-     *         campaignId: 101
+     *         campaignId: "tf_1234567890"
      *     })
      */
     attach(request, requestOptions) {

package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.d.ts

@@ -7,13 +7,22 @@ import * as Pinnacle from "../../../../../../index.js";
  *     {
  *         phones: ["+14155550123", "+14155559876", "+14155550111"],
  *         campaignType: "TOLL_FREE",
- *         campaignId: 101
+ *         campaignId: "tf_1234567890"
  *     }
  */
 export interface AttachCampaignParams {
     /** List of phone number (E.164 format). */
     phones: string[];
     campaignType: Pinnacle.MessagingProfileEnum;
-    /** Campaign's identifier. */
-    campaignId: number;
+    /**
+     * Unique identifier for the campaign. <br>
+     *
+     *  - **TOLL_FREE** campaigns:
+     *    - Must begin with the prefix `tf_`
+     *    - Example: `tf_1234567890`
+     *  - **10DLC** campaigns:
+     *    - Must begin with the prefix `dlc_`
+     *    - Example: `dlc_1234567890`
+     */
+    campaignId: string;
 }

package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.d.ts

@@ -46,7 +46,7 @@ export declare class Webhook {
      *
      * @example
      *     await client.phoneNumbers.webhook.attach("%2B14155551234", {
-     *         webhookId: 123,
+     *         webhookId: "wh_1234567890",
      *         event: "MESSAGE.STATUS"
      *     })
      */
@@ -60,9 +60,9 @@ export declare class Webhook {
      * @param {string} phone - The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B). <br>
      *
      *                         Must be a phone number that you own and currently has the specified webhook attached.
-     * @param {number} webhookId - The unique identifier of the webhook you want to detach from the phone number. <br>
+     * @param {string} webhookId - The unique identifier of the webhook you want to detach from the phone number. <br>
      *
-     *                             This must be a valid webhook ID that is currently attached to the specified phone number.
+     *                             This must be a valid webhook ID that is currently attached to the specified phone number. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`.
      * @param {Webhook.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -72,9 +72,9 @@ export declare class Webhook {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.phoneNumbers.webhook.detach("+14155551234", 123)
+     *     await client.phoneNumbers.webhook.detach("+14155551234", "wh_1234567890")
      */
-    detach(phone: string, webhookId: number, requestOptions?: Webhook.RequestOptions): core.HttpResponsePromise<Pinnacle.DetachedWebhookInfo>;
+    detach(phone: string, webhookId: string, requestOptions?: Webhook.RequestOptions): core.HttpResponsePromise<Pinnacle.DetachedWebhookInfo>;
     private __detach;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "PINNACLE-API-KEY": string | undefined;

package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.js

@@ -72,7 +72,7 @@ class Webhook {
      *
      * @example
      *     await client.phoneNumbers.webhook.attach("%2B14155551234", {
-     *         webhookId: 123,
+     *         webhookId: "wh_1234567890",
      *         event: "MESSAGE.STATUS"
      *     })
      */
@@ -143,9 +143,9 @@ class Webhook {
      * @param {string} phone - The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B). <br>
      *
      *                         Must be a phone number that you own and currently has the specified webhook attached.
-     * @param {number} webhookId - The unique identifier of the webhook you want to detach from the phone number. <br>
+     * @param {string} webhookId - The unique identifier of the webhook you want to detach from the phone number. <br>
      *
-     *                             This must be a valid webhook ID that is currently attached to the specified phone number.
+     *                             This must be a valid webhook ID that is currently attached to the specified phone number. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`.
      * @param {Webhook.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -155,7 +155,7 @@ class Webhook {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.phoneNumbers.webhook.detach("+14155551234", 123)
+     *     await client.phoneNumbers.webhook.detach("+14155551234", "wh_1234567890")
      */
     detach(phone, webhookId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__detach(phone, webhookId, requestOptions));

package/dist/cjs/api/resources/status/resources/get/client/Client.d.ts

@@ -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/cjs/api/resources/status/resources/get/client/Client.js

@@ -58,7 +58,7 @@ 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}
@@ -68,7 +68,7 @@ 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));
@@ -129,7 +129,7 @@ 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}
@@ -139,7 +139,7 @@ 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));
@@ -200,7 +200,7 @@ 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}
@@ -210,7 +210,7 @@ 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));
@@ -271,7 +271,7 @@ 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}
@@ -281,7 +281,7 @@ 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/cjs/api/resources/tools/resources/contactCard/client/Client.d.ts

@@ -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/cjs/api/resources/tools/resources/contactCard/client/Client.js

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

package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.d.ts

@@ -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/cjs/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.d.ts

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

package/dist/cjs/api/resources/tools/resources/file/client/Client.d.ts

@@ -69,7 +69,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/cjs/api/resources/tools/resources/file/client/Client.js

@@ -148,7 +148,7 @@ 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/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.ts

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

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

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

@@ -9,7 +9,7 @@ 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;
+    messageId: string | null;
 }
 export declare namespace 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. */
+    /** 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/cjs/api/types/ConversationList.d.ts

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