atmn 2.0.33 → 2.0.35

package/src/generated/apiRoutes.ts

@@ -4048,7 +4048,8 @@ export const API_ROUTES: readonly ApiRoute[] = [
 				name: "name",
 				type: "string",
 				required: true,
-				description: "A name for the sandbox, unique within your organization.",
+				description:
+					"A name for the sandbox, unique within your organization. No spaces, and it can't be `live` or `sandbox`.",
 			},
 			{
 				name: "color",
@@ -4100,4 +4101,167 @@ export const API_ROUTES: readonly ApiRoute[] = [
 		body: "none",
 		fields: [],
 	},
+	{
+		group: "webhooks",
+		method: "create",
+		path: "/v1/webhooks.create",
+		description:
+			"Creates a webhook: a URL Autumn sends the listed events to, in the environment of the calling key. You choose the `id`, and it can't be changed later. Returns the signing secret once, in this response — store it, it cannot be read back.",
+		body: "object",
+		fields: [
+			{
+				name: "id",
+				type: "string",
+				required: true,
+				description:
+					"Your ID for the webhook: letters, digits, `-` and `_`. It can't be changed after creation.",
+			},
+			{
+				name: "url",
+				type: "string",
+				required: true,
+				description:
+					"The https URL Autumn sends events to. Localhost and private-network addresses are rejected; tunnels such as ngrok work.",
+			},
+			{
+				name: "events",
+				type: "json",
+				required: true,
+				description:
+					"The events sent to this webhook. At least one. `vercel.*` events can't be mixed with other events.",
+			},
+			{
+				name: "description",
+				type: "string",
+				required: false,
+				description: "A note for your own reference.",
+			},
+			{
+				name: "disabled",
+				type: "boolean",
+				required: false,
+				description: "When true, no events are sent to the webhook.",
+			},
+		],
+	},
+	{
+		group: "webhooks",
+		method: "get",
+		path: "/v1/webhooks.get",
+		description:
+			"Gets one webhook by ID. The signing secret is never returned here — only `webhooks.create` and `webhooks.sync` show one, when they create the webhook.",
+		body: "object",
+		fields: [
+			{
+				name: "id",
+				type: "string",
+				required: true,
+				description:
+					"The webhook's ID. Webhooks made in the dashboard use the `ep_…` ID shown by `webhooks.list`.",
+			},
+		],
+	},
+	{
+		group: "webhooks",
+		method: "list",
+		path: "/v1/webhooks.list",
+		description:
+			"Lists every webhook in the environment of the calling key, including ones made in the dashboard (these show their `ep_…` ID).",
+		body: "none",
+		fields: [],
+	},
+	{
+		group: "webhooks",
+		method: "update",
+		path: "/v1/webhooks.update",
+		description:
+			"Updates a webhook's URL, events, description or disabled state. Only the fields you pass change. The ID can't be changed — to rename, create a new webhook.",
+		body: "object",
+		fields: [
+			{
+				name: "id",
+				type: "string",
+				required: true,
+				description:
+					"The webhook's ID. Webhooks made in the dashboard use the `ep_…` ID shown by `webhooks.list`.",
+			},
+			{
+				name: "url",
+				type: "string",
+				required: false,
+				description:
+					"The https URL Autumn sends events to. Localhost and private-network addresses are rejected; tunnels such as ngrok work.",
+			},
+			{
+				name: "events",
+				type: "json",
+				required: false,
+				description:
+					"The events sent to this webhook. At least one. `vercel.*` events can't be mixed with other events.",
+			},
+			{
+				name: "description",
+				type: "string",
+				required: false,
+				description: "A note for your own reference.",
+			},
+			{
+				name: "disabled",
+				type: "boolean",
+				required: false,
+				description: "When true, no events are sent to the webhook.",
+			},
+		],
+	},
+	{
+		group: "webhooks",
+		method: "delete",
+		path: "/v1/webhooks.delete",
+		description:
+			"Permanently deletes a webhook. Autumn stops sending it events immediately. Cannot be undone.",
+		body: "object",
+		fields: [
+			{
+				name: "id",
+				type: "string",
+				required: true,
+				description:
+					"The webhook's ID. Webhooks made in the dashboard use the `ep_…` ID shown by `webhooks.list`.",
+			},
+		],
+	},
+	{
+		group: "webhooks",
+		method: "preview_sync",
+		path: "/v1/webhooks.preview_sync",
+		description:
+			"Shows what `webhooks.sync` would do with the same body, without changing anything: which webhooks it would create or update, and which existing ones it would leave alone because the body doesn't list them.",
+		body: "object",
+		fields: [
+			{
+				name: "webhooks",
+				type: "json",
+				required: true,
+				description:
+					"The webhooks to create or update. Webhooks not listed are left alone; nothing is deleted.",
+			},
+		],
+	},
+	{
+		group: "webhooks",
+		method: "sync",
+		path: "/v1/webhooks.sync",
+		description:
+			"Makes the listed webhooks exist as described: creates missing ones and updates ones that differ. Webhooks not listed are left alone — sync never deletes. Returns the signing secret of each webhook it created, once. Each webhook is applied on its own: failures are listed in `errors` while the rest still apply, and the request fails only when none could be applied.",
+		body: "object",
+		fields: [
+			{
+				name: "webhooks",
+				type: "json",
+				required: true,
+				description:
+					"The webhooks to create or update. Webhooks not listed are left alone; nothing is deleted.",
+			},
+		],
+	},
 ];