rcs-js 2.0.14 → 2.0.16

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

@@ -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/esm/api/types/WebhookEventEnum.mjs

@@ -1,10 +1,11 @@
 // This file was auto-generated by Fern from our API Definition.
 /**
- * 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 const WebhookEventEnum = {
     MessageStatus: "MESSAGE.STATUS",
     MessageReceived: "MESSAGE.RECEIVED",
+    UserTyping: "USER.TYPING",
 };

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

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

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

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

package/dist/esm/version.d.mts

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

package/dist/esm/version.mjs

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "rcs-js",
-    "version": "2.0.14",
+    "version": "2.0.16",
     "private": false,
     "repository": "github:pinnacle-dev/rcs-js",
     "type": "commonjs",

package/reference.md

@@ -2172,6 +2172,143 @@ await client.webhooks.list();
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">attach</a>({ ...params }) -> Pinnacle.AttachWebhookResult</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.webhooks.attach({
+    senders: ["+14155551234", "agent_abc123"]
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pinnacle.AttachWebhookParams` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Webhooks.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">detach</a>({ ...params }) -> Pinnacle.DetachWebhookResult</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.webhooks.detach({
+    webhookId: "webhookId",
+    senders: ["+14155551234", "agent_abc123"]
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pinnacle.DetachWebhookParams` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Webhooks.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -3429,16 +3566,13 @@ await client.campaigns.rcs.upsert({
     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"
-    },
-    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"
+        privacyPolicy: "\u201Chttps://www.trypinnacle.app/privacy\u201D",
+        termsOfService: "\u201Chttps://www.trypinnacle.app/terms\u201D"
     },
-    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.",
@@ -3457,9 +3591,6 @@ await client.campaigns.rcs.upsert({
         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."
 });
@@ -3930,11 +4061,6 @@ Requires an active RCS agent and recipient devices that support RCS Business Mes
 
 ```typescript
 await client.messages.rcs.send({
-    quickReplies: [{
-            type: "openUrl",
-            payload: "payload",
-            title: "title"
-        }],
     text: "text",
     from: "from",
     to: "to"
@@ -4078,11 +4204,6 @@ Validate RCS message content without sending it.
 
 ```typescript
 await client.messages.rcs.validate({
-    quickReplies: [{
-            type: "openUrl",
-            payload: "payload",
-            title: "title"
-        }],
     text: "text"
 });
 
@@ -4547,166 +4668,6 @@ await client.messages.blasts.list();
 </dl>
 
 
-</dd>
-</dl>
-</details>
-
-## PhoneNumbers Webhook
-<details><summary><code>client.phoneNumbers.webhook.<a href="/src/api/resources/phoneNumbers/resources/webhook/client/Client.ts">attach</a>(phone, { ...params }) -> Pinnacle.ConfiguredWebhook</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Connect a webhook to your phone number to receive real-time notifications for incoming messages, delivery status updates, and other communication events.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.phoneNumbers.webhook.attach("%2B14155551234", {
-    webhookId: "wh_1234567890",
-    event: "MESSAGE.STATUS"
-});
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**phone:** `string` 
-
-The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B). <br>
-
-Must be a phone number that you own and have already [purchased](./buy) through the API. A phone number can have multiple webhooks attached to it.
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `Pinnacle.AttachWebhookParams` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Webhook.RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.phoneNumbers.webhook.<a href="/src/api/resources/phoneNumbers/resources/webhook/client/Client.ts">detach</a>(phone, webhookId) -> Pinnacle.DetachedWebhookInfo</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Disconnect a webhook from your phone number to stop receiving event notifications for that specific number. <br>
-
-The webhook configuration itself remains intact and available for use with other phone numbers.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.phoneNumbers.webhook.detach("+14155551234", "wh_1234567890");
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**phone:** `string` 
-
-The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B). <br>
-
-Must be a phone number that you own and currently has the specified webhook attached.
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**webhookId:** `string` 
-
-The unique identifier of the webhook you want to detach from the phone number. <br>
-
-This must be a valid webhook ID that is currently attached to the specified phone number. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`.
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Webhook.RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
 </dd>
 </dl>
 </details>

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

@@ -1,63 +0,0 @@
-import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.js";
-import * as core from "../../../../../../core/index.js";
-import * as Pinnacle from "../../../../../index.js";
-export declare namespace Webhook {
-    interface Options extends BaseClientOptions {
-    }
-    interface RequestOptions extends BaseRequestOptions {
-    }
-}
-export declare class Webhook {
-    protected readonly _options: Webhook.Options;
-    constructor(_options: Webhook.Options);
-    /**
-     * Connect a webhook to your phone number to receive real-time notifications for incoming messages, delivery status updates, and other communication events.
-     *
-     * @param {string} phone - The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B). <br>
-     *
-     *                         Must be a phone number that you own and have already [purchased](./buy) through the API. A phone number can have multiple webhooks attached to it.
-     * @param {Pinnacle.AttachWebhookParams} request
-     * @param {Webhook.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Pinnacle.BadRequestError}
-     * @throws {@link Pinnacle.UnauthorizedError}
-     * @throws {@link Pinnacle.ForbiddenError}
-     * @throws {@link Pinnacle.NotFoundError}
-     * @throws {@link Pinnacle.InternalServerError}
-     * @throws {@link Pinnacle.NotImplementedError}
-     *
-     * @example
-     *     await client.phoneNumbers.webhook.attach("%2B14155551234", {
-     *         webhookId: "wh_1234567890",
-     *         event: "MESSAGE.STATUS"
-     *     })
-     */
-    attach(phone: string, request: Pinnacle.AttachWebhookParams, requestOptions?: Webhook.RequestOptions): core.HttpResponsePromise<Pinnacle.ConfiguredWebhook>;
-    private __attach;
-    /**
-     * Disconnect a webhook from your phone number to stop receiving event notifications for that specific number. <br>
-     *
-     * The webhook configuration itself remains intact and available for use with other phone numbers.
-     *
-     * @param {string} phone - The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B). <br>
-     *
-     *                         Must be a phone number that you own and currently has the specified webhook attached.
-     * @param {string} webhookId - The unique identifier of the webhook you want to detach from the phone number. <br>
-     *
-     *                             This must be a valid webhook ID that is currently attached to the specified phone number. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`.
-     * @param {Webhook.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Pinnacle.BadRequestError}
-     * @throws {@link Pinnacle.UnauthorizedError}
-     * @throws {@link Pinnacle.ForbiddenError}
-     * @throws {@link Pinnacle.NotFoundError}
-     * @throws {@link Pinnacle.InternalServerError}
-     * @throws {@link Pinnacle.NotImplementedError}
-     *
-     * @example
-     *     await client.phoneNumbers.webhook.detach("+14155551234", "wh_1234567890")
-     */
-    detach(phone: string, webhookId: string, requestOptions?: Webhook.RequestOptions): core.HttpResponsePromise<Pinnacle.DetachedWebhookInfo>;
-    private __detach;
-    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
-}