@naturali/cli 0.40.0 → 0.41.0

package/dist/index.mjs

@@ -14,7 +14,7 @@ var __exportAll = (all, no_symbols) => {
 };
 //#endregion
 //#region package.json
-var version = "0.40.0";
+var version = "0.41.0";
 //#endregion
 //#region ../sdk/src/generated/core/bodySerializer.gen.ts
 const jsonBodySerializer = { bodySerializer: (body) => JSON.stringify(body, (_key, value) => typeof value === "bigint" ? value.toString() : value) };
@@ -1850,6 +1850,126 @@ var Traces = class {
 		});
 	}
 };
+var Webhooks = class {
+	/**
+	* List webhooks
+	*
+	* The endpoints registered in the project, newest first.
+	*/
+	static listWebhooks(options) {
+		return (options.client ?? client).get({
+			url: "/v1/projects/{project_id}/webhooks",
+			...options
+		});
+	}
+	/**
+	* Create a webhook
+	*
+	* Register an endpoint and subscribe it to one or more event types.
+	* The response carries `secret` — the signing key, in plaintext. **This is the only time it is returned.** Store it where your receiver can read it; if you lose it, rotate rather than re-create, so the endpoint keeps its delivery history.
+	* Returns `501` on a deployment with no credential-sealing key configured, since the secret could not then be stored safely.
+	*
+	*/
+	static createWebhook(options) {
+		return (options.client ?? client).post({
+			url: "/v1/projects/{project_id}/webhooks",
+			...options,
+			headers: {
+				"Content-Type": "application/json",
+				...options.headers
+			}
+		});
+	}
+	/**
+	* Delete a webhook
+	*
+	* Removes the endpoint and its delivery records. To stop deliveries while keeping the audit trail, `PATCH` it to `active: false` instead.
+	*
+	*/
+	static deleteWebhook(options) {
+		return (options.client ?? client).delete({
+			url: "/v1/projects/{project_id}/webhooks/{webhook_id}",
+			...options
+		});
+	}
+	/**
+	* Get a webhook
+	*/
+	static getWebhook(options) {
+		return (options.client ?? client).get({
+			url: "/v1/projects/{project_id}/webhooks/{webhook_id}",
+			...options
+		});
+	}
+	/**
+	* Update a webhook
+	*
+	* Change the destination, the subscription, the label, or whether deliveries are attempted at all. At least one field is required.
+	* Setting `active: false` is the reversible half of `DELETE`: deliveries stop, the endpoint and its history stay. It is what to reach for while a receiver is being repaired.
+	*
+	*/
+	static updateWebhook(options) {
+		return (options.client ?? client).patch({
+			url: "/v1/projects/{project_id}/webhooks/{webhook_id}",
+			...options,
+			headers: {
+				"Content-Type": "application/json",
+				...options.headers
+			}
+		});
+	}
+	/**
+	* Rotate the signing secret
+	*
+	* Issues a new signing secret for the same endpoint and returns it — the second and last time a secret is ever returned. This is the `…:rotate-secret` action; the path segment is `{webhook_id}:rotate-secret`.
+	* The change takes effect on the next delivery, including retries of deliveries already queued, so roll the new secret out to your receiver promptly. There is no overlap window in which both secrets verify.
+	*
+	*/
+	static rotateWebhookSecret(options) {
+		return (options.client ?? client).post({
+			url: "/v1/projects/{project_id}/webhooks/{webhook_id}:rotate-secret",
+			...options
+		});
+	}
+	/**
+	* List webhook deliveries
+	*
+	* Every delivery attempted in the project, newest first — what was sent, where, how many times, and what came back. Filter by endpoint, by lifecycle status, or by event type.
+	* Deliveries are per (event, endpoint): an event matching two subscribed endpoints produces two rows, retried and observed independently.
+	*
+	*/
+	static listWebhookDeliveries(options) {
+		return (options.client ?? client).get({
+			url: "/v1/projects/{project_id}/webhook-deliveries",
+			...options
+		});
+	}
+	/**
+	* Get a webhook delivery
+	*
+	* One delivery, including the exact payload that was signed and sent.
+	*
+	*/
+	static getWebhookDelivery(options) {
+		return (options.client ?? client).get({
+			url: "/v1/projects/{project_id}/webhook-deliveries/{delivery_id}",
+			...options
+		});
+	}
+	/**
+	* Redeliver an event
+	*
+	* Queue the same event at the same endpoint again — the recovery path for a delivery that failed, or one your receiver dropped. This is the `…:redeliver` action; the path segment is `{delivery_id}:redeliver`.
+	* A **new** delivery is created and returned; the original record is left untouched, because its attempt history is the evidence you redelivered on. The event's `id` is carried over unchanged, so a receiver deduping on the event sees the same event twice while one deduping on `X-Naturali-Delivery` sees a distinct delivery.
+	*
+	*/
+	static redeliverWebhookDelivery(options) {
+		return (options.client ?? client).post({
+			url: "/v1/projects/{project_id}/webhook-deliveries/{delivery_id}:redeliver",
+			...options
+		});
+	}
+};
 //#endregion
 //#region ../sdk/src/naturaliClient.ts
 /**
@@ -1912,6 +2032,7 @@ var NaturaliClient = class {
 	tasks;
 	tools;
 	traces;
+	webhooks;
 	/** The underlying HTTP client, for interceptors or one-off requests. */
 	http;
 	constructor({ token, headers } = {}) {
@@ -1937,6 +2058,7 @@ var NaturaliClient = class {
 		this.tasks = bindResource(Tasks, this.http);
 		this.tools = bindResource(Tools, this.http);
 		this.traces = bindResource(Traces, this.http);
+		this.webhooks = bindResource(Webhooks, this.http);
 	}
 };
 //#endregion
@@ -1958,6 +2080,7 @@ var src_exports = /* @__PURE__ */ __exportAll({
 	Tasks: () => Tasks,
 	Tools: () => Tools,
 	Traces: () => Traces,
+	Webhooks: () => Webhooks,
 	createClient: () => createClient,
 	createConfig: () => createConfig
 });
@@ -5747,6 +5870,306 @@ const routes = {
 				"in": "query"
 			}
 		]
+	},
+	"list-webhooks": {
+		serviceClass: "Webhooks",
+		operationId: "listWebhooks",
+		description: "The endpoints registered in the project, newest first.",
+		moduleDocsUrl: "https://docs.naturali.ai/docs/modules/webhooks",
+		httpMethod: "get",
+		pathParams: ["project_id"],
+		queryParams: ["limit", "cursor"],
+		flags: [
+			{
+				"name": "project_id",
+				"description": "Project public ID (proj_ prefix).",
+				"required": true,
+				"type": "string",
+				"in": "path"
+			},
+			{
+				"name": "limit",
+				"description": "Maximum items per page.",
+				"required": false,
+				"type": "integer",
+				"in": "query"
+			},
+			{
+				"name": "cursor",
+				"description": "Opaque pagination cursor from a previous response's next_cursor.",
+				"required": false,
+				"type": "string",
+				"in": "query"
+			}
+		]
+	},
+	"create-webhook": {
+		serviceClass: "Webhooks",
+		operationId: "createWebhook",
+		description: "Register an endpoint and subscribe it to one or more event types. The response carries `secret` — the signing key, in plaintext. **This is the only time it is returned.** Store it where your receiver can read it; if you lose it, rotate rather than re-create, so the endpoint keeps its delivery history. Returns `501` on a deployment with no credential-sealing key configured, since the secret could not then be stored safely.",
+		moduleDocsUrl: "https://docs.naturali.ai/docs/modules/webhooks",
+		httpMethod: "post",
+		pathParams: ["project_id"],
+		queryParams: [],
+		flags: [
+			{
+				"name": "project_id",
+				"description": "Project public ID (proj_ prefix).",
+				"required": true,
+				"type": "string",
+				"in": "path"
+			},
+			{
+				"name": "url",
+				"description": "An `https://` endpoint (`http://` is accepted for localhost, so a tunnel works in development).\n",
+				"required": true,
+				"type": "string",
+				"in": "body"
+			},
+			{
+				"name": "events",
+				"description": "Which events this endpoint receives. Each entry is an exact type (`task.created`), a resource wildcard (`task.*`), or `*` for everything. A bare resource name (`task`) matches nothing and is rejected.\n",
+				"required": true,
+				"type": "array",
+				"in": "body"
+			},
+			{
+				"name": "description",
+				"description": "",
+				"required": false,
+				"type": "string",
+				"in": "body"
+			},
+			{
+				"name": "active",
+				"description": "",
+				"required": false,
+				"type": "boolean",
+				"in": "body"
+			}
+		]
+	},
+	"get-webhook": {
+		serviceClass: "Webhooks",
+		operationId: "getWebhook",
+		description: "Get a webhook",
+		moduleDocsUrl: "https://docs.naturali.ai/docs/modules/webhooks",
+		httpMethod: "get",
+		pathParams: ["project_id", "webhook_id"],
+		queryParams: [],
+		flags: [{
+			"name": "project_id",
+			"description": "Project public ID (proj_ prefix).",
+			"required": true,
+			"type": "string",
+			"in": "path"
+		}, {
+			"name": "webhook_id",
+			"description": "Webhook public ID (whk_ prefix).",
+			"required": true,
+			"type": "string",
+			"in": "path"
+		}]
+	},
+	"update-webhook": {
+		serviceClass: "Webhooks",
+		operationId: "updateWebhook",
+		description: "Change the destination, the subscription, the label, or whether deliveries are attempted at all. At least one field is required. Setting `active: false` is the reversible half of `DELETE`: deliveries stop, the endpoint and its history stay. It is what to reach for while a receiver is being repaired.",
+		moduleDocsUrl: "https://docs.naturali.ai/docs/modules/webhooks",
+		httpMethod: "patch",
+		pathParams: ["project_id", "webhook_id"],
+		queryParams: [],
+		flags: [
+			{
+				"name": "project_id",
+				"description": "Project public ID (proj_ prefix).",
+				"required": true,
+				"type": "string",
+				"in": "path"
+			},
+			{
+				"name": "webhook_id",
+				"description": "Webhook public ID (whk_ prefix).",
+				"required": true,
+				"type": "string",
+				"in": "path"
+			},
+			{
+				"name": "url",
+				"description": "",
+				"required": false,
+				"type": "string",
+				"in": "body"
+			},
+			{
+				"name": "events",
+				"description": "Which events this endpoint receives. Each entry is an exact type (`task.created`), a resource wildcard (`task.*`), or `*` for everything. A bare resource name (`task`) matches nothing and is rejected.\n",
+				"required": false,
+				"type": "array",
+				"in": "body"
+			},
+			{
+				"name": "description",
+				"description": "",
+				"required": false,
+				"type": "string",
+				"in": "body"
+			},
+			{
+				"name": "active",
+				"description": "",
+				"required": false,
+				"type": "boolean",
+				"in": "body"
+			}
+		]
+	},
+	"delete-webhook": {
+		serviceClass: "Webhooks",
+		operationId: "deleteWebhook",
+		description: "Removes the endpoint and its delivery records. To stop deliveries while keeping the audit trail, `PATCH` it to `active: false` instead.",
+		moduleDocsUrl: "https://docs.naturali.ai/docs/modules/webhooks",
+		httpMethod: "delete",
+		pathParams: ["project_id", "webhook_id"],
+		queryParams: [],
+		flags: [{
+			"name": "project_id",
+			"description": "Project public ID (proj_ prefix).",
+			"required": true,
+			"type": "string",
+			"in": "path"
+		}, {
+			"name": "webhook_id",
+			"description": "Webhook public ID (whk_ prefix).",
+			"required": true,
+			"type": "string",
+			"in": "path"
+		}]
+	},
+	"rotate-webhook-secret": {
+		serviceClass: "Webhooks",
+		operationId: "rotateWebhookSecret",
+		description: "Issues a new signing secret for the same endpoint and returns it — the second and last time a secret is ever returned. This is the `…:rotate-secret` action; the path segment is `{webhook_id}:rotate-secret`. The change takes effect on the next delivery, including retries of deliveries already queued, so roll the new secret out to your receiver promptly. There is no overlap window in which both secrets verify.",
+		moduleDocsUrl: "https://docs.naturali.ai/docs/modules/webhooks",
+		httpMethod: "post",
+		pathParams: ["project_id", "webhook_id"],
+		queryParams: [],
+		flags: [{
+			"name": "project_id",
+			"description": "Project public ID (proj_ prefix).",
+			"required": true,
+			"type": "string",
+			"in": "path"
+		}, {
+			"name": "webhook_id",
+			"description": "Webhook public ID (whk_ prefix).",
+			"required": true,
+			"type": "string",
+			"in": "path"
+		}]
+	},
+	"list-webhook-deliveries": {
+		serviceClass: "Webhooks",
+		operationId: "listWebhookDeliveries",
+		description: "Every delivery attempted in the project, newest first — what was sent, where, how many times, and what came back. Filter by endpoint, by lifecycle status, or by event type. Deliveries are per (event, endpoint): an event matching two subscribed endpoints produces two rows, retried and observed independently.",
+		moduleDocsUrl: "https://docs.naturali.ai/docs/modules/webhooks",
+		httpMethod: "get",
+		pathParams: ["project_id"],
+		queryParams: [
+			"limit",
+			"cursor",
+			"webhook_id",
+			"status",
+			"event_type"
+		],
+		flags: [
+			{
+				"name": "project_id",
+				"description": "Project public ID (proj_ prefix).",
+				"required": true,
+				"type": "string",
+				"in": "path"
+			},
+			{
+				"name": "limit",
+				"description": "Maximum items per page.",
+				"required": false,
+				"type": "integer",
+				"in": "query"
+			},
+			{
+				"name": "cursor",
+				"description": "Opaque pagination cursor from a previous response's next_cursor.",
+				"required": false,
+				"type": "string",
+				"in": "query"
+			},
+			{
+				"name": "webhook_id",
+				"description": "Only deliveries addressed to this endpoint.",
+				"required": false,
+				"type": "string",
+				"in": "query"
+			},
+			{
+				"name": "status",
+				"description": "Only deliveries in this state.",
+				"required": false,
+				"type": "string",
+				"in": "query"
+			},
+			{
+				"name": "event_type",
+				"description": "Only deliveries of this event type.",
+				"required": false,
+				"type": "string",
+				"in": "query"
+			}
+		]
+	},
+	"get-webhook-delivery": {
+		serviceClass: "Webhooks",
+		operationId: "getWebhookDelivery",
+		description: "One delivery, including the exact payload that was signed and sent.",
+		moduleDocsUrl: "https://docs.naturali.ai/docs/modules/webhooks",
+		httpMethod: "get",
+		pathParams: ["project_id", "delivery_id"],
+		queryParams: [],
+		flags: [{
+			"name": "project_id",
+			"description": "Project public ID (proj_ prefix).",
+			"required": true,
+			"type": "string",
+			"in": "path"
+		}, {
+			"name": "delivery_id",
+			"description": "Delivery public ID (whd_ prefix).",
+			"required": true,
+			"type": "string",
+			"in": "path"
+		}]
+	},
+	"redeliver-webhook-delivery": {
+		serviceClass: "Webhooks",
+		operationId: "redeliverWebhookDelivery",
+		description: "Queue the same event at the same endpoint again — the recovery path for a delivery that failed, or one your receiver dropped. This is the `…:redeliver` action; the path segment is `{delivery_id}:redeliver`. A **new** delivery is created and returned; the original record is left untouched, because its attempt history is the evidence you redelivered on. The event's `id` is carried over unchanged, so a receiver deduping on the event sees the same event twice while one deduping on `X-Naturali-Delivery` sees a distinct delivery.",
+		moduleDocsUrl: "https://docs.naturali.ai/docs/modules/webhooks",
+		httpMethod: "post",
+		pathParams: ["project_id", "delivery_id"],
+		queryParams: [],
+		flags: [{
+			"name": "project_id",
+			"description": "Project public ID (proj_ prefix).",
+			"required": true,
+			"type": "string",
+			"in": "path"
+		}, {
+			"name": "delivery_id",
+			"description": "Delivery public ID (whd_ prefix).",
+			"required": true,
+			"type": "string",
+			"in": "path"
+		}]
 	}
 };
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturali/cli",
-  "version": "0.40.0",
+  "version": "0.41.0",
   "description": "Command-line interface for the naturali.ai API, generated from its OpenAPI specs",
   "type": "module",
   "bin": {
@@ -30,7 +30,7 @@
     "tsx": "^4.23.1",
     "typescript": "~6.0.3",
     "vitest": "^4.1.10",
-    "@naturali/sdk": "0.40.0"
+    "@naturali/sdk": "0.41.0"
   },
   "scripts": {
     "generate": "tsx scripts/generate.ts",