featurebase-node 0.0.2

package/resources/tickets/tickets.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tickets.mjs","sourceRoot":"","sources":["../../src/resources/tickets/tickets.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,aAAa;OAClB,EAAE,UAAU,EAAoE;OAChF,KAAK,eAAe;OACpB,EAAoD,YAAY,EAAE;OAClE,KAAK,WAAW;OAChB,EAA8D,QAAQ,EAAE;OAExE,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,iBAAY,GAAiC,IAAI,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5F,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClF,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA2T1E,CAAC;IAzTC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8DG;IACH,MAAM,CAAC,MAA0B,EAAE,OAAwB;QACzD,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CACN,EAAU,EACV,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE;YAC/C,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,MAAM,CAAC,EAAU,EAAE,MAA0B,EAAE,OAAwB;QACrE,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE;YACjD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,IAAI,CACF,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE;YACrC,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CACJ,EAAU,EACV,SAAgD,EAAE,EAClD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE;YAClD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,EAAU,EAAE,MAAyB,EAAE,OAAwB;QACnE,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,eAAe,EAAE,QAAQ,EAAE;YACtD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAooBD,OAAO,CAAC,YAAY,GAAG,YAAY,CAAC;AACpC,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;AAChC,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC"}

package/resources/tickets.d.mts

@@ -0,0 +1,2 @@
+export * from "./tickets/index.mjs";
+//# sourceMappingURL=tickets.d.mts.map

package/resources/tickets.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tickets.d.mts","sourceRoot":"","sources":["../src/resources/tickets.ts"],"names":[],"mappings":""}

package/resources/tickets.d.ts

@@ -0,0 +1,2 @@
+export * from "./tickets/index.js";
+//# sourceMappingURL=tickets.d.ts.map

package/resources/tickets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tickets.d.ts","sourceRoot":"","sources":["../src/resources/tickets.ts"],"names":[],"mappings":""}

package/resources/tickets.js

@@ -0,0 +1,6 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("../internal/tslib.js");
+tslib_1.__exportStar(require("./tickets/index.js"), exports);
+//# sourceMappingURL=tickets.js.map

package/resources/tickets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tickets.js","sourceRoot":"","sources":["../src/resources/tickets.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6DAAgC"}

package/resources/tickets.mjs

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export * from "./tickets/index.mjs";
+//# sourceMappingURL=tickets.mjs.map

package/resources/tickets.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tickets.mjs","sourceRoot":"","sources":["../src/resources/tickets.ts"],"names":[],"mappings":"AAAA,sFAAsF"}

package/resources/webhooks.d.mts

@@ -0,0 +1,626 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Webhooks allow you to receive real-time HTTP callbacks when events occur in your Featurebase organization. Configure webhook endpoints to subscribe to specific event types.
+ */
+export declare class Webhooks extends APIResource {
+    /**
+     * Creates a new webhook to receive event notifications.
+     *
+     * ### Request Body
+     *
+     * | Field                   | Type     | Required | Description                          |
+     * | ----------------------- | -------- | -------- | ------------------------------------ |
+     * | `name`                  | string   | Yes      | Human-readable name (max 100 chars)  |
+     * | `url`                   | string   | Yes      | Webhook endpoint URL (must be HTTPS) |
+     * | `description`           | string   | No       | Optional description (max 500 chars) |
+     * | `topics`                | string[] | Yes      | Event topics to subscribe to         |
+     * | `requestConfig`         | object   | No       | Request configuration                |
+     * | `requestConfig.headers` | object   | No       | Custom headers to send (max 10)      |
+     *
+     * ### Available Topics
+     *
+     * - `post.created` - When a new feedback post is created
+     * - `post.updated` - When a feedback post is updated
+     * - `post.deleted` - When a feedback post is deleted
+     * - `post.voted` - When a feedback post receives a vote
+     * - `ticket.created` - When a new ticket is created
+     * - `ticket.updated` - When a ticket is updated
+     * - `ticket.deleted` - When a ticket is deleted
+     * - `changelog.published` - When a changelog is published
+     * - `comment.created` - When a comment is created
+     * - `comment.updated` - When a comment is updated
+     * - `comment.deleted` - When a comment is deleted
+     *
+     * ### Response
+     *
+     * Returns the created webhook object including the signing secret.
+     *
+     * ### Example Request
+     *
+     * ```json
+     * {
+     *   "name": "Production Webhook",
+     *   "url": "https://example.com/webhooks",
+     *   "description": "Handles all production events",
+     *   "topics": ["post.created", "post.updated", "comment.created"],
+     *   "requestConfig": {
+     *     "timeoutMs": 10000,
+     *     "headers": {
+     *       "X-Custom-Header": "value"
+     *     }
+     *   }
+     * }
+     * ```
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "webhook",
+     *   "id": "507f1f77bcf86cd799439011",
+     *   "name": "Production Webhook",
+     *   "url": "https://example.com/webhooks",
+     *   "secret": "whsec_abc123def456ghi789",
+     *   "topics": ["post.created", "post.updated", "comment.created"],
+     *   "status": "active",
+     *   ...
+     * }
+     * ```
+     *
+     * ### Limits
+     *
+     * Each organization has a maximum number of webhooks (default: 10). Creating a
+     * webhook when the limit is reached will return a 400 error.
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.create({
+     *   name: 'Production Webhook',
+     *   topics: ['post.created', 'post.updated'],
+     *   url: 'https://example.com/webhooks',
+     * });
+     * ```
+     */
+    create(params: WebhookCreateParams, options?: RequestOptions): APIPromise<Webhook>;
+    /**
+     * Retrieves a single webhook by its unique identifier.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The webhook ID (24-character ObjectId)
+     *
+     * ### Response Format
+     *
+     * Returns a webhook object with:
+     *
+     * - `object` - Always "webhook"
+     * - `id` - Unique webhook identifier
+     * - `name` - Human-readable webhook name
+     * - `url` - Webhook endpoint URL
+     * - `description` - Optional description
+     * - `topics` - Array of subscribed event topics
+     * - `status` - Current status ("active", "paused", "suspended")
+     * - `requestConfig` - Request configuration (timeout, headers)
+     * - `lastStatus` - Last delivery attempt status
+     * - `health` - Health metrics
+     * - `createdAt` - Creation timestamp
+     * - `updatedAt` - Last update timestamp
+     *
+     * The response includes the webhook signing secret for payload verification.
+     *
+     * ### Example
+     *
+     * ```json
+     * {
+     *   "object": "webhook",
+     *   "id": "507f1f77bcf86cd799439011",
+     *   "name": "Production Webhook",
+     *   "url": "https://example.com/webhooks",
+     *   "description": "Handles all production events",
+     *   "topics": ["post.created", "post.updated"],
+     *   "status": "active",
+     *   "requestConfig": {
+     *     "timeoutMs": 5000,
+     *     "headers": {}
+     *   },
+     *   "lastStatus": {
+     *     "code": 200,
+     *     "message": "Success",
+     *     "timestamp": "2025-01-15T10:30:00.000Z"
+     *   },
+     *   "health": {
+     *     "lastResponseTime": 150,
+     *     "avgResponseTime": 200,
+     *     "lastSuccessAt": "2025-01-15T10:30:00.000Z",
+     *     "errorsSinceLastSuccess": 0,
+     *     "consecutiveFailures": 0
+     *   },
+     *   "createdAt": "2025-01-01T00:00:00.000Z",
+     *   "updatedAt": "2025-01-15T10:30:00.000Z"
+     * }
+     * ```
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.retrieve(
+     *   '507f1f77bcf86cd799439011',
+     * );
+     * ```
+     */
+    retrieve(id: string, params?: WebhookRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Webhook>;
+    /**
+     * Updates a webhook's properties. Supports partial updates - only provided fields
+     * will be updated.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The webhook ID (24-character ObjectId)
+     *
+     * ### Request Body
+     *
+     * All fields are optional. Only provided fields will be updated.
+     *
+     * | Field                   | Type        | Description                                        |
+     * | ----------------------- | ----------- | -------------------------------------------------- |
+     * | `name`                  | string      | Human-readable name (max 100 chars)                |
+     * | `url`                   | string      | Webhook endpoint URL (must be HTTPS)               |
+     * | `description`           | string/null | Description (null to clear)                        |
+     * | `topics`                | string[]    | Event topics to subscribe to                       |
+     * | `status`                | string      | "active" to reactivate, "paused" to pause delivery |
+     * | `requestConfig`         | object      | Request configuration                              |
+     * | `requestConfig.headers` | object      | Custom headers to send (max 10)                    |
+     *
+     * ### Pausing and Reactivating Webhooks
+     *
+     * You can pause a webhook to temporarily stop receiving events:
+     *
+     * ```json
+     * {
+     *   "status": "paused"
+     * }
+     * ```
+     *
+     * Webhooks may also be automatically paused or suspended due to delivery failures.
+     * To reactivate:
+     *
+     * ```json
+     * {
+     *   "status": "active"
+     * }
+     * ```
+     *
+     * Reactivating a webhook resets the health metrics and allows it to receive events
+     * again.
+     *
+     * ### Example: Update Topics
+     *
+     * ```json
+     * {
+     *   "topics": ["post.created", "post.updated", "post.deleted"]
+     * }
+     * ```
+     *
+     * ### Example: Update Request Config
+     *
+     * ```json
+     * {
+     *   "requestConfig": {
+     *     "headers": {
+     *       "X-Custom-Header": "new-value"
+     *     }
+     *   }
+     * }
+     * ```
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.update(
+     *   '507f1f77bcf86cd799439011',
+     * );
+     * ```
+     */
+    update(id: string, params: WebhookUpdateParams, options?: RequestOptions): APIPromise<Webhook>;
+    /**
+     * Returns a list of webhooks in your organization using cursor-based pagination.
+     *
+     * ### Query Parameters
+     *
+     * - `limit` - Number of webhooks to return (1-100, default 10)
+     * - `cursor` - Cursor from previous response for pagination
+     * - `status` - Filter by status: "active", "paused", or "suspended"
+     *
+     * ### Response Format
+     *
+     * Returns a list object with:
+     *
+     * - `object` - Always "list"
+     * - `data` - Array of webhook objects
+     * - `nextCursor` - Cursor for the next page, or null if no more results
+     *
+     * ### Webhook Object
+     *
+     * Each webhook includes:
+     *
+     * - `id` - Unique webhook identifier
+     * - `name` - Human-readable webhook name
+     * - `url` - Webhook endpoint URL
+     * - `topics` - Array of subscribed event topics
+     * - `status` - Current status ("active", "paused", "suspended")
+     * - `health` - Health metrics (response times, error counts)
+     * - `createdAt` - Creation timestamp
+     * - `updatedAt` - Last update timestamp
+     *
+     * ### Example
+     *
+     * ```json
+     * {
+     *   "object": "list",
+     *   "data": [
+     *     {
+     *       "object": "webhook",
+     *       "id": "507f1f77bcf86cd799439011",
+     *       "name": "Production Webhook",
+     *       "url": "https://example.com/webhooks",
+     *       "topics": ["post.created", "post.updated"],
+     *       "status": "active",
+     *       ...
+     *     }
+     *   ],
+     *   "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9"
+     * }
+     * ```
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const webhooks = await client.webhooks.list();
+     * ```
+     */
+    list(params?: WebhookListParams | null | undefined, options?: RequestOptions): APIPromise<WebhookListResponse>;
+    /**
+     * Permanently deletes a webhook.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The webhook ID (24-character ObjectId)
+     *
+     * ### Response
+     *
+     * Returns a deletion confirmation object:
+     *
+     * ```json
+     * {
+     *   "id": "507f1f77bcf86cd799439011",
+     *   "object": "webhook",
+     *   "deleted": true
+     * }
+     * ```
+     *
+     * ### Caution
+     *
+     * This operation is **irreversible**. The webhook and its configuration will be
+     * permanently deleted. After deletion, no events will be sent to the webhook
+     * endpoint.
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.delete(
+     *   '507f1f77bcf86cd799439011',
+     * );
+     * ```
+     */
+    delete(id: string, params?: WebhookDeleteParams | null | undefined, options?: RequestOptions): APIPromise<WebhookDeleteResponse>;
+    /**
+     * Generates a new signing secret for a webhook. The previous secret is immediately
+     * invalidated.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The webhook ID (24-character ObjectId)
+     *
+     * ### Response
+     *
+     * Returns the updated webhook object, including the new signing secret.
+     *
+     * ### Important
+     *
+     * After refreshing the secret, any integrations that verify webhook signatures
+     * using the old secret will stop working until they are updated with the new
+     * secret.
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "webhook",
+     *   "id": "507f1f77bcf86cd799439011",
+     *   "name": "Production Webhook",
+     *   "url": "https://example.com/webhooks",
+     *   "secret": "whsec_newSecret123abc456def",
+     *   "topics": ["post.created", "post.updated"],
+     *   "status": "active",
+     *   ...
+     * }
+     * ```
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.webhooks.refreshSecret(
+     *   '507f1f77bcf86cd799439011',
+     * );
+     * ```
+     */
+    refreshSecret(id: string, params?: WebhookRefreshSecretParams | null | undefined, options?: RequestOptions): APIPromise<Webhook>;
+}
+export interface Webhook {
+    /**
+     * Unique identifier
+     */
+    id: string;
+    /**
+     * ISO timestamp when the webhook was created
+     */
+    createdAt: string;
+    /**
+     * Optional description of the webhook purpose
+     */
+    description: string | null;
+    health: Webhook.Health;
+    /**
+     * Last delivery attempt status
+     */
+    lastStatus: Webhook.LastStatus | null;
+    /**
+     * Human-readable webhook name
+     */
+    name: string;
+    /**
+     * Object type identifier
+     */
+    object: 'webhook';
+    requestConfig: Webhook.RequestConfig;
+    /**
+     * Webhook signing secret for verifying payloads
+     */
+    secret: string;
+    /**
+     * Current status of the webhook
+     */
+    status: 'active' | 'paused' | 'suspended';
+    /**
+     * Array of event topics the webhook subscribes to
+     */
+    topics: Array<'post.created' | 'post.updated' | 'post.deleted' | 'post.voted' | 'ticket.created' | 'ticket.updated' | 'ticket.deleted' | 'changelog.published' | 'comment.created' | 'comment.updated' | 'comment.deleted' | 'conversation.user.created' | 'conversation.user.replied' | 'conversation.admin.replied' | 'conversation.admin.closed' | 'conversation.handover_requested' | 'conversation.admin.assigned' | 'conversation.admin.noted' | 'conversation.admin.snoozed' | 'conversation.admin.unsnoozed' | 'conversation.admin.opened' | 'conversation.priority.updated' | 'conversation.deleted' | 'conversation.contact.attached' | 'conversation.contact.detached' | 'conversation.read' | 'conversation_part.redacted'>;
+    /**
+     * ISO timestamp when the webhook was last updated
+     */
+    updatedAt: string;
+    /**
+     * Webhook endpoint URL
+     */
+    url: string;
+    /**
+     * API version for webhook payloads
+     */
+    version: string;
+}
+export declare namespace Webhook {
+    interface Health {
+        /**
+         * Average response time in milliseconds
+         */
+        avgResponseTime: number;
+        /**
+         * Number of consecutive delivery failures
+         */
+        consecutiveFailures: number;
+        /**
+         * Number of errors since last successful delivery
+         */
+        errorsSinceLastSuccess: number;
+        /**
+         * Last response time in milliseconds
+         */
+        lastResponseTime: number;
+        /**
+         * ISO timestamp of last successful delivery
+         */
+        lastSuccessAt: string | null;
+    }
+    /**
+     * Last delivery attempt status
+     */
+    interface LastStatus {
+        /**
+         * HTTP status code from last delivery attempt
+         */
+        code: number;
+        /**
+         * Status message from last delivery attempt
+         */
+        message: string;
+        /**
+         * ISO timestamp of last status update
+         */
+        timestamp: string;
+    }
+    interface RequestConfig {
+        /**
+         * Request timeout in milliseconds (1000-30000)
+         */
+        timeoutMs: number;
+        /**
+         * Custom headers to send with webhook requests
+         */
+        headers?: {
+            [key: string]: string;
+        };
+    }
+}
+/**
+ * Request configuration for webhook delivery
+ */
+export interface WebhookRequestConfigInput {
+    /**
+     * Custom headers to send with webhook requests (max 10)
+     */
+    headers?: {
+        [key: string]: string;
+    };
+}
+export interface WebhookListResponse {
+    /**
+     * Array of webhooks
+     */
+    data: Array<Webhook>;
+    /**
+     * Cursor for fetching the next page (cursor-based pagination)
+     */
+    nextCursor: string | null;
+    /**
+     * Object type identifier
+     */
+    object: 'list';
+}
+export interface WebhookDeleteResponse {
+    /**
+     * Unique identifier of the deleted webhook
+     */
+    id: string;
+    /**
+     * Indicates the resource was deleted
+     */
+    deleted: true;
+    /**
+     * Object type identifier
+     */
+    object: 'webhook';
+}
+export interface WebhookCreateParams {
+    /**
+     * Body param: Human-readable name for the webhook
+     */
+    name: string;
+    /**
+     * Body param: Array of event topics to subscribe to
+     */
+    topics: Array<'post.created' | 'post.updated' | 'post.deleted' | 'post.voted' | 'ticket.created' | 'ticket.updated' | 'ticket.deleted' | 'changelog.published' | 'comment.created' | 'comment.updated' | 'comment.deleted' | 'conversation.user.created' | 'conversation.user.replied' | 'conversation.admin.replied' | 'conversation.admin.closed' | 'conversation.handover_requested' | 'conversation.admin.assigned' | 'conversation.admin.noted' | 'conversation.admin.snoozed' | 'conversation.admin.unsnoozed' | 'conversation.admin.opened' | 'conversation.priority.updated' | 'conversation.deleted' | 'conversation.contact.attached' | 'conversation.contact.detached' | 'conversation.read' | 'conversation_part.redacted'>;
+    /**
+     * Body param: Webhook endpoint URL (must be HTTPS)
+     */
+    url: string;
+    /**
+     * Body param: Optional description of the webhook purpose
+     */
+    description?: string;
+    /**
+     * Body param: Request configuration for webhook delivery
+     */
+    requestConfig?: WebhookRequestConfigInput;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface WebhookRetrieveParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface WebhookUpdateParams {
+    /**
+     * Body param: Optional description of the webhook purpose (null to clear)
+     */
+    description?: string | null;
+    /**
+     * Body param: Human-readable name for the webhook
+     */
+    name?: string;
+    /**
+     * Body param: Request configuration for webhook delivery
+     */
+    requestConfig?: WebhookRequestConfigInput;
+    /**
+     * Body param: Set to "active" to reactivate or "paused" to pause webhook delivery
+     */
+    status?: 'active' | 'paused';
+    /**
+     * Body param: Array of event topics to subscribe to
+     */
+    topics?: Array<'post.created' | 'post.updated' | 'post.deleted' | 'post.voted' | 'ticket.created' | 'ticket.updated' | 'ticket.deleted' | 'changelog.published' | 'comment.created' | 'comment.updated' | 'comment.deleted' | 'conversation.user.created' | 'conversation.user.replied' | 'conversation.admin.replied' | 'conversation.admin.closed' | 'conversation.handover_requested' | 'conversation.admin.assigned' | 'conversation.admin.noted' | 'conversation.admin.snoozed' | 'conversation.admin.unsnoozed' | 'conversation.admin.opened' | 'conversation.priority.updated' | 'conversation.deleted' | 'conversation.contact.attached' | 'conversation.contact.detached' | 'conversation.read' | 'conversation_part.redacted'>;
+    /**
+     * Body param: Webhook endpoint URL (must be HTTPS)
+     */
+    url?: string;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface WebhookListParams {
+    /**
+     * Query param: An opaque cursor for pagination. Use the nextCursor value from a
+     * previous response to fetch the next page of results.
+     */
+    cursor?: string;
+    /**
+     * Query param: A limit on the number of objects to be returned, between 1 and 100.
+     */
+    limit?: number;
+    /**
+     * Query param: Filter webhooks by status
+     */
+    status?: 'active' | 'paused' | 'suspended';
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface WebhookDeleteParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface WebhookRefreshSecretParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export declare namespace Webhooks {
+    export { type Webhook as Webhook, type WebhookRequestConfigInput as WebhookRequestConfigInput, type WebhookListResponse as WebhookListResponse, type WebhookDeleteResponse as WebhookDeleteResponse, type WebhookCreateParams as WebhookCreateParams, type WebhookRetrieveParams as WebhookRetrieveParams, type WebhookUpdateParams as WebhookUpdateParams, type WebhookListParams as WebhookListParams, type WebhookDeleteParams as WebhookDeleteParams, type WebhookRefreshSecretParams as WebhookRefreshSecretParams, };
+}
+//# sourceMappingURL=webhooks.d.mts.map

package/resources/webhooks.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.d.mts","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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiFG;IACH,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAYlF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAWtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0EG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAY9F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;IACH,IAAI,CACF,MAAM,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAYlC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAWpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,aAAa,CACX,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;CAUvB;AAED,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB,aAAa,EAAE,OAAO,CAAC,aAAa,CAAC;IAErC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,WAAW,CAAC;IAE1C;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,cAAc,GACd,cAAc,GACd,cAAc,GACd,YAAY,GACZ,gBAAgB,GAChB,gBAAgB,GAChB,gBAAgB,GAChB,qBAAqB,GACrB,iBAAiB,GACjB,iBAAiB,GACjB,iBAAiB,GACjB,2BAA2B,GAC3B,2BAA2B,GAC3B,4BAA4B,GAC5B,2BAA2B,GAC3B,iCAAiC,GACjC,6BAA6B,GAC7B,0BAA0B,GAC1B,4BAA4B,GAC5B,8BAA8B,GAC9B,2BAA2B,GAC3B,+BAA+B,GAC/B,sBAAsB,GACtB,+BAA+B,GAC/B,+BAA+B,GAC/B,mBAAmB,GACnB,4BAA4B,CAC/B,CAAC;IAEF;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,yBAAiB,OAAO,CAAC;IACvB,UAAiB,MAAM;QACrB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,sBAAsB,EAAE,MAAM,CAAC;QAE/B;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,aAAa;QAC5B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;KACrC;CACF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,cAAc,GACd,cAAc,GACd,cAAc,GACd,YAAY,GACZ,gBAAgB,GAChB,gBAAgB,GAChB,gBAAgB,GAChB,qBAAqB,GACrB,iBAAiB,GACjB,iBAAiB,GACjB,iBAAiB,GACjB,2BAA2B,GAC3B,2BAA2B,GAC3B,4BAA4B,GAC5B,2BAA2B,GAC3B,iCAAiC,GACjC,6BAA6B,GAC7B,0BAA0B,GAC1B,4BAA4B,GAC5B,8BAA8B,GAC9B,2BAA2B,GAC3B,+BAA+B,GAC/B,sBAAsB,GACtB,+BAA+B,GAC/B,+BAA+B,GAC/B,mBAAmB,GACnB,4BAA4B,CAC/B,CAAC;IAEF;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,yBAAyB,CAAC;IAE1C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,aAAa,CAAC,EAAE,yBAAyB,CAAC;IAE1C;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CACV,cAAc,GACd,cAAc,GACd,cAAc,GACd,YAAY,GACZ,gBAAgB,GAChB,gBAAgB,GAChB,gBAAgB,GAChB,qBAAqB,GACrB,iBAAiB,GACjB,iBAAiB,GACjB,iBAAiB,GACjB,2BAA2B,GAC3B,2BAA2B,GAC3B,4BAA4B,GAC5B,2BAA2B,GAC3B,iCAAiC,GACjC,6BAA6B,GAC7B,0BAA0B,GAC1B,4BAA4B,GAC5B,8BAA8B,GAC9B,2BAA2B,GAC3B,+BAA+B,GAC/B,sBAAsB,GACtB,+BAA+B,GAC/B,+BAA+B,GAC/B,mBAAmB,GACnB,4BAA4B,CAC/B,CAAC;IAEF;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,WAAW,CAAC;IAE3C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}