@barndoor-ai/sdk 1.3.0 → 2.0.0-dev.g37b8897

package/dist/esm/models/PricingRuleSummary.d.ts

@@ -0,0 +1,146 @@
+/**
+ * Barndoor.ai Public API
+ * Unified public API specification for Barndoor.ai platform
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { PricingChangeSource } from './PricingChangeSource.js';
+import type { LongContextTier } from './LongContextTier.js';
+import type { PricingSyncMode } from './PricingSyncMode.js';
+/**
+ * One entry in the per-rule list returned by `GET /admin/model-pricing`.
+ * `current` is the latest version with `effective_from <= now()` (so the
+ * row UI can render exactly as it did pre-V34), `scheduled_count` /
+ * `next_scheduled_effective_from` drive the small "Scheduled" affordance on
+ * the row, and `version_count` decides whether to show the history icon.
+ * @export
+ * @interface PricingRuleSummary
+ */
+export interface PricingRuleSummary {
+    /**
+     * Per-million-token cost for input tokens served from the prompt
+     * cache. `None` ⇒ the calculator bills cached input at
+     * `input_cost_per_million_tokens`.
+     */
+    cacheReadCostPerMillionTokens?: number;
+    /**
+     * Per-million-token cost for input tokens added to the prompt cache.
+     * `None` ⇒ same fallback as `cache_read_cost_per_million_tokens`.
+     */
+    cacheWriteCostPerMillionTokens?: number;
+    /**
+     * Catalog slug for provider-level pricing (e.g. "openai", "aws_bedrock").
+     */
+    catalogSlug?: string;
+    /**
+     *
+     */
+    effectiveFrom: Date;
+    /**
+     *
+     */
+    id: string;
+    /**
+     *
+     */
+    inputCostPerMillionTokens: number;
+    /**
+     * Optional context-tiered surcharge (BCP-3904). `None` ⇒ one rate set
+     * at every prompt size, i.e. exactly the pre-BCP-3904 behaviour.
+     *
+     * Serialized as `long_context`, not as the Rust field name. This struct
+     * reaches the admin API through `AdminModelPricing`'s
+     * `#[serde(flatten)]`, so the field name here *is* the wire key — and
+     * every sibling surface (`DefaultPricingEntry`, `EffectivePricing`, the
+     * create/update request bodies) already spells it `long_context`. Left
+     * unrenamed, the pricing tab would write a tier successfully and then
+     * read back nothing, which is precisely how it behaved before this
+     * attribute existed: the surcharge saved, the dialog reopened unchecked,
+     * and the edit looked silently discarded. Pinned by
+     * `admin_model_pricing_serializes_the_tier_as_long_context`.
+     */
+    longContext?: LongContextTier;
+    /**
+     *
+     */
+    modelPattern: string;
+    /**
+     *
+     */
+    modelProvider?: string;
+    /**
+     *
+     */
+    orgId: string;
+    /**
+     *
+     */
+    outputCostPerMillionTokens: number;
+    /**
+     * Optional reference to a specific LLM Gateway provider instance.
+     */
+    providerId?: string;
+    /**
+     *
+     */
+    providerName?: string;
+    /**
+     *
+     */
+    changeReason?: string;
+    /**
+     *
+     */
+    changeSource: PricingChangeSource;
+    /**
+     *
+     */
+    createdByEmail?: string;
+    /**
+     *
+     */
+    createdByName?: string;
+    /**
+     *
+     */
+    createdByUserId?: string;
+    /**
+     * True for tombstone rows produced by `archive_rule` (V35). When
+     * the latest effective version of a group has `is_archived = true`,
+     * the rule is considered archived: the cost calculator skips it
+     * and the admin summary list hides it by default. Past non-archived
+     * versions remain in the timeline so the History dialog can show
+     * the rule's full life including the archive event.
+     */
+    isArchived: boolean;
+    /**
+     *
+     */
+    syncMode: PricingSyncMode;
+    /**
+     * When the next scheduled version takes effect, if any.
+     */
+    nextScheduledEffectiveFrom?: Date | null;
+    /**
+     * Versions of this rule with `effective_from > now()` that haven't
+     * activated yet. `0` means no scheduled change pending.
+     */
+    scheduledCount: number;
+    /**
+     * Total versions in this rule's history (including `current`).
+     */
+    versionCount: number;
+}
+/**
+ * Check if a given object implements the PricingRuleSummary interface.
+ */
+export declare function instanceOfPricingRuleSummary(value: object): value is PricingRuleSummary;
+export declare function PricingRuleSummaryFromJSON(json: any): PricingRuleSummary;
+export declare function PricingRuleSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): PricingRuleSummary;
+export declare function PricingRuleSummaryToJSON(json: any): PricingRuleSummary;
+export declare function PricingRuleSummaryToJSONTyped(value?: PricingRuleSummary | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PricingRuleSummary.js

@@ -0,0 +1,111 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Barndoor.ai Public API
+ * Unified public API specification for Barndoor.ai platform
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { parseDateTime, serializeDateTime } from '../runtime.js';
+import { PricingChangeSourceFromJSON, PricingChangeSourceToJSON, } from './PricingChangeSource.js';
+import { LongContextTierFromJSON, LongContextTierToJSON, } from './LongContextTier.js';
+import { PricingSyncModeFromJSON, PricingSyncModeToJSON, } from './PricingSyncMode.js';
+/**
+ * Check if a given object implements the PricingRuleSummary interface.
+ */
+export function instanceOfPricingRuleSummary(value) {
+    if ((!('effectiveFrom' in value) && !('effective_from' in value)) || (value['effectiveFrom'] === undefined && value['effective_from'] === undefined))
+        return false;
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if ((!('inputCostPerMillionTokens' in value) && !('input_cost_per_million_tokens' in value)) || (value['inputCostPerMillionTokens'] === undefined && value['input_cost_per_million_tokens'] === undefined))
+        return false;
+    if ((!('modelPattern' in value) && !('model_pattern' in value)) || (value['modelPattern'] === undefined && value['model_pattern'] === undefined))
+        return false;
+    if ((!('orgId' in value) && !('org_id' in value)) || (value['orgId'] === undefined && value['org_id'] === undefined))
+        return false;
+    if ((!('outputCostPerMillionTokens' in value) && !('output_cost_per_million_tokens' in value)) || (value['outputCostPerMillionTokens'] === undefined && value['output_cost_per_million_tokens'] === undefined))
+        return false;
+    if ((!('changeSource' in value) && !('change_source' in value)) || (value['changeSource'] === undefined && value['change_source'] === undefined))
+        return false;
+    if ((!('isArchived' in value) && !('is_archived' in value)) || (value['isArchived'] === undefined && value['is_archived'] === undefined))
+        return false;
+    if ((!('syncMode' in value) && !('sync_mode' in value)) || (value['syncMode'] === undefined && value['sync_mode'] === undefined))
+        return false;
+    if ((!('scheduledCount' in value) && !('scheduled_count' in value)) || (value['scheduledCount'] === undefined && value['scheduled_count'] === undefined))
+        return false;
+    if ((!('versionCount' in value) && !('version_count' in value)) || (value['versionCount'] === undefined && value['version_count'] === undefined))
+        return false;
+    return true;
+}
+export function PricingRuleSummaryFromJSON(json) {
+    return PricingRuleSummaryFromJSONTyped(json, false);
+}
+export function PricingRuleSummaryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'cacheReadCostPerMillionTokens': json['cache_read_cost_per_million_tokens'] == null ? undefined : json['cache_read_cost_per_million_tokens'],
+        'cacheWriteCostPerMillionTokens': json['cache_write_cost_per_million_tokens'] == null ? undefined : json['cache_write_cost_per_million_tokens'],
+        'catalogSlug': json['catalog_slug'] == null ? undefined : json['catalog_slug'],
+        'effectiveFrom': (json['effective_from'] == null ? json['effective_from'] : parseDateTime(json['effective_from'])),
+        'id': json['id'],
+        'inputCostPerMillionTokens': json['input_cost_per_million_tokens'],
+        'longContext': json['long_context'] == null ? undefined : LongContextTierFromJSON(json['long_context']),
+        'modelPattern': json['model_pattern'],
+        'modelProvider': json['model_provider'] == null ? undefined : json['model_provider'],
+        'orgId': json['org_id'],
+        'outputCostPerMillionTokens': json['output_cost_per_million_tokens'],
+        'providerId': json['provider_id'] == null ? undefined : json['provider_id'],
+        'providerName': json['provider_name'] == null ? undefined : json['provider_name'],
+        'changeReason': json['change_reason'] == null ? undefined : json['change_reason'],
+        'changeSource': PricingChangeSourceFromJSON(json['change_source']),
+        'createdByEmail': json['created_by_email'] == null ? undefined : json['created_by_email'],
+        'createdByName': json['created_by_name'] == null ? undefined : json['created_by_name'],
+        'createdByUserId': json['created_by_user_id'] == null ? undefined : json['created_by_user_id'],
+        'isArchived': json['is_archived'],
+        'syncMode': PricingSyncModeFromJSON(json['sync_mode']),
+        'nextScheduledEffectiveFrom': json['next_scheduled_effective_from'] === undefined ? undefined : json['next_scheduled_effective_from'] === null ? null : (parseDateTime(json['next_scheduled_effective_from'])),
+        'scheduledCount': json['scheduled_count'],
+        'versionCount': json['version_count'],
+    };
+}
+export function PricingRuleSummaryToJSON(json) {
+    return PricingRuleSummaryToJSONTyped(json, false);
+}
+export function PricingRuleSummaryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'cache_read_cost_per_million_tokens': value['cacheReadCostPerMillionTokens'],
+        'cache_write_cost_per_million_tokens': value['cacheWriteCostPerMillionTokens'],
+        'catalog_slug': value['catalogSlug'],
+        'effective_from': value['effectiveFrom'] == null ? value['effectiveFrom'] : serializeDateTime(value['effectiveFrom']),
+        'id': value['id'],
+        'input_cost_per_million_tokens': value['inputCostPerMillionTokens'],
+        'long_context': LongContextTierToJSON(value['longContext']),
+        'model_pattern': value['modelPattern'],
+        'model_provider': value['modelProvider'],
+        'org_id': value['orgId'],
+        'output_cost_per_million_tokens': value['outputCostPerMillionTokens'],
+        'provider_id': value['providerId'],
+        'provider_name': value['providerName'],
+        'change_reason': value['changeReason'],
+        'change_source': PricingChangeSourceToJSON(value['changeSource']),
+        'created_by_email': value['createdByEmail'],
+        'created_by_name': value['createdByName'],
+        'created_by_user_id': value['createdByUserId'],
+        'is_archived': value['isArchived'],
+        'sync_mode': PricingSyncModeToJSON(value['syncMode']),
+        'next_scheduled_effective_from': value['nextScheduledEffectiveFrom'] == null ? value['nextScheduledEffectiveFrom'] : serializeDateTime(value['nextScheduledEffectiveFrom']),
+        'scheduled_count': value['scheduledCount'],
+        'version_count': value['versionCount'],
+    };
+}

package/dist/esm/models/PricingSyncMode.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Barndoor.ai Public API
+ * Unified public API specification for Barndoor.ai platform
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Per-row sync behavior. Stored as a `VARCHAR(16)` constrained to
+ * `tracking | pinned | auto` (see migration V33).
+ * @export
+ */
+export declare const PricingSyncMode: {
+    readonly Tracking: "tracking";
+    readonly Pinned: "pinned";
+    readonly Auto: "auto";
+};
+export type PricingSyncMode = typeof PricingSyncMode[keyof typeof PricingSyncMode];
+export declare function instanceOfPricingSyncMode(value: any): boolean;
+export declare function PricingSyncModeFromJSON(json: any): PricingSyncMode;
+export declare function PricingSyncModeFromJSONTyped(json: any, ignoreDiscriminator: boolean): PricingSyncMode;
+export declare function PricingSyncModeToJSON(value?: PricingSyncMode | null): any;
+export declare function PricingSyncModeToJSONTyped(value: any, ignoreDiscriminator: boolean): PricingSyncMode;

package/dist/esm/models/PricingSyncMode.js

@@ -0,0 +1,45 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Barndoor.ai Public API
+ * Unified public API specification for Barndoor.ai platform
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Per-row sync behavior. Stored as a `VARCHAR(16)` constrained to
+ * `tracking | pinned | auto` (see migration V33).
+ * @export
+ */
+export const PricingSyncMode = {
+    Tracking: 'tracking',
+    Pinned: 'pinned',
+    Auto: 'auto',
+};
+export function instanceOfPricingSyncMode(value) {
+    for (const key in PricingSyncMode) {
+        if (Object.prototype.hasOwnProperty.call(PricingSyncMode, key)) {
+            if (PricingSyncMode[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function PricingSyncModeFromJSON(json) {
+    return PricingSyncModeFromJSONTyped(json, false);
+}
+export function PricingSyncModeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function PricingSyncModeToJSON(value) {
+    return value;
+}
+export function PricingSyncModeToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/esm/models/Protocol.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Barndoor.ai Public API
+ * Unified public API specification for Barndoor.ai platform
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Protocol enum for MCP server communication.
+ * @export
+ */
+export declare const Protocol: {
+    readonly Mcp: "mcp";
+    readonly Sse: "sse";
+};
+export type Protocol = typeof Protocol[keyof typeof Protocol];
+export declare function instanceOfProtocol(value: any): boolean;
+export declare function ProtocolFromJSON(json: any): Protocol;
+export declare function ProtocolFromJSONTyped(json: any, ignoreDiscriminator: boolean): Protocol;
+export declare function ProtocolToJSON(value?: Protocol | null): any;
+export declare function ProtocolToJSONTyped(value: any, ignoreDiscriminator: boolean): Protocol;

package/dist/esm/models/Protocol.js

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Barndoor.ai Public API
+ * Unified public API specification for Barndoor.ai platform
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Protocol enum for MCP server communication.
+ * @export
+ */
+export const Protocol = {
+    Mcp: 'mcp',
+    Sse: 'sse',
+};
+export function instanceOfProtocol(value) {
+    for (const key in Protocol) {
+        if (Object.prototype.hasOwnProperty.call(Protocol, key)) {
+            if (Protocol[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function ProtocolFromJSON(json) {
+    return ProtocolFromJSONTyped(json, false);
+}
+export function ProtocolFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function ProtocolToJSON(value) {
+    return value;
+}
+export function ProtocolToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/esm/models/Provider.d.ts

@@ -0,0 +1,200 @@
+/**
+ * Barndoor.ai Public API
+ * Unified public API specification for Barndoor.ai platform
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { BillingReason } from './BillingReason.js';
+import type { BillingMode } from './BillingMode.js';
+import type { ModelSyncMode } from './ModelSyncMode.js';
+/**
+ *
+ * @export
+ * @interface Provider
+ */
+export interface Provider {
+    /**
+     *
+     */
+    createdByEmail?: string | null;
+    /**
+     *
+     */
+    createdByName?: string | null;
+    /**
+     *
+     */
+    createdByUserId?: string | null;
+    /**
+     * Optional free text explaining *why* the last change was made
+     * ("Raised for the Q3 batch job", "Vendor deprecated the old endpoint").
+     *
+     * Admin-authored and rendered in the portal, so it is untrusted input:
+     * length-capped here, escaped on render.
+     */
+    lastChangeNote?: string | null;
+    /**
+     * When the change named by `last_modified_by_*` happened.
+     *
+     * Its own column rather than the row's `updated_at`, because `updated_at`
+     * is bumped by writes nobody is attributed for -- pairing the two would
+     * date a named admin's edit to a background job's clock. See the V75
+     * migration for the full reasoning.
+     */
+    lastModifiedAt?: Date | null;
+    /**
+     *
+     */
+    lastModifiedByEmail?: string | null;
+    /**
+     *
+     */
+    lastModifiedByName?: string | null;
+    /**
+     *
+     */
+    lastModifiedByUserId?: string | null;
+    /**
+     *
+     */
+    authType: string;
+    /**
+     *
+     */
+    baseUrl: string;
+    /**
+     * Whether the gateway records a per-token cost for this provider's
+     * traffic (V69 / BCP-3876). `PerToken` for every provider that has not
+     * opted in, which is the default and the back-compat value.
+     *
+     * The request path does **not** read this field: billing consults
+     * [`ai_governance::CostCalculator`]'s own cached not-metered set, which
+     * is refreshed from the same query as pricing. This exists for the admin
+     * API surface and the audit trail.
+     */
+    billingMode: BillingMode;
+    /**
+     * Optional free-text context for the arrangement (max 200 chars).
+     * Human-readable only — never parsed, never aggregated.
+     */
+    billingNote?: string | null;
+    /**
+     * How the vendor bills this provider. Required when `billing_mode` is
+     * `NotMetered`, optional otherwise (V69 CHECK-enforced) — a subscription
+     * billing overages is both per-token and a subscription. Purely
+     * descriptive: no code branches on it, which is what lets a new reason be
+     * added without touching the billing path.
+     */
+    billingReason?: BillingReason | null;
+    /**
+     *
+     */
+    catalogId?: string | null;
+    /**
+     *
+     */
+    catalogSlug?: string | null;
+    /**
+     *
+     */
+    connectionId?: string | null;
+    /**
+     *
+     */
+    createdAt: Date;
+    /**
+     *
+     */
+    enabled: boolean;
+    /**
+     * Operator override for the health gate (V46). When `true` (default)
+     * routing requires `health_status <> 'unhealthy'`; when `false` the gate
+     * is bypassed and the provider serves regardless of probe results (we
+     * still probe and surface health). Lets an admin force traffic through a
+     * false-positive probe.
+     */
+    enforceHealthCheck: boolean;
+    /**
+     * When the last connectivity probe ran (NULL until the first probe).
+     */
+    healthCheckedAt?: Date | null;
+    /**
+     * Human-readable reason for the last `unhealthy` probe (NULL otherwise).
+     */
+    healthDetail?: string | null;
+    /**
+     * Observed upstream reachability, recorded separately from `enabled`
+     * (operator intent) so the system never overwrites the toggle (V45).
+     * One of `unverified` | `healthy` | `unhealthy`. `unverified` is the
+     * back-compat default and also covers provider families we don't probe
+     * (Bedrock/Vertex/Azure, claude_oauth, codex_oauth). A provider serves traffic only
+     * when `enabled` AND `health_status <> 'unhealthy'`: a failed probe
+     * auto-suspends it from routing (see `resolve_*`) without disabling it,
+     * and it resumes once a probe records it healthy again.
+     */
+    healthStatus: string;
+    /**
+     *
+     */
+    id: string;
+    /**
+     *
+     */
+    modelProvider: string;
+    /**
+     * Whether this provider tracks Barndoor's model catalog, and how far
+     * (V63 / BCP-3811). `Off` for every provider that has not opted in,
+     * which is the default and the back-compat value.
+     */
+    modelSyncMode: ModelSyncMode;
+    /**
+     *
+     */
+    name: string;
+    /**
+     *
+     */
+    orgId: string;
+    /**
+     * Provider-tier total-request timeout override (non-streaming).
+     * Operator-only and `None` by default: the effective value is written
+     * at the route tier (`model_mappings`), so this only applies if a route
+     * row somehow leaves it unset. Range
+     * `TOTAL_REQUEST_TIMEOUT_MIN_SECS..=TOTAL_REQUEST_TIMEOUT_MAX_SECS` is
+     * enforced by the CHECK constraint (see `proxy::timeouts`).
+     */
+    requestTimeoutSecs?: number | null;
+    /**
+     *
+     */
+    secretPath: string;
+    /**
+     *
+     */
+    settings: any | null;
+    /**
+     * Provider-tier stream-idle timeout override (streaming). Operator-only
+     * and `None` by default; the effective value is written at the route
+     * tier (`model_mappings`). Range
+     * `STREAM_IDLE_TIMEOUT_MIN_SECS..=STREAM_IDLE_TIMEOUT_MAX_SECS` is
+     * enforced by the CHECK constraint (see `proxy::timeouts`).
+     */
+    streamIdleTimeoutSecs?: number | null;
+    /**
+     *
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the Provider interface.
+ */
+export declare function instanceOfProvider(value: object): value is Provider;
+export declare function ProviderFromJSON(json: any): Provider;
+export declare function ProviderFromJSONTyped(json: any, ignoreDiscriminator: boolean): Provider;
+export declare function ProviderToJSON(json: any): Provider;
+export declare function ProviderToJSONTyped(value?: Provider | null, ignoreDiscriminator?: boolean): any;