@formbricks/hub 0.2.0 → 0.4.1

package/resources/webhooks.d.ts

@@ -0,0 +1,338 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Webhook subscription management
+ */
+export declare class Webhooks extends APIResource {
+    /**
+     * Creates a new webhook endpoint. When events occur (e.g.
+     * feedback*record.created), the Hub POSTs a signed payload to the webhook URL. If
+     * signing_key is omitted, a key is auto-generated (Standard Webhooks format,
+     * whsec*...). See WebhookDeliveryPayload for the payload structure sent to your
+     * URL.
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.create({
+     *   url: 'https://example.com/hub-events',
+     *   enabled: true,
+     *   event_types: [
+     *     'feedback_record.created',
+     *     'feedback_record.updated',
+     *     'feedback_record.deleted',
+     *   ],
+     * });
+     * ```
+     */
+    create(body: WebhookCreateParams, options?: RequestOptions): APIPromise<WebhookCreateResponse>;
+    /**
+     * Retrieves a single webhook endpoint by its UUID. signing_key is omitted for
+     * security.
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.retrieve(
+     *   '018e1234-5678-9abc-def0-123456789abc',
+     * );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<WebhookRetrieveResponse>;
+    /**
+     * Updates specific fields of a webhook endpoint
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.update(
+     *   '018e1234-5678-9abc-def0-123456789abc',
+     * );
+     * ```
+     */
+    update(id: string, body: WebhookUpdateParams, options?: RequestOptions): APIPromise<WebhookUpdateResponse>;
+    /**
+     * Lists webhook endpoints with optional filters and pagination
+     *
+     * @example
+     * ```ts
+     * const webhooks = await client.webhooks.list();
+     * ```
+     */
+    list(query?: WebhookListParams | null | undefined, options?: RequestOptions): APIPromise<WebhookListResponse>;
+    /**
+     * Permanently deletes a webhook endpoint. It will no longer receive events.
+     *
+     * @example
+     * ```ts
+     * await client.webhooks.delete(
+     *   '018e1234-5678-9abc-def0-123456789abc',
+     * );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<void>;
+}
+export interface WebhookCreateResponse {
+    /**
+     * Webhook ID (UUID)
+     */
+    id: string;
+    /**
+     * When the webhook was created
+     */
+    created_at: string;
+    /**
+     * Whether the webhook is active
+     */
+    enabled: boolean;
+    /**
+     * Key used to sign payloads (Standard Webhooks)
+     */
+    signing_key: string;
+    /**
+     * When the webhook was last updated
+     */
+    updated_at: string;
+    /**
+     * URL that receives webhook POSTs
+     */
+    url: string;
+    /**
+     * Read-only. When the webhook was disabled. Omitted when null. Cleared when the
+     * webhook is re-enabled via PATCH.
+     */
+    disabled_at?: string | null;
+    /**
+     * Read-only. Set by the system when the webhook was disabled (e.g. after 410 Gone
+     * or max delivery failures). Omitted when null.
+     */
+    disabled_reason?: string | null;
+    /**
+     * Event types this webhook subscribes to (empty = all)
+     */
+    event_types?: Array<'feedback_record.created' | 'feedback_record.updated' | 'feedback_record.deleted' | 'webhook.created' | 'webhook.updated' | 'webhook.deleted'>;
+    /**
+     * Tenant/organization identifier
+     */
+    tenant_id?: string;
+}
+/**
+ * Webhook data for GET and LIST responses; signing_key is omitted for security
+ */
+export interface WebhookRetrieveResponse {
+    /**
+     * Webhook ID (UUID)
+     */
+    id: string;
+    /**
+     * When the webhook was created
+     */
+    created_at: string;
+    /**
+     * Whether the webhook is active
+     */
+    enabled: boolean;
+    /**
+     * When the webhook was last updated
+     */
+    updated_at: string;
+    /**
+     * URL that receives webhook POSTs
+     */
+    url: string;
+    /**
+     * Read-only. When the webhook was disabled. Omitted when null.
+     */
+    disabled_at?: string | null;
+    /**
+     * Read-only. Set by the system when the webhook was disabled. Omitted when null.
+     */
+    disabled_reason?: string | null;
+    /**
+     * Event types this webhook subscribes to (empty = all)
+     */
+    event_types?: Array<'feedback_record.created' | 'feedback_record.updated' | 'feedback_record.deleted' | 'webhook.created' | 'webhook.updated' | 'webhook.deleted'>;
+    /**
+     * Tenant/organization identifier
+     */
+    tenant_id?: string;
+}
+/**
+ * Webhook data for GET and LIST responses; signing_key is omitted for security
+ */
+export interface WebhookUpdateResponse {
+    /**
+     * Webhook ID (UUID)
+     */
+    id: string;
+    /**
+     * When the webhook was created
+     */
+    created_at: string;
+    /**
+     * Whether the webhook is active
+     */
+    enabled: boolean;
+    /**
+     * When the webhook was last updated
+     */
+    updated_at: string;
+    /**
+     * URL that receives webhook POSTs
+     */
+    url: string;
+    /**
+     * Read-only. When the webhook was disabled. Omitted when null.
+     */
+    disabled_at?: string | null;
+    /**
+     * Read-only. Set by the system when the webhook was disabled. Omitted when null.
+     */
+    disabled_reason?: string | null;
+    /**
+     * Event types this webhook subscribes to (empty = all)
+     */
+    event_types?: Array<'feedback_record.created' | 'feedback_record.updated' | 'feedback_record.deleted' | 'webhook.created' | 'webhook.updated' | 'webhook.deleted'>;
+    /**
+     * Tenant/organization identifier
+     */
+    tenant_id?: string;
+}
+export interface WebhookListResponse {
+    /**
+     * List of webhooks (signing_key omitted for security)
+     */
+    data: Array<WebhookListResponse.Data>;
+    /**
+     * Limit used in query
+     */
+    limit: number;
+    /**
+     * Opaque cursor for the next page (keyset paging). Present only when there may be
+     * more results. Use as the cursor query param for the next page.
+     */
+    next_cursor?: string;
+    /**
+     * Offset used in query (present when offset-based; omitted when using cursor)
+     */
+    offset?: number;
+    /**
+     * Total count matching filters (present when offset-based; omitted when using
+     * cursor)
+     */
+    total?: number;
+}
+export declare namespace WebhookListResponse {
+    /**
+     * Webhook data for GET and LIST responses; signing_key is omitted for security
+     */
+    interface Data {
+        /**
+         * Webhook ID (UUID)
+         */
+        id: string;
+        /**
+         * When the webhook was created
+         */
+        created_at: string;
+        /**
+         * Whether the webhook is active
+         */
+        enabled: boolean;
+        /**
+         * When the webhook was last updated
+         */
+        updated_at: string;
+        /**
+         * URL that receives webhook POSTs
+         */
+        url: string;
+        /**
+         * Read-only. When the webhook was disabled. Omitted when null.
+         */
+        disabled_at?: string | null;
+        /**
+         * Read-only. Set by the system when the webhook was disabled. Omitted when null.
+         */
+        disabled_reason?: string | null;
+        /**
+         * Event types this webhook subscribes to (empty = all)
+         */
+        event_types?: Array<'feedback_record.created' | 'feedback_record.updated' | 'feedback_record.deleted' | 'webhook.created' | 'webhook.updated' | 'webhook.deleted'>;
+        /**
+         * Tenant/organization identifier
+         */
+        tenant_id?: string;
+    }
+}
+export interface WebhookCreateParams {
+    /**
+     * URL to receive webhook POSTs. Must be an HTTP or HTTPS URL. NULL bytes not
+     * allowed.
+     */
+    url: string;
+    /**
+     * Whether the webhook is active (default true)
+     */
+    enabled?: boolean;
+    /**
+     * Event types this webhook subscribes to. Each value must be one of
+     * WebhookEventType. If empty, the webhook receives all event types.
+     */
+    event_types?: Array<'feedback_record.created' | 'feedback_record.updated' | 'feedback_record.deleted' | 'webhook.created' | 'webhook.updated' | 'webhook.deleted'>;
+    /**
+     * Optional. If omitted, a key is auto-generated (whsec\_...). Used to sign
+     * payloads (Standard Webhooks). When provided, max 255 characters; NULL bytes not
+     * allowed.
+     */
+    signing_key?: string;
+    /**
+     * Tenant/organization identifier. NULL bytes not allowed.
+     */
+    tenant_id?: string;
+}
+export interface WebhookUpdateParams {
+    /**
+     * Enable or disable the webhook
+     */
+    enabled?: boolean;
+    /**
+     * New list of event types (use empty array to clear). Each value must be one of
+     * WebhookEventType.
+     */
+    event_types?: Array<'feedback_record.created' | 'feedback_record.updated' | 'feedback_record.deleted' | 'webhook.created' | 'webhook.updated' | 'webhook.deleted'>;
+    /**
+     * New signing key. NULL bytes not allowed.
+     */
+    signing_key?: string;
+    /**
+     * Omit or send null to leave unchanged. Send empty string to clear (store as
+     * null).
+     */
+    tenant_id?: string | null;
+    /**
+     * New webhook URL. Must be an HTTP or HTTPS URL. NULL bytes not allowed.
+     */
+    url?: string;
+}
+export interface WebhookListParams {
+    /**
+     * Omit for the first page. For the next page, use the exact value from the
+     * previous response's next_cursor. Opaque (base64-encoded); keyset pagination.
+     */
+    cursor?: string;
+    /**
+     * Filter by enabled status
+     */
+    enabled?: boolean;
+    /**
+     * Number of results to return (max 1000)
+     */
+    limit?: number;
+    /**
+     * Filter by tenant ID. NULL bytes not allowed.
+     */
+    tenant_id?: string;
+}
+export declare namespace Webhooks {
+    export { type WebhookCreateResponse as WebhookCreateResponse, type WebhookRetrieveResponse as WebhookRetrieveResponse, type WebhookUpdateResponse as WebhookUpdateResponse, type WebhookListResponse as WebhookListResponse, type WebhookCreateParams as WebhookCreateParams, type WebhookUpdateParams as WebhookUpdateParams, type WebhookListParams as WebhookListParams, };
+}
+//# sourceMappingURL=webhooks.d.ts.map

package/resources/webhooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.d.ts","sourceRoot":"","sources":["../src/resources/webhooks.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAInF;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI1G;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM/D;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CACf,yBAAyB,GACzB,yBAAyB,GACzB,yBAAyB,GACzB,iBAAiB,GACjB,iBAAiB,GACjB,iBAAiB,CACpB,CAAC;IAEF;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CACf,yBAAyB,GACzB,yBAAyB,GACzB,yBAAyB,GACzB,iBAAiB,GACjB,iBAAiB,GACjB,iBAAiB,CACpB,CAAC;IAEF;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CACf,yBAAyB,GACzB,yBAAyB,GACzB,yBAAyB,GACzB,iBAAiB,GACjB,iBAAiB,GACjB,iBAAiB,CACpB,CAAC;IAEF;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAEtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;WAEG;QACH,WAAW,CAAC,EAAE,KAAK,CACf,yBAAyB,GACzB,yBAAyB,GACzB,yBAAyB,GACzB,iBAAiB,GACjB,iBAAiB,GACjB,iBAAiB,CACpB,CAAC;QAEF;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CACf,yBAAyB,GACzB,yBAAyB,GACzB,yBAAyB,GACzB,iBAAiB,GACjB,iBAAiB,GACjB,iBAAiB,CACpB,CAAC;IAEF;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CACf,yBAAyB,GACzB,yBAAyB,GACzB,yBAAyB,GACzB,iBAAiB,GACjB,iBAAiB,GACjB,iBAAiB,CACpB,CAAC;IAEF;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/webhooks.js

@@ -0,0 +1,91 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Webhooks = void 0;
+const resource_1 = require("../core/resource.js");
+const headers_1 = require("../internal/headers.js");
+const path_1 = require("../internal/utils/path.js");
+/**
+ * Webhook subscription management
+ */
+class Webhooks extends resource_1.APIResource {
+    /**
+     * Creates a new webhook endpoint. When events occur (e.g.
+     * feedback*record.created), the Hub POSTs a signed payload to the webhook URL. If
+     * signing_key is omitted, a key is auto-generated (Standard Webhooks format,
+     * whsec*...). See WebhookDeliveryPayload for the payload structure sent to your
+     * URL.
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.create({
+     *   url: 'https://example.com/hub-events',
+     *   enabled: true,
+     *   event_types: [
+     *     'feedback_record.created',
+     *     'feedback_record.updated',
+     *     'feedback_record.deleted',
+     *   ],
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/v1/webhooks', { body, ...options });
+    }
+    /**
+     * Retrieves a single webhook endpoint by its UUID. signing_key is omitted for
+     * security.
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.retrieve(
+     *   '018e1234-5678-9abc-def0-123456789abc',
+     * );
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get((0, path_1.path) `/v1/webhooks/${id}`, options);
+    }
+    /**
+     * Updates specific fields of a webhook endpoint
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.update(
+     *   '018e1234-5678-9abc-def0-123456789abc',
+     * );
+     * ```
+     */
+    update(id, body, options) {
+        return this._client.patch((0, path_1.path) `/v1/webhooks/${id}`, { body, ...options });
+    }
+    /**
+     * Lists webhook endpoints with optional filters and pagination
+     *
+     * @example
+     * ```ts
+     * const webhooks = await client.webhooks.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/v1/webhooks', { query, ...options });
+    }
+    /**
+     * Permanently deletes a webhook endpoint. It will no longer receive events.
+     *
+     * @example
+     * ```ts
+     * await client.webhooks.delete(
+     *   '018e1234-5678-9abc-def0-123456789abc',
+     * );
+     * ```
+     */
+    delete(id, options) {
+        return this._client.delete((0, path_1.path) `/v1/webhooks/${id}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+}
+exports.Webhooks = Webhooks;
+//# sourceMappingURL=webhooks.js.map

package/resources/webhooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../src/resources/webhooks.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,IAAyB,EAAE,OAAwB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE;YACnD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AArFD,4BAqFC"}

package/resources/webhooks.mjs

@@ -0,0 +1,87 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { buildHeaders } from "../internal/headers.mjs";
+import { path } from "../internal/utils/path.mjs";
+/**
+ * Webhook subscription management
+ */
+export class Webhooks extends APIResource {
+    /**
+     * Creates a new webhook endpoint. When events occur (e.g.
+     * feedback*record.created), the Hub POSTs a signed payload to the webhook URL. If
+     * signing_key is omitted, a key is auto-generated (Standard Webhooks format,
+     * whsec*...). See WebhookDeliveryPayload for the payload structure sent to your
+     * URL.
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.create({
+     *   url: 'https://example.com/hub-events',
+     *   enabled: true,
+     *   event_types: [
+     *     'feedback_record.created',
+     *     'feedback_record.updated',
+     *     'feedback_record.deleted',
+     *   ],
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/v1/webhooks', { body, ...options });
+    }
+    /**
+     * Retrieves a single webhook endpoint by its UUID. signing_key is omitted for
+     * security.
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.retrieve(
+     *   '018e1234-5678-9abc-def0-123456789abc',
+     * );
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get(path `/v1/webhooks/${id}`, options);
+    }
+    /**
+     * Updates specific fields of a webhook endpoint
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.update(
+     *   '018e1234-5678-9abc-def0-123456789abc',
+     * );
+     * ```
+     */
+    update(id, body, options) {
+        return this._client.patch(path `/v1/webhooks/${id}`, { body, ...options });
+    }
+    /**
+     * Lists webhook endpoints with optional filters and pagination
+     *
+     * @example
+     * ```ts
+     * const webhooks = await client.webhooks.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/v1/webhooks', { query, ...options });
+    }
+    /**
+     * Permanently deletes a webhook endpoint. It will no longer receive events.
+     *
+     * @example
+     * ```ts
+     * await client.webhooks.delete(
+     *   '018e1234-5678-9abc-def0-123456789abc',
+     * );
+     * ```
+     */
+    delete(id, options) {
+        return this._client.delete(path `/v1/webhooks/${id}`, {
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+}
+//# sourceMappingURL=webhooks.mjs.map

package/resources/webhooks.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.mjs","sourceRoot":"","sources":["../src/resources/webhooks.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,IAAyB,EAAE,OAAwB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE;YACnD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}

package/src/client.ts

@@ -11,11 +11,23 @@ import type { APIResponseProps } from './internal/parse';
 import { getPlatformHeaders } from './internal/detect-platform';
 import * as Shims from './internal/shims';
 import * as Opts from './internal/request-options';
+import { stringifyQuery } from './internal/utils/query';
 import { VERSION } from './version';
 import * as Errors from './core/error';
 import * as Uploads from './core/uploads';
 import * as API from './resources/index';
 import { APIPromise } from './core/api-promise';
+import { Health, HealthCheckResponse } from './resources/health';
+import {
+  WebhookCreateParams,
+  WebhookCreateResponse,
+  WebhookListParams,
+  WebhookListResponse,
+  WebhookRetrieveResponse,
+  WebhookUpdateParams,
+  WebhookUpdateResponse,
+  Webhooks,
+} from './resources/webhooks';
 import {
   FeedbackRecordBulkDeleteParams,
   FeedbackRecordBulkDeleteResponse,
@@ -23,10 +35,11 @@ import {
   FeedbackRecordData,
   FeedbackRecordListParams,
   FeedbackRecordListResponse,
+  FeedbackRecordRetrieveSimilarParams,
+  FeedbackRecordRetrieveSimilarResponse,
   FeedbackRecordUpdateParams,
   FeedbackRecords,
-} from './resources/feedback-records';
-import { Health, HealthCheckResponse } from './resources/health';
+} from './resources/feedback-records/feedback-records';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';
@@ -223,21 +236,8 @@ export class FormbricksHub {
   /**
    * Basic re-implementation of `qs.stringify` for primitive types.
    */
-  protected stringifyQuery(query: Record<string, unknown>): string {
-    return Object.entries(query)
-      .filter(([_, value]) => typeof value !== 'undefined')
-      .map(([key, value]) => {
-        if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-          return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
-        }
-        if (value === null) {
-          return `${encodeURIComponent(key)}=`;
-        }
-        throw new Errors.FormbricksHubError(
-          `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
-        );
-      })
-      .join('&');
+  protected stringifyQuery(query: object | Record<string, unknown>): string {
+    return stringifyQuery(query);
   }
 
   private getUserAgent(): string {
@@ -269,12 +269,13 @@ export class FormbricksHub {
       : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
 
     const defaultQuery = this.defaultQuery();
-    if (!isEmptyObj(defaultQuery)) {
-      query = { ...defaultQuery, ...query };
+    const pathQuery = Object.fromEntries(url.searchParams);
+    if (!isEmptyObj(defaultQuery) || !isEmptyObj(pathQuery)) {
+      query = { ...pathQuery, ...defaultQuery, ...query };
     }
 
     if (typeof query === 'object' && query && !Array.isArray(query)) {
-      url.search = this.stringifyQuery(query as Record<string, unknown>);
+      url.search = this.stringifyQuery(query);
     }
 
     return url.toString();
@@ -579,9 +580,9 @@ export class FormbricksHub {
       }
     }
 
-    // If the API asks us to wait a certain amount of time (and it's a reasonable amount),
-    // just do what it says, but otherwise calculate a default
-    if (!(timeoutMillis && 0 <= timeoutMillis && timeoutMillis < 60 * 1000)) {
+    // If the API asks us to wait a certain amount of time, just do what it
+    // says, but otherwise calculate a default
+    if (timeoutMillis === undefined) {
       const maxRetries = options.maxRetries ?? this.maxRetries;
       timeoutMillis = this.calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries);
     }
@@ -707,6 +708,14 @@ export class FormbricksHub {
         (Symbol.iterator in body && 'next' in body && typeof body.next === 'function'))
     ) {
       return { bodyHeaders: undefined, body: Shims.ReadableStreamFrom(body as AsyncIterable<Uint8Array>) };
+    } else if (
+      typeof body === 'object' &&
+      headers.values.get('content-type') === 'application/x-www-form-urlencoded'
+    ) {
+      return {
+        bodyHeaders: { 'content-type': 'application/x-www-form-urlencoded' },
+        body: this.stringifyQuery(body),
+      };
     } else {
       return this.#encoder({ body, headers });
     }
@@ -731,12 +740,23 @@ export class FormbricksHub {
 
   static toFile = Uploads.toFile;
 
+  /**
+   * Health check endpoints
+   */
   health: API.Health = new API.Health(this);
+  /**
+   * Feedback record CRUD and search
+   */
   feedbackRecords: API.FeedbackRecords = new API.FeedbackRecords(this);
+  /**
+   * Webhook subscription management
+   */
+  webhooks: API.Webhooks = new API.Webhooks(this);
 }
 
 FormbricksHub.Health = Health;
 FormbricksHub.FeedbackRecords = FeedbackRecords;
+FormbricksHub.Webhooks = Webhooks;
 
 export declare namespace FormbricksHub {
   export type RequestOptions = Opts.RequestOptions;
@@ -748,9 +768,22 @@ export declare namespace FormbricksHub {
     type FeedbackRecordData as FeedbackRecordData,
     type FeedbackRecordListResponse as FeedbackRecordListResponse,
     type FeedbackRecordBulkDeleteResponse as FeedbackRecordBulkDeleteResponse,
+    type FeedbackRecordRetrieveSimilarResponse as FeedbackRecordRetrieveSimilarResponse,
     type FeedbackRecordCreateParams as FeedbackRecordCreateParams,
     type FeedbackRecordUpdateParams as FeedbackRecordUpdateParams,
     type FeedbackRecordListParams as FeedbackRecordListParams,
     type FeedbackRecordBulkDeleteParams as FeedbackRecordBulkDeleteParams,
+    type FeedbackRecordRetrieveSimilarParams as FeedbackRecordRetrieveSimilarParams,
+  };
+
+  export {
+    Webhooks as Webhooks,
+    type WebhookCreateResponse as WebhookCreateResponse,
+    type WebhookRetrieveResponse as WebhookRetrieveResponse,
+    type WebhookUpdateResponse as WebhookUpdateResponse,
+    type WebhookListResponse as WebhookListResponse,
+    type WebhookCreateParams as WebhookCreateParams,
+    type WebhookUpdateParams as WebhookUpdateParams,
+    type WebhookListParams as WebhookListParams,
   };
 }