@barndoor-ai/sdk 2.4.0 → 2.13.0-dev.gcd8ac17

package/dist/esm/apis/LlmGatewayApi.d.ts

@@ -2,7 +2,7 @@
  * Barndoor.ai Public API
  * Unified public API specification for Barndoor.ai platform
  *
- * The version of the OpenAPI document: 2.4.0
+ * The version of the OpenAPI document: 2.13.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,6 +16,7 @@ import { type AgentRuntimeProfile } from '../models/AgentRuntimeProfile.js';
 import { type ApiKey } from '../models/ApiKey.js';
 import { type ApiKeyDisabledResponse } from '../models/ApiKeyDisabledResponse.js';
 import { type ArchivePricingResponse } from '../models/ArchivePricingResponse.js';
+import { type ClientSettings } from '../models/ClientSettings.js';
 import { type Connection } from '../models/Connection.js';
 import { type CreateApiKeyRequest } from '../models/CreateApiKeyRequest.js';
 import { type CreateApiKeyResponse } from '../models/CreateApiKeyResponse.js';
@@ -29,8 +30,11 @@ import { type CreateProviderRequest } from '../models/CreateProviderRequest.js';
 import { type CreateRateLimitRequest } from '../models/CreateRateLimitRequest.js';
 import { type CreateRouteGroupRequest } from '../models/CreateRouteGroupRequest.js';
 import { type DefaultPricingEntry } from '../models/DefaultPricingEntry.js';
+import { type DefaultSetupRequest } from '../models/DefaultSetupRequest.js';
+import { type DefaultSetupResponse } from '../models/DefaultSetupResponse.js';
 import { type DeletedResponse } from '../models/DeletedResponse.js';
 import { type GovernanceConfig } from '../models/GovernanceConfig.js';
+import { type ListClientSettingsResponse } from '../models/ListClientSettingsResponse.js';
 import { type ListProfilesResponse } from '../models/ListProfilesResponse.js';
 import { type ListRoutingRulesResponse } from '../models/ListRoutingRulesResponse.js';
 import { type LlmGatewayAwsRoleConfigResponse } from '../models/LlmGatewayAwsRoleConfigResponse.js';
@@ -42,6 +46,9 @@ import { type ModelMappingWithProviderAndBudgetStatus } from '../models/ModelMap
 import { type ModelRouteGroup } from '../models/ModelRouteGroup.js';
 import { type PricingRuleSummary } from '../models/PricingRuleSummary.js';
 import { type Provider } from '../models/Provider.js';
+import { type PutClientSettingsRequest } from '../models/PutClientSettingsRequest.js';
+import { type RenameModelRouteRequest } from '../models/RenameModelRouteRequest.js';
+import { type RenameModelRouteResponse } from '../models/RenameModelRouteResponse.js';
 import { type ReorderModelMappingsRequest } from '../models/ReorderModelMappingsRequest.js';
 import { type ReorderedResponse } from '../models/ReorderedResponse.js';
 import { type RevokedResponse } from '../models/RevokedResponse.js';
@@ -103,6 +110,12 @@ export interface CreateConnectionOperationRequest {
      */
     createConnectionRequest: CreateConnectionRequest;
 }
+export interface CreateDefaultSetupRequest {
+    /**
+     *
+     */
+    defaultSetupRequest: DefaultSetupRequest;
+}
 export interface CreateModelAccessOperationRequest {
     /**
      *
@@ -227,6 +240,12 @@ export interface GetApiKeyRequest {
      */
     id: string | null;
 }
+export interface GetClientSettingsRequest {
+    /**
+     * `claude` (Claude Code) or `codex` (Codex)
+     */
+    client: string | null;
+}
 export interface GetConnectionRequest {
     /**
      * Identifier, a UUID
@@ -289,6 +308,16 @@ export interface PatchProfileMetadataRequest {
      */
     metadataPatchRequest: MetadataPatchRequest;
 }
+export interface PutClientSettingsOperationRequest {
+    /**
+     * `claude` (Claude Code) or `codex` (Codex)
+     */
+    client: string;
+    /**
+     *
+     */
+    putClientSettingsRequest: PutClientSettingsRequest;
+}
 export interface RemoveRouteGroupMemberRequest {
     /**
      * Identifier, a UUID
@@ -299,6 +328,12 @@ export interface RemoveRouteGroupMemberRequest {
      */
     alias: string | null;
 }
+export interface RenameModelRouteOperationRequest {
+    /**
+     *
+     */
+    renameModelRouteRequest: RenameModelRouteRequest;
+}
 export interface ReorderModelMappingsOperationRequest {
     /**
      *
@@ -533,6 +568,20 @@ export declare class LlmGatewayApi extends runtime.BaseAPI {
      * Create a provider connection
      */
     createConnection(requestParameters: CreateConnectionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Connection>;
+    /**
+     * Creates request options for createDefaultSetup without sending the request
+     */
+    createDefaultSetupRequestOpts(requestParameters: CreateDefaultSetupRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Creates a Model Route per current Claude model on the login provider, first enabling the newest catalog Opus, Sonnet, Haiku or Fable model on it when nothing in that family is enabled (`models_enabled` lists them; the organization\'s pricing requirement applies). Because a login (seat) token works only for Claude Code, each route it creates that has no fallback behind it yet also gets a lower-priority fallback target on the first enabled API-key, Bedrock, Vertex or Foundry provider (by name) that has the same model enabled; `routes[].fallback_provider` names it. A route that already exists with only login-token targets gets the same fallback (never a second one), and `fallback_provider` reports the fallback a route already has. Routes left with only login-token targets are returned in `warnings` (code `seat_only_route`).
+     * Create the safe default Claude launch setup for a login provider
+     */
+    createDefaultSetupRaw(requestParameters: CreateDefaultSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DefaultSetupResponse>>;
+    /**
+     * Creates a Model Route per current Claude model on the login provider, first enabling the newest catalog Opus, Sonnet, Haiku or Fable model on it when nothing in that family is enabled (`models_enabled` lists them; the organization\'s pricing requirement applies). Because a login (seat) token works only for Claude Code, each route it creates that has no fallback behind it yet also gets a lower-priority fallback target on the first enabled API-key, Bedrock, Vertex or Foundry provider (by name) that has the same model enabled; `routes[].fallback_provider` names it. A route that already exists with only login-token targets gets the same fallback (never a second one), and `fallback_provider` reports the fallback a route already has. Routes left with only login-token targets are returned in `warnings` (code `seat_only_route`).
+     * Create the safe default Claude launch setup for a login provider
+     */
+    createDefaultSetup(requestParameters: CreateDefaultSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DefaultSetupResponse>;
     /**
      * Creates request options for createModelAccess without sending the request
      */
@@ -571,14 +620,19 @@ export declare class LlmGatewayApi extends runtime.BaseAPI {
     createPricing(requestParameters: CreatePricingOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminModelPricing>;
     /**
      * Creates request options for createProfile without sending the request
+     * @deprecated
      */
     createProfileRequestOpts(requestParameters: CreateProfileOperationRequest): Promise<runtime.RequestOpts>;
     /**
+     * Creates the client\'s settings at version 1. An organization has one settings object per client, so this is refused with 409 when the client already has one; edit it instead.
      * Create an agent runtime profile
+     * @deprecated
      */
     createProfileRaw(requestParameters: CreateProfileOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentRuntimeProfile>>;
     /**
+     * Creates the client\'s settings at version 1. An organization has one settings object per client, so this is refused with 409 when the client already has one; edit it instead.
      * Create an agent runtime profile
+     * @deprecated
      */
     createProfile(requestParameters: CreateProfileOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentRuntimeProfile>;
     /**
@@ -691,14 +745,17 @@ export declare class LlmGatewayApi extends runtime.BaseAPI {
     deleteModelMapping(requestParameters: DeleteModelMappingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeletedResponse>;
     /**
      * Creates request options for deleteProfile without sending the request
+     * @deprecated
      */
     deleteProfileRequestOpts(requestParameters: DeleteProfileRequest): Promise<runtime.RequestOpts>;
     /**
      * Delete an agent runtime profile
+     * @deprecated
      */
     deleteProfileRaw(requestParameters: DeleteProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeletedResponse>>;
     /**
      * Delete an agent runtime profile
+     * @deprecated
      */
     deleteProfile(requestParameters: DeleteProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeletedResponse>;
     /**
@@ -777,6 +834,18 @@ export declare class LlmGatewayApi extends runtime.BaseAPI {
      * Fetch one API key
      */
     getApiKey(requestParameters: GetApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKey>;
+    /**
+     * Creates request options for getClientSettings without sending the request
+     */
+    getClientSettingsRequestOpts(requestParameters: GetClientSettingsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Fetch one client\'s settings
+     */
+    getClientSettingsRaw(requestParameters: GetClientSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientSettings>>;
+    /**
+     * Fetch one client\'s settings
+     */
+    getClientSettings(requestParameters: GetClientSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientSettings>;
     /**
      * Creates request options for getConnection without sending the request
      */
@@ -803,14 +872,17 @@ export declare class LlmGatewayApi extends runtime.BaseAPI {
     getGovernanceConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GovernanceConfig>;
     /**
      * Creates request options for getProfile without sending the request
+     * @deprecated
      */
     getProfileRequestOpts(requestParameters: GetProfileRequest): Promise<runtime.RequestOpts>;
     /**
      * Fetch one agent runtime profile
+     * @deprecated
      */
     getProfileRaw(requestParameters: GetProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentRuntimeProfile>>;
     /**
      * Fetch one agent runtime profile
+     * @deprecated
      */
     getProfile(requestParameters: GetProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentRuntimeProfile>;
     /**
@@ -873,6 +945,20 @@ export declare class LlmGatewayApi extends runtime.BaseAPI {
      * List the organization\'s token budgets
      */
     listBudgets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<WithAttributionTokenBudget>>;
+    /**
+     * Creates request options for listClientSettings without sending the request
+     */
+    listClientSettingsRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Returns the settings for both clients, Claude Code first. A client the organization has not configured is returned with `exists: false`, version 0 and the built-in defaults.
+     * List the organization\'s client settings
+     */
+    listClientSettingsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListClientSettingsResponse>>;
+    /**
+     * Returns the settings for both clients, Claude Code first. A client the organization has not configured is returned with `exists: false`, version 0 and the built-in defaults.
+     * List the organization\'s client settings
+     */
+    listClientSettings(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListClientSettingsResponse>;
     /**
      * Creates request options for listConnections without sending the request
      */
@@ -947,14 +1033,17 @@ export declare class LlmGatewayApi extends runtime.BaseAPI {
     listPricingHistory(requestParameters: ListPricingHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminModelPricing>>;
     /**
      * Creates request options for listProfiles without sending the request
+     * @deprecated
      */
     listProfilesRequestOpts(requestParameters: ListProfilesRequest): Promise<runtime.RequestOpts>;
     /**
      * List the organization\'s agent runtime profiles
+     * @deprecated
      */
     listProfilesRaw(requestParameters: ListProfilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListProfilesResponse>>;
     /**
      * List the organization\'s agent runtime profiles
+     * @deprecated
      */
     listProfiles(requestParameters?: ListProfilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListProfilesResponse>;
     /**
@@ -1031,16 +1120,35 @@ export declare class LlmGatewayApi extends runtime.BaseAPI {
     lookupPricingVersion(requestParameters: LookupPricingVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminModelPricing>;
     /**
      * Creates request options for patchProfileMetadata without sending the request
+     * @deprecated
      */
     patchProfileMetadataRequestOpts(requestParameters: PatchProfileMetadataRequest): Promise<runtime.RequestOpts>;
     /**
+     * Changes the display name. `active` is accepted only when it restates the profile\'s current state: client settings can\'t be switched off, and an archived profile can\'t be switched back on (promote it instead).
      * Update a profile\'s display metadata
+     * @deprecated
      */
     patchProfileMetadataRaw(requestParameters: PatchProfileMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentRuntimeProfile>>;
     /**
+     * Changes the display name. `active` is accepted only when it restates the profile\'s current state: client settings can\'t be switched off, and an archived profile can\'t be switched back on (promote it instead).
      * Update a profile\'s display metadata
+     * @deprecated
      */
     patchProfileMetadata(requestParameters: PatchProfileMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentRuntimeProfile>;
+    /**
+     * Creates request options for putClientSettings without sending the request
+     */
+    putClientSettingsRequestOpts(requestParameters: PutClientSettingsOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Replaces the client\'s capabilities, appending a version; the first save creates the settings. `preferences` are stored but not read by a launch: Model Access decides which models each person can use, and every launch slot is derived from that (the newest allowed route of the slot\'s family).
+     * Save one client\'s settings
+     */
+    putClientSettingsRaw(requestParameters: PutClientSettingsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientSettings>>;
+    /**
+     * Replaces the client\'s capabilities, appending a version; the first save creates the settings. `preferences` are stored but not read by a launch: Model Access decides which models each person can use, and every launch slot is derived from that (the newest allowed route of the slot\'s family).
+     * Save one client\'s settings
+     */
+    putClientSettings(requestParameters: PutClientSettingsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientSettings>;
     /**
      * Creates request options for removeRouteGroupMember without sending the request
      */
@@ -1053,6 +1161,20 @@ export declare class LlmGatewayApi extends runtime.BaseAPI {
      * Remove a model from a route group
      */
     removeRouteGroupMember(requestParameters: RemoveRouteGroupMemberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ModelRouteGroup>;
+    /**
+     * Creates request options for renameModelRoute without sending the request
+     */
+    renameModelRouteRequestOpts(requestParameters: RenameModelRouteOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Renames a route in one transaction: every target, and the route\'s route-group memberships (BCP-4580). Renaming target by target through `PUT /admin/model-mappings/{id}` still works, but leaves the route split across two names until the last PUT lands, and moves the memberships on the first one.
+     * Rename a model route
+     */
+    renameModelRouteRaw(requestParameters: RenameModelRouteOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RenameModelRouteResponse>>;
+    /**
+     * Renames a route in one transaction: every target, and the route\'s route-group memberships (BCP-4580). Renaming target by target through `PUT /admin/model-mappings/{id}` still works, but leaves the route split across two names until the last PUT lands, and moves the memberships on the first one.
+     * Rename a model route
+     */
+    renameModelRoute(requestParameters: RenameModelRouteOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RenameModelRouteResponse>;
     /**
      * Creates request options for reorderModelMappings without sending the request
      */
@@ -1091,14 +1213,19 @@ export declare class LlmGatewayApi extends runtime.BaseAPI {
     setApiKeyDisabled(requestParameters: SetApiKeyDisabledOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKeyDisabledResponse>;
     /**
      * Creates request options for setProfileDefault without sending the request
+     * @deprecated
      */
     setProfileDefaultRequestOpts(requestParameters: SetProfileDefaultRequest): Promise<runtime.RequestOpts>;
     /**
-     * Make this the organization\'s default profile for its client
+     * Promotes an archived profile to the client\'s settings and archives the current settings, in one transaction. Naming the current settings is a no-op.
+     * Make this the organization\'s settings for its client
+     * @deprecated
      */
     setProfileDefaultRaw(requestParameters: SetProfileDefaultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentRuntimeProfile>>;
     /**
-     * Make this the organization\'s default profile for its client
+     * Promotes an archived profile to the client\'s settings and archives the current settings, in one transaction. Naming the current settings is a no-op.
+     * Make this the organization\'s settings for its client
+     * @deprecated
      */
     setProfileDefault(requestParameters: SetProfileDefaultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentRuntimeProfile>;
     /**
@@ -1177,14 +1304,17 @@ export declare class LlmGatewayApi extends runtime.BaseAPI {
     updatePricing(requestParameters: UpdatePricingOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminModelPricing>;
     /**
      * Creates request options for updateProfileContract without sending the request
+     * @deprecated
      */
     updateProfileContractRequestOpts(requestParameters: UpdateProfileContractRequest): Promise<runtime.RequestOpts>;
     /**
      * Replace a profile\'s capability contract
+     * @deprecated
      */
     updateProfileContractRaw(requestParameters: UpdateProfileContractRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentRuntimeProfile>>;
     /**
      * Replace a profile\'s capability contract
+     * @deprecated
      */
     updateProfileContract(requestParameters: UpdateProfileContractRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentRuntimeProfile>;
     /**