rcs-js 2.0.13 → 2.0.14

package/dist/cjs/api/resources/rcs/resources/agents/client/requests/ListAgentsParams.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @example
+ *     {}
+ */
+export interface ListAgentsParams {
+    pageIndex?: number;
+    pageSize?: number;
+    /** Filter by agent type. */
+    agentType?: ListAgentsParams.AgentType;
+    /** Case-insensitive substring search on agent name. */
+    name?: string;
+}
+export declare namespace ListAgentsParams {
+    /** Filter by agent type. */
+    const AgentType: {
+        readonly Production: "PRODUCTION";
+        readonly Test: "TEST";
+    };
+    type AgentType = (typeof AgentType)[keyof typeof AgentType];
+}

package/dist/cjs/api/resources/rcs/resources/agents/client/requests/ListAgentsParams.js

@@ -0,0 +1,12 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListAgentsParams = void 0;
+var ListAgentsParams;
+(function (ListAgentsParams) {
+    /** Filter by agent type. */
+    ListAgentsParams.AgentType = {
+        Production: "PRODUCTION",
+        Test: "TEST",
+    };
+})(ListAgentsParams || (exports.ListAgentsParams = ListAgentsParams = {}));

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

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

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

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

package/dist/cjs/api/resources/rcs/resources/agents/index.d.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";

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

@@ -0,0 +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("./client/index.js"), exports);

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

@@ -0,0 +1,6 @@
+export * from "./agents/client/requests/index.js";
+export * as agents from "./agents/index.js";
+export * from "./test/client/requests/index.js";
+export * as test from "./test/index.js";
+export * from "./whitelistedNumbers/client/requests/index.js";
+export * as whitelistedNumbers from "./whitelistedNumbers/index.js";

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

@@ -0,0 +1,45 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+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);
+};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.whitelistedNumbers = exports.test = exports.agents = void 0;
+__exportStar(require("./agents/client/requests/index.js"), exports);
+exports.agents = __importStar(require("./agents/index.js"));
+__exportStar(require("./test/client/requests/index.js"), exports);
+exports.test = __importStar(require("./test/index.js"));
+__exportStar(require("./whitelistedNumbers/client/requests/index.js"), exports);
+exports.whitelistedNumbers = __importStar(require("./whitelistedNumbers/index.js"));

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

@@ -0,0 +1,214 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.js";
+import * as core from "../../../../../../core/index.js";
+import * as Pinnacle from "../../../../../index.js";
+export declare namespace Test {
+    interface Options extends BaseClientOptions {
+    }
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class Test {
+    protected readonly _options: Test.Options;
+    constructor(_options: Test.Options);
+    /**
+     * Create a new RCS test agent for development and testing.
+     *
+     * ## Overview
+     *
+     * Test agents let you build and test full RCS functionality — rich cards, carousels, buttons,
+     * quick replies, and media messages — without going through the full carrier review process.
+     * Messages from test agents can only be sent to [whitelisted phone numbers](/api-reference/rcs-agents/test/whitelist-number).
+     *
+     * ## Limits
+     *
+     * - **Maximum 5 test agents per account.**
+     *
+     * ## Image Requirements
+     *
+     * | Image | Format | Max Size |
+     * |-------|--------|----------|
+     * | Logo  | JPEG, PNG | 50 KB |
+     * | Hero  | JPEG, PNG | 200 KB |
+     *
+     * ## After Creation
+     *
+     * Once your test agent is created, you'll need to:
+     *
+     * 1. **Whitelist test phone numbers** using [`POST /rcs/test/agents/{agentId}/whitelist`](/api-reference/rcs-agents/test/whitelist-number).
+     * 2. **Accept the tester invite** on each whitelisted device.
+     * 3. **Send messages** using [`POST /messages/send/rcs`](/api-reference/messages/send-rcs) with the returned agent ID as the `from` field.
+     *
+     * > **2-Minute Cooldown**
+     * >
+     * > After creating a test agent, there is a mandatory 2-minute cooldown before you can whitelist phone numbers.
+     * > This is a requirement imposed by Google's RBM platform.
+     *
+     * @param {Pinnacle.rcs.CreateTestAgentRequest} request
+     * @param {Test.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.rcs.test.createAgent({
+     *         displayName: "Acme Support",
+     *         description: "Get help with your Acme orders and account",
+     *         logoUrl: "https://example.com/logo.png",
+     *         heroUrl: "https://example.com/hero.png",
+     *         phoneNumbers: [{
+     *                 number: "+14155550123",
+     *                 label: "Support"
+     *             }],
+     *         emails: [{
+     *                 address: "support@example.com",
+     *                 label: "Support"
+     *             }],
+     *         websites: [{
+     *                 url: "https://example.com",
+     *                 label: "Website"
+     *             }],
+     *         privacyUrl: "https://example.com/privacy",
+     *         termsUrl: "https://example.com/terms",
+     *         color: "#FF6B00",
+     *         isConversational: true,
+     *         agentUseCase: "MULTI_USE"
+     *     })
+     */
+    createAgent(request: Pinnacle.rcs.CreateTestAgentRequest, requestOptions?: Test.RequestOptions): core.HttpResponsePromise<Pinnacle.TestAgentResponse>;
+    private __createAgent;
+    /**
+     * Update an existing RCS test agent's configuration.
+     *
+     * All fields are optional — only include the fields you want to update.
+     *
+     * ## Image Requirements
+     *
+     * If updating images, the same requirements apply as when creating an agent:
+     *
+     * | Image | Format | Max Size |
+     * |-------|--------|----------|
+     * | Logo  | JPEG, PNG | 50 KB |
+     * | Hero  | JPEG, PNG | 200 KB |
+     *
+     * > **2-Minute Cooldown**
+     * >
+     * > After updating a test agent, there is a mandatory 2-minute cooldown before you can whitelist phone numbers.
+     * > This is a requirement imposed by Google's RBM platform.
+     *
+     * @param {string} agentId - The RCS agent ID (must be prefixed with `agent_`).
+     * @param {Pinnacle.rcs.UpdateTestAgentRequest} request
+     * @param {Test.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.rcs.test.updateAgent("agent_abc123def456", {
+     *         displayName: "Acme Premium Support"
+     *     })
+     *
+     * @example
+     *     await client.rcs.test.updateAgent("agent_abc123def456", {
+     *         displayName: "Acme Premium Support",
+     *         description: "Premium support for Acme customers",
+     *         color: "#0066FF"
+     *     })
+     */
+    updateAgent(agentId: string, request?: Pinnacle.rcs.UpdateTestAgentRequest, requestOptions?: Test.RequestOptions): core.HttpResponsePromise<Pinnacle.TestAgentResponse>;
+    private __updateAgent;
+    /**
+     * Whitelist a phone number for testing with a specific test agent.
+     *
+     * During development and testing, RCS agents can only send messages to whitelisted phone numbers.
+     * Use this endpoint to whitelist specific phone numbers so you can send and receive messages from the test agent.
+     *
+     * ## Verification Process
+     *
+     * After whitelisting, the recipient must accept the tester invite:
+     *
+     * 1. The recipient's device will receive a message from "RBM Tester Management".
+     * 2. The recipient must tap "Make me a tester" to accept.
+     * 3. Once accepted, the status transitions from `PENDING` to `ACCEPTED`.
+     *
+     * ## Verification
+     *
+     * <div style="display: flex; gap: 16px;">
+     *   <div style="flex: 1; text-align: center;">
+     *     <strong>Accepting the invite</strong><br/>
+     *     <img src="https://pncl.to/f769cAvCbEx-MmezZjR6dz6KVkr5ZO" alt="Accepting the tester invite" style="max-width: 100%;" />
+     *   </div>
+     *   <div style="flex: 1; text-align: center;">
+     *     <strong>Declining the invite</strong><br/>
+     *     <img src="https://pncl.to/VRere3tEKfx4n0HNaxK-vwl7pbLHTJ" alt="Declining the tester invite" style="max-width: 100%;" />
+     *   </div>
+     * </div>
+     *
+     * ## Cooldown
+     *
+     * There is a **2-minute cooldown** after creating or updating a test agent before you can whitelist numbers.
+     * Attempting to whitelist during the cooldown returns a `500` error with the remaining wait time.
+     *
+     * @param {string} agentId - The RCS agent ID (must be prefixed with `agent_`).
+     * @param {Pinnacle.rcs.TestAgentWhitelistRequest} request
+     * @param {Test.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.rcs.test.whitelistNumber("agent_abc123def456", {
+     *         phoneNumber: "+12345678901"
+     *     })
+     */
+    whitelistNumber(agentId: string, request: Pinnacle.rcs.TestAgentWhitelistRequest, requestOptions?: Test.RequestOptions): core.HttpResponsePromise<Pinnacle.TestAgentWhitelistResponse>;
+    private __whitelistNumber;
+    /**
+     * Check the current whitelist status of a phone number for a specific test agent.
+     *
+     * Use this endpoint to poll the status of a previously whitelisted number and determine
+     * whether the recipient has accepted or rejected the tester invite.
+     *
+     * ## Status Values
+     *
+     * - **`PENDING`** — The tester invite was sent but the recipient has not yet responded. Ask the recipient to check their messages and accept the invite.
+     * - **`ACCEPTED`** — The recipient accepted the invite. Messages can be exchanged.
+     * - **`REJECTED`** — The recipient rejected the invite or the invite could not be delivered since the carrier does not support test agents. If the user rejected the invite, they can accept it again by tapping "Make me a tester" in the same message from "RBM Tester Management".
+     *
+     * <div style="display: flex; gap: 16px;">
+     *   <div style="flex: 1; text-align: center;">
+     *     <strong>Accepting the invite</strong><br/>
+     *     <img src="https://pncl.to/f769cAvCbEx-MmezZjR6dz6KVkr5ZO" alt="Accepting the tester invite" style="max-width: 100%;" />
+     *   </div>
+     *   <div style="flex: 1; text-align: center;">
+     *     <strong>Declining the invite</strong><br/>
+     *     <img src="https://pncl.to/VRere3tEKfx4n0HNaxK-vwl7pbLHTJ" alt="Declining the tester invite" style="max-width: 100%;" />
+     *   </div>
+     * </div>
+     *
+     * @param {string} agentId - The RCS agent ID (must be prefixed with `agent_`).
+     * @param {Pinnacle.rcs.TestGetWhitelistStatusRequest} request
+     * @param {Test.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.rcs.test.getWhitelistStatus("agent_abc123def456", {
+     *         phoneNumber: "+12345678901"
+     *     })
+     */
+    getWhitelistStatus(agentId: string, request: Pinnacle.rcs.TestGetWhitelistStatusRequest, requestOptions?: Test.RequestOptions): core.HttpResponsePromise<Pinnacle.TestAgentWhitelistResponse>;
+    private __getWhitelistStatus;
+    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
+}