rcs-js 2.0.14 → 2.0.16

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

@@ -2,7 +2,6 @@ import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClie
 import * as core from "../../../../core/index.mjs";
 import * as Pinnacle from "../../../index.mjs";
 import { Campaign } from "../resources/campaign/client/Client.mjs";
-import { Webhook } from "../resources/webhook/client/Client.mjs";
 export declare namespace PhoneNumbers {
     interface Options extends BaseClientOptions {
     }
@@ -11,10 +10,8 @@ export declare namespace PhoneNumbers {
 }
 export declare class PhoneNumbers {
     protected readonly _options: PhoneNumbers.Options;
-    protected _webhook: Webhook | undefined;
     protected _campaign: Campaign | undefined;
     constructor(_options: PhoneNumbers.Options);
-    get webhook(): Webhook;
     get campaign(): Campaign;
     /**
      * Search for available phone numbers that match your exact criteria.

package/dist/esm/api/resources/phoneNumbers/client/Client.mjs

@@ -14,15 +14,10 @@ import * as environments from "../../../../environments.mjs";
 import * as errors from "../../../../errors/index.mjs";
 import * as Pinnacle from "../../../index.mjs";
 import { Campaign } from "../resources/campaign/client/Client.mjs";
-import { Webhook } from "../resources/webhook/client/Client.mjs";
 export class PhoneNumbers {
     constructor(_options) {
         this._options = _options;
     }
-    get webhook() {
-        var _a;
-        return ((_a = this._webhook) !== null && _a !== void 0 ? _a : (this._webhook = new Webhook(this._options)));
-    }
     get campaign() {
         var _a;
         return ((_a = this._campaign) !== null && _a !== void 0 ? _a : (this._campaign = new Campaign(this._options)));

package/dist/esm/api/resources/phoneNumbers/resources/index.d.mts

@@ -1,3 +1,2 @@
 export * from "./campaign/client/requests/index.mjs";
 export * as campaign from "./campaign/index.mjs";
-export * as webhook from "./webhook/index.mjs";

package/dist/esm/api/resources/phoneNumbers/resources/index.mjs

@@ -1,3 +1,2 @@
 export * from "./campaign/client/requests/index.mjs";
 export * as campaign from "./campaign/index.mjs";
-export * as webhook from "./webhook/index.mjs";

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

@@ -43,5 +43,48 @@ export declare class Webhooks {
      */
     list(request?: Pinnacle.ListWebhooksParams, requestOptions?: Webhooks.RequestOptions): core.HttpResponsePromise<Pinnacle.ListWebhooksResponse>;
     private __list;
+    /**
+     * Attach a webhook to one or more senders (phone numbers or RCS agent IDs) to receive real-time event notifications. <br>
+     *
+     * You can attach an existing webhook by providing its ID, or create a new webhook by specifying a name and URL. Supports bulk operations with up to 50 senders per request. <br>
+     *
+     * Subscriptions are additive — attaching new senders does not remove existing ones. Re-attaching the same sender updates the event type filter without creating duplicates.
+     *
+     * @param {Pinnacle.AttachWebhookParams} request
+     * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.webhooks.attach({
+     *         senders: ["+14155551234", "agent_abc123"]
+     *     })
+     */
+    attach(request: Pinnacle.AttachWebhookParams, requestOptions?: Webhooks.RequestOptions): core.HttpResponsePromise<Pinnacle.AttachWebhookResult>;
+    private __attach;
+    /**
+     * Detach a webhook from one or more senders (phone numbers or RCS agent IDs) to stop receiving event notifications. <br>
+     *
+     * The webhook itself is not deleted and remains available for use with other senders. Works regardless of webhook status. Supports bulk operations with up to 50 senders per request.
+     *
+     * @param {Pinnacle.DetachWebhookParams} request
+     * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.webhooks.detach({
+     *         webhookId: "webhookId",
+     *         senders: ["+14155551234", "agent_abc123"]
+     *     })
+     */
+    detach(request: Pinnacle.DetachWebhookParams, requestOptions?: Webhooks.RequestOptions): core.HttpResponsePromise<Pinnacle.DetachWebhookResult>;
+    private __detach;
     protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
 }

package/dist/esm/api/resources/webhooks/client/Client.mjs

@@ -162,6 +162,163 @@ export class Webhooks {
             }
         });
     }
+    /**
+     * Attach a webhook to one or more senders (phone numbers or RCS agent IDs) to receive real-time event notifications. <br>
+     *
+     * You can attach an existing webhook by providing its ID, or create a new webhook by specifying a name and URL. Supports bulk operations with up to 50 senders per request. <br>
+     *
+     * Subscriptions are additive — attaching new senders does not remove existing ones. Re-attaching the same sender updates the event type filter without creating duplicates.
+     *
+     * @param {Pinnacle.AttachWebhookParams} request
+     * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.webhooks.attach({
+     *         senders: ["+14155551234", "agent_abc123"]
+     *     })
+     */
+    attach(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__attach(request, requestOptions));
+    }
+    __attach(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _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, "webhooks/attach"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            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);
+                    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 /webhooks/attach.");
+                case "unknown":
+                    throw new errors.PinnacleError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Detach a webhook from one or more senders (phone numbers or RCS agent IDs) to stop receiving event notifications. <br>
+     *
+     * The webhook itself is not deleted and remains available for use with other senders. Works regardless of webhook status. Supports bulk operations with up to 50 senders per request.
+     *
+     * @param {Pinnacle.DetachWebhookParams} request
+     * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.webhooks.detach({
+     *         webhookId: "webhookId",
+     *         senders: ["+14155551234", "agent_abc123"]
+     *     })
+     */
+    detach(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__detach(request, requestOptions));
+    }
+    __detach(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _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, "webhooks/detach"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            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);
+                    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 /webhooks/detach.");
+                case "unknown":
+                    throw new errors.PinnacleError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     _getCustomAuthorizationHeaders() {
         return __awaiter(this, void 0, void 0, function* () {
             const apiKeyValue = yield core.Supplier.get(this._options.apiKey);

package/dist/esm/api/resources/webhooks/client/requests/AttachWebhookParams.d.mts

@@ -0,0 +1,23 @@
+import type * as Pinnacle from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         senders: ["+14155551234", "agent_abc123"]
+ *     }
+ */
+export interface AttachWebhookParams {
+    /** Array of senders to attach the webhook to. Can be phone numbers in E.164 format or RCS agent IDs. */
+    senders: string[];
+    /** Existing webhook ID (starts with `wh_`). Provide this OR `name` + `url` to create a new webhook. The webhook must be in ENABLED status. Disabled webhooks can be re-enabled from the [dashboard](https://app.pinnacle.sh/dashboard/development/webhooks). */
+    webhookId?: string;
+    /** Name for a new webhook (required if no `webhookId`). */
+    name?: string;
+    /** HTTPS endpoint URL for a new webhook (required if no `webhookId`). */
+    url?: string;
+    /**
+     * Event type filter for the subscription. Set to `null` to receive all events. <br>
+     *
+     * `USER.TYPING` is only supported for RCS agent senders, not phone numbers.
+     */
+    event?: Pinnacle.WebhookEventEnum | null;
+}

package/dist/esm/api/resources/webhooks/client/requests/DetachWebhookParams.d.mts

@@ -0,0 +1,13 @@
+/**
+ * @example
+ *     {
+ *         webhookId: "webhookId",
+ *         senders: ["+14155551234", "agent_abc123"]
+ *     }
+ */
+export interface DetachWebhookParams {
+    /** Webhook ID to detach (starts with `wh_`). Must be a webhook owned by your team. */
+    webhookId: string;
+    /** Array of senders to detach the webhook from. Can be phone numbers in E.164 format or RCS agent IDs. */
+    senders: string[];
+}

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

@@ -1,2 +1,4 @@
+export type { AttachWebhookParams } from "./AttachWebhookParams.mjs";
+export type { DetachWebhookParams } from "./DetachWebhookParams.mjs";
 export type { GetWebhookParams } from "./GetWebhookParams.mjs";
 export type { ListWebhooksParams } from "./ListWebhooksParams.mjs";

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

@@ -0,0 +1,22 @@
+import type * as Pinnacle from "../index.mjs";
+export interface AttachWebhookResult {
+    webhook: AttachWebhookResult.Webhook;
+    /** The event type filter applied to these subscriptions. */
+    event: Pinnacle.WebhookEventEnum | null;
+    /** Senders that were successfully attached (phone numbers in E.164 format or RCS agent IDs). */
+    senders: string[];
+    /** Senders that could not be attached, with error details. */
+    failed: Pinnacle.FailedSender[];
+}
+export declare namespace AttachWebhookResult {
+    interface Webhook {
+        /** Unique webhook identifier (starts with `wh_`). */
+        id: string;
+        /** Name of the webhook. */
+        name: string;
+        /** HTTPS endpoint URL where events are delivered. */
+        url: string;
+        /** Signing secret sent in the `PINNACLE-SIGNING-SECRET` header for request verification. */
+        secret: string;
+    }
+}

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

@@ -4,7 +4,24 @@ export interface BaseRichMessage {
     from: string;
     fallback?: Pinnacle.FallbackMessage;
     /** Configure how your RCS message is sent and tracked. */
-    options?: Pinnacle.SendRichMessageOptions;
+    options?: BaseRichMessage.Options;
     /** Recipient's phone number in E.164 format. */
     to: string;
 }
+export declare namespace BaseRichMessage {
+    /**
+     * Configure how your RCS message is sent and tracked.
+     */
+    interface Options {
+        schedule?: Pinnacle.MessageSchedule;
+        tracking?: Pinnacle.Tracking;
+        /** Media files and card media will be transcoded to a supported RCS format. This adds a small delay to sending the message. Ignored for rich text messages. */
+        transcode?: boolean;
+        /**
+         * Validate your message for any unsupported files. <br>
+         *
+         * If failed, errors will be thrown and the message will not send.
+         */
+        validate?: boolean;
+    }
+}

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

@@ -0,0 +1,9 @@
+import type * as Pinnacle from "../index.mjs";
+export interface DetachWebhookResult {
+    /** The webhook that was detached from the senders. */
+    webhookId: string;
+    /** Senders that were successfully detached (phone numbers in E.164 format or RCS agent IDs). */
+    senders: string[];
+    /** Senders that could not be detached, with error details. */
+    failed: Pinnacle.FailedSender[];
+}

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

@@ -1,9 +1,9 @@
 import type * as Pinnacle from "../index.mjs";
 export interface ExtendedBrandWithVetting extends Pinnacle.ExtendedBrand {
     /** ISO 8601 formatted timestamp of the last TCR vetting. */
-    lastTcrVettingDate: string | null;
+    lastTcrVettingDate: string;
     /** Feedback from The Campaign Registry if TCR vetting was performed. */
-    tcrFeedback: Pinnacle.VettingFeedback[] | null;
+    tcrFeedback: Pinnacle.VettingFeedback[];
     /** History of all external vetting attempts for this brand. */
     vettingHistory: Pinnacle.VettingHistory[];
 }

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

@@ -13,21 +13,15 @@ export interface ExtendedRcsCampaign {
     /** Legal documentation links. */
     links?: ExtendedRcsCampaign.Links;
     status: Pinnacle.ProfileStatusEnum;
-    /** Use case classification for the campaign. */
-    useCase?: ExtendedRcsCampaign.UseCase;
-    /** Details on how opt-in is acquired. If it is done through a website or app, provide the link. See the [Opt-In Terms and Conditions](/guides/campaigns/rcs-compliance#opt-in-terms-and-conditions) section for requirements. */
-    optInTermsAndConditions?: string;
+    /** Detailed summary of what the brand is and how this agent will be used. See the [Use Case Behavior](/guides/campaigns/rcs-compliance#use-case-behavior) section for requirements. */
+    useCaseDescription?: string;
     messagingType?: Pinnacle.RcsMessagingTypeEnum;
-    /** Description of the agent's purpose, shown to carriers for approval. See the [Carrier Description](/guides/campaigns/rcs-compliance#carrier-description) section for requirements. */
-    carrierDescription?: string;
+    /** URL to the opt-in form or a URL to a screenshot of the opt-in CTA. */
+    ctaMedia?: string;
+    /** Details on how opt-in is acquired. If it is done through a website or app, provide the link. See the [Opt-In Method](/guides/campaigns/rcs-compliance#opt-in-method) section for requirements. */
+    optInMethod?: string;
     keywords?: ExtendedRcsCampaign.Keywords;
     traffic?: ExtendedRcsCampaign.Traffic;
-    /** Explanation of how the agent is triggered. This includes how the first message is delivered, whether messages follow a schedule or triggered by user actions, and any external triggers. See the [Agent Triggers](/guides/campaigns/rcs-compliance#agent-triggers) section for requirements. */
-    agentTriggers?: string;
-    /** Description of all agent interactions, including primary and secondary use cases. See the [Interaction Description](/guides/campaigns/rcs-compliance#interaction-description) section for requirements. */
-    interactionDescription?: string;
-    /** Whether the agent supports conversational flows or respond to P2A messages from the users. Set to false for one-way messages from agent to user. */
-    isConversational?: boolean;
     /** Required text that appears next to the opt-in checkbox for your opt-in form. This checkbox has to be unchecked by default. See the [CTA Language](/guides/campaigns/rcs-compliance#cta-language-opt-in-disclosure) section for requirements. */
     ctaLanguage?: string;
     /** Instructions on how an external reviewer can trigger messages and an example flow from the agent. This is usually an inbound text message to the agent that will start a flow of messages between the agent and the user. See the [Demo Trigger](/guides/campaigns/rcs-compliance#demo-trigger) section for requirements. */
@@ -93,14 +87,6 @@ export declare namespace ExtendedRcsCampaign {
         /** Terms of service URL. */
         termsOfService?: string;
     }
-    /**
-     * Use case classification for the campaign.
-     */
-    interface UseCase {
-        /** Detailed summary of what the brand is and how this agent will be used. See the [Use Case Behavior](/guides/campaigns/rcs-compliance#use-case-behavior) section for requirements. */
-        behavior?: string;
-        value?: Pinnacle.RcsCampaignUseCaseEnum;
-    }
     interface Keywords {
         HELP?: Keywords.Help;
         OPT_IN?: Keywords.OptIn;

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

@@ -0,0 +1,6 @@
+export interface FailedSender {
+    /** The sender that failed. */
+    sender: string;
+    /** Reason for the failure. */
+    error: string;
+}

package/dist/esm/api/types/FailedSender.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -8,21 +8,15 @@ export interface RcsCampaign {
     expectedAgentResponses?: string[];
     /** Legal documentation links. */
     links?: RcsCampaign.Links;
-    /** Use case classification for the campaign. */
-    useCase?: RcsCampaign.UseCase;
-    /** Details on how opt-in is acquired. If it is done through a website or app, provide the link. See the [Opt-In Terms and Conditions](/guides/campaigns/rcs-compliance#opt-in-terms-and-conditions) section for requirements. */
-    optInTermsAndConditions?: string;
+    /** Detailed summary of what the brand is and how this agent will be used. See the [Use Case Behavior](/guides/campaigns/rcs-compliance#use-case-behavior) section for requirements. */
+    useCaseDescription?: string;
     messagingType?: Pinnacle.RcsMessagingTypeEnum;
-    /** Description of the agent's purpose, shown to carriers for approval. See the [Carrier Description](/guides/campaigns/rcs-compliance#carrier-description) section for requirements. */
-    carrierDescription?: string;
+    /** URL to the opt-in form or a URL to a screenshot of the opt-in CTA. */
+    ctaMedia?: string;
+    /** Details on how opt-in is acquired. If it is done through a website or app, provide the link. See the [Opt-In Method](/guides/campaigns/rcs-compliance#opt-in-method) section for requirements. */
+    optInMethod?: string;
     keywords?: RcsCampaign.Keywords;
     traffic?: RcsCampaign.Traffic;
-    /** Explanation of how the agent is triggered. This includes how the first message is delivered, whether messages follow a schedule or triggered by user actions, and any external triggers. See the [Agent Triggers](/guides/campaigns/rcs-compliance#agent-triggers) section for requirements. */
-    agentTriggers?: string;
-    /** Description of all agent interactions, including primary and secondary use cases. See the [Interaction Description](/guides/campaigns/rcs-compliance#interaction-description) section for requirements. */
-    interactionDescription?: string;
-    /** Whether the agent supports conversational flows or respond to P2A messages from the users. Set to false for one-way messages from agent to user. */
-    isConversational?: boolean;
     /** Required text that appears next to the opt-in checkbox for your opt-in form. This checkbox has to be unchecked by default. See the [CTA Language](/guides/campaigns/rcs-compliance#cta-language-opt-in-disclosure) section for requirements. */
     ctaLanguage?: string;
     /** Instructions on how an external reviewer can trigger messages and an example flow from the agent. This is usually an inbound text message to the agent that will start a flow of messages between the agent and the user. See the [Demo Trigger](/guides/campaigns/rcs-compliance#demo-trigger) section for requirements. */
@@ -88,14 +82,6 @@ export declare namespace RcsCampaign {
         /** Terms of service URL. */
         termsOfService?: string;
     }
-    /**
-     * Use case classification for the campaign.
-     */
-    interface UseCase {
-        /** Detailed summary of what the brand is and how this agent will be used. See the [Use Case Behavior](/guides/campaigns/rcs-compliance#use-case-behavior) section for requirements. */
-        behavior?: string;
-        value?: Pinnacle.RcsCampaignUseCaseEnum;
-    }
     interface Keywords {
         HELP?: Keywords.Help;
         OPT_IN?: Keywords.OptIn;

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

@@ -7,8 +7,6 @@ export interface RcsCampaignSummary {
     status: RcsCampaignSummary.Status;
     /** Brand ID associated with this campaign. */
     brandId?: string;
-    /** Primary use case for this campaign. */
-    useCase?: string;
     /** RCS agent ID associated with this campaign. */
     agentId?: string;
     /** ISO 8601 timestamp of when the campaign was created. */

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

@@ -14,7 +14,7 @@ export interface RcsCardsContent {
      * List of interactive quick reply buttons in the message. <br><br>
      * **Limit:** 10 max
      */
-    quickReplies: Pinnacle.RichButton[];
+    quickReplies?: Pinnacle.RichButton[];
 }
 export declare namespace RcsCardsContent {
     type Cards = Cards.Item[];

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

@@ -10,5 +10,5 @@ export interface RcsMediaContent {
      * List of interactive quick reply buttons in the message. <br><br>
      * **Limit:** 10 max
      */
-    quickReplies: Pinnacle.RichButton[];
+    quickReplies?: Pinnacle.RichButton[];
 }

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

@@ -9,7 +9,7 @@ Pinnacle.RichText
  * See [supported media types](https://app.pinnacle.sh/supported-file-types?type=RCS-MEDIA). */
  | {
     media: string;
-    quickReplies: Pinnacle.RichButton[];
+    quickReplies?: Pinnacle.RichButton[] | undefined;
 }
 /**
  * Message containing cards, each with its own title, subtitle, and/or buttons. Quick replies can also be added. <br>

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

@@ -14,7 +14,7 @@ export interface RichCards {
      * List of interactive quick reply buttons in the message. <br><br>
      * **Limit:** 10 max
      */
-    quickReplies: Pinnacle.RichButton[];
+    quickReplies?: Pinnacle.RichButton[];
 }
 export declare namespace RichCards {
     type Cards = Cards.Item[];

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

@@ -1,5 +1,6 @@
 import type * as Pinnacle from "../index.mjs";
 export interface RichCardsMessage extends Pinnacle.RichCards {
+    /** Configure how your RCS message is sent and tracked. */
     options?: RichCardsMessage.Options;
     /** Your RCS agent ID which must be prefixed with 'agent_'. */
     from: string;
@@ -8,7 +9,20 @@ export interface RichCardsMessage extends Pinnacle.RichCards {
     to: string;
 }
 export declare namespace RichCardsMessage {
-    interface Options extends Pinnacle.SendRichMessageOptions {
+    /**
+     * Configure how your RCS message is sent and tracked.
+     */
+    interface Options {
+        schedule?: Pinnacle.MessageSchedule;
+        tracking?: Pinnacle.Tracking;
+        /** Media files and card media will be transcoded to a supported RCS format. This adds a small delay to sending the message. Ignored for rich text messages. */
+        transcode?: boolean;
+        /**
+         * Validate your message for any unsupported files. <br>
+         *
+         * If failed, errors will be thrown and the message will not send.
+         */
+        validate?: boolean;
         /**
          * Configure standalone card layout options for enhanced visual presentation.
          *

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

@@ -10,5 +10,5 @@ export interface RichMediaMessage extends Pinnacle.BaseRichMessage {
      * List of interactive quick reply buttons in the message. <br>
      * `≤10`
      */
-    quickReplies: Pinnacle.RichButton[];
+    quickReplies?: Pinnacle.RichButton[];
 }

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

@@ -7,7 +7,7 @@ export interface RichText {
      * List of interactive quick reply buttons in the message. <br><br>
      * **Limit:** 10 max
      */
-    quickReplies: Pinnacle.RichButton[];
+    quickReplies?: Pinnacle.RichButton[];
     /** Text content of the RCS message. */
     text: string;
 }

package/dist/esm/api/types/{SendRichMessageOptions.d.mts → SendRichMessageOptions4.d.mts}

@@ -2,7 +2,7 @@ import type * as Pinnacle from "../index.mjs";
 /**
  * Configure how your RCS message is sent and tracked.
  */
-export interface SendRichMessageOptions {
+export interface SendRichMessageOptions4 {
     schedule?: Pinnacle.MessageSchedule;
     tracking?: Pinnacle.Tracking;
     /** Media files and card media will be transcoded to a supported RCS format. This adds a small delay to sending the message. Ignored for rich text messages. */

package/dist/esm/api/types/SendRichMessageOptions4.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -4,7 +4,7 @@ import type * as Pinnacle from "../index.mjs";
  */
 export interface SentRichMessageFallbackMms extends Pinnacle.SentMmsDetails {
     /** Indicates that the fallback MMS was sent because the recipient does not support RCS. */
-    fallbackSent: boolean;
+    fallbackSent: true;
     /** Unique identifier of the original RCS message that triggered this fallback. Always begins with the prefix `msg_`. This is the RCS message that could not be delivered — the `messageIds` field on this response refers to the actual MMS message(s) that were sent as the fallback. */
     originalMessageId: string;
 }

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

@@ -4,7 +4,7 @@ import type * as Pinnacle from "../index.mjs";
  */
 export interface SentRichMessageFallbackSms extends Pinnacle.SentSmsDetails {
     /** Indicates that the fallback SMS was sent because the recipient does not support RCS. */
-    fallbackSent: boolean;
+    fallbackSent: true;
     /** Unique identifier of the original RCS message that triggered this fallback. Always begins with the prefix `msg_`. This is the RCS message that could not be delivered — the `messageId` field on this response refers to the actual SMS that was sent as the fallback. */
     originalMessageId: string;
 }

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

@@ -3,5 +3,5 @@
  */
 export interface SuccessfulConversationUpdate {
     /** Indicates the operation was successful. */
-    success: boolean;
+    success: true;
 }

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

@@ -1,5 +1,5 @@
 import type * as Pinnacle from "../index.mjs";
 export interface VcardContent extends Pinnacle.Vcard {
     /** ISO 8601 timestamp of last vCard update. */
-    revision?: string;
+    revision: string;
 }