@breign/client 1.0.179 → 1.0.181

package/dist/openapi.json

@@ -99,6 +99,9 @@
   }, {
     "description" : "Actions and mentions waiting for the current user",
     "name" : "inbox"
+  }, {
+    "description" : "Support page of an organization, its settings and the requests sent from it",
+    "name" : "support"
   } ],
   "paths" : {
     "/health" : {
@@ -19182,6 +19185,141 @@
         "tags" : [ "execution-nodes" ]
       }
     },
+    "/organizations/{organizationId}/support-settings" : {
+      "get" : {
+        "description" : "Lisibles par les membres de l'organisation, pour afficher la page Support.",
+        "operationId" : "getOrganizationSupportSettings",
+        "parameters" : [ {
+          "description" : "ID of the organization",
+          "in" : "path",
+          "name" : "organizationId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/SupportSettings"
+                }
+              }
+            },
+            "description" : "OK"
+          },
+          "401" : {
+            "description" : "Unauthenticated"
+          },
+          "403" : {
+            "description" : "Not a member of the organization"
+          }
+        },
+        "summary" : "Get the support page settings of an organization",
+        "tags" : [ "support" ]
+      },
+      "put" : {
+        "description" : "Réservé aux superadmins.",
+        "operationId" : "updateOrganizationSupportSettings",
+        "parameters" : [ {
+          "description" : "ID of the organization",
+          "in" : "path",
+          "name" : "organizationId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/SupportSettings"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/SupportSettings"
+                }
+              }
+            },
+            "description" : "OK"
+          },
+          "400" : {
+            "description" : "Unknown agent or automation"
+          },
+          "401" : {
+            "description" : "Unauthenticated"
+          },
+          "403" : {
+            "description" : "Not a superadmin"
+          }
+        },
+        "summary" : "Update the support page settings of an organization",
+        "tags" : [ "support" ]
+      }
+    },
+    "/organizations/{organizationId}/support-requests" : {
+      "post" : {
+        "description" : "Au nom de l'utilisateur connecté, membre de l'organisation : la demande, avec son identité et son organisation, est mise en file sur l'automatisation du formulaire, comme un appel de son webhook.",
+        "operationId" : "createOrganizationSupportRequest",
+        "parameters" : [ {
+          "description" : "ID of the organization",
+          "in" : "path",
+          "name" : "organizationId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/SupportRequestCreate"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "202" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/SupportRequestAccepted"
+                }
+              }
+            },
+            "description" : "Accepted"
+          },
+          "400" : {
+            "description" : "Invalid request or attachments too large"
+          },
+          "401" : {
+            "description" : "Unauthenticated"
+          },
+          "403" : {
+            "description" : "Not a member of the organization"
+          },
+          "404" : {
+            "description" : "Support form not enabled for this organization"
+          },
+          "429" : {
+            "description" : "Too many requests"
+          }
+        },
+        "summary" : "Send a support request from the support page form",
+        "tags" : [ "support" ]
+      }
+    },
     "/execution-nodes/{nodeId}/sessions/{sessionId}" : {
       "get" : {
         "operationId" : "getExecutionNodeSession",
@@ -19699,9 +19837,10 @@
         "tags" : [ "tickets" ]
       }
     },
-    "/organizations/{organizationId}/integrations/gitlab" : {
+    "/organizations/{organizationId}/automations" : {
       "get" : {
-        "operationId" : "listGitlabIntegrations",
+        "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",
@@ -19710,31 +19849,87 @@
           "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" : {
-                  "items" : {
-                    "$ref" : "#/components/schemas/GitlabIntegration"
-                  },
-                  "type" : "array"
+                  "$ref" : "#/components/schemas/AutomationList"
                 }
               }
             },
-            "description" : "The integrations"
+            "description" : "The automations, newest first, with their key figures"
+          },
+          "400" : {
+            "description" : "Invalid query"
+          },
+          "401" : {
+            "description" : "Unauthorized"
           },
           "403" : {
-            "description" : "Not an admin of the organization"
+            "description" : "Not a member of the organization"
+          },
+          "404" : {
+            "description" : "Agent not in the organization"
           }
         },
-        "summary" : "List the GitLab integrations of an organization",
-        "tags" : [ "integrations" ]
-      },
-      "post" : {
-        "description" : "A webhook secret is generated; it is returned with the integration.",
-        "operationId" : "createGitlabIntegration",
+        "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",
@@ -19743,45 +19938,164 @@
           "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"
+          }
         } ],
-        "requestBody" : {
-          "content" : {
-            "application/json" : {
-              "schema" : {
-                "$ref" : "#/components/schemas/GitlabIntegrationCreate"
-              }
-            }
-          },
-          "required" : true
-        },
         "responses" : {
-          "201" : {
+          "200" : {
             "content" : {
               "application/json" : {
                 "schema" : {
-                  "$ref" : "#/components/schemas/GitlabIntegrationDetail"
+                  "$ref" : "#/components/schemas/AutomationRunList"
                 }
               }
             },
-            "description" : "Integration created"
+            "description" : "The runs, with what triggered them and what became of their result"
           },
           "400" : {
-            "description" : "Invalid body"
+            "description" : "Invalid query"
+          },
+          "401" : {
+            "description" : "Unauthorized"
           },
           "403" : {
-            "description" : "Not an admin of the organization"
+            "description" : "Not a member of the organization"
           },
-          "422" : {
-            "description" : "Invalid base URL, or GITLAB_HOST_NOT_ALLOWED (private or reserved network)"
+          "404" : {
+            "description" : "Agent not in the organization"
           }
         },
-        "summary" : "Link a GitLab instance to the organization",
-        "tags" : [ "integrations" ]
+        "summary" : "The runs of the automations of the organization, or of one of its agents",
+        "tags" : [ "scheduledTasks" ]
       }
     },
-    "/organizations/{organizationId}/integrations/gitlab/{integrationId}" : {
-      "delete" : {
-        "operationId" : "deleteGitlabIntegration",
+    "/organizations/{organizationId}/integrations/gitlab" : {
+      "get" : {
+        "operationId" : "listGitlabIntegrations",
+        "parameters" : [ {
+          "description" : "ID of the organization",
+          "in" : "path",
+          "name" : "organizationId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "items" : {
+                    "$ref" : "#/components/schemas/GitlabIntegration"
+                  },
+                  "type" : "array"
+                }
+              }
+            },
+            "description" : "The integrations"
+          },
+          "403" : {
+            "description" : "Not an admin of the organization"
+          }
+        },
+        "summary" : "List the GitLab integrations of an organization",
+        "tags" : [ "integrations" ]
+      },
+      "post" : {
+        "description" : "A webhook secret is generated; it is returned with the integration.",
+        "operationId" : "createGitlabIntegration",
+        "parameters" : [ {
+          "description" : "ID of the organization",
+          "in" : "path",
+          "name" : "organizationId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/GitlabIntegrationCreate"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "201" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/GitlabIntegrationDetail"
+                }
+              }
+            },
+            "description" : "Integration created"
+          },
+          "400" : {
+            "description" : "Invalid body"
+          },
+          "403" : {
+            "description" : "Not an admin of the organization"
+          },
+          "422" : {
+            "description" : "Invalid base URL, or GITLAB_HOST_NOT_ALLOWED (private or reserved network)"
+          }
+        },
+        "summary" : "Link a GitLab instance to the organization",
+        "tags" : [ "integrations" ]
+      }
+    },
+    "/organizations/{organizationId}/integrations/gitlab/{integrationId}" : {
+      "delete" : {
+        "operationId" : "deleteGitlabIntegration",
         "parameters" : [ {
           "description" : "ID of the organization",
           "in" : "path",
@@ -32003,6 +32317,93 @@
         "enum" : [ "members", "admins", "none" ],
         "type" : "string"
       },
+      "SupportSettings" : {
+        "description" : "La page Support d'une organisation. Réglée par les superadmins ; lue par les membres pour afficher la page.",
+        "properties" : {
+          "enabled" : {
+            "description" : "La page et son lien dans la barre latérale ne s'affichent que si elle est activée.",
+            "type" : "boolean"
+          },
+          "chatAgentId" : {
+            "description" : "Agent d'accueil de l'onglet Chat, de l'organisation. Null, pas d'onglet Chat.",
+            "nullable" : true,
+            "type" : "string"
+          },
+          "formAutomationId" : {
+            "description" : "Automatisation déclenchée par webhook, de l'organisation, qui reçoit les demandes du formulaire. Null, pas d'onglet Formulaire.",
+            "nullable" : true,
+            "type" : "string"
+          }
+        },
+        "required" : [ "chatAgentId", "enabled", "formAutomationId" ],
+        "type" : "object"
+      },
+      "SupportRequestCreate" : {
+        "description" : "Une demande de support ; le demandeur et son organisation sont ajoutés par l'API.",
+        "properties" : {
+          "requestId" : {
+            "description" : "Tirée par le formulaire. Un second envoi avec la même clé ne crée rien de plus.",
+            "format" : "uuid",
+            "type" : "string"
+          },
+          "category" : {
+            "enum" : [ "question", "bug", "account", "billing", "feature", "other" ],
+            "type" : "string"
+          },
+          "subject" : {
+            "maxLength" : 150,
+            "type" : "string"
+          },
+          "description" : {
+            "maxLength" : 5000,
+            "type" : "string"
+          },
+          "urgency" : {
+            "enum" : [ "low", "normal", "high", "critical" ],
+            "type" : "string"
+          },
+          "attachments" : {
+            "items" : {
+              "$ref" : "#/components/schemas/SupportRequestAttachment"
+            },
+            "maxItems" : 3,
+            "type" : "array"
+          }
+        },
+        "required" : [ "category", "description", "requestId", "subject", "urgency" ],
+        "type" : "object"
+      },
+      "SupportRequestAttachment" : {
+        "properties" : {
+          "name" : {
+            "maxLength" : 255,
+            "type" : "string"
+          },
+          "contentType" : {
+            "maxLength" : 255,
+            "type" : "string"
+          },
+          "contentBase64" : {
+            "type" : "string"
+          }
+        },
+        "required" : [ "contentBase64", "contentType", "name" ],
+        "type" : "object"
+      },
+      "SupportRequestAccepted" : {
+        "properties" : {
+          "eventId" : {
+            "description" : "L'événement mis en file sur l'automatisation, référence de la demande.",
+            "nullable" : true,
+            "type" : "string"
+          },
+          "duplicate" : {
+            "type" : "boolean"
+          }
+        },
+        "required" : [ "duplicate", "eventId" ],
+        "type" : "object"
+      },
       "NodeSessionDetail" : {
         "allOf" : [ {
           "$ref" : "#/components/schemas/NodeSession"
@@ -32262,6 +32663,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" : {