@breign/client 1.0.179 → 1.0.180

package/dist/openapi.json

@@ -19699,6 +19699,182 @@
         "tags" : [ "tickets" ]
       }
     },
+    "/organizations/{organizationId}/automations" : {
+      "get" : {
+        "description" : "Every member of the organization can read them, as they can read its agents.",
+        "operationId" : "listOrganizationAutomations",
+        "parameters" : [ {
+          "description" : "ID of the organization",
+          "in" : "path",
+          "name" : "organizationId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "in" : "query",
+          "name" : "agentId",
+          "required" : false,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "in" : "query",
+          "name" : "trigger",
+          "required" : false,
+          "schema" : {
+            "$ref" : "#/components/schemas/AutomationTriggerKind"
+          }
+        }, {
+          "description" : "Comma-separated statuses among active, paused, done (default active,paused).",
+          "in" : "query",
+          "name" : "status",
+          "required" : false,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "in" : "query",
+          "name" : "q",
+          "required" : false,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "in" : "query",
+          "name" : "limit",
+          "required" : false,
+          "schema" : {
+            "default" : 50,
+            "maximum" : 100,
+            "minimum" : 1,
+            "type" : "integer"
+          }
+        }, {
+          "in" : "query",
+          "name" : "offset",
+          "required" : false,
+          "schema" : {
+            "default" : 0,
+            "minimum" : 0,
+            "type" : "integer"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/AutomationList"
+                }
+              }
+            },
+            "description" : "The automations, newest first, with their key figures"
+          },
+          "400" : {
+            "description" : "Invalid query"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Not a member of the organization"
+          },
+          "404" : {
+            "description" : "Agent not in the organization"
+          }
+        },
+        "summary" : "The automations of the organization, or of one of its agents",
+        "tags" : [ "scheduledTasks" ]
+      }
+    },
+    "/organizations/{organizationId}/automation-runs" : {
+      "get" : {
+        "description" : "Most recent first. Every member of the organization can read them.",
+        "operationId" : "listOrganizationAutomationRuns",
+        "parameters" : [ {
+          "description" : "ID of the organization",
+          "in" : "path",
+          "name" : "organizationId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "in" : "query",
+          "name" : "agentId",
+          "required" : false,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "in" : "query",
+          "name" : "taskId",
+          "required" : false,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "in" : "query",
+          "name" : "trigger",
+          "required" : false,
+          "schema" : {
+            "$ref" : "#/components/schemas/AutomationTriggerKind"
+          }
+        }, {
+          "in" : "query",
+          "name" : "status",
+          "required" : false,
+          "schema" : {
+            "$ref" : "#/components/schemas/AutomationRunOutcome"
+          }
+        }, {
+          "in" : "query",
+          "name" : "before",
+          "required" : false,
+          "schema" : {
+            "format" : "date-time",
+            "type" : "string"
+          }
+        }, {
+          "in" : "query",
+          "name" : "limit",
+          "required" : false,
+          "schema" : {
+            "default" : 30,
+            "maximum" : 100,
+            "minimum" : 1,
+            "type" : "integer"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/AutomationRunList"
+                }
+              }
+            },
+            "description" : "The runs, with what triggered them and what became of their result"
+          },
+          "400" : {
+            "description" : "Invalid query"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Not a member of the organization"
+          },
+          "404" : {
+            "description" : "Agent not in the organization"
+          }
+        },
+        "summary" : "The runs of the automations of the organization, or of one of its agents",
+        "tags" : [ "scheduledTasks" ]
+      }
+    },
     "/organizations/{organizationId}/integrations/gitlab" : {
       "get" : {
         "operationId" : "listGitlabIntegrations",
@@ -32262,6 +32438,323 @@
         "required" : [ "assignees", "description", "priority", "reviewer", "startMode", "title", "workspacePaths" ],
         "type" : "object"
       },
+      "AutomationTriggerKind" : {
+        "description" : "What starts the automation, as shown in lists — its schedule, a GitLab mention, or its webhook.",
+        "enum" : [ "schedule", "gitlab", "webhook" ],
+        "type" : "string"
+      },
+      "AutomationList" : {
+        "properties" : {
+          "items" : {
+            "items" : {
+              "$ref" : "#/components/schemas/AutomationSummary"
+            },
+            "type" : "array"
+          },
+          "total" : {
+            "type" : "integer"
+          },
+          "stats" : {
+            "$ref" : "#/components/schemas/AutomationStats"
+          }
+        },
+        "required" : [ "items", "stats", "total" ],
+        "type" : "object"
+      },
+      "AutomationSummary" : {
+        "properties" : {
+          "id" : {
+            "type" : "string"
+          },
+          "name" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "message" : {
+            "type" : "string"
+          },
+          "agentId" : {
+            "type" : "string"
+          },
+          "agentName" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "mode" : {
+            "enum" : [ "once", "recurring" ],
+            "type" : "string"
+          },
+          "status" : {
+            "enum" : [ "active", "paused", "done" ],
+            "type" : "string"
+          },
+          "trigger" : {
+            "$ref" : "#/components/schemas/AutomationTriggerKind"
+          },
+          "schedule" : {
+            "allOf" : [ {
+              "$ref" : "#/components/schemas/TaskSchedule"
+            } ],
+            "nullable" : true
+          },
+          "timezone" : {
+            "type" : "string"
+          },
+          "nextRunAt" : {
+            "format" : "date-time",
+            "nullable" : true,
+            "type" : "string"
+          },
+          "callbackUrl" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "lastRun" : {
+            "allOf" : [ {
+              "$ref" : "#/components/schemas/AutomationLastRun"
+            } ],
+            "nullable" : true
+          },
+          "days" : {
+            "description" : "The last 7 UTC days, oldest first.",
+            "items" : {
+              "$ref" : "#/components/schemas/AutomationDayCount"
+            },
+            "type" : "array"
+          },
+          "runs7d" : {
+            "type" : "integer"
+          }
+        },
+        "required" : [ "agentId", "agentName", "callbackUrl", "days", "id", "lastRun", "message", "mode", "name", "nextRunAt", "runs7d", "schedule", "status", "timezone", "trigger" ],
+        "type" : "object"
+      },
+      "AutomationLastRun" : {
+        "properties" : {
+          "id" : {
+            "type" : "string"
+          },
+          "status" : {
+            "$ref" : "#/components/schemas/AutomationRunOutcome"
+          },
+          "triggeredAt" : {
+            "format" : "date-time",
+            "type" : "string"
+          },
+          "finishedAt" : {
+            "format" : "date-time",
+            "nullable" : true,
+            "type" : "string"
+          }
+        },
+        "required" : [ "finishedAt", "id", "status", "triggeredAt" ],
+        "type" : "object"
+      },
+      "AutomationRunOutcome" : {
+        "enum" : [ "success", "error", "running" ],
+        "type" : "string"
+      },
+      "AutomationDayCount" : {
+        "properties" : {
+          "date" : {
+            "description" : "UTC day, YYYY-MM-DD.",
+            "type" : "string"
+          },
+          "success" : {
+            "type" : "integer"
+          },
+          "error" : {
+            "type" : "integer"
+          }
+        },
+        "required" : [ "date", "error", "success" ],
+        "type" : "object"
+      },
+      "AutomationStats" : {
+        "properties" : {
+          "active" : {
+            "type" : "integer"
+          },
+          "event" : {
+            "description" : "Active automations triggered by a GitLab mention or a webhook.",
+            "type" : "integer"
+          },
+          "runs24h" : {
+            "type" : "integer"
+          },
+          "runs7d" : {
+            "type" : "integer"
+          },
+          "failures7d" : {
+            "type" : "integer"
+          },
+          "pending" : {
+            "description" : "Mentions and webhook calls of the organization not handled yet.",
+            "type" : "integer"
+          }
+        },
+        "required" : [ "active", "event", "failures7d", "pending", "runs24h", "runs7d" ],
+        "type" : "object"
+      },
+      "AutomationRunList" : {
+        "properties" : {
+          "runs" : {
+            "items" : {
+              "$ref" : "#/components/schemas/AutomationRun"
+            },
+            "type" : "array"
+          },
+          "nextBefore" : {
+            "description" : "Pass as `before` to get the next page; null on the last one.",
+            "format" : "date-time",
+            "nullable" : true,
+            "type" : "string"
+          }
+        },
+        "required" : [ "nextBefore", "runs" ],
+        "type" : "object"
+      },
+      "AutomationRun" : {
+        "properties" : {
+          "id" : {
+            "type" : "string"
+          },
+          "taskId" : {
+            "type" : "string"
+          },
+          "taskName" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "agentId" : {
+            "type" : "string"
+          },
+          "agentName" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "status" : {
+            "$ref" : "#/components/schemas/AutomationRunOutcome"
+          },
+          "triggeredAt" : {
+            "format" : "date-time",
+            "type" : "string"
+          },
+          "startedAt" : {
+            "format" : "date-time",
+            "nullable" : true,
+            "type" : "string"
+          },
+          "finishedAt" : {
+            "format" : "date-time",
+            "nullable" : true,
+            "type" : "string"
+          },
+          "durationMs" : {
+            "nullable" : true,
+            "type" : "integer"
+          },
+          "conversationId" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "trigger" : {
+            "$ref" : "#/components/schemas/AutomationTriggerKind"
+          },
+          "source" : {
+            "$ref" : "#/components/schemas/AutomationRunSource"
+          },
+          "delivery" : {
+            "$ref" : "#/components/schemas/AutomationRunDelivery"
+          },
+          "reply" : {
+            "description" : "Start of the agent answer (500 characters at most).",
+            "nullable" : true,
+            "type" : "string"
+          },
+          "error" : {
+            "nullable" : true,
+            "type" : "string"
+          }
+        },
+        "required" : [ "agentId", "agentName", "conversationId", "delivery", "durationMs", "error", "finishedAt", "id", "reply", "source", "startedAt", "status", "taskId", "taskName", "trigger", "triggeredAt" ],
+        "type" : "object"
+      },
+      "AutomationRunSource" : {
+        "description" : "What triggered the run. `schedule`: `schedule`, `timezone`, `mode`. `gitlab`: `author`, `authorUsername`, `ref`, `title`, `url`, `text` (untrusted user content). `webhook`: `thread`, `contentType`.",
+        "properties" : {
+          "kind" : {
+            "$ref" : "#/components/schemas/AutomationTriggerKind"
+          },
+          "schedule" : {
+            "allOf" : [ {
+              "$ref" : "#/components/schemas/TaskSchedule"
+            } ],
+            "nullable" : true
+          },
+          "timezone" : {
+            "type" : "string"
+          },
+          "mode" : {
+            "enum" : [ "once", "recurring" ],
+            "type" : "string"
+          },
+          "author" : {
+            "type" : "string"
+          },
+          "authorUsername" : {
+            "type" : "string"
+          },
+          "ref" : {
+            "type" : "string"
+          },
+          "title" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "url" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "text" : {
+            "type" : "string"
+          },
+          "thread" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "contentType" : {
+            "type" : "string"
+          }
+        },
+        "required" : [ "kind" ],
+        "type" : "object"
+      },
+      "AutomationRunDelivery" : {
+        "description" : "What became of the result — the reply in the GitLab thread, the caller's callback, or nothing.",
+        "properties" : {
+          "kind" : {
+            "enum" : [ "gitlab_reply", "callback", "none" ],
+            "type" : "string"
+          },
+          "eventStatus" : {
+            "allOf" : [ {
+              "$ref" : "#/components/schemas/ExternalEventStatus"
+            } ],
+            "nullable" : true
+          },
+          "url" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "error" : {
+            "nullable" : true,
+            "type" : "string"
+          }
+        },
+        "required" : [ "error", "eventStatus", "kind", "url" ],
+        "type" : "object"
+      },
       "GitlabIntegration" : {
         "description" : "A GitLab instance linked to an organization. Its projects send webhooks to `webhookUrl`.",
         "properties" : {

package/package.json

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