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

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

@@ -0,0 +1,46 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface AzureContentSafetyConnectionResponse
+ */
+export interface AzureContentSafetyConnectionResponse {
+    /**
+     *
+     */
+    apiVersion: string;
+    /**
+     *
+     */
+    endpoint: string;
+    /**
+     *
+     */
+    hasApiKey: boolean;
+    /**
+     *
+     */
+    orgId: string;
+    /**
+     *
+     */
+    severityThreshold: number;
+}
+/**
+ * Check if a given object implements the AzureContentSafetyConnectionResponse interface.
+ */
+export declare function instanceOfAzureContentSafetyConnectionResponse(value: object): value is AzureContentSafetyConnectionResponse;
+export declare function AzureContentSafetyConnectionResponseFromJSON(json: any): AzureContentSafetyConnectionResponse;
+export declare function AzureContentSafetyConnectionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AzureContentSafetyConnectionResponse;
+export declare function AzureContentSafetyConnectionResponseToJSON(json: any): AzureContentSafetyConnectionResponse;
+export declare function AzureContentSafetyConnectionResponseToJSONTyped(value?: AzureContentSafetyConnectionResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AzureContentSafetyConnectionResponse.js

@@ -0,0 +1,59 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the AzureContentSafetyConnectionResponse interface.
+ */
+export function instanceOfAzureContentSafetyConnectionResponse(value) {
+    if ((!('apiVersion' in value) && !('api_version' in value)) || (value['apiVersion'] === undefined && value['api_version'] === undefined))
+        return false;
+    if (!('endpoint' in value) || value['endpoint'] === undefined)
+        return false;
+    if ((!('hasApiKey' in value) && !('has_api_key' in value)) || (value['hasApiKey'] === undefined && value['has_api_key'] === undefined))
+        return false;
+    if ((!('orgId' in value) && !('org_id' in value)) || (value['orgId'] === undefined && value['org_id'] === undefined))
+        return false;
+    if ((!('severityThreshold' in value) && !('severity_threshold' in value)) || (value['severityThreshold'] === undefined && value['severity_threshold'] === undefined))
+        return false;
+    return true;
+}
+export function AzureContentSafetyConnectionResponseFromJSON(json) {
+    return AzureContentSafetyConnectionResponseFromJSONTyped(json, false);
+}
+export function AzureContentSafetyConnectionResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'apiVersion': json['api_version'],
+        'endpoint': json['endpoint'],
+        'hasApiKey': json['has_api_key'],
+        'orgId': json['org_id'],
+        'severityThreshold': json['severity_threshold'],
+    };
+}
+export function AzureContentSafetyConnectionResponseToJSON(json) {
+    return AzureContentSafetyConnectionResponseToJSONTyped(json, false);
+}
+export function AzureContentSafetyConnectionResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'api_version': value['apiVersion'],
+        'endpoint': value['endpoint'],
+        'has_api_key': value['hasApiKey'],
+        'org_id': value['orgId'],
+        'severity_threshold': value['severityThreshold'],
+    };
+}

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

@@ -0,0 +1,36 @@
+/**
+ * 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.
+ */
+/**
+ * Whether the gateway computes a per-token cost for a provider. Persisted as
+ * a `VARCHAR(16)` constrained to `per_token | not_metered` (see migration
+ * V69, BCP-3876).
+ *
+ * Deliberately binary, with the *why* held separately in [`BillingReason`].
+ * The reason list is open-ended; this question is not, and never will be.
+ * Folding both into one enum would make every "is this zero-cost" check grow
+ * an OR-list as reasons are added, and would need a [`PricingSource`] variant
+ * per reason — an enum whose values reach ClickHouse, the reporting labels, a
+ * frontend union type and three UI modules.
+ *
+ * [`PricingSource`]: ai_governance::PricingSource
+ * @export
+ */
+export declare const BillingMode: {
+    readonly PerToken: "per_token";
+    readonly NotMetered: "not_metered";
+};
+export type BillingMode = typeof BillingMode[keyof typeof BillingMode];
+export declare function instanceOfBillingMode(value: any): boolean;
+export declare function BillingModeFromJSON(json: any): BillingMode;
+export declare function BillingModeFromJSONTyped(json: any, ignoreDiscriminator: boolean): BillingMode;
+export declare function BillingModeToJSON(value?: BillingMode | null): any;
+export declare function BillingModeToJSONTyped(value: any, ignoreDiscriminator: boolean): BillingMode;

package/dist/esm/models/BillingMode.js

@@ -0,0 +1,54 @@
+/* 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.
+ */
+/**
+ * Whether the gateway computes a per-token cost for a provider. Persisted as
+ * a `VARCHAR(16)` constrained to `per_token | not_metered` (see migration
+ * V69, BCP-3876).
+ *
+ * Deliberately binary, with the *why* held separately in [`BillingReason`].
+ * The reason list is open-ended; this question is not, and never will be.
+ * Folding both into one enum would make every "is this zero-cost" check grow
+ * an OR-list as reasons are added, and would need a [`PricingSource`] variant
+ * per reason — an enum whose values reach ClickHouse, the reporting labels, a
+ * frontend union type and three UI modules.
+ *
+ * [`PricingSource`]: ai_governance::PricingSource
+ * @export
+ */
+export const BillingMode = {
+    PerToken: 'per_token',
+    NotMetered: 'not_metered',
+};
+export function instanceOfBillingMode(value) {
+    for (const key in BillingMode) {
+        if (Object.prototype.hasOwnProperty.call(BillingMode, key)) {
+            if (BillingMode[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function BillingModeFromJSON(json) {
+    return BillingModeFromJSONTyped(json, false);
+}
+export function BillingModeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function BillingModeToJSON(value) {
+    return value;
+}
+export function BillingModeToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,42 @@
+/**
+ * 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.
+ */
+/**
+ * How the vendor bills a provider. Persisted as a nullable `VARCHAR(16)`,
+ * required when `billing_mode = 'not_metered'` and optional otherwise (V69
+ * CHECK-enforced).
+ *
+ * **Independent of [`BillingMode`], not paired with it.** A subscription that
+ * bills overages beyond the plan is genuinely per-token *and* genuinely a
+ * subscription; requiring the two to agree made that unrepresentable. What
+ * survives is the half worth keeping: a provider must not stop recording cost
+ * without saying why.
+ *
+ * **Label only — nothing branches on this.** That is the point of separating
+ * it from [`BillingMode`]: adding a reason touches this enum, its label maps
+ * and the CHECK constraint, and never the billing path. If a proposed
+ * category needs different *behaviour* (prepaid credits drawing down a
+ * balance, committed spend needing a floor), it is a feature, not a variant
+ * here.
+ * @export
+ */
+export declare const BillingReason: {
+    readonly Subscription: "subscription";
+    readonly Local: "local";
+    readonly External: "external";
+    readonly Other: "other";
+};
+export type BillingReason = typeof BillingReason[keyof typeof BillingReason];
+export declare function instanceOfBillingReason(value: any): boolean;
+export declare function BillingReasonFromJSON(json: any): BillingReason;
+export declare function BillingReasonFromJSONTyped(json: any, ignoreDiscriminator: boolean): BillingReason;
+export declare function BillingReasonToJSON(value?: BillingReason | null): any;
+export declare function BillingReasonToJSONTyped(value: any, ignoreDiscriminator: boolean): BillingReason;

package/dist/esm/models/BillingReason.js

@@ -0,0 +1,60 @@
+/* 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.
+ */
+/**
+ * How the vendor bills a provider. Persisted as a nullable `VARCHAR(16)`,
+ * required when `billing_mode = 'not_metered'` and optional otherwise (V69
+ * CHECK-enforced).
+ *
+ * **Independent of [`BillingMode`], not paired with it.** A subscription that
+ * bills overages beyond the plan is genuinely per-token *and* genuinely a
+ * subscription; requiring the two to agree made that unrepresentable. What
+ * survives is the half worth keeping: a provider must not stop recording cost
+ * without saying why.
+ *
+ * **Label only — nothing branches on this.** That is the point of separating
+ * it from [`BillingMode`]: adding a reason touches this enum, its label maps
+ * and the CHECK constraint, and never the billing path. If a proposed
+ * category needs different *behaviour* (prepaid credits drawing down a
+ * balance, committed spend needing a floor), it is a feature, not a variant
+ * here.
+ * @export
+ */
+export const BillingReason = {
+    Subscription: 'subscription',
+    Local: 'local',
+    External: 'external',
+    Other: 'other',
+};
+export function instanceOfBillingReason(value) {
+    for (const key in BillingReason) {
+        if (Object.prototype.hasOwnProperty.call(BillingReason, key)) {
+            if (BillingReason[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function BillingReasonFromJSON(json) {
+    return BillingReasonFromJSONTyped(json, false);
+}
+export function BillingReasonFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function BillingReasonToJSON(value) {
+    return value;
+}
+export function BillingReasonToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,26 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ */
+export declare const BudgetAction: {
+    readonly Block: "block";
+    readonly Throttle: "throttle";
+    readonly Warn: "warn";
+};
+export type BudgetAction = typeof BudgetAction[keyof typeof BudgetAction];
+export declare function instanceOfBudgetAction(value: any): boolean;
+export declare function BudgetActionFromJSON(json: any): BudgetAction;
+export declare function BudgetActionFromJSONTyped(json: any, ignoreDiscriminator: boolean): BudgetAction;
+export declare function BudgetActionToJSON(value?: BudgetAction | null): any;
+export declare function BudgetActionToJSONTyped(value: any, ignoreDiscriminator: boolean): BudgetAction;

package/dist/esm/models/BudgetAction.js

@@ -0,0 +1,44 @@
+/* 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.
+ */
+/**
+ *
+ * @export
+ */
+export const BudgetAction = {
+    Block: 'block',
+    Throttle: 'throttle',
+    Warn: 'warn',
+};
+export function instanceOfBudgetAction(value) {
+    for (const key in BudgetAction) {
+        if (Object.prototype.hasOwnProperty.call(BudgetAction, key)) {
+            if (BudgetAction[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function BudgetActionFromJSON(json) {
+    return BudgetActionFromJSONTyped(json, false);
+}
+export function BudgetActionFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function BudgetActionToJSON(value) {
+    return value;
+}
+export function BudgetActionToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/esm/models/BudgetLimitKind.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.
+ */
+/**
+ * Which limit on the budget actually exhausted.
+ * @export
+ */
+export declare const BudgetLimitKind: {
+    readonly Token: "token";
+    readonly Cost: "cost";
+};
+export type BudgetLimitKind = typeof BudgetLimitKind[keyof typeof BudgetLimitKind];
+export declare function instanceOfBudgetLimitKind(value: any): boolean;
+export declare function BudgetLimitKindFromJSON(json: any): BudgetLimitKind;
+export declare function BudgetLimitKindFromJSONTyped(json: any, ignoreDiscriminator: boolean): BudgetLimitKind;
+export declare function BudgetLimitKindToJSON(value?: BudgetLimitKind | null): any;
+export declare function BudgetLimitKindToJSONTyped(value: any, ignoreDiscriminator: boolean): BudgetLimitKind;

package/dist/esm/models/BudgetLimitKind.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.
+ */
+/**
+ * Which limit on the budget actually exhausted.
+ * @export
+ */
+export const BudgetLimitKind = {
+    Token: 'token',
+    Cost: 'cost',
+};
+export function instanceOfBudgetLimitKind(value) {
+    for (const key in BudgetLimitKind) {
+        if (Object.prototype.hasOwnProperty.call(BudgetLimitKind, key)) {
+            if (BudgetLimitKind[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function BudgetLimitKindFromJSON(json) {
+    return BudgetLimitKindFromJSONTyped(json, false);
+}
+export function BudgetLimitKindFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function BudgetLimitKindToJSON(value) {
+    return value;
+}
+export function BudgetLimitKindToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,33 @@
+/**
+ * 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.
+ */
+/**
+ * How often a budget's counter resets.
+ *
+ * **Every period boundary is UTC**, with no per-org configuration:
+ * `key_suffix` formats `Utc::now()`, so `Daily` rolls at 00:00 UTC, `Weekly`
+ * at Monday 00:00 UTC (ISO-8601 week), and `Monthly` on the 1st at 00:00 UTC.
+ * An admin in a western timezone therefore sees their "daily" cap reset in
+ * the afternoon — [`Self::period_end`] exists so the UI can say so rather
+ * than leave them to infer it (BCP-4204).
+ * @export
+ */
+export declare const BudgetPeriod: {
+    readonly Daily: "daily";
+    readonly Weekly: "weekly";
+    readonly Monthly: "monthly";
+};
+export type BudgetPeriod = typeof BudgetPeriod[keyof typeof BudgetPeriod];
+export declare function instanceOfBudgetPeriod(value: any): boolean;
+export declare function BudgetPeriodFromJSON(json: any): BudgetPeriod;
+export declare function BudgetPeriodFromJSONTyped(json: any, ignoreDiscriminator: boolean): BudgetPeriod;
+export declare function BudgetPeriodToJSON(value?: BudgetPeriod | null): any;
+export declare function BudgetPeriodToJSONTyped(value: any, ignoreDiscriminator: boolean): BudgetPeriod;

package/dist/esm/models/BudgetPeriod.js

@@ -0,0 +1,51 @@
+/* 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.
+ */
+/**
+ * How often a budget's counter resets.
+ *
+ * **Every period boundary is UTC**, with no per-org configuration:
+ * `key_suffix` formats `Utc::now()`, so `Daily` rolls at 00:00 UTC, `Weekly`
+ * at Monday 00:00 UTC (ISO-8601 week), and `Monthly` on the 1st at 00:00 UTC.
+ * An admin in a western timezone therefore sees their "daily" cap reset in
+ * the afternoon — [`Self::period_end`] exists so the UI can say so rather
+ * than leave them to infer it (BCP-4204).
+ * @export
+ */
+export const BudgetPeriod = {
+    Daily: 'daily',
+    Weekly: 'weekly',
+    Monthly: 'monthly',
+};
+export function instanceOfBudgetPeriod(value) {
+    for (const key in BudgetPeriod) {
+        if (Object.prototype.hasOwnProperty.call(BudgetPeriod, key)) {
+            if (BudgetPeriod[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function BudgetPeriodFromJSON(json) {
+    return BudgetPeriodFromJSONTyped(json, false);
+}
+export function BudgetPeriodFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function BudgetPeriodToJSON(value) {
+    return value;
+}
+export function BudgetPeriodToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,28 @@
+/**
+ * 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.
+ */
+/**
+ * Which target dimension the exhausted budget is scoped to. Drives the
+ * pill label in the admin Model Mappings page and the user-portal Models
+ * page.
+ * @export
+ */
+export declare const BudgetTargetKind: {
+    readonly Provider: "provider";
+    readonly UpstreamModel: "upstream_model";
+    readonly ModelAlias: "model_alias";
+};
+export type BudgetTargetKind = typeof BudgetTargetKind[keyof typeof BudgetTargetKind];
+export declare function instanceOfBudgetTargetKind(value: any): boolean;
+export declare function BudgetTargetKindFromJSON(json: any): BudgetTargetKind;
+export declare function BudgetTargetKindFromJSONTyped(json: any, ignoreDiscriminator: boolean): BudgetTargetKind;
+export declare function BudgetTargetKindToJSON(value?: BudgetTargetKind | null): any;
+export declare function BudgetTargetKindToJSONTyped(value: any, ignoreDiscriminator: boolean): BudgetTargetKind;

package/dist/esm/models/BudgetTargetKind.js

@@ -0,0 +1,46 @@
+/* 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.
+ */
+/**
+ * Which target dimension the exhausted budget is scoped to. Drives the
+ * pill label in the admin Model Mappings page and the user-portal Models
+ * page.
+ * @export
+ */
+export const BudgetTargetKind = {
+    Provider: 'provider',
+    UpstreamModel: 'upstream_model',
+    ModelAlias: 'model_alias',
+};
+export function instanceOfBudgetTargetKind(value) {
+    for (const key in BudgetTargetKind) {
+        if (Object.prototype.hasOwnProperty.call(BudgetTargetKind, key)) {
+            if (BudgetTargetKind[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function BudgetTargetKindFromJSON(json) {
+    return BudgetTargetKindFromJSONTyped(json, false);
+}
+export function BudgetTargetKindFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function BudgetTargetKindToJSON(value) {
+    return value;
+}
+export function BudgetTargetKindToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,58 @@
+/**
+ * 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 { BudgetLimitKind } from './BudgetLimitKind.js';
+import type { BudgetTargetKind } from './BudgetTargetKind.js';
+/**
+ * Per-mapping annotation: a budget that is currently blocking traffic for
+ * the (provider, upstream, alias) the mapping resolves to. Serialised as
+ * `budget_status` on each listing row.
+ * @export
+ * @interface BudgetTargetStatus
+ */
+export interface BudgetTargetStatus {
+    /**
+     * Filter to one policy
+     */
+    budgetId: string | null;
+    /**
+     * Optional return URL for redirecting the user after connection completes.
+     */
+    budgetName: string | null;
+    /**
+     *
+     */
+    kind: BudgetTargetKind;
+    /**
+     *
+     */
+    limitKind: BudgetLimitKind;
+    /**
+     * Short human-readable summary suitable for a tooltip / pill label.
+     */
+    message: string;
+    /**
+     *
+     */
+    percentageUsed: number;
+    /**
+     * Optional return URL for redirecting the user after connection completes.
+     */
+    period: string | null;
+}
+/**
+ * Check if a given object implements the BudgetTargetStatus interface.
+ */
+export declare function instanceOfBudgetTargetStatus(value: object): value is BudgetTargetStatus;
+export declare function BudgetTargetStatusFromJSON(json: any): BudgetTargetStatus;
+export declare function BudgetTargetStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): BudgetTargetStatus;
+export declare function BudgetTargetStatusToJSON(json: any): BudgetTargetStatus;
+export declare function BudgetTargetStatusToJSONTyped(value?: BudgetTargetStatus | null, ignoreDiscriminator?: boolean): any;