@breign/client 1.0.178 → 1.0.179

package/dist/models/WebhookTestResponseUio.js

@@ -0,0 +1,50 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * brain-client
+ * Api ands models for brain-app and brain-app
+ *
+ * The version of the OpenAPI document: 0.0.0-SNAPSHOT
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfWebhookTestResponseUio = instanceOfWebhookTestResponseUio;
+exports.WebhookTestResponseUioFromJSON = WebhookTestResponseUioFromJSON;
+exports.WebhookTestResponseUioFromJSONTyped = WebhookTestResponseUioFromJSONTyped;
+exports.WebhookTestResponseUioToJSON = WebhookTestResponseUioToJSON;
+exports.WebhookTestResponseUioToJSONTyped = WebhookTestResponseUioToJSONTyped;
+/**
+ * Check if a given object implements the WebhookTestResponseUio interface.
+ */
+function instanceOfWebhookTestResponseUio(value) {
+    if (!('eventId' in value) || value['eventId'] === undefined)
+        return false;
+    return true;
+}
+function WebhookTestResponseUioFromJSON(json) {
+    return WebhookTestResponseUioFromJSONTyped(json, false);
+}
+function WebhookTestResponseUioFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'eventId': json['eventId'],
+    };
+}
+function WebhookTestResponseUioToJSON(json) {
+    return WebhookTestResponseUioToJSONTyped(json, false);
+}
+function WebhookTestResponseUioToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'eventId': value['eventId'],
+    };
+}

package/dist/models/index.d.ts

@@ -648,6 +648,12 @@ export * from './UserIdentifierRequestUio';
 export * from './UserIdentifierUio';
 export * from './UserLockRequestUio';
 export * from './UserUpdateRequestUio';
+export * from './WebhookEndpointUio';
+export * from './WebhookEndpointUpdateUio';
+export * from './WebhookEventListUio';
+export * from './WebhookEventUio';
+export * from './WebhookTestRequestUio';
+export * from './WebhookTestResponseUio';
 export * from './WorkspaceFileContentUio';
 export * from './WorkspaceFileEntryUio';
 export * from './WorkspaceFileWriteRequestUio';

package/dist/models/index.js

@@ -666,6 +666,12 @@ __exportStar(require("./UserIdentifierRequestUio"), exports);
 __exportStar(require("./UserIdentifierUio"), exports);
 __exportStar(require("./UserLockRequestUio"), exports);
 __exportStar(require("./UserUpdateRequestUio"), exports);
+__exportStar(require("./WebhookEndpointUio"), exports);
+__exportStar(require("./WebhookEndpointUpdateUio"), exports);
+__exportStar(require("./WebhookEventListUio"), exports);
+__exportStar(require("./WebhookEventUio"), exports);
+__exportStar(require("./WebhookTestRequestUio"), exports);
+__exportStar(require("./WebhookTestResponseUio"), exports);
 __exportStar(require("./WorkspaceFileContentUio"), exports);
 __exportStar(require("./WorkspaceFileEntryUio"), exports);
 __exportStar(require("./WorkspaceFileWriteRequestUio"), exports);

package/dist/openapi.json

@@ -3067,6 +3067,326 @@
         "tags" : [ "scheduledTasks" ]
       }
     },
+    "/agents/{agentId}/scheduled-tasks/{taskId}/webhook" : {
+      "get" : {
+        "operationId" : "getScheduledTaskWebhook",
+        "parameters" : [ {
+          "description" : "ID of the agent",
+          "in" : "path",
+          "name" : "agentId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        }, {
+          "description" : "ID of the scheduled task",
+          "in" : "path",
+          "name" : "taskId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/WebhookEndpoint"
+                }
+              }
+            },
+            "description" : "The webhook, without its secret"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "404" : {
+            "description" : "Task not found, or not triggered by a webhook"
+          }
+        },
+        "summary" : "The webhook of an automation triggered by a webhook",
+        "tags" : [ "scheduledTasks" ]
+      },
+      "patch" : {
+        "operationId" : "updateScheduledTaskWebhook",
+        "parameters" : [ {
+          "description" : "ID of the agent",
+          "in" : "path",
+          "name" : "agentId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        }, {
+          "description" : "ID of the scheduled task",
+          "in" : "path",
+          "name" : "taskId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/WebhookEndpointUpdate"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/WebhookEndpoint"
+                }
+              }
+            },
+            "description" : "The updated webhook"
+          },
+          "400" : {
+            "description" : "Invalid body"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden (another service user requires an organization admin)"
+          },
+          "404" : {
+            "description" : "Task not found, or not triggered by a webhook"
+          },
+          "422" : {
+            "description" : "The service user is not a member of the organization"
+          }
+        },
+        "summary" : "Disable the webhook or change its service user",
+        "tags" : [ "scheduledTasks" ]
+      }
+    },
+    "/agents/{agentId}/scheduled-tasks/{taskId}/webhook/rotate-secret" : {
+      "post" : {
+        "operationId" : "rotateScheduledTaskWebhookSecret",
+        "parameters" : [ {
+          "description" : "ID of the agent",
+          "in" : "path",
+          "name" : "agentId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        }, {
+          "description" : "ID of the scheduled task",
+          "in" : "path",
+          "name" : "taskId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/WebhookEndpoint"
+                }
+              }
+            },
+            "description" : "The webhook, with its new secret (shown once)"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "404" : {
+            "description" : "Task not found, or not triggered by a webhook"
+          }
+        },
+        "summary" : "Rotate the webhook secret (the old one stops working)",
+        "tags" : [ "scheduledTasks" ]
+      }
+    },
+    "/agents/{agentId}/scheduled-tasks/{taskId}/webhook/regenerate-url" : {
+      "post" : {
+        "operationId" : "regenerateScheduledTaskWebhookUrl",
+        "parameters" : [ {
+          "description" : "ID of the agent",
+          "in" : "path",
+          "name" : "agentId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        }, {
+          "description" : "ID of the scheduled task",
+          "in" : "path",
+          "name" : "taskId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/WebhookEndpoint"
+                }
+              }
+            },
+            "description" : "The webhook at its new URL"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "404" : {
+            "description" : "Task not found, or not triggered by a webhook"
+          }
+        },
+        "summary" : "Give the webhook a new URL (the old one answers 404)",
+        "tags" : [ "scheduledTasks" ]
+      }
+    },
+    "/agents/{agentId}/scheduled-tasks/{taskId}/webhook/events" : {
+      "get" : {
+        "operationId" : "listScheduledTaskWebhookEvents",
+        "parameters" : [ {
+          "description" : "ID of the agent",
+          "in" : "path",
+          "name" : "agentId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        }, {
+          "description" : "ID of the scheduled task",
+          "in" : "path",
+          "name" : "taskId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "in" : "query",
+          "name" : "limit",
+          "required" : false,
+          "schema" : {
+            "default" : 20,
+            "maximum" : 100,
+            "minimum" : 1,
+            "type" : "integer"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/WebhookEventList"
+                }
+              }
+            },
+            "description" : "The latest calls, most recent first"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "404" : {
+            "description" : "Task not found, or not triggered by a webhook"
+          }
+        },
+        "summary" : "The latest calls received on the webhook",
+        "tags" : [ "scheduledTasks" ]
+      }
+    },
+    "/agents/{agentId}/scheduled-tasks/{taskId}/webhook/test" : {
+      "post" : {
+        "description" : "The call goes through the same ingestion as a real one, and the agent runs for real.",
+        "operationId" : "testScheduledTaskWebhook",
+        "parameters" : [ {
+          "description" : "ID of the agent",
+          "in" : "path",
+          "name" : "agentId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        }, {
+          "description" : "ID of the scheduled task",
+          "in" : "path",
+          "name" : "taskId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/WebhookTestRequest"
+              }
+            }
+          },
+          "required" : false
+        },
+        "responses" : {
+          "202" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/WebhookTestResponse"
+                }
+              }
+            },
+            "description" : "The test call is queued"
+          },
+          "400" : {
+            "description" : "Invalid body"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "404" : {
+            "description" : "Task not found, or not triggered by a webhook"
+          },
+          "422" : {
+            "description" : "The webhook or the automation is not active"
+          },
+          "429" : {
+            "description" : "Too many calls this minute"
+          }
+        },
+        "summary" : "Send a test call to the webhook, signed by the server",
+        "tags" : [ "scheduledTasks" ]
+      }
+    },
     "/agents/{agentId}/apps" : {
       "get" : {
         "description" : "Get apps for agent id",
@@ -23440,12 +23760,15 @@
             "allOf" : [ {
               "$ref" : "#/components/schemas/TaskSchedule"
             } ],
-            "description" : "null for an automation triggered by an event.",
+            "description" : "null for an automation triggered by an event or a webhook.",
             "nullable" : true
           },
           "trigger" : {
             "$ref" : "#/components/schemas/TaskTrigger"
           },
+          "webhook" : {
+            "$ref" : "#/components/schemas/WebhookEndpoint"
+          },
           "cronExpression" : {
             "type" : "string"
           },
@@ -23547,10 +23870,14 @@
         "type" : "object"
       },
       "TaskTrigger" : {
-        "description" : "What starts the automation. `schedule` (default): its schedule. `event`: a mention of one of the bot accounts in GitLab, in the given kinds of objects and projects (empty: all projects; `groupe/projet` or `groupe/*`).",
+        "description" : "What starts the automation. `schedule` (default): its schedule. `event`: a mention of one of the bot accounts in GitLab, in the given kinds of objects and projects (empty: all projects; `groupe/projet` or `groupe/*`). `webhook`: a call to its webhook (see `ScheduledTask.webhook`); the result goes to `callbackUrl`.",
         "properties" : {
           "type" : {
-            "enum" : [ "schedule", "event" ],
+            "enum" : [ "schedule", "event", "webhook" ],
+            "type" : "string"
+          },
+          "runAsUserId" : {
+            "description" : "`webhook` only, on create or update: the member the conversations run as (default: the caller; another member requires an organization admin). Not stored on the task.",
             "type" : "string"
           },
           "source" : {
@@ -23584,7 +23911,7 @@
         "type" : "object"
       },
       "ScheduledTaskCreate" : {
-        "description" : "`schedule` is required unless `trigger.type` is `event` (then `mode` must be `recurring`).",
+        "description" : "`schedule` is required unless `trigger.type` is `event` or `webhook` (then `mode` must be `recurring`). A `webhook` trigger creates the webhook, returned in `webhook` with its secret (shown once).",
         "properties" : {
           "message" : {
             "minLength" : 1,
@@ -23755,15 +24082,31 @@
         "type" : "object"
       },
       "ScheduledTaskRunTrigger" : {
-        "description" : "The GitLab mention that triggered a run.",
+        "description" : "The external event that triggered a run: a GitLab mention (`source: gitlab`, GitLab fields set) or a webhook call (`source: webhook`: `thread`, `contentType`, `payload`).",
         "properties" : {
           "eventId" : {
             "type" : "string"
           },
           "source" : {
-            "enum" : [ "gitlab" ],
+            "enum" : [ "gitlab", "webhook" ],
             "type" : "string"
           },
+          "thread" : {
+            "description" : "webhook only — the `X-Breign-Thread` of the call.",
+            "nullable" : true,
+            "type" : "string"
+          },
+          "contentType" : {
+            "description" : "webhook only.",
+            "type" : "string"
+          },
+          "payload" : {
+            "description" : "webhook only — the body received (untrusted caller data), or its start as text."
+          },
+          "payloadTruncated" : {
+            "description" : "webhook only.",
+            "type" : "boolean"
+          },
           "status" : {
             "$ref" : "#/components/schemas/ExternalEventStatus"
           },
@@ -23820,7 +24163,138 @@
             "type" : "string"
           }
         },
-        "required" : [ "author", "body", "botUsername", "conversationId", "eventId", "noteUrl", "projectPath", "receivedAt", "replyUrl", "routing", "source", "status", "targetIid", "targetTitle", "targetType", "targetUrl" ],
+        "required" : [ "conversationId", "eventId", "receivedAt", "source", "status" ],
+        "type" : "object"
+      },
+      "WebhookEndpoint" : {
+        "description" : "The public address of an automation triggered by a webhook. Callers POST to `url` with `Authorization: Bearer <secret>`, or sign the raw body with HMAC-SHA256 (`X-Breign-Signature: sha256=<hex>`; with `X-Breign-Timestamp: <unix seconds>` the signature covers `<timestamp>.<body>`). Optional headers: `Idempotency-Key`, `X-Breign-Thread`.",
+        "properties" : {
+          "id" : {
+            "type" : "string"
+          },
+          "url" : {
+            "type" : "string"
+          },
+          "status" : {
+            "enum" : [ "active", "disabled" ],
+            "type" : "string"
+          },
+          "runAsUserId" : {
+            "description" : "The organization member the conversations run as (user-scoped MCP tools, quotas, history).",
+            "type" : "string"
+          },
+          "lastEventAt" : {
+            "format" : "date-time",
+            "nullable" : true,
+            "type" : "string"
+          },
+          "createdAt" : {
+            "format" : "date-time",
+            "type" : "string"
+          },
+          "updatedAt" : {
+            "format" : "date-time",
+            "type" : "string"
+          },
+          "secret" : {
+            "description" : "Only returned when the endpoint is created and after a rotation.",
+            "type" : "string"
+          }
+        },
+        "required" : [ "createdAt", "id", "lastEventAt", "runAsUserId", "status", "updatedAt", "url" ],
+        "type" : "object"
+      },
+      "WebhookEndpointUpdate" : {
+        "minProperties" : 1,
+        "properties" : {
+          "runAsUserId" : {
+            "description" : "Another member than the caller requires an organization admin.",
+            "type" : "string"
+          },
+          "status" : {
+            "enum" : [ "active", "disabled" ],
+            "type" : "string"
+          }
+        },
+        "type" : "object"
+      },
+      "WebhookEventList" : {
+        "properties" : {
+          "events" : {
+            "items" : {
+              "$ref" : "#/components/schemas/WebhookEvent"
+            },
+            "type" : "array"
+          }
+        },
+        "required" : [ "events" ],
+        "type" : "object"
+      },
+      "WebhookEvent" : {
+        "description" : "A call received on the webhook, and where it is in the queue.",
+        "properties" : {
+          "id" : {
+            "type" : "string"
+          },
+          "status" : {
+            "$ref" : "#/components/schemas/ExternalEventStatus"
+          },
+          "receivedAt" : {
+            "format" : "date-time",
+            "type" : "string"
+          },
+          "finishedAt" : {
+            "format" : "date-time",
+            "nullable" : true,
+            "type" : "string"
+          },
+          "attempts" : {
+            "type" : "integer"
+          },
+          "lastError" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "thread" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "contentType" : {
+            "type" : "string"
+          },
+          "runId" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "conversationId" : {
+            "nullable" : true,
+            "type" : "string"
+          }
+        },
+        "required" : [ "attempts", "contentType", "conversationId", "finishedAt", "id", "lastError", "receivedAt", "runId", "status", "thread" ],
+        "type" : "object"
+      },
+      "WebhookTestRequest" : {
+        "properties" : {
+          "body" : {
+            "description" : "The JSON body of the test call (default `{\"test\": true}`)."
+          },
+          "thread" : {
+            "description" : "Sent as `X-Breign-Thread`.",
+            "maxLength" : 200,
+            "type" : "string"
+          }
+        },
+        "type" : "object"
+      },
+      "WebhookTestResponse" : {
+        "properties" : {
+          "eventId" : {
+            "nullable" : true,
+            "type" : "string"
+          }
+        },
+        "required" : [ "eventId" ],
         "type" : "object"
       },
       "AppLight" : {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@breign/client",
-  "version": "1.0.178",
+  "version": "1.0.179",
   "main": "dist/index.js",
   "exports": {
     ".": "./dist/index.js",