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

package/dist/esm/api/resources/rcs/client/Client.d.mts

@@ -0,0 +1,121 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Pinnacle from "../../../index.mjs";
+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;
+    }>;
+}

package/dist/esm/api/resources/{messages/resources/send → rcs}/client/Client.mjs

@@ -10,43 +10,43 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import * as environments from "../../../../../../environments.mjs";
-import * as core from "../../../../../../core/index.mjs";
-import * as Pinnacle from "../../../../../index.mjs";
-import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
-import * as errors from "../../../../../../errors/index.mjs";
-export class Send {
+import * as environments from "../../../../environments.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Pinnacle from "../../../index.mjs";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.mjs";
+import * as errors from "../../../../errors/index.mjs";
+export class Rcs {
     constructor(_options) {
         this._options = _options;
     }
     /**
-     * Send a SMS message immediately or schedule it for future delivery.
+     * Check RCS capabilities for one or more phone numbers.
      *
-     * @param {Pinnacle.messages.Sms} request
-     * @param {Send.RequestOptions} requestOptions - Request-specific configuration.
+     * 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.PaymentRequiredError}
-     * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.messages.send.sms({
-     *         from: "+14155164736",
-     *         text: "Hey! \uD83D\uDE02",
-     *         to: "+14154746461"
+     *     await client.rcs.getCapabilities({
+     *         phoneNumbers: ["+12345678901", "+19876543210"]
      *     })
      */
-    sms(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__sms(request, requestOptions));
+    getCapabilities(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getCapabilities(request, requestOptions));
     }
-    __sms(request, requestOptions) {
+    __getCapabilities(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
             let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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"),
+                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, "rcs/capabilities"),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
@@ -66,12 +66,10 @@ export class Send {
                         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,
@@ -88,7 +86,7 @@ export class Send {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /messages/send/sms.");
+                    throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /rcs/capabilities.");
                 case "unknown":
                     throw new errors.PinnacleError({
                         message: _response.error.errorMessage,
@@ -98,38 +96,52 @@ export class Send {
         });
     }
     /**
-     * Send a MMS immediately or schedule it for future delivery.
+     * 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.messages.Mms} request
-     * @param {Send.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {Pinnacle.RcsWhitelistRequest} 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.send.mms({
-     *         from: "+14155164736",
-     *         mediaUrls: ["https://fastly.picsum.photos/id/941/300/300.jpg?hmac=mDxM9PWSqRDjecwSCEpzU4bj35gqnG7yA25OL29uNv0"],
-     *         options: {
-     *             multiple_messages: true,
-     *             validate: true
-     *         },
-     *         text: "Check out this image!",
-     *         to: "+14154746461"
+     *     await client.rcs.whitelist({
+     *         agentId: "agent_XXXXXXXXXXXX",
+     *         phoneNumber: "+12345678901"
      *     })
      */
-    mms(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__mms(request, requestOptions));
+    whitelist(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__whitelist(request, requestOptions));
     }
-    __mms(request, requestOptions) {
+    __whitelist(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
             let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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/mms"),
+                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, "rcs/whitelist"),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
@@ -149,12 +161,12 @@ export class Send {
                         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,
@@ -171,7 +183,7 @@ export class Send {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /messages/send/mms.");
+                    throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /rcs/whitelist.");
                 case "unknown":
                     throw new errors.PinnacleError({
                         message: _response.error.errorMessage,
@@ -181,40 +193,37 @@ export class Send {
         });
     }
     /**
-     * Send a RCS message immediately or schedule it for future delivery. <br>
+     * Generate a link for initiating an RCS conversation with your agent.
      *
-     * Requires an active RCS agent and recipient devices that support RCS Business Messaging.
+     * Users can click these links to start conversations with your RCS agent directly
+     * from websites, emails, or other applications.
      *
-     * @param {Pinnacle.Rcs} request
-     * @param {Send.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {Pinnacle.RcsLinkRequest} 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.send.rcs({
-     *         quickReplies: [{
-     *                 type: "openUrl",
-     *                 payload: "payload",
-     *                 title: "title"
-     *             }],
-     *         text: "text",
-     *         from: "from",
-     *         to: "to"
+     *     await client.rcs.getLink({
+     *         agentId: "agent_XXXXXXXXXXXX",
+     *         testMode: false,
+     *         phoneNumber: "+12345678901",
+     *         body: "Hello, I need help with my order"
      *     })
      */
-    rcs(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__rcs(request, requestOptions));
+    getLink(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getLink(request, requestOptions));
     }
-    __rcs(request, requestOptions) {
+    __getLink(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
             let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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"),
+                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, "rcs/link"),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
@@ -234,12 +243,12 @@ export class Send {
                         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,
@@ -256,7 +265,7 @@ export class Send {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /messages/send/rcs.");
+                    throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /rcs/link.");
                 case "unknown":
                     throw new errors.PinnacleError({
                         message: _response.error.errorMessage,

package/dist/esm/api/resources/rcs/client/index.d.mts

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

package/dist/esm/api/resources/rcs/client/index.mjs

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.mts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         phoneNumbers: ["+12345678901", "+19876543210"]
+ *     }
+ */
+export interface RcsCapabilitiesQuery {
+    /** List of phone numbers to check RCS capabilities for (E.164 format) */
+    phoneNumbers: string[];
+}

package/dist/esm/api/resources/rcs/client/requests/RcsLinkRequest.d.mts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         agentId: "agent_XXXXXXXXXXXX",
+ *         testMode: false,
+ *         phoneNumber: "+12345678901",
+ *         body: "Hello, I need help with my order"
+ *     }
+ */
+export interface RcsLinkRequest {
+    /** The RCS agent ID (must be prefixed with 'agent_') */
+    agentId: string;
+    /** Link to the test agent or the production agent if false */
+    testMode?: boolean;
+    /** Fallback phone number (E.164 format) to use if the phone number does not support RCS. If not provided, no url will be generated. */
+    phoneNumber?: string;
+    /** Optional message body to pre-fill after the user clicks the link */
+    body?: string;
+}

package/dist/esm/api/resources/rcs/client/requests/RcsWhitelistRequest.d.mts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         agentId: "agent_XXXXXXXXXXXX",
+ *         phoneNumber: "+12345678901"
+ *     }
+ */
+export interface RcsWhitelistRequest {
+    /** The RCS agent ID (must be prefixed with 'agent_') */
+    agentId: string;
+    /** Phone number to whitelist for testing (E.164 format) */
+    phoneNumber: string;
+}

package/dist/esm/api/resources/rcs/client/requests/index.d.mts

@@ -0,0 +1,3 @@
+export { type RcsCapabilitiesQuery } from "./RcsCapabilitiesQuery.mjs";
+export { type RcsWhitelistRequest } from "./RcsWhitelistRequest.mjs";
+export { type RcsLinkRequest } from "./RcsLinkRequest.mjs";

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

@@ -64,9 +64,9 @@ export declare class Get {
     tollFree(campaignId: number, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.TollFreeCampaignStatus>;
     private __tollFree;
     /**
-     * Retrieve a DLC campaign's status.
+     * Retrieve a 10DLC campaign's status.
      *
-     * @param {number} campaignId - ID of the DLC campaign.
+     * @param {number} campaignId - ID of the 10DLC campaign.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}

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

@@ -162,9 +162,9 @@ export class Get {
         });
     }
     /**
-     * Retrieve a DLC campaign's status.
+     * Retrieve a 10DLC campaign's status.
      *
-     * @param {number} campaignId - ID of the DLC campaign.
+     * @param {number} campaignId - ID of the 10DLC campaign.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}

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

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

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

@@ -24,7 +24,7 @@ export interface DlcCampaignStatus {
      */
     status: Pinnacle.ProfileStatusEnum;
     /**
-     * Status of toll free numbers that are being attached to this campaign. <br>
+     * Status of local long code numbers that are being attached to this campaign. <br>
      *
      * Note that phone numbers can only be attached to `VERIFIED` campaigns via the [attach campaign endpoint](../phone-numbers/attach-campaign).
      */
@@ -32,7 +32,7 @@ export interface DlcCampaignStatus {
 }
 export declare namespace DlcCampaignStatus {
     /**
-     * Status of toll free numbers that are being attached to this campaign. <br>
+     * Status of local long code numbers that are being attached to this campaign. <br>
      *
      * Note that phone numbers can only be attached to `VERIFIED` campaigns via the [attach campaign endpoint](../phone-numbers/attach-campaign).
      */

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

@@ -9,6 +9,8 @@ export interface ExtendedRcsCampaign {
     agentId: string;
     /** Brand associated with this campaign. */
     brand: Pinnacle.ExtendedBrand;
+    /** Link to document verifying the brand's name. This may be the certificate of incorporation, business license, or other relevant document. You can typically find this on the Secretary of State website. */
+    brandVerificationUrl?: string;
     /** Indicates whether the brand has provided an attestation. */
     brandAttestation: boolean;
     /** Unique identifier for the campaign. */
@@ -35,9 +37,9 @@ export declare namespace ExtendedRcsCampaign {
         description?: string;
         /** List of emails. */
         emails?: Agent.Emails.Item[];
-        /** Link to the agent's hero. */
+        /** Link to the agent's hero. Hero must be an image file with dimensions 1440x448px. */
         heroUrl?: string;
-        /** Link to the agent's icon. */
+        /** Link to the agent's icon. Icon must be an image file with dimensions 224x224px. */
         iconUrl?: string;
         /** Name of the agent. */
         name?: string;

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

@@ -5,10 +5,10 @@ import * as Pinnacle from "../index.mjs";
 export type Rcs = 
 /**
  * Send a text RCS message with optional quick reply buttons. */
-Pinnacle.RcsText
+Pinnacle.RichTextMessage
 /**
  * Send a media RCS message with optional quick reply buttons. */
- | Pinnacle.RcsMedia
+ | Pinnacle.RichMediaMessage
 /**
  * Send a cards RCS message with optional quick reply buttons. */
- | Pinnacle.RcsCard;
+ | Pinnacle.RichCardsMessage;

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

@@ -7,6 +7,8 @@ export interface RcsCampaign {
     agent?: RcsCampaign.Agent;
     /** Unique identifier for the campaign. */
     campaignId?: number;
+    /** Link to document verifying the brand's name. This may be the certificate of incorporation, business license, or other relevant document. You can typically find this on the Secretary of State website. */
+    brandVerificationUrl?: string;
     /** List of what the agent might say to users. */
     expectedAgentResponses?: string[];
     /** Legal documentation links. */
@@ -35,9 +37,9 @@ export declare namespace RcsCampaign {
         phones?: Agent.Phones.Item[];
         /** List of urls. */
         websites?: Agent.Websites.Item[];
-        /** Link to the agent's hero. */
+        /** Link to the agent's hero. Hero must be an image file with dimensions 1440x448px. */
         heroUrl?: string;
-        /** Link to the agent's icon. */
+        /** Link to the agent's icon. Icon must be an image file with dimensions 224x224px. */
         iconUrl?: string;
     }
     namespace Agent {

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+/**
+ * Response containing RCS capabilities for requested phone numbers
+ */
+export type RcsCapabilitiesResult = Record<string, (Pinnacle.RcsCapability | null) | undefined>;

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

@@ -0,0 +1,36 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * RCS capabilities for a phone number
+ */
+export interface RcsCapability {
+    cards: RcsCapability.Cards;
+    /** Supported button action types inside the rich cards or quick replies. Each key is a button action type that defines a specific button type in the Pinnacle API. */
+    actions: RcsCapability.Actions;
+}
+export declare namespace RcsCapability {
+    interface Cards {
+        /** Whether the phone number supports standalone rich cards (`cards.length == 1`) */
+        standalone: boolean;
+        /** Whether the phone number supports carousel rich cards */
+        carousel: boolean;
+    }
+    /**
+     * Supported button action types inside the rich cards or quick replies. Each key is a button action type that defines a specific button type in the Pinnacle API.
+     */
+    interface Actions {
+        /** Buttons that open URLs are supported */
+        openUrl: boolean;
+        /** Buttons that make phone calls are supported */
+        call: boolean;
+        /** Buttons that trigger actions are supported */
+        trigger: boolean;
+        /** Buttons that request user location are supported */
+        requestUserLocation: boolean;
+        /** Buttons are supported */
+        scheduleEvent: boolean;
+        /** Buttons that send location are supported */
+        sendLocation: boolean;
+    }
+}

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

@@ -11,7 +11,7 @@ export interface RcsCards {
     /** Collection of cards attached to the message. */
     cards: RcsCards.Cards.Item[];
     /** List of interactive quick reply buttons in the message. */
-    quickReplies: Pinnacle.RcsButtonContent[];
+    quickReplies: Pinnacle.RichButton[];
 }
 export declare namespace RcsCards {
     type Cards = Cards.Item[];
@@ -21,7 +21,7 @@ export declare namespace RcsCards {
          */
         interface Item {
             /** Action buttons attached to the card. */
-            buttons: Pinnacle.RcsButtonContent[];
+            buttons: Pinnacle.RichButton[];
             /** Media file URLs to send. */
             media?: string;
             /** Secondary text displayed below the title for additional context. */