rcs-js 2.0.1 → 2.0.3-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/messages/resources/index.d.ts

@@ -6,3 +6,4 @@ export * as rcs from "./rcs/index.js";
 export * from "./rcs/types/index.js";
 export * from "./sms/client/requests/index.js";
 export * from "./mms/client/requests/index.js";
+export * from "./rcs/client/requests/index.js";

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

@@ -45,3 +45,4 @@ exports.rcs = __importStar(require("./rcs/index.js"));
 __exportStar(require("./rcs/types/index.js"), exports);
 __exportStar(require("./sms/client/requests/index.js"), exports);
 __exportStar(require("./mms/client/requests/index.js"), exports);
+__exportStar(require("./rcs/client/requests/index.js"), exports);

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

@@ -58,6 +58,39 @@ export declare class Rcs {
      */
     send(request: Pinnacle.RichMessage, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.messages.RcsSendResponse>;
     private __send;
+    /**
+     * Send a typing indicator from an RCS agent to a recipient.
+     *
+     * This endpoint allows RCS agents to display a typing indicator to recipients. The indicator is a message bubble with animated typing dots like this: <img src="https://server.trypinnacle.app/storage/v1/object/public/pinnacle-public-assets/ios-typing-indicator.png" alt="Typing Indicator" style="display: inline; height: 1.5em; vertical-align: middle; margin: 0 4px;" />
+     *
+     * **Use Case:** Typing indicators are especially useful for providing feedback to users while the agent is thinking or generating a response that may take some time, creating a more engaging conversational experience.
+     *
+     * **Expiration:** Typing indicators automatically expire after around 20 seconds or when the agent sends a message, whichever comes first.
+     *
+     * **Frequency:** You can send typing indicators as many times as needed, though only one will be displayed at a time. Sending multiple typing indicators will extend the duration of the current indicator.
+     *
+     * > **Note:** Typing indicators are best-effort hints, not delivery-guaranteed state. The platform is allowed to coalesce or drop them, and the client UI decides when to show/hide.
+     *
+     * @param {Pinnacle.messages.SendTypingIndicatorSchema} request
+     * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
+     *
+     * @example
+     *     await client.messages.rcs.sendTyping({
+     *         agentId: "agent_pinnacle",
+     *         to: "+14154746461",
+     *         options: {
+     *             test_mode: false
+     *         }
+     *     })
+     */
+    sendTyping(request: Pinnacle.messages.SendTypingIndicatorSchema, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.SendTypingIndicatorResponse>;
+    private __sendTyping;
     /**
      * Validate RCS message content without sending it.
      *

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

@@ -143,6 +143,96 @@ class Rcs {
             }
         });
     }
+    /**
+     * Send a typing indicator from an RCS agent to a recipient.
+     *
+     * This endpoint allows RCS agents to display a typing indicator to recipients. The indicator is a message bubble with animated typing dots like this: <img src="https://server.trypinnacle.app/storage/v1/object/public/pinnacle-public-assets/ios-typing-indicator.png" alt="Typing Indicator" style="display: inline; height: 1.5em; vertical-align: middle; margin: 0 4px;" />
+     *
+     * **Use Case:** Typing indicators are especially useful for providing feedback to users while the agent is thinking or generating a response that may take some time, creating a more engaging conversational experience.
+     *
+     * **Expiration:** Typing indicators automatically expire after around 20 seconds or when the agent sends a message, whichever comes first.
+     *
+     * **Frequency:** You can send typing indicators as many times as needed, though only one will be displayed at a time. Sending multiple typing indicators will extend the duration of the current indicator.
+     *
+     * > **Note:** Typing indicators are best-effort hints, not delivery-guaranteed state. The platform is allowed to coalesce or drop them, and the client UI decides when to show/hide.
+     *
+     * @param {Pinnacle.messages.SendTypingIndicatorSchema} request
+     * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
+     *
+     * @example
+     *     await client.messages.rcs.sendTyping({
+     *         agentId: "agent_pinnacle",
+     *         to: "+14154746461",
+     *         options: {
+     *             test_mode: false
+     *         }
+     *     })
+     */
+    sendTyping(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__sendTyping(request, requestOptions));
+    }
+    __sendTyping(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "messages/typing"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 501:
+                        throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PinnacleError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.PinnacleError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /messages/typing.");
+                case "unknown":
+                    throw new errors.PinnacleError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Validate RCS message content without sending it.
      *

package/dist/cjs/api/resources/messages/resources/rcs/client/index.d.ts

@@ -1 +1,2 @@
 export {};
+export * from "./requests/index.js";

package/dist/cjs/api/resources/messages/resources/rcs/client/index.js

@@ -1,2 +1,17 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./requests/index.js"), exports);

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

@@ -0,0 +1,38 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         agentId: "agent_pinnacle",
+ *         to: "+14154746461",
+ *         options: {
+ *             test_mode: false
+ *         }
+ *     }
+ */
+export interface SendTypingIndicatorSchema {
+    /**
+     * The unique identifier of the RCS agent sending the typing indicator. <br>
+     *
+     * Format: `agent_` followed by alphanumeric characters (e.g., `agent_pinnacle`).
+     */
+    agentId: string;
+    /**
+     * The recipient's phone number in E.164 format. <br>
+     *
+     * Must include country code with a leading plus sign (e.g., `+14155551234`).
+     */
+    to: string;
+    /** Configure how your typing indicator is sent. */
+    options?: SendTypingIndicatorSchema.Options;
+}
+export declare namespace SendTypingIndicatorSchema {
+    /**
+     * Configure how your typing indicator is sent.
+     */
+    interface Options {
+        /** Send via the test agent to whitelisted test devices. Useful for development and debugging. */
+        test_mode?: boolean;
+    }
+}

package/dist/cjs/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.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/resources/messages/resources/rcs/client/requests/index.d.ts

@@ -0,0 +1 @@
+export { type SendTypingIndicatorSchema } from "./SendTypingIndicatorSchema.js";

package/dist/cjs/api/resources/messages/resources/rcs/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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/rcs/client/Client.d.ts

@@ -55,23 +55,27 @@ export declare class Rcs {
      *
      * ## Overview
      * During development and testing, RCS agents can only send messages to whitelisted phone numbers.
-     * Use this endpoint to add test devices to your agent's whitelist before sending test messages.
+     * Use this endpoint to whitelist specific phone numbers to send and receive messages from the test agent.
      *
      * ## Verification Process
      * After whitelisting a number, you'll need to complete verification:
      *
-     * 1. Check the test device for an "RBM Tester Management" request
-     * 2. Accept the request on the device
-     * 3. Enter the 4-digit verification code in the Pinnacle dashboard at:
+     * 1. Check the test device for message from "RBM Tester Management"
+     * 2. Click the "Make me a tester" button
+     * 3. Enter the separate 4-digit verification SMS code in the Pinnacle dashboard at:
      *    ```
      *    https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
      *    ```
      *
+     *  > **⚠️ Important: Re-whitelisting Numbers**
+     * >
+     * > If you whitelist a number that's already whitelisted, you'll receive a new message from "RBM Tester Management". **You must click the "Make me a tester" button again to continue sending and receiving messages.**
+     *
      * > **Important Notes**
      * >
-     * > - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled number
-     * > - **AT&T limitation:** Whitelisting may currently fail for AT&T numbers
-     * > - **Verification required:** The whitelist request isn't complete until you verify the device.
+     * > - **Verification required:** Messages cannot be sent nor received until you have clicked the "Make me a tester" button on the test device.
+     * > - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled number.
+     * > - **Network limitations:** Whitelisting may be temporarily unavailable for some carriers but are usually restored shortly.
      *
      * @param {Pinnacle.RcsWhitelistRequest} request
      * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -136,23 +136,27 @@ class Rcs {
      *
      * ## Overview
      * During development and testing, RCS agents can only send messages to whitelisted phone numbers.
-     * Use this endpoint to add test devices to your agent's whitelist before sending test messages.
+     * Use this endpoint to whitelist specific phone numbers to send and receive messages from the test agent.
      *
      * ## Verification Process
      * After whitelisting a number, you'll need to complete verification:
      *
-     * 1. Check the test device for an "RBM Tester Management" request
-     * 2. Accept the request on the device
-     * 3. Enter the 4-digit verification code in the Pinnacle dashboard at:
+     * 1. Check the test device for message from "RBM Tester Management"
+     * 2. Click the "Make me a tester" button
+     * 3. Enter the separate 4-digit verification SMS code in the Pinnacle dashboard at:
      *    ```
      *    https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
      *    ```
      *
+     *  > **⚠️ Important: Re-whitelisting Numbers**
+     * >
+     * > If you whitelist a number that's already whitelisted, you'll receive a new message from "RBM Tester Management". **You must click the "Make me a tester" button again to continue sending and receiving messages.**
+     *
      * > **Important Notes**
      * >
-     * > - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled number
-     * > - **AT&T limitation:** Whitelisting may currently fail for AT&T numbers
-     * > - **Verification required:** The whitelist request isn't complete until you verify the device.
+     * > - **Verification required:** Messages cannot be sent nor received until you have clicked the "Make me a tester" button on the test device.
+     * > - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled number.
+     * > - **Network limitations:** Whitelisting may be temporarily unavailable for some carriers but are usually restored shortly.
      *
      * @param {Pinnacle.RcsWhitelistRequest} request
      * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.

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>