rcs-js 2.0.14 → 2.0.16

package/dist/cjs/api/types/ExtendedRcsCampaign.d.ts

@@ -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/cjs/api/types/FailedSender.d.ts

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

package/dist/cjs/api/types/FailedSender.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/RcsCampaign.d.ts

@@ -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/cjs/api/types/RcsCampaignSummary.d.ts

@@ -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/cjs/api/types/RcsCardsContent.d.ts

@@ -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/cjs/api/types/RcsMediaContent.d.ts

@@ -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/cjs/api/types/RcsValidateContent.d.ts

@@ -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/cjs/api/types/RichCards.d.ts

@@ -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/cjs/api/types/RichCardsMessage.d.ts

@@ -1,5 +1,6 @@
 import type * as Pinnacle from "../index.js";
 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/cjs/api/types/RichMediaMessage.d.ts

@@ -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/cjs/api/types/RichText.d.ts

@@ -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/cjs/api/types/{SendRichMessageOptions.d.ts → SendRichMessageOptions4.d.ts}

@@ -2,7 +2,7 @@ import type * as Pinnacle from "../index.js";
 /**
  * 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/cjs/api/types/SendRichMessageOptions4.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/SentRichMessageFallbackMms.d.ts

@@ -4,7 +4,7 @@ import type * as Pinnacle from "../index.js";
  */
 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/cjs/api/types/SentRichMessageFallbackSms.d.ts

@@ -4,7 +4,7 @@ import type * as Pinnacle from "../index.js";
  */
 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/cjs/api/types/SuccessfulConversationUpdate.d.ts

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

package/dist/cjs/api/types/VcardContent.d.ts

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

package/dist/cjs/api/types/WebhookEventEnum.d.ts

@@ -1,10 +1,11 @@
 /**
- * Types of events that can trigger webhook notifications for phone numbers.
- * Subscribe to specific events to receive real-time updates about your phone number activity.
+ * Types of events that can trigger webhook notifications.
+ * Subscribe to specific events to receive real-time updates about your sender activity.
  * Use `null` to listen to all events.
  */
 export declare const WebhookEventEnum: {
     readonly MessageStatus: "MESSAGE.STATUS";
     readonly MessageReceived: "MESSAGE.RECEIVED";
+    readonly UserTyping: "USER.TYPING";
 };
 export type WebhookEventEnum = (typeof WebhookEventEnum)[keyof typeof WebhookEventEnum];

package/dist/cjs/api/types/WebhookEventEnum.js

@@ -3,11 +3,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebhookEventEnum = void 0;
 /**
- * Types of events that can trigger webhook notifications for phone numbers.
- * Subscribe to specific events to receive real-time updates about your phone number activity.
+ * Types of events that can trigger webhook notifications.
+ * Subscribe to specific events to receive real-time updates about your sender activity.
  * Use `null` to listen to all events.
  */
 exports.WebhookEventEnum = {
     MessageStatus: "MESSAGE.STATUS",
     MessageReceived: "MESSAGE.RECEIVED",
+    UserTyping: "USER.TYPING",
 };

package/dist/cjs/api/types/index.d.ts

@@ -5,7 +5,7 @@ export * from "./AgentSummary.js";
 export * from "./AgentUseCase.js";
 export * from "./AgentWebsiteEntry.js";
 export * from "./AttachedPhoneNumberResult.js";
-export * from "./AttachWebhookParams.js";
+export * from "./AttachWebhookResult.js";
 export * from "./AudienceCountOnly.js";
 export * from "./AudienceSummary.js";
 export * from "./AudienceWithPagination.js";
@@ -29,7 +29,6 @@ export * from "./CarrierLaunchStatus.js";
 export * from "./CompanyEntityTypeEnum.js";
 export * from "./CompanySectorEnum.js";
 export * from "./CompanyTypeEnum.js";
-export * from "./ConfiguredWebhook.js";
 export * from "./Contact.js";
 export * from "./ContactId.js";
 export * from "./Conversation.js";
@@ -37,7 +36,7 @@ export * from "./ConversationList.js";
 export * from "./CreateUrlOptions.js";
 export * from "./DeleteAudienceResponse.js";
 export * from "./DetachedPhoneNumberResult.js";
-export * from "./DetachedWebhookInfo.js";
+export * from "./DetachWebhookResult.js";
 export * from "./DetailedPhoneNumberEnum.js";
 export * from "./DlcAssignmentStatusEnum.js";
 export * from "./DlcCampaignStatus.js";
@@ -50,6 +49,7 @@ export * from "./Error_.js";
 export * from "./ExtendedBrand.js";
 export * from "./ExtendedBrandWithVetting.js";
 export * from "./ExtendedRcsCampaign.js";
+export * from "./FailedSender.js";
 export * from "./FallbackMessage.js";
 export * from "./GetConversationParams.js";
 export * from "./LinkClickEvent.js";
@@ -119,7 +119,6 @@ export * from "./RcsButtonTrigger.js";
 export * from "./RcsCampaign.js";
 export * from "./RcsCampaignStatus.js";
 export * from "./RcsCampaignSummary.js";
-export * from "./RcsCampaignUseCaseEnum.js";
 export * from "./RcsCapabilitiesResult.js";
 export * from "./RcsCapability.js";
 export * from "./RcsCardsContent.js";
@@ -145,7 +144,7 @@ export * from "./ScheduledBlastDetails.js";
 export * from "./ScheduledMessage.js";
 export * from "./ScheduledMessageSummary.js";
 export * from "./Sender.js";
-export * from "./SendRichMessageOptions.js";
+export * from "./SendRichMessageOptions4.js";
 export * from "./SendTypingIndicatorResponse.js";
 export * from "./SentMmsDetails.js";
 export * from "./SentRichMessage.js";

package/dist/cjs/api/types/index.js

@@ -21,7 +21,7 @@ __exportStar(require("./AgentSummary.js"), exports);
 __exportStar(require("./AgentUseCase.js"), exports);
 __exportStar(require("./AgentWebsiteEntry.js"), exports);
 __exportStar(require("./AttachedPhoneNumberResult.js"), exports);
-__exportStar(require("./AttachWebhookParams.js"), exports);
+__exportStar(require("./AttachWebhookResult.js"), exports);
 __exportStar(require("./AudienceCountOnly.js"), exports);
 __exportStar(require("./AudienceSummary.js"), exports);
 __exportStar(require("./AudienceWithPagination.js"), exports);
@@ -45,7 +45,6 @@ __exportStar(require("./CarrierLaunchStatus.js"), exports);
 __exportStar(require("./CompanyEntityTypeEnum.js"), exports);
 __exportStar(require("./CompanySectorEnum.js"), exports);
 __exportStar(require("./CompanyTypeEnum.js"), exports);
-__exportStar(require("./ConfiguredWebhook.js"), exports);
 __exportStar(require("./Contact.js"), exports);
 __exportStar(require("./ContactId.js"), exports);
 __exportStar(require("./Conversation.js"), exports);
@@ -53,7 +52,7 @@ __exportStar(require("./ConversationList.js"), exports);
 __exportStar(require("./CreateUrlOptions.js"), exports);
 __exportStar(require("./DeleteAudienceResponse.js"), exports);
 __exportStar(require("./DetachedPhoneNumberResult.js"), exports);
-__exportStar(require("./DetachedWebhookInfo.js"), exports);
+__exportStar(require("./DetachWebhookResult.js"), exports);
 __exportStar(require("./DetailedPhoneNumberEnum.js"), exports);
 __exportStar(require("./DlcAssignmentStatusEnum.js"), exports);
 __exportStar(require("./DlcCampaignStatus.js"), exports);
@@ -66,6 +65,7 @@ __exportStar(require("./Error_.js"), exports);
 __exportStar(require("./ExtendedBrand.js"), exports);
 __exportStar(require("./ExtendedBrandWithVetting.js"), exports);
 __exportStar(require("./ExtendedRcsCampaign.js"), exports);
+__exportStar(require("./FailedSender.js"), exports);
 __exportStar(require("./FallbackMessage.js"), exports);
 __exportStar(require("./GetConversationParams.js"), exports);
 __exportStar(require("./LinkClickEvent.js"), exports);
@@ -135,7 +135,6 @@ __exportStar(require("./RcsButtonTrigger.js"), exports);
 __exportStar(require("./RcsCampaign.js"), exports);
 __exportStar(require("./RcsCampaignStatus.js"), exports);
 __exportStar(require("./RcsCampaignSummary.js"), exports);
-__exportStar(require("./RcsCampaignUseCaseEnum.js"), exports);
 __exportStar(require("./RcsCapabilitiesResult.js"), exports);
 __exportStar(require("./RcsCapability.js"), exports);
 __exportStar(require("./RcsCardsContent.js"), exports);
@@ -161,7 +160,7 @@ __exportStar(require("./ScheduledBlastDetails.js"), exports);
 __exportStar(require("./ScheduledMessage.js"), exports);
 __exportStar(require("./ScheduledMessageSummary.js"), exports);
 __exportStar(require("./Sender.js"), exports);
-__exportStar(require("./SendRichMessageOptions.js"), exports);
+__exportStar(require("./SendRichMessageOptions4.js"), exports);
 __exportStar(require("./SendTypingIndicatorResponse.js"), exports);
 __exportStar(require("./SentMmsDetails.js"), exports);
 __exportStar(require("./SentRichMessage.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.0.14";
+export declare const SDK_VERSION = "2.0.16";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "2.0.14";
+exports.SDK_VERSION = "2.0.16";

package/dist/esm/Client.mjs

@@ -17,8 +17,8 @@ export class PinnacleClient {
         this._options = Object.assign(Object.assign({}, _options), { logging: core.logging.createLogger(_options === null || _options === void 0 ? void 0 : _options.logging), headers: mergeHeaders({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "rcs-js",
-                "X-Fern-SDK-Version": "2.0.14",
-                "User-Agent": "rcs-js/2.0.14",
+                "X-Fern-SDK-Version": "2.0.16",
+                "User-Agent": "rcs-js/2.0.16",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

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

@@ -109,16 +109,13 @@ export declare class Rcs {
      *         campaignId: "rcs_1234567890",
      *         expectedAgentResponses: ["Here are the things I can help you with.", "I can assist you with booking an appointment, or you may choose to book manually.", "Here are the available times to connect with a representative tomorrow.", "Your appointment has been scheduled."],
      *         links: {
-     *             privacyPolicy: "https://www.trypinnacle.app/privacy",
-     *             termsOfService: "https://www.trypinnacle.app/terms"
+     *             privacyPolicy: "\u201Chttps://www.trypinnacle.app/privacy\u201D",
+     *             termsOfService: "\u201Chttps://www.trypinnacle.app/terms\u201D"
      *         },
-     *         useCase: {
-     *             behavior: "Pinnacle is a developer-focused RCS assistant that helps teams design, test, and optimize rich messaging experiences across SMS, MMS, and RCS. The agent acts as both an \u201Conboarding guide\u201D for new customers and a \u201Cbest-practices coach\u201D for existing teams exploring higher-value RCS workflows like rich cards, carousels, and suggested actions.<br>\nThe agent delivers a mix of operational updates and educational content (2\u20136 messages/month). Content includes important platform notices (e.g., deliverability or throughput changes), implementation tips with sample RCS templates, and personalized recommendations on how to upgrade existing SMS campaigns into richer, higher-converting RCS conversations.\n",
-     *             value: "OTHER"
-     *         },
-     *         optInTermsAndConditions: "We ensure consent through an explicit opt-in process that follows 10DLC best practices.Users must agree to receive messages from Pinnacle before the agent sends them any messages.<br>\nUsers agree to these messages by signing an opt-in paper form that they can be found online at https://www.pinnacle.sh/opt-in. We only send messages once users have filled out the form and submitted it to us via email or through the dashboard.\n",
-     *         messagingType: "MULTI_USE",
-     *         carrierDescription: "Demonstrate the power of RCS to medium and large companies already sending massive SMS/MMS volumes through our platform. These clients send conversational messages in industries such as commerce, appointments, and customer support.",
+     *         useCaseDescription: "Pinnacle is a developer-focused RCS assistant that helps teams design, test, and optimize rich messaging experiences across SMS, MMS, and RCS. The agent acts as both an \u201Conboarding guide\u201D for new customers and a \u201Cbest-practices coach\u201D for existing teams exploring higher-value RCS workflows like rich cards, carousels, and suggested actions.<br>\nThe agent delivers a mix of operational updates and educational content (2\u20136 messages/month). Content includes important platform notices (e.g., deliverability or throughput changes), implementation tips with sample RCS templates, and personalized recommendations on how to upgrade existing SMS campaigns into richer, higher-converting RCS conversations.\n",
+     *         messagingType: "OTP",
+     *         ctaMedia: "\u201Chttps://www.pinnacle.sh/send\u201D",
+     *         optInMethod: "We ensure consent through an explicit opt-in process that follows 10DLC best practices.Users must agree to receive messages from Pinnacle before the agent sends them any messages.<br>\nUsers agree to these messages by signing an opt-in paper form that they can be found online at https://www.pinnacle.sh/opt-in. We only send messages once users have filled out the form and submitted it to us via email or through the dashboard.\n",
      *         keywords: {
      *             HELP: {
      *                 message: "Email founders@trypinnacle.app for support.",
@@ -137,9 +134,6 @@ export declare class Rcs {
      *             monthlyWebsite: 10000,
      *             monthlyRcsEstimate: 10000
      *         },
-     *         agentTriggers: "The agent sends the first message when the user subscribes to Pinnacle. Messages are based on user actions such as pressing suggestion buttons. External triggers such as reminders can be setup by users in advance for a later time.",
-     *         interactionDescription: "The agent's primary interaction will be customer service \u2014 helping users with questions, troubleshooting issues, and providing quick assistance through chat. Other interactions include appointment management and sending notifications to the user.",
-     *         isConversational: true,
      *         ctaLanguage: "By checking this box and submitting this form, you consent to receive transactional text messages for support, appointment, and reminder messages from Pinnacle Software Development Inc. Reply STOP to opt out. Reply HELP for help. Standard message and data rates may apply. Message frequency may vary. View our Terms and Conditions at https://www.pinnacle.sh/terms. View our Privacy Policy at https://www.pinnacle.sh/privacy.",
      *         demoTrigger: "Text \"START\" to trigger the flow."
      *     })

package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.mjs

@@ -290,16 +290,13 @@ export class Rcs {
      *         campaignId: "rcs_1234567890",
      *         expectedAgentResponses: ["Here are the things I can help you with.", "I can assist you with booking an appointment, or you may choose to book manually.", "Here are the available times to connect with a representative tomorrow.", "Your appointment has been scheduled."],
      *         links: {
-     *             privacyPolicy: "https://www.trypinnacle.app/privacy",
-     *             termsOfService: "https://www.trypinnacle.app/terms"
+     *             privacyPolicy: "\u201Chttps://www.trypinnacle.app/privacy\u201D",
+     *             termsOfService: "\u201Chttps://www.trypinnacle.app/terms\u201D"
      *         },
-     *         useCase: {
-     *             behavior: "Pinnacle is a developer-focused RCS assistant that helps teams design, test, and optimize rich messaging experiences across SMS, MMS, and RCS. The agent acts as both an \u201Conboarding guide\u201D for new customers and a \u201Cbest-practices coach\u201D for existing teams exploring higher-value RCS workflows like rich cards, carousels, and suggested actions.<br>\nThe agent delivers a mix of operational updates and educational content (2\u20136 messages/month). Content includes important platform notices (e.g., deliverability or throughput changes), implementation tips with sample RCS templates, and personalized recommendations on how to upgrade existing SMS campaigns into richer, higher-converting RCS conversations.\n",
-     *             value: "OTHER"
-     *         },
-     *         optInTermsAndConditions: "We ensure consent through an explicit opt-in process that follows 10DLC best practices.Users must agree to receive messages from Pinnacle before the agent sends them any messages.<br>\nUsers agree to these messages by signing an opt-in paper form that they can be found online at https://www.pinnacle.sh/opt-in. We only send messages once users have filled out the form and submitted it to us via email or through the dashboard.\n",
-     *         messagingType: "MULTI_USE",
-     *         carrierDescription: "Demonstrate the power of RCS to medium and large companies already sending massive SMS/MMS volumes through our platform. These clients send conversational messages in industries such as commerce, appointments, and customer support.",
+     *         useCaseDescription: "Pinnacle is a developer-focused RCS assistant that helps teams design, test, and optimize rich messaging experiences across SMS, MMS, and RCS. The agent acts as both an \u201Conboarding guide\u201D for new customers and a \u201Cbest-practices coach\u201D for existing teams exploring higher-value RCS workflows like rich cards, carousels, and suggested actions.<br>\nThe agent delivers a mix of operational updates and educational content (2\u20136 messages/month). Content includes important platform notices (e.g., deliverability or throughput changes), implementation tips with sample RCS templates, and personalized recommendations on how to upgrade existing SMS campaigns into richer, higher-converting RCS conversations.\n",
+     *         messagingType: "OTP",
+     *         ctaMedia: "\u201Chttps://www.pinnacle.sh/send\u201D",
+     *         optInMethod: "We ensure consent through an explicit opt-in process that follows 10DLC best practices.Users must agree to receive messages from Pinnacle before the agent sends them any messages.<br>\nUsers agree to these messages by signing an opt-in paper form that they can be found online at https://www.pinnacle.sh/opt-in. We only send messages once users have filled out the form and submitted it to us via email or through the dashboard.\n",
      *         keywords: {
      *             HELP: {
      *                 message: "Email founders@trypinnacle.app for support.",
@@ -318,9 +315,6 @@ export class Rcs {
      *             monthlyWebsite: 10000,
      *             monthlyRcsEstimate: 10000
      *         },
-     *         agentTriggers: "The agent sends the first message when the user subscribes to Pinnacle. Messages are based on user actions such as pressing suggestion buttons. External triggers such as reminders can be setup by users in advance for a later time.",
-     *         interactionDescription: "The agent's primary interaction will be customer service \u2014 helping users with questions, troubleshooting issues, and providing quick assistance through chat. Other interactions include appointment management and sending notifications to the user.",
-     *         isConversational: true,
      *         ctaLanguage: "By checking this box and submitting this form, you consent to receive transactional text messages for support, appointment, and reminder messages from Pinnacle Software Development Inc. Reply STOP to opt out. Reply HELP for help. Standard message and data rates may apply. Message frequency may vary. View our Terms and Conditions at https://www.pinnacle.sh/terms. View our Privacy Policy at https://www.pinnacle.sh/privacy.",
      *         demoTrigger: "Text \"START\" to trigger the flow."
      *     })

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

@@ -25,16 +25,13 @@ import type * as Pinnacle from "../../../../../../index.mjs";
  *         campaignId: "rcs_1234567890",
  *         expectedAgentResponses: ["Here are the things I can help you with.", "I can assist you with booking an appointment, or you may choose to book manually.", "Here are the available times to connect with a representative tomorrow.", "Your appointment has been scheduled."],
  *         links: {
- *             privacyPolicy: "https://www.trypinnacle.app/privacy",
- *             termsOfService: "https://www.trypinnacle.app/terms"
+ *             privacyPolicy: "\u201Chttps://www.trypinnacle.app/privacy\u201D",
+ *             termsOfService: "\u201Chttps://www.trypinnacle.app/terms\u201D"
  *         },
- *         useCase: {
- *             behavior: "Pinnacle is a developer-focused RCS assistant that helps teams design, test, and optimize rich messaging experiences across SMS, MMS, and RCS. The agent acts as both an \u201Conboarding guide\u201D for new customers and a \u201Cbest-practices coach\u201D for existing teams exploring higher-value RCS workflows like rich cards, carousels, and suggested actions.<br>\nThe agent delivers a mix of operational updates and educational content (2\u20136 messages/month). Content includes important platform notices (e.g., deliverability or throughput changes), implementation tips with sample RCS templates, and personalized recommendations on how to upgrade existing SMS campaigns into richer, higher-converting RCS conversations.\n",
- *             value: "OTHER"
- *         },
- *         optInTermsAndConditions: "We ensure consent through an explicit opt-in process that follows 10DLC best practices.Users must agree to receive messages from Pinnacle before the agent sends them any messages.<br>\nUsers agree to these messages by signing an opt-in paper form that they can be found online at https://www.pinnacle.sh/opt-in. We only send messages once users have filled out the form and submitted it to us via email or through the dashboard.\n",
- *         messagingType: "MULTI_USE",
- *         carrierDescription: "Demonstrate the power of RCS to medium and large companies already sending massive SMS/MMS volumes through our platform. These clients send conversational messages in industries such as commerce, appointments, and customer support.",
+ *         useCaseDescription: "Pinnacle is a developer-focused RCS assistant that helps teams design, test, and optimize rich messaging experiences across SMS, MMS, and RCS. The agent acts as both an \u201Conboarding guide\u201D for new customers and a \u201Cbest-practices coach\u201D for existing teams exploring higher-value RCS workflows like rich cards, carousels, and suggested actions.<br>\nThe agent delivers a mix of operational updates and educational content (2\u20136 messages/month). Content includes important platform notices (e.g., deliverability or throughput changes), implementation tips with sample RCS templates, and personalized recommendations on how to upgrade existing SMS campaigns into richer, higher-converting RCS conversations.\n",
+ *         messagingType: "OTP",
+ *         ctaMedia: "\u201Chttps://www.pinnacle.sh/send\u201D",
+ *         optInMethod: "We ensure consent through an explicit opt-in process that follows 10DLC best practices.Users must agree to receive messages from Pinnacle before the agent sends them any messages.<br>\nUsers agree to these messages by signing an opt-in paper form that they can be found online at https://www.pinnacle.sh/opt-in. We only send messages once users have filled out the form and submitted it to us via email or through the dashboard.\n",
  *         keywords: {
  *             HELP: {
  *                 message: "Email founders@trypinnacle.app for support.",
@@ -53,9 +50,6 @@ import type * as Pinnacle from "../../../../../../index.mjs";
  *             monthlyWebsite: 10000,
  *             monthlyRcsEstimate: 10000
  *         },
- *         agentTriggers: "The agent sends the first message when the user subscribes to Pinnacle. Messages are based on user actions such as pressing suggestion buttons. External triggers such as reminders can be setup by users in advance for a later time.",
- *         interactionDescription: "The agent's primary interaction will be customer service \u2014 helping users with questions, troubleshooting issues, and providing quick assistance through chat. Other interactions include appointment management and sending notifications to the user.",
- *         isConversational: true,
  *         ctaLanguage: "By checking this box and submitting this form, you consent to receive transactional text messages for support, appointment, and reminder messages from Pinnacle Software Development Inc. Reply STOP to opt out. Reply HELP for help. Standard message and data rates may apply. Message frequency may vary. View our Terms and Conditions at https://www.pinnacle.sh/terms. View our Privacy Policy at https://www.pinnacle.sh/privacy.",
  *         demoTrigger: "Text \"START\" to trigger the flow."
  *     }
@@ -74,21 +68,15 @@ export interface UpsertRcsCampaignParams {
     expectedAgentResponses?: string[];
     /** Legal documentation links. */
     links?: UpsertRcsCampaignParams.Links;
-    /** Use case classification for the campaign. */
-    useCase?: UpsertRcsCampaignParams.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?: UpsertRcsCampaignParams.Keywords;
     traffic?: UpsertRcsCampaignParams.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. */
@@ -175,14 +163,6 @@ export declare namespace UpsertRcsCampaignParams {
         /** 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/resources/messages/resources/rcs/client/Client.d.mts

@@ -28,11 +28,6 @@ export declare class Rcs {
      *
      * @example
      *     await client.messages.rcs.send({
-     *         quickReplies: [{
-     *                 type: "openUrl",
-     *                 payload: "payload",
-     *                 title: "title"
-     *             }],
      *         text: "text",
      *         from: "from",
      *         to: "to"
@@ -84,11 +79,6 @@ export declare class Rcs {
      *
      * @example
      *     await client.messages.rcs.validate({
-     *         quickReplies: [{
-     *                 type: "openUrl",
-     *                 payload: "payload",
-     *                 title: "title"
-     *             }],
      *         text: "text"
      *     })
      */

package/dist/esm/api/resources/messages/resources/rcs/client/Client.mjs

@@ -35,11 +35,6 @@ export class Rcs {
      *
      * @example
      *     await client.messages.rcs.send({
-     *         quickReplies: [{
-     *                 type: "openUrl",
-     *                 payload: "payload",
-     *                 title: "title"
-     *             }],
      *         text: "text",
      *         from: "from",
      *         to: "to"
@@ -218,11 +213,6 @@ export class Rcs {
      *
      * @example
      *     await client.messages.rcs.validate({
-     *         quickReplies: [{
-     *                 type: "openUrl",
-     *                 payload: "payload",
-     *                 title: "title"
-     *             }],
      *         text: "text"
      *     })
      */