@breign/client 1.0.180 → 1.0.182

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" : {
@@ -8049,13 +8052,42 @@
         "tags" : [ "admin" ]
       }
     },
-    "/admin/organisations/{orgId}/platform-engines" : {
-      "patch" : {
-        "description" : "Superadmin. Ouvre ou retire à l'organisation l'accès aux moteurs plateforme.",
-        "operationId" : "setOrganisationAllowPlatformEngines",
+    "/admin/platform-engines/{id}/access" : {
+      "get" : {
+        "description" : "Superadmin. Organisations qui ont accès à chaque modèle du moteur plateforme.",
+        "operationId" : "getPlatformEngineAccess",
         "parameters" : [ {
           "in" : "path",
-          "name" : "orgId",
+          "name" : "id",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/PlatformEngineAccess"
+                }
+              }
+            },
+            "description" : "Access per model"
+          },
+          "404" : {
+            "description" : "Platform engine not found"
+          }
+        },
+        "summary" : "Get platform engine access",
+        "tags" : [ "admin" ]
+      },
+      "put" : {
+        "description" : "Superadmin. Remplace, pour chaque modèle listé, les organisations qui y ont accès. Les modèles absents du corps gardent leurs organisations.\n",
+        "operationId" : "setPlatformEngineAccess",
+        "parameters" : [ {
+          "in" : "path",
+          "name" : "id",
           "required" : true,
           "schema" : {
             "type" : "string"
@@ -8065,7 +8097,7 @@
           "content" : {
             "application/json" : {
               "schema" : {
-                "$ref" : "#/components/schemas/AllowPlatformEngines"
+                "$ref" : "#/components/schemas/PlatformEngineAccess"
               }
             }
           },
@@ -8076,20 +8108,128 @@
             "content" : {
               "application/json" : {
                 "schema" : {
-                  "$ref" : "#/components/schemas/AllowPlatformEngines"
+                  "$ref" : "#/components/schemas/PlatformEngineAccess"
                 }
               }
             },
             "description" : "Updated access"
           },
           "400" : {
-            "description" : "Invalid request"
+            "description" : "Unknown model or organisation"
           },
           "404" : {
-            "description" : "Organisation not found"
+            "description" : "Platform engine not found"
+          }
+        },
+        "summary" : "Set platform engine access",
+        "tags" : [ "admin" ]
+      }
+    },
+    "/organizations/{organizationId}/engines/access" : {
+      "get" : {
+        "description" : "Admin de l'organisation. Modèles réservés à certains membres.",
+        "operationId" : "getOrganizationModelAccess",
+        "parameters" : [ {
+          "in" : "path",
+          "name" : "organizationId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/OrganizationModelAccess"
+                }
+              }
+            },
+            "description" : "Model access rules"
+          },
+          "403" : {
+            "description" : "Not an admin of the organization"
+          }
+        },
+        "summary" : "List model user restrictions of an organization",
+        "tags" : [ "engine" ]
+      }
+    },
+    "/organizations/{organizationId}/engines/providers/{providerId}/access" : {
+      "put" : {
+        "description" : "Admin de l'organisation. Réserve un modèle (de l'organisation ou plateforme ouvert à l'organisation) à certains membres, ou le rouvre à tous avec `restrictToUsers: false`.\n",
+        "operationId" : "setModelUserAccess",
+        "parameters" : [ {
+          "in" : "path",
+          "name" : "organizationId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "in" : "path",
+          "name" : "providerId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/SetModelUserAccess"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/ModelUserAccess"
+                }
+              }
+            },
+            "description" : "Updated rule"
+          },
+          "400" : {
+            "description" : "Model not available to the organization, or user not a member"
+          },
+          "403" : {
+            "description" : "Not an admin of the organization"
+          }
+        },
+        "summary" : "Restrict a model to some members",
+        "tags" : [ "engine" ]
+      }
+    },
+    "/admin/organisations" : {
+      "get" : {
+        "description" : "Superadmin. Toutes les organisations de la plateforme, avec leurs membres.",
+        "operationId" : "listAdminOrganisations",
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "items" : {
+                    "$ref" : "#/components/schemas/Organization"
+                  },
+                  "type" : "array"
+                }
+              }
+            },
+            "description" : "Organisations"
+          },
+          "403" : {
+            "description" : "Not a superadmin"
           }
         },
-        "summary" : "Allow or forbid platform engines for an organisation",
+        "summary" : "List all organisations",
         "tags" : [ "admin" ]
       }
     },
@@ -19182,6 +19322,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",
@@ -26748,13 +27023,110 @@
         "required" : [ "agentsByModel", "defaultEnginesByModel", "knowledgeBases" ],
         "type" : "object"
       },
-      "AllowPlatformEngines" : {
+      "PlatformEngineAccess" : {
+        "description" : "Organisations qui ont accès à chaque modèle d'un moteur plateforme.",
         "properties" : {
-          "allowPlatformEngines" : {
+          "models" : {
+            "items" : {
+              "$ref" : "#/components/schemas/PlatformEngineAccess_models_inner"
+            },
+            "type" : "array"
+          }
+        },
+        "required" : [ "models" ],
+        "type" : "object"
+      },
+      "OrganizationModelAccess" : {
+        "properties" : {
+          "rules" : {
+            "description" : "Seuls les modèles restreints, ou l'ayant été, figurent ici. Absent ⇒ tous les membres.",
+            "items" : {
+              "$ref" : "#/components/schemas/ModelUserAccess"
+            },
+            "type" : "array"
+          }
+        },
+        "required" : [ "rules" ],
+        "type" : "object"
+      },
+      "ModelUserAccess" : {
+        "description" : "Restriction d'un modèle à certains membres d'une organisation.",
+        "properties" : {
+          "providerId" : {
+            "type" : "string"
+          },
+          "modelId" : {
+            "type" : "string"
+          },
+          "restrictToUsers" : {
+            "description" : "Vrai ⇒ seuls `userIds` et les admins de l'organisation peuvent utiliser le modèle.",
             "type" : "boolean"
+          },
+          "userIds" : {
+            "items" : {
+              "type" : "string"
+            },
+            "type" : "array"
+          }
+        },
+        "required" : [ "modelId", "providerId", "restrictToUsers", "userIds" ],
+        "type" : "object"
+      },
+      "SetModelUserAccess" : {
+        "properties" : {
+          "modelId" : {
+            "type" : "string"
+          },
+          "restrictToUsers" : {
+            "type" : "boolean"
+          },
+          "userIds" : {
+            "items" : {
+              "type" : "string"
+            },
+            "type" : "array"
           }
         },
-        "required" : [ "allowPlatformEngines" ],
+        "required" : [ "modelId", "restrictToUsers", "userIds" ],
+        "type" : "object"
+      },
+      "Organization" : {
+        "properties" : {
+          "id" : {
+            "type" : "string"
+          },
+          "name" : {
+            "type" : "string"
+          },
+          "slug" : {
+            "type" : "string"
+          },
+          "engine" : {
+            "$ref" : "#/components/schemas/OrganizationEngine"
+          },
+          "ocr" : {
+            "$ref" : "#/components/schemas/OrganizationOcrConfig"
+          },
+          "users" : {
+            "items" : {
+              "$ref" : "#/components/schemas/OrganizationUser"
+            },
+            "type" : "array"
+          }
+        },
+        "required" : [ "id", "name", "slug" ],
+        "type" : "object"
+      },
+      "OrganizationUser" : {
+        "properties" : {
+          "id" : {
+            "type" : "string"
+          },
+          "role" : {
+            "type" : "string"
+          }
+        },
+        "required" : [ "id", "role" ],
         "type" : "object"
       },
       "OrganisationPlatformEngineUsage" : {
@@ -26768,9 +27140,16 @@
           },
           "knowledgeBases" : {
             "type" : "integer"
+          },
+          "models" : {
+            "description" : "Le même usage, modèle par modèle.",
+            "items" : {
+              "$ref" : "#/components/schemas/OrganisationPlatformEngineUsage_models_inner"
+            },
+            "type" : "array"
           }
         },
-        "required" : [ "agents", "defaultEngine", "knowledgeBases" ],
+        "required" : [ "agents", "defaultEngine", "knowledgeBases", "models" ],
         "type" : "object"
       },
       "FileWithDownloadUrl" : {
@@ -27222,49 +27601,6 @@
         },
         "type" : "object"
       },
-      "Organization" : {
-        "properties" : {
-          "id" : {
-            "type" : "string"
-          },
-          "name" : {
-            "type" : "string"
-          },
-          "slug" : {
-            "type" : "string"
-          },
-          "engine" : {
-            "$ref" : "#/components/schemas/OrganizationEngine"
-          },
-          "ocr" : {
-            "$ref" : "#/components/schemas/OrganizationOcrConfig"
-          },
-          "allowPlatformEngines" : {
-            "description" : "L'organisation peut choisir les moteurs plateforme Breign.",
-            "type" : "boolean"
-          },
-          "users" : {
-            "items" : {
-              "$ref" : "#/components/schemas/OrganizationUser"
-            },
-            "type" : "array"
-          }
-        },
-        "required" : [ "id", "name", "slug" ],
-        "type" : "object"
-      },
-      "OrganizationUser" : {
-        "properties" : {
-          "id" : {
-            "type" : "string"
-          },
-          "role" : {
-            "type" : "string"
-          }
-        },
-        "required" : [ "id", "role" ],
-        "type" : "object"
-      },
       "Role" : {
         "properties" : {
           "id" : {
@@ -32179,6 +32515,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"
@@ -35489,6 +35912,43 @@
         "required" : [ "id", "name", "organizationId" ],
         "type" : "object"
       },
+      "PlatformEngineAccess_models_inner" : {
+        "properties" : {
+          "modelId" : {
+            "type" : "string"
+          },
+          "organizationIds" : {
+            "items" : {
+              "type" : "string"
+            },
+            "type" : "array"
+          }
+        },
+        "required" : [ "modelId", "organizationIds" ],
+        "type" : "object"
+      },
+      "OrganisationPlatformEngineUsage_models_inner" : {
+        "properties" : {
+          "providerId" : {
+            "type" : "string"
+          },
+          "modelId" : {
+            "type" : "string"
+          },
+          "agents" : {
+            "type" : "integer"
+          },
+          "defaultEngine" : {
+            "type" : "boolean"
+          },
+          "knowledgeBases" : {
+            "description" : "Bases de connaissances indexées avec ce modèle d'embedding.",
+            "type" : "integer"
+          }
+        },
+        "required" : [ "agents", "defaultEngine", "knowledgeBases", "modelId", "providerId" ],
+        "type" : "object"
+      },
       "MetricForAgent_identifier" : {
         "properties" : {
           "agentId" : {

package/package.json

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