rcs-js 2.0.0-rc.1 → 2.0.0-rc.11

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

@@ -29,6 +29,35 @@ export declare namespace Rcs {
 export declare class Rcs {
     protected readonly _options: Rcs.Options;
     constructor(_options: Rcs.Options);
+    /**
+     * Send a RCS message immediately or schedule it for future delivery. <br>
+     *
+     * Requires an active RCS agent and recipient devices that support RCS Business Messaging.
+     *
+     * @param {Pinnacle.Rcs} request
+     * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.PaymentRequiredError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
+     *
+     * @example
+     *     await client.messages.rcs.send({
+     *         quickReplies: [{
+     *                 type: "openUrl",
+     *                 payload: "payload",
+     *                 title: "title"
+     *             }],
+     *         text: "text",
+     *         from: "from",
+     *         to: "to"
+     *     })
+     */
+    send(request: Pinnacle.Rcs, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.messages.RcsSendResponse>;
+    private __send;
     /**
      * Validate RCS message content without sending it.
      *

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

@@ -55,6 +55,94 @@ class Rcs {
     constructor(_options) {
         this._options = _options;
     }
+    /**
+     * Send a RCS message immediately or schedule it for future delivery. <br>
+     *
+     * Requires an active RCS agent and recipient devices that support RCS Business Messaging.
+     *
+     * @param {Pinnacle.Rcs} request
+     * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.PaymentRequiredError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
+     *
+     * @example
+     *     await client.messages.rcs.send({
+     *         quickReplies: [{
+     *                 type: "openUrl",
+     *                 payload: "payload",
+     *                 title: "title"
+     *             }],
+     *         text: "text",
+     *         from: "from",
+     *         to: "to"
+     *     })
+     */
+    send(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__send(request, requestOptions));
+    }
+    __send(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/send/rcs"),
+                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 402:
+                        throw new Pinnacle.PaymentRequiredError(_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/send/rcs.");
+                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/index.d.ts

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

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

@@ -14,4 +14,5 @@ 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("./types/index.js"), exports);
 __exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/messages/resources/{send/types/SendSmsResponse.d.ts → rcs/types/RcsSendResponse.d.ts}

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Pinnacle from "../../../../../index.js";
-export type SendSmsResponse = Pinnacle.SentSmsDetails | Pinnacle.ScheduledMessaage;
+export type RcsSendResponse = Pinnacle.SentRcsDetails | Pinnacle.ScheduledMessaage;

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

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

package/dist/cjs/api/resources/messages/resources/rcs/types/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("./RcsSendResponse.js"), exports);

package/dist/cjs/api/resources/{message → messages}/resources/sms/client/Client.d.ts

@@ -29,6 +29,28 @@ export declare namespace Sms {
 export declare class Sms {
     protected readonly _options: Sms.Options;
     constructor(_options: Sms.Options);
+    /**
+     * Send a SMS message immediately or schedule it for future delivery.
+     *
+     * @param {Pinnacle.messages.Sms} request
+     * @param {Sms.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.PaymentRequiredError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
+     *
+     * @example
+     *     await client.messages.sms.send({
+     *         from: "+14155164736",
+     *         text: "Hey!",
+     *         to: "+14154746461"
+     *     })
+     */
+    send(request: Pinnacle.messages.Sms, requestOptions?: Sms.RequestOptions): core.HttpResponsePromise<Pinnacle.messages.SmsSendResponse>;
+    private __send;
     /**
      * Validate SMS message content without sending it.
      *
@@ -40,7 +62,7 @@ export declare class Sms {
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.message.sms.validate({
+     *     await client.messages.sms.validate({
      *         text: "Hello from Pinnacle"
      *     })
      */

package/dist/cjs/api/resources/{message → messages}/resources/sms/client/Client.js

@@ -55,6 +55,87 @@ class Sms {
     constructor(_options) {
         this._options = _options;
     }
+    /**
+     * Send a SMS message immediately or schedule it for future delivery.
+     *
+     * @param {Pinnacle.messages.Sms} request
+     * @param {Sms.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.PaymentRequiredError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
+     *
+     * @example
+     *     await client.messages.sms.send({
+     *         from: "+14155164736",
+     *         text: "Hey!",
+     *         to: "+14154746461"
+     *     })
+     */
+    send(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__send(request, requestOptions));
+    }
+    __send(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/send/sms"),
+                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 402:
+                        throw new Pinnacle.PaymentRequiredError(_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/send/sms.");
+                case "unknown":
+                    throw new errors.PinnacleError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Validate SMS message content without sending it.
      *
@@ -66,7 +147,7 @@ class Sms {
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.message.sms.validate({
+     *     await client.messages.sms.validate({
      *         text: "Hello from Pinnacle"
      *     })
      */

package/dist/cjs/api/resources/messages/resources/{send → sms}/client/requests/Sms.d.ts

@@ -6,14 +6,14 @@ import * as Pinnacle from "../../../../../../index.js";
  * @example
  *     {
  *         from: "+14155164736",
- *         text: "Hey! \uD83D\uDE02",
+ *         text: "Hey!",
  *         to: "+14154746461"
  *     }
  *
  * @example
  *     {
  *         from: "+14155164736",
- *         text: "Hey! \uD83D\uDE02",
+ *         text: "Hey!",
  *         to: "+14154746461"
  *     }
  */

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

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

package/dist/cjs/api/resources/messages/resources/{send/types/SendMmsResponse.d.ts → sms/types/SmsSendResponse.d.ts}

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Pinnacle from "../../../../../index.js";
-export type SendMmsResponse = Pinnacle.SentMmsDetails | Pinnacle.ScheduledMessaage;
+export type SmsSendResponse = Pinnacle.SentSmsDetails | Pinnacle.ScheduledMessaage;

package/dist/cjs/api/resources/messages/resources/sms/types/index.d.ts

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

package/dist/cjs/api/resources/messages/resources/sms/types/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("./SmsSendResponse.js"), exports);

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

@@ -29,7 +29,7 @@ export interface SearchPhoneNumberParams {
      */
     location?: SearchPhoneNumberParams.Location;
     /** Filter your search by digit pattern. */
-    number?: SearchPhoneNumberParams.PhoneNumberDigitFilters;
+    number?: SearchPhoneNumberParams.Number;
     /** Extra search settings to control how many results you get. */
     options?: SearchPhoneNumberParams.Options;
     /** Types of phone numbers to return in your search. */
@@ -58,7 +58,7 @@ export declare namespace SearchPhoneNumberParams {
     /**
      * Filter your search by digit pattern.
      */
-    interface PhoneNumberDigitFilters {
+    interface Number {
         /** Your search will return only numbers that contain this digit sequence anywhere within them. */
         contains?: string;
         /** Your search will return only numbers that end with these digits. */

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

@@ -39,6 +39,7 @@ export declare class Campaign {
      * @throws {@link Pinnacle.UnauthorizedError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.phoneNumbers.campaign.attach({
@@ -59,6 +60,7 @@ export declare class Campaign {
      * @throws {@link Pinnacle.UnauthorizedError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.phoneNumbers.campaign.detach({

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

@@ -65,6 +65,7 @@ class Campaign {
      * @throws {@link Pinnacle.UnauthorizedError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.phoneNumbers.campaign.attach({
@@ -105,6 +106,8 @@ class Campaign {
                         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,
@@ -140,6 +143,7 @@ class Campaign {
      * @throws {@link Pinnacle.UnauthorizedError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.phoneNumbers.campaign.detach({
@@ -178,6 +182,8 @@ class Campaign {
                         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,

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

@@ -68,6 +68,7 @@ export declare class Webhook {
      * @throws {@link Pinnacle.UnauthorizedError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.phoneNumbers.webhook.detach("+14155551234", 123)

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

@@ -151,6 +151,7 @@ class Webhook {
      * @throws {@link Pinnacle.UnauthorizedError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.phoneNumbers.webhook.detach("+14155551234", 123)
@@ -184,6 +185,8 @@ class Webhook {
                         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,

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

@@ -0,0 +1,121 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments.js";
+import * as core from "../../../../core/index.js";
+import * as Pinnacle from "../../../index.js";
+export declare namespace Rcs {
+    interface Options {
+        environment?: core.Supplier<environments.PinnacleEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        apiKey: core.Supplier<string>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+}
+export declare class Rcs {
+    protected readonly _options: Rcs.Options;
+    constructor(_options: Rcs.Options);
+    /**
+     * Check RCS capabilities for one or more phone numbers.
+     *
+     * This endpoint allows you to verify which RCS features (cards, buttons, etc.) are supported
+     * on specific phone numbers before sending RCS messages to them.
+     *
+     * @param {Pinnacle.RcsCapabilitiesQuery} request
+     * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
+     *
+     * @example
+     *     await client.rcs.getCapabilities({
+     *         phoneNumbers: ["+12345678901", "+19876543210"]
+     *     })
+     */
+    getCapabilities(request: Pinnacle.RcsCapabilitiesQuery, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsCapabilitiesResult>;
+    private __getCapabilities;
+    /**
+     * Whitelist a phone number for testing with your test RCS agent.
+     *
+     * ## 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.
+     *
+     * ## 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:
+     *    ```
+     *    https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
+     *    ```
+     *
+     * > **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.
+     *
+     * @param {Pinnacle.RcsWhitelistRequest} 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.rcs.whitelist({
+     *         agentId: "agent_XXXXXXXXXXXX",
+     *         phoneNumber: "+12345678901"
+     *     })
+     */
+    whitelist(request: Pinnacle.RcsWhitelistRequest, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsWhitelistResponse>;
+    private __whitelist;
+    /**
+     * Generate a link for initiating an RCS conversation with your agent.
+     *
+     * Users can click these links to start conversations with your RCS agent directly
+     * from websites, emails, or other applications.
+     *
+     * @param {Pinnacle.RcsLinkRequest} 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.rcs.getLink({
+     *         agentId: "agent_XXXXXXXXXXXX",
+     *         testMode: false,
+     *         phoneNumber: "+12345678901",
+     *         body: "Hello, I need help with my order"
+     *     })
+     */
+    getLink(request: Pinnacle.RcsLinkRequest, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsLinkResult>;
+    private __getLink;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "PINNACLE-API-KEY": string;
+    }>;
+}