rcs-js 2.0.17 → 2.0.18

package/dist/cjs/Client.js

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

package/dist/cjs/api/resources/webhooks/client/Client.d.ts

@@ -48,7 +48,9 @@ export declare class Webhooks {
      *
      * 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.
      *
      * @param {Pinnacle.AttachWebhookParams} request
      * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/webhooks/client/Client.js

@@ -203,7 +203,9 @@ class Webhooks {
      *
      * 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.
      *
      * @param {Pinnacle.AttachWebhookParams} request
      * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/webhooks/client/requests/AttachWebhookParams.d.ts

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

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

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

@@ -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/cjs/version.d.ts

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

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.17";
+exports.SDK_VERSION = "2.0.18";

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.17",
-                "User-Agent": "rcs-js/2.0.17",
+                "X-Fern-SDK-Version": "2.0.18",
+                "User-Agent": "rcs-js/2.0.18",
                 "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/webhooks/client/Client.d.mts

@@ -48,7 +48,9 @@ export declare class Webhooks {
      *
      * 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.
      *
      * @param {Pinnacle.AttachWebhookParams} request
      * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -167,7 +167,9 @@ export class Webhooks {
      *
      * 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.
      *
      * @param {Pinnacle.AttachWebhookParams} request
      * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.

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/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/version.d.mts

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

package/dist/esm/version.mjs

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "rcs-js",
-    "version": "2.0.17",
+    "version": "2.0.18",
     "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>