@breign/client 1.0.172 → 1.0.173

package/dist/openapi.json

@@ -7148,6 +7148,296 @@
         "tags" : [ "engine" ]
       }
     },
+    "/admin/platform-engines" : {
+      "get" : {
+        "description" : "Superadmin. Moteurs IA dont la clé d'API appartient à Breign.",
+        "operationId" : "listPlatformEngines",
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "items" : {
+                    "$ref" : "#/components/schemas/Provider"
+                  },
+                  "type" : "array"
+                }
+              }
+            },
+            "description" : "Platform engines"
+          }
+        },
+        "summary" : "List platform engines",
+        "tags" : [ "admin" ]
+      },
+      "post" : {
+        "description" : "Superadmin. Enregistre un moteur Breign, ses modèles, leurs capacités et leur prix au million de tokens.",
+        "operationId" : "createPlatformEngine",
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/ProviderCreateRequest"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "201" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/BodyWithMessage"
+                }
+              }
+            },
+            "description" : "Created"
+          }
+        },
+        "summary" : "Create a platform engine",
+        "tags" : [ "admin" ]
+      }
+    },
+    "/admin/platform-engines/{id}" : {
+      "delete" : {
+        "operationId" : "deletePlatformEngine",
+        "parameters" : [ {
+          "in" : "path",
+          "name" : "id",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/DeletePlatformEngineResponse"
+                }
+              }
+            },
+            "description" : "Deleted"
+          },
+          "404" : {
+            "description" : "Platform engine not found"
+          }
+        },
+        "summary" : "Delete a platform engine",
+        "tags" : [ "admin" ]
+      },
+      "put" : {
+        "operationId" : "updatePlatformEngine",
+        "parameters" : [ {
+          "in" : "path",
+          "name" : "id",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/ProviderCreateRequest"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/BodyWithMessage"
+                }
+              }
+            },
+            "description" : "Updated"
+          },
+          "404" : {
+            "description" : "Platform engine not found"
+          }
+        },
+        "summary" : "Update a platform engine",
+        "tags" : [ "admin" ]
+      }
+    },
+    "/admin/platform-engines/{id}/usage" : {
+      "get" : {
+        "description" : "Superadmin. Ce qui casse si l'on supprime ce moteur ou l'un de ses modèles.",
+        "operationId" : "getPlatformEngineUsage",
+        "parameters" : [ {
+          "in" : "path",
+          "name" : "id",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/PlatformEngineUsage"
+                }
+              }
+            },
+            "description" : "Usage of the platform engine"
+          },
+          "404" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/BodyWithMessage"
+                }
+              }
+            },
+            "description" : "Platform engine not found"
+          }
+        },
+        "summary" : "Get platform engine usage",
+        "tags" : [ "admin" ]
+      }
+    },
+    "/admin/platform-engines/{id}/available-models" : {
+      "post" : {
+        "description" : "Superadmin. Modèles exposés par la clé déjà enregistrée sur le moteur plateforme.",
+        "operationId" : "listPlatformEngineAvailableModels",
+        "parameters" : [ {
+          "in" : "path",
+          "name" : "id",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "items" : {
+                    "$ref" : "#/components/schemas/Model"
+                  },
+                  "type" : "array"
+                }
+              }
+            },
+            "description" : "Models exposed by the stored API key"
+          },
+          "400" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/BodyWithMessage"
+                }
+              }
+            },
+            "description" : "No API key stored for this engine"
+          },
+          "404" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/BodyWithMessage"
+                }
+              }
+            },
+            "description" : "Platform engine not found"
+          },
+          "500" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/BodyWithMessage"
+                }
+              }
+            },
+            "description" : "Stored API key cannot be decrypted or models cannot be fetched"
+          }
+        },
+        "summary" : "List models available with a platform engine key",
+        "tags" : [ "admin" ]
+      }
+    },
+    "/admin/organisations/{orgId}/platform-engines" : {
+      "patch" : {
+        "description" : "Superadmin. Ouvre ou retire à l'organisation l'accès aux moteurs plateforme.",
+        "operationId" : "setOrganisationAllowPlatformEngines",
+        "parameters" : [ {
+          "in" : "path",
+          "name" : "orgId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/AllowPlatformEngines"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/AllowPlatformEngines"
+                }
+              }
+            },
+            "description" : "Updated access"
+          },
+          "400" : {
+            "description" : "Invalid request"
+          },
+          "404" : {
+            "description" : "Organisation not found"
+          }
+        },
+        "summary" : "Allow or forbid platform engines for an organisation",
+        "tags" : [ "admin" ]
+      }
+    },
+    "/admin/organisations/{orgId}/platform-engines/usage" : {
+      "get" : {
+        "description" : "Superadmin. Ce que l'organisation perd si on lui retire les moteurs plateforme.",
+        "operationId" : "getOrganisationPlatformEngineUsage",
+        "parameters" : [ {
+          "in" : "path",
+          "name" : "orgId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/OrganisationPlatformEngineUsage"
+                }
+              }
+            },
+            "description" : "Usage of platform engines by the organisation"
+          }
+        },
+        "summary" : "Get organisation platform engine usage",
+        "tags" : [ "admin" ]
+      }
+    },
     "/files" : {
       "get" : {
         "description" : "Retrieves a list of all files (admin only)",
@@ -15711,6 +16001,14 @@
             "format" : "date-time",
             "type" : "string"
           }
+        }, {
+          "description" : "Périmètre des moteurs. EXTERNAL (défaut) = clés propres de l'organisation. INTERNAL = modèles Breign, réservé au superAdmin ; ignoré pour un admin d'organisation.",
+          "in" : "query",
+          "name" : "providerSource",
+          "schema" : {
+            "enum" : [ "INTERNAL", "EXTERNAL" ],
+            "type" : "string"
+          }
         }, {
           "description" : "Pas de regroupement de la série temporelle",
           "in" : "query",
@@ -15759,7 +16057,7 @@
     },
     "/organizations/{organizationId}/ai-gateway/settings" : {
       "get" : {
-        "description" : "Organization admin settings for gateway RPM and per-model token quotas.",
+        "description" : "Limites des modèles dont l'organisation détient la clé API (providerSource EXTERNAL). Les modèles Breign se configurent via internal-settings.",
         "operationId" : "getAiGatewaySettings",
         "parameters" : [ {
           "description" : "ID of the organization",
@@ -15795,7 +16093,7 @@
         "tags" : [ "ai-gateway" ]
       },
       "put" : {
-        "description" : "Organization admin can set gateway RPM and per-model token quotas.",
+        "description" : "L'admin d'organisation fixe le RPM et les quotas de ses modèles à clé propre. Un quota visant un modèle Breign est refusé.",
         "operationId" : "updateAiGatewaySettings",
         "parameters" : [ {
           "description" : "ID of the organization",
@@ -15844,6 +16142,122 @@
         "tags" : [ "ai-gateway" ]
       }
     },
+    "/organizations/{organizationId}/ai-gateway/internal-settings" : {
+      "get" : {
+        "description" : "Limites des modèles Breign (providerSource INTERNAL) pour une organisation. Réservé au superAdmin. La forme de la réponse est la même que les settings d'organisation : gatewayRpm et modelTokenQuotas portent ici le périmètre Breign.",
+        "operationId" : "getAiGatewayInternalSettings",
+        "parameters" : [ {
+          "description" : "ID of the organization",
+          "in" : "path",
+          "name" : "organizationId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/AiGatewaySettings"
+                }
+              }
+            },
+            "description" : "Current Breign model limits"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "500" : {
+            "description" : "Server error"
+          }
+        },
+        "summary" : "Get Breign model limit settings",
+        "tags" : [ "ai-gateway" ]
+      },
+      "put" : {
+        "description" : "Le superAdmin fixe le RPM et les quotas des modèles Breign. Un quota visant un modèle à clé propre est refusé. N'écrase pas les limites de l'admin.",
+        "operationId" : "updateAiGatewayInternalSettings",
+        "parameters" : [ {
+          "description" : "ID of the organization",
+          "in" : "path",
+          "name" : "organizationId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/AiGatewaySettingsUpdateRequest"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/AiGatewaySettings"
+                }
+              }
+            },
+            "description" : "Updated Breign model limits"
+          },
+          "400" : {
+            "description" : "Invalid request"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "500" : {
+            "description" : "Server error"
+          }
+        },
+        "summary" : "Update Breign model limit settings",
+        "tags" : [ "ai-gateway" ]
+      }
+    },
+    "/admin/ai-gateway/internal-settings" : {
+      "get" : {
+        "description" : "Superadmin. Plafonds des modèles Breign de toutes les organisations, en une requête ; une organisation absente n'en a aucun. `maxQuotaRatio` est l'usage du quota le plus entamé sur sa période en cours (null sans quota).",
+        "operationId" : "listAiGatewayInternalSettings",
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "items" : {
+                    "$ref" : "#/components/schemas/AiGatewayInternalSettingsSummary"
+                  },
+                  "type" : "array"
+                }
+              }
+            },
+            "description" : "Breign model limits by organisation"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          }
+        },
+        "summary" : "List Breign model limit settings of every organisation",
+        "tags" : [ "admin" ]
+      }
+    },
     "/organizations/{organizationId}/ai-gateway/v1/models" : {
       "get" : {
         "description" : "Équivalent de `GET /v1/models` de l'AI Gateway Vercel, monté sous le préfixe organisation. Liste les modèles des providers configurés pour l'organisation.",
@@ -24026,6 +24440,10 @@
           "model" : {
             "type" : "string"
           },
+          "organizationId" : {
+            "description" : "Requis quand le moteur est un moteur plateforme, pour savoir quelle organisation reçoit ce modèle par défaut.",
+            "type" : "string"
+          },
           "options" : {
             "additionalProperties" : true,
             "type" : "object"
@@ -24074,6 +24492,14 @@
           "providerSource" : {
             "enum" : [ "INTERNAL", "EXTERNAL" ],
             "type" : "string"
+          },
+          "isPlatform" : {
+            "description" : "Moteur plateforme dont la clé d'API appartient à Breign. Il est proposé aux organisations autorisées et n'est pas modifiable par elles.",
+            "type" : "boolean"
+          },
+          "organizationId" : {
+            "nullable" : true,
+            "type" : "string"
           }
         },
         "required" : [ "models", "name", "providerType" ],
@@ -24113,6 +24539,25 @@
             "minimum" : 1,
             "type" : "integer"
           },
+          "inputTokenPrice" : {
+            "description" : "Prix d'un million de tokens en entrée. Défini par le superadmin sur un moteur plateforme.",
+            "minimum" : 0,
+            "type" : "number"
+          },
+          "outputTokenPrice" : {
+            "description" : "Prix d'un million de tokens en sortie. Les tokens de raisonnement suivent ce tarif.",
+            "minimum" : 0,
+            "type" : "number"
+          },
+          "currency" : {
+            "description" : "Devise ISO du prix au token, par exemple EUR ou USD.",
+            "type" : "string"
+          },
+          "priceSource" : {
+            "description" : "Origine du prix au token. configuration = tarifs déjà enregistrés par Breign, catalog = catalogue public, manual = saisi à la main.",
+            "enum" : [ "configuration", "catalog", "manual" ],
+            "type" : "string"
+          },
           "options" : {
             "additionalProperties" : true,
             "type" : "object"
@@ -24193,6 +24638,74 @@
         "required" : [ "label", "value" ],
         "type" : "object"
       },
+      "DeletePlatformEngineResponse" : {
+        "properties" : {
+          "message" : {
+            "type" : "string"
+          },
+          "agentsEngineUnsetCount" : {
+            "type" : "integer"
+          },
+          "knowledgeBasesAffected" : {
+            "items" : {
+              "$ref" : "#/components/schemas/DeletePlatformEngineResponse_knowledgeBasesAffected_inner"
+            },
+            "type" : "array"
+          }
+        },
+        "required" : [ "agentsEngineUnsetCount", "knowledgeBasesAffected", "message" ],
+        "type" : "object"
+      },
+      "PlatformEngineUsage" : {
+        "description" : "Ce qui dépend d'un moteur plateforme, toutes organisations confondues.",
+        "properties" : {
+          "agentsByModel" : {
+            "additionalProperties" : {
+              "type" : "integer"
+            },
+            "description" : "Agents branchés sur chaque modèle, par `modelId` du fournisseur.",
+            "type" : "object"
+          },
+          "defaultEnginesByModel" : {
+            "additionalProperties" : {
+              "type" : "integer"
+            },
+            "description" : "Organisations dont c'est le moteur par défaut, par `modelId` du fournisseur.",
+            "type" : "object"
+          },
+          "knowledgeBases" : {
+            "description" : "Bases de connaissances indexées avec ses embeddings.",
+            "type" : "integer"
+          }
+        },
+        "required" : [ "agentsByModel", "defaultEnginesByModel", "knowledgeBases" ],
+        "type" : "object"
+      },
+      "AllowPlatformEngines" : {
+        "properties" : {
+          "allowPlatformEngines" : {
+            "type" : "boolean"
+          }
+        },
+        "required" : [ "allowPlatformEngines" ],
+        "type" : "object"
+      },
+      "OrganisationPlatformEngineUsage" : {
+        "description" : "Ce qu'une organisation perd si on lui retire les moteurs plateforme.",
+        "properties" : {
+          "agents" : {
+            "type" : "integer"
+          },
+          "defaultEngine" : {
+            "type" : "boolean"
+          },
+          "knowledgeBases" : {
+            "type" : "integer"
+          }
+        },
+        "required" : [ "agents", "defaultEngine", "knowledgeBases" ],
+        "type" : "object"
+      },
       "FileWithDownloadUrl" : {
         "allOf" : [ {
           "$ref" : "#/components/schemas/File"
@@ -24659,6 +25172,10 @@
           "ocr" : {
             "$ref" : "#/components/schemas/OrganizationOcrConfig"
           },
+          "allowPlatformEngines" : {
+            "description" : "L'organisation peut choisir les moteurs plateforme Breign.",
+            "type" : "boolean"
+          },
           "users" : {
             "items" : {
               "$ref" : "#/components/schemas/OrganizationUser"
@@ -27723,6 +28240,9 @@
               "$ref" : "#/components/schemas/AiGatewayUsageBreakdownItem"
             },
             "type" : "array"
+          },
+          "cost" : {
+            "$ref" : "#/components/schemas/AiGatewayUsageCost"
           }
         },
         "required" : [ "byModel", "byProvider", "byUser", "series", "total" ],
@@ -27801,6 +28321,39 @@
         "required" : [ "inputTokens", "key", "label", "outputTokens", "requests", "totalTokens" ],
         "type" : "object"
       },
+      "AiGatewayUsageCost" : {
+        "description" : "Coût estimé, joint seulement sur le périmètre des modèles Breign (réservé au superAdmin).",
+        "properties" : {
+          "total" : {
+            "$ref" : "#/components/schemas/AiGatewayCostByCurrency"
+          },
+          "byModel" : {
+            "additionalProperties" : {
+              "$ref" : "#/components/schemas/AiGatewayCostByCurrency"
+            },
+            "type" : "object"
+          },
+          "byUser" : {
+            "additionalProperties" : {
+              "$ref" : "#/components/schemas/AiGatewayCostByCurrency"
+            },
+            "type" : "object"
+          },
+          "unpricedTokens" : {
+            "description" : "Tokens sans prix connu ; le coût est alors une estimation partielle.",
+            "type" : "integer"
+          }
+        },
+        "required" : [ "byModel", "byUser", "total", "unpricedTokens" ],
+        "type" : "object"
+      },
+      "AiGatewayCostByCurrency" : {
+        "additionalProperties" : {
+          "type" : "number"
+        },
+        "description" : "Montant par devise ISO ; deux devises ne s'additionnent pas.",
+        "type" : "object"
+      },
       "AiGatewaySettings" : {
         "properties" : {
           "organizationId" : {
@@ -27873,6 +28426,21 @@
         },
         "type" : "object"
       },
+      "AiGatewayInternalSettingsSummary" : {
+        "allOf" : [ {
+          "$ref" : "#/components/schemas/AiGatewaySettings"
+        }, {
+          "properties" : {
+            "maxQuotaRatio" : {
+              "description" : "Usage du quota le plus entamé sur sa période en cours ; null sans quota.",
+              "nullable" : true,
+              "type" : "number"
+            }
+          },
+          "required" : [ "maxQuotaRatio" ],
+          "type" : "object"
+        } ]
+      },
       "AiGatewayV1ModelList" : {
         "properties" : {
           "object" : {
@@ -31932,6 +32500,21 @@
         "required" : [ "id", "modelId", "name" ],
         "type" : "object"
       },
+      "DeletePlatformEngineResponse_knowledgeBasesAffected_inner" : {
+        "properties" : {
+          "id" : {
+            "type" : "string"
+          },
+          "name" : {
+            "type" : "string"
+          },
+          "organizationId" : {
+            "type" : "string"
+          }
+        },
+        "required" : [ "id", "name", "organizationId" ],
+        "type" : "object"
+      },
       "MetricForAgent_identifier" : {
         "properties" : {
           "agentId" : {

package/package.json

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