rcs-js 2.0.17 → 2.0.19

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

@@ -8,7 +8,11 @@ import type * as Pinnacle from "../../../../index.mjs";
 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). */
+    /**
+     * 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).
+     *
+     * Supplying `headers` alongside `webhookId` **overwrites** the stored headers on the webhook. Omit `headers` to leave them unchanged.
+     */
     webhookId?: string;
     /** Name for a new webhook (required if no `webhookId`). */
     name?: string;
@@ -20,4 +24,14 @@ export interface AttachWebhookParams {
      * `USER.TYPING` is only supported for RCS agent senders, not phone numbers.
      */
     event?: Pinnacle.WebhookEventEnum | null;
+    /**
+     * Optional custom HTTP headers (key-value map) to include when dispatching webhook events to the endpoint.
+     *
+     * Header names must start with a letter or digit and contain only letters, digits, `-`, or `_` (matching the pattern `^[A-Za-z0-9][A-Za-z0-9_-]*$`). Names are case-insensitive per [RFC 9110](https://datatracker.ietf.org/doc/html/rfc9110#name-field-names) and are normalized to uppercase before storage and sending.
+     *
+     * When provided with an existing `webhookId`, these headers **overwrite** any headers currently stored on that webhook. Omit to leave existing headers unchanged.
+     *
+     * The reserved `PINNACLE-SIGNING-SECRET` header is silently ignored and cannot be overridden.
+     */
+    headers?: Record<string, string | null> | null;
 }

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

@@ -18,5 +18,7 @@ export declare namespace AttachWebhookResult {
         url: string;
         /** Signing secret sent in the `PINNACLE-SIGNING-SECRET` header for request verification. */
         secret: string;
+        /** Optional custom HTTP headers sent on every webhook delivery. Header names must match the regex `^[A-Za-z0-9][A-Za-z0-9_-]*$` — start with a letter or digit and contain only letters, digits, `-`, or `_`. Keys are case-insensitive and stored in uppercase. Values must be strings. The reserved `PINNACLE-SIGNING-SECRET` header is never returned here and cannot be overridden. */
+        headers?: Record<string, string | null> | null;
     }
 }

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

@@ -0,0 +1,10 @@
+/**
+ * User message payload. At least one of `text` or `mediaUrls` must be non-empty.
+ * Send only `text` to simulate an inbound SMS; include `mediaUrls` to simulate an inbound MMS.
+ */
+export interface SimulateMessageInput {
+    /** Text message sent by the user. */
+    text?: string;
+    /** URLs of media files sent by the user. */
+    mediaUrls?: string[];
+}

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

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

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

@@ -0,0 +1,11 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Simulate a button press from a user.
+ */
+export interface SimulateUserButton {
+    /** User phone number in E.164 format. */
+    from: string;
+    /** RCS agent ID (prefixed with `agent_`). */
+    to: string;
+    button: Pinnacle.UserButtonPress;
+}

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

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

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

@@ -0,0 +1,11 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Simulate an inbound message from a user.
+ */
+export interface SimulateUserMessage {
+    /** User phone number in E.164 format. */
+    from: string;
+    /** Receiver phone number in E.164 format or RCS agent ID (prefixed with `agent_`). */
+    to: string;
+    message: Pinnacle.SimulateMessageInput;
+}

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

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

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

@@ -0,0 +1,11 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Request body for simulating an inbound event from a user.
+ */
+export type SimulateUserParams = 
+/**
+ * Simulate an inbound message from a user. */
+Pinnacle.SimulateUserMessage
+/**
+ * Simulate a button press from a user. Only for RCS agents. */
+ | Pinnacle.SimulateUserButton;

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

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

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

@@ -0,0 +1,6 @@
+/**
+ * Result of the simulation.
+ */
+export interface SimulateUserResponse {
+    success: boolean;
+}

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

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

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

@@ -0,0 +1,25 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Discriminated union of button presses that can be simulated for a user.
+ */
+export type UserButtonPress = Pinnacle.UserButtonPress.Trigger | Pinnacle.UserButtonPress.OpenUrl | Pinnacle.UserButtonPress.Call | Pinnacle.UserButtonPress.ScheduleEvent | Pinnacle.UserButtonPress.SendLocation | Pinnacle.UserButtonPress.RequestUserLocation;
+export declare namespace UserButtonPress {
+    interface Trigger extends Pinnacle.UserButtonPressTrigger {
+        type: "trigger";
+    }
+    interface OpenUrl extends Pinnacle.UserButtonPressOpenUrl {
+        type: "openUrl";
+    }
+    interface Call extends Pinnacle.UserButtonPressCall {
+        type: "call";
+    }
+    interface ScheduleEvent extends Pinnacle.UserButtonPressScheduleEvent {
+        type: "scheduleEvent";
+    }
+    interface SendLocation extends Pinnacle.UserButtonPressSendLocation {
+        type: "sendLocation";
+    }
+    interface RequestUserLocation extends Pinnacle.UserButtonPressRequestUserLocation {
+        type: "requestUserLocation";
+    }
+}

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

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

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

@@ -0,0 +1,11 @@
+/**
+ * Simulates when a user presses a `call` button.
+ */
+export interface UserButtonPressCall {
+    /** Name of the button that you want to press. */
+    title: string;
+    /** Metadata attached to the button. */
+    metadata?: string;
+    /** Destination phone number in E.164 format. */
+    payload?: string;
+}

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

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

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

@@ -0,0 +1,11 @@
+/**
+ * Simulates when a user presses an `openUrl` button.
+ */
+export interface UserButtonPressOpenUrl {
+    /** Name of the button that you want to press. */
+    title: string;
+    /** Metadata attached to the button. */
+    metadata?: string;
+    /** Destination URL of the tapped button. */
+    payload?: string;
+}

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

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

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

@@ -0,0 +1,22 @@
+/**
+ * Simulates when a user presses a `requestUserLocation` button.
+ */
+export interface UserButtonPressRequestUserLocation {
+    /** Name of the button that you want to press. */
+    title: string;
+    /** Metadata attached to the button. */
+    metadata?: string;
+    /** Location the simulated user responded with. */
+    location?: UserButtonPressRequestUserLocation.Location;
+}
+export declare namespace UserButtonPressRequestUserLocation {
+    /**
+     * Location the simulated user responded with.
+     */
+    interface Location {
+        text?: string;
+        latitude?: number;
+        longitude?: number;
+        address?: string;
+    }
+}

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

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

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

@@ -0,0 +1,15 @@
+/**
+ * Simulates when a user presses a `scheduleEvent` button.
+ */
+export interface UserButtonPressScheduleEvent {
+    /** Name of the button that you want to press. */
+    title: string;
+    /** Metadata attached to the button. */
+    metadata?: string;
+    /** ISO 8601 start time. Defaults to the current time. */
+    eventStartTime?: string;
+    /** ISO 8601 end time. Defaults to one hour after `eventStartTime`. */
+    eventEndTime?: string;
+    eventTitle?: string;
+    eventDescription?: string;
+}

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

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

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

@@ -0,0 +1,24 @@
+/**
+ * Simulates when a user presses a `sendLocation` button.
+ */
+export interface UserButtonPressSendLocation {
+    /** Name of the button that you want to press. */
+    title: string;
+    /** Metadata attached to the button. */
+    metadata?: string;
+    /** Name of the location shared. */
+    name?: string;
+    /** Shared coordinates. */
+    latLong?: UserButtonPressSendLocation.LatLong;
+}
+export declare namespace UserButtonPressSendLocation {
+    /**
+     * Shared coordinates.
+     */
+    interface LatLong {
+        /** Latitude of the shared location. */
+        lat?: number;
+        /** Longitude of the shared location. */
+        lng?: number;
+    }
+}

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

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

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

@@ -0,0 +1,11 @@
+/**
+ * Simulates when a user presses a `trigger` button.
+ */
+export interface UserButtonPressTrigger {
+    /** Name of the button that you want to press. */
+    title: string;
+    /** Metadata attached to the button. */
+    metadata?: string;
+    /** Button's postback payload. */
+    payload?: string;
+}

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

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

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

@@ -11,6 +11,8 @@ export interface WebhookSummary {
     createdAt: string;
     /** ISO 8601 timestamp of when the webhook was last updated. */
     updatedAt: string;
+    /** Optional custom HTTP headers sent when dispatching webhook events. Header names must match the regex `^[A-Za-z0-9][A-Za-z0-9_-]*$` — start with a letter or digit and contain only letters, digits, `-`, or `_`. Keys are case-insensitive and stored in uppercase. Values must be strings. The reserved `PINNACLE-SIGNING-SECRET` header is never returned here and cannot be overridden. */
+    headers?: Record<string, string | null> | null;
 }
 export declare namespace WebhookSummary {
     /** Current status of the webhook. */

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

@@ -8,4 +8,6 @@ export interface Webhooks {
     id: string;
     /** Name of the webhook. */
     name: string;
+    /** Optional custom HTTP headers sent on every webhook delivery. Header names must match the regex `^[A-Za-z0-9][A-Za-z0-9_-]*$` — start with a letter or digit and contain only letters, digits, `-`, or `_`. Keys are case-insensitive and stored in uppercase. Values must be strings. The reserved `PINNACLE-SIGNING-SECRET` header is never returned here and cannot be overridden. */
+    headers?: Record<string, string | null> | null;
 }

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

@@ -153,6 +153,11 @@ export * from "./SentRichMessageFallbackSms.mjs";
 export * from "./SentSmsDetails.mjs";
 export * from "./ShortenedUrl.mjs";
 export * from "./ShortenedUrlWithClickData.mjs";
+export * from "./SimulateMessageInput.mjs";
+export * from "./SimulateUserButton.mjs";
+export * from "./SimulateUserMessage.mjs";
+export * from "./SimulateUserParams.mjs";
+export * from "./SimulateUserResponse.mjs";
 export * from "./SmsContent.mjs";
 export * from "./SmsValidationResult.mjs";
 export * from "./SubmissionResults.mjs";
@@ -169,6 +174,13 @@ export * from "./TollFreeStatusEnum.mjs";
 export * from "./Tracking.mjs";
 export * from "./UpdatedContactId.mjs";
 export * from "./UploadResults.mjs";
+export * from "./UserButtonPress.mjs";
+export * from "./UserButtonPressCall.mjs";
+export * from "./UserButtonPressOpenUrl.mjs";
+export * from "./UserButtonPressRequestUserLocation.mjs";
+export * from "./UserButtonPressScheduleEvent.mjs";
+export * from "./UserButtonPressSendLocation.mjs";
+export * from "./UserButtonPressTrigger.mjs";
 export * from "./UserEvent.mjs";
 export * from "./ValidateCampaignParams.mjs";
 export * from "./ValidationErrorDetails.mjs";

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

@@ -153,6 +153,11 @@ export * from "./SentRichMessageFallbackSms.mjs";
 export * from "./SentSmsDetails.mjs";
 export * from "./ShortenedUrl.mjs";
 export * from "./ShortenedUrlWithClickData.mjs";
+export * from "./SimulateMessageInput.mjs";
+export * from "./SimulateUserButton.mjs";
+export * from "./SimulateUserMessage.mjs";
+export * from "./SimulateUserParams.mjs";
+export * from "./SimulateUserResponse.mjs";
 export * from "./SmsContent.mjs";
 export * from "./SmsValidationResult.mjs";
 export * from "./SubmissionResults.mjs";
@@ -169,6 +174,13 @@ export * from "./TollFreeStatusEnum.mjs";
 export * from "./Tracking.mjs";
 export * from "./UpdatedContactId.mjs";
 export * from "./UploadResults.mjs";
+export * from "./UserButtonPress.mjs";
+export * from "./UserButtonPressCall.mjs";
+export * from "./UserButtonPressOpenUrl.mjs";
+export * from "./UserButtonPressRequestUserLocation.mjs";
+export * from "./UserButtonPressScheduleEvent.mjs";
+export * from "./UserButtonPressSendLocation.mjs";
+export * from "./UserButtonPressTrigger.mjs";
 export * from "./UserEvent.mjs";
 export * from "./ValidateCampaignParams.mjs";
 export * from "./ValidationErrorDetails.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.0.17";
+export declare const SDK_VERSION = "2.0.19";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "2.0.17";
+export const SDK_VERSION = "2.0.19";

package/package.json

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

package/reference.md

@@ -2192,7 +2192,9 @@ Attach a webhook to one or more senders (phone numbers or RCS agent IDs) to rece
 
 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.
+Subscriptions are additive — attaching new senders does not remove existing ones. Re-attaching the same sender updates the event type filter without creating duplicates. <br>
+
+**Custom headers** may be provided in either case via the optional `headers` field. When attaching a new webhook, the headers are stored on the webhook and sent on every delivery. When attaching an existing `webhookId`, supplying `headers` **overwrites** the stored headers on that webhook — omit the field to leave them unchanged, or pass an empty object `{}` to clear them. The reserved `PINNACLE-SIGNING-SECRET` header is always set by Pinnacle and cannot be overridden.
 </dd>
 </dl>
 </dd>
@@ -4668,6 +4670,76 @@ await client.messages.blasts.list();
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Messages Simulate
+<details><summary><code>client.messages.simulate.<a href="/src/api/resources/messages/resources/simulate/client/Client.ts">user</a>({ ...params }) -> Pinnacle.SimulateUserResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Simulate inbound messages and button presses from a user.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.messages.simulate.user({
+    from: "+14155551234",
+    to: "+14155555678",
+    message: {
+        text: "Hello from the test user!"
+    }
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pinnacle.SimulateUserParams` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Simulate.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>