@oxy.so/contracts 4.11.0 → 4.12.0

package/dist/types/accountSubject.d.ts

@@ -166,7 +166,7 @@ export declare const financialEffectAttributionSchema: z.ZodEffects<z.ZodObject<
     }>;
 }, "strict", z.ZodTypeAny, {
     schemaVersion: 1;
-    direction: "debit" | "credit";
+    direction: "credit" | "debit";
     subjectAccountId: string & z.BRAND<"OxyAccountId">;
     actor: {
         schemaVersion: 1;
@@ -176,7 +176,7 @@ export declare const financialEffectAttributionSchema: z.ZodEffects<z.ZodObject<
     };
 }, {
     schemaVersion: 1;
-    direction: "debit" | "credit";
+    direction: "credit" | "debit";
     subjectAccountId: string;
     actor: {
         schemaVersion: 1;
@@ -186,7 +186,7 @@ export declare const financialEffectAttributionSchema: z.ZodEffects<z.ZodObject<
     };
 }>, {
     schemaVersion: 1;
-    direction: "debit" | "credit";
+    direction: "credit" | "debit";
     subjectAccountId: string & z.BRAND<"OxyAccountId">;
     actor: {
         schemaVersion: 1;
@@ -196,7 +196,7 @@ export declare const financialEffectAttributionSchema: z.ZodEffects<z.ZodObject<
     };
 }, {
     schemaVersion: 1;
-    direction: "debit" | "credit";
+    direction: "credit" | "debit";
     subjectAccountId: string;
     actor: {
         schemaVersion: 1;

package/dist/types/index.d.ts

@@ -64,8 +64,8 @@ export type { EmailVerificationPurpose, EmailVerificationStartRequest, EmailVeri
 export { transparencyCheckpointSignatureSchema, transparencyAnchorSchema, transparencyCheckpointSchema, transparencyInclusionProofSchema, transparencyCheckpointListSchema, } from './transparency';
 export type { TransparencyCheckpointSignature, TransparencyAnchor, TransparencyCheckpoint, TransparencyInclusionProof, TransparencyCheckpointList, } from './transparency';
 export { INFERENCE_CONTRACT_VERSION, } from './inference/version';
-export { oxyAccountIdSchema, delegatedUserIdSchema, oxyApplicationIdSchema, oxyCredentialIdSchema, requestIdSchema, generationIdSchema, idempotencyKeySchema, inferenceEnvironmentSchema, inferenceTimestampSchema, inferenceDateSchema, inferenceHttpsUrlSchema, sha256DigestSchema, publisherSlugSchema, modelSlugSchema, modelIdSchema, modelRevisionLabelSchema, modelReferenceSchema, routingProfileIdSchema, routingProfileSlugSchema, inferenceProviderSlugSchema, deploymentIdSchema, inferenceRegionSchema, RESERVED_ALIA_PUBLISHER, } from './inference/identifiers';
-export type { OxyAccountId, DelegatedUserId, InferenceEnvironment, ModelReference, ModelId, } from './inference/identifiers';
+export { oxyAccountIdSchema, delegatedUserIdSchema, oxyApplicationIdSchema, oxyCredentialIdSchema, requestIdSchema, generationIdSchema, idempotencyKeySchema, inferenceEnvironmentSchema, inferenceTimestampSchema, inferenceDateSchema, inferenceHttpsUrlSchema, sha256DigestSchema, publisherSlugSchema, modelSlugSchema, modelIdSchema, modelRevisionLabelSchema, modelReferenceSchema, routingProfileIdSchema, routingProfileSlugSchema, inferenceProviderSlugSchema, deploymentIdSchema, inferenceRegionSchema, inferenceFundingTierSchema, RESERVED_ALIA_PUBLISHER, } from './inference/identifiers';
+export type { OxyAccountId, DelegatedUserId, InferenceEnvironment, InferenceFundingTier, ModelReference, ModelId, } from './inference/identifiers';
 export { currencyCodeSchema, INFERENCE_MONEY_SCALE, exactDecimalSchema, moneySchema, USAGE_UNITS, usageUnitSchema, USAGE_SOURCES, usageSourceSchema, usageQuantitySchema, unitPriceSchema, } from './inference/money';
 export type { CurrencyCode, ExactDecimal, Money, UsageUnit, UsageSource, UsageQuantity, UnitPrice, } from './inference/money';
 export { INFERENCE_SCOPES, inferenceScopeSchema, billingPrincipalSchema, authenticatedPrincipalSchema, inferenceAttributionSchema, } from './inference/attribution';

package/dist/types/inference/accountBilling.d.ts

@@ -322,7 +322,7 @@ export declare const billingInvoiceSchema: z.ZodObject<{
     paidAt: z.ZodOptional<z.ZodString>;
     receiptCount: z.ZodNumber;
 }, "strict", z.ZodTypeAny, {
-    status: "void" | "draft" | "open" | "paid";
+    status: "void" | "paid" | "draft" | "open";
     schemaVersion: 1;
     accountId: string & z.BRAND<"OxyAccountId">;
     id: string;
@@ -337,7 +337,7 @@ export declare const billingInvoiceSchema: z.ZodObject<{
     externalInvoiceRef?: string | undefined;
     paidAt?: string | undefined;
 }, {
-    status: "void" | "draft" | "open" | "paid";
+    status: "void" | "paid" | "draft" | "open";
     schemaVersion: 1;
     accountId: string;
     id: string;

package/dist/types/inference/decisions.d.ts

@@ -531,6 +531,7 @@ export declare const decisionResultSchema: z.ZodEffects<z.ZodEffects<z.ZodObject
         servingProvider: z.ZodString;
         deploymentId: z.ZodString;
         routeSwitches: z.ZodNumber;
+        fundingTier: z.ZodOptional<z.ZodEnum<["free", "credit", "paid"]>>;
         startedAt: z.ZodString;
         completedAt: z.ZodString;
         timeToFirstTokenMs: z.ZodOptional<z.ZodNumber>;
@@ -564,6 +565,7 @@ export declare const decisionResultSchema: z.ZodEffects<z.ZodEffects<z.ZodObject
         routeSwitches: number;
         startedAt: string;
         generationId?: string | undefined;
+        fundingTier?: "free" | "credit" | "paid" | undefined;
         timeToFirstTokenMs?: number | undefined;
     }, {
         schemaVersion: 2;
@@ -595,6 +597,7 @@ export declare const decisionResultSchema: z.ZodEffects<z.ZodEffects<z.ZodObject
         routeSwitches: number;
         startedAt: string;
         generationId?: string | undefined;
+        fundingTier?: "free" | "credit" | "paid" | undefined;
         timeToFirstTokenMs?: number | undefined;
     }>, {
         schemaVersion: 2;
@@ -626,6 +629,7 @@ export declare const decisionResultSchema: z.ZodEffects<z.ZodEffects<z.ZodObject
         routeSwitches: number;
         startedAt: string;
         generationId?: string | undefined;
+        fundingTier?: "free" | "credit" | "paid" | undefined;
         timeToFirstTokenMs?: number | undefined;
     }, {
         schemaVersion: 2;
@@ -657,6 +661,7 @@ export declare const decisionResultSchema: z.ZodEffects<z.ZodEffects<z.ZodObject
         routeSwitches: number;
         startedAt: string;
         generationId?: string | undefined;
+        fundingTier?: "free" | "credit" | "paid" | undefined;
         timeToFirstTokenMs?: number | undefined;
     }>;
     schemaVersion: z.ZodLiteral<1>;
@@ -803,6 +808,7 @@ export declare const decisionResultSchema: z.ZodEffects<z.ZodEffects<z.ZodObject
         routeSwitches: number;
         startedAt: string;
         generationId?: string | undefined;
+        fundingTier?: "free" | "credit" | "paid" | undefined;
         timeToFirstTokenMs?: number | undefined;
     };
 }, {
@@ -857,6 +863,7 @@ export declare const decisionResultSchema: z.ZodEffects<z.ZodEffects<z.ZodObject
         routeSwitches: number;
         startedAt: string;
         generationId?: string | undefined;
+        fundingTier?: "free" | "credit" | "paid" | undefined;
         timeToFirstTokenMs?: number | undefined;
     };
 }>, {
@@ -911,6 +918,7 @@ export declare const decisionResultSchema: z.ZodEffects<z.ZodEffects<z.ZodObject
         routeSwitches: number;
         startedAt: string;
         generationId?: string | undefined;
+        fundingTier?: "free" | "credit" | "paid" | undefined;
         timeToFirstTokenMs?: number | undefined;
     };
 }, {
@@ -965,6 +973,7 @@ export declare const decisionResultSchema: z.ZodEffects<z.ZodEffects<z.ZodObject
         routeSwitches: number;
         startedAt: string;
         generationId?: string | undefined;
+        fundingTier?: "free" | "credit" | "paid" | undefined;
         timeToFirstTokenMs?: number | undefined;
     };
 }>, {
@@ -1019,6 +1028,7 @@ export declare const decisionResultSchema: z.ZodEffects<z.ZodEffects<z.ZodObject
         routeSwitches: number;
         startedAt: string;
         generationId?: string | undefined;
+        fundingTier?: "free" | "credit" | "paid" | undefined;
         timeToFirstTokenMs?: number | undefined;
     };
 }, {
@@ -1073,6 +1083,7 @@ export declare const decisionResultSchema: z.ZodEffects<z.ZodEffects<z.ZodObject
         routeSwitches: number;
         startedAt: string;
         generationId?: string | undefined;
+        fundingTier?: "free" | "credit" | "paid" | undefined;
         timeToFirstTokenMs?: number | undefined;
     };
 }>;
@@ -1250,6 +1261,7 @@ export declare const decisionFailureSchema: z.ZodEffects<z.ZodObject<{
         servingProvider: z.ZodString;
         deploymentId: z.ZodString;
         routeSwitches: z.ZodNumber;
+        fundingTier: z.ZodOptional<z.ZodEnum<["free", "credit", "paid"]>>;
         startedAt: z.ZodString;
         completedAt: z.ZodString;
         timeToFirstTokenMs: z.ZodOptional<z.ZodNumber>;
@@ -1283,6 +1295,7 @@ export declare const decisionFailureSchema: z.ZodEffects<z.ZodObject<{
         routeSwitches: number;
         startedAt: string;
         generationId?: string | undefined;
+        fundingTier?: "free" | "credit" | "paid" | undefined;
         timeToFirstTokenMs?: number | undefined;
     }, {
         schemaVersion: 2;
@@ -1314,6 +1327,7 @@ export declare const decisionFailureSchema: z.ZodEffects<z.ZodObject<{
         routeSwitches: number;
         startedAt: string;
         generationId?: string | undefined;
+        fundingTier?: "free" | "credit" | "paid" | undefined;
         timeToFirstTokenMs?: number | undefined;
     }>, {
         schemaVersion: 2;
@@ -1345,6 +1359,7 @@ export declare const decisionFailureSchema: z.ZodEffects<z.ZodObject<{
         routeSwitches: number;
         startedAt: string;
         generationId?: string | undefined;
+        fundingTier?: "free" | "credit" | "paid" | undefined;
         timeToFirstTokenMs?: number | undefined;
     }, {
         schemaVersion: 2;
@@ -1376,6 +1391,7 @@ export declare const decisionFailureSchema: z.ZodEffects<z.ZodObject<{
         routeSwitches: number;
         startedAt: string;
         generationId?: string | undefined;
+        fundingTier?: "free" | "credit" | "paid" | undefined;
         timeToFirstTokenMs?: number | undefined;
     }>>;
 }, "strict", z.ZodTypeAny, {
@@ -1427,6 +1443,7 @@ export declare const decisionFailureSchema: z.ZodEffects<z.ZodObject<{
         routeSwitches: number;
         startedAt: string;
         generationId?: string | undefined;
+        fundingTier?: "free" | "credit" | "paid" | undefined;
         timeToFirstTokenMs?: number | undefined;
     } | undefined;
 }, {
@@ -1478,6 +1495,7 @@ export declare const decisionFailureSchema: z.ZodEffects<z.ZodObject<{
         routeSwitches: number;
         startedAt: string;
         generationId?: string | undefined;
+        fundingTier?: "free" | "credit" | "paid" | undefined;
         timeToFirstTokenMs?: number | undefined;
     } | undefined;
 }>, {
@@ -1529,6 +1547,7 @@ export declare const decisionFailureSchema: z.ZodEffects<z.ZodObject<{
         routeSwitches: number;
         startedAt: string;
         generationId?: string | undefined;
+        fundingTier?: "free" | "credit" | "paid" | undefined;
         timeToFirstTokenMs?: number | undefined;
     } | undefined;
 }, {
@@ -1580,6 +1599,7 @@ export declare const decisionFailureSchema: z.ZodEffects<z.ZodObject<{
         routeSwitches: number;
         startedAt: string;
         generationId?: string | undefined;
+        fundingTier?: "free" | "credit" | "paid" | undefined;
         timeToFirstTokenMs?: number | undefined;
     } | undefined;
 }>;

package/dist/types/inference/identifiers.d.ts

@@ -182,3 +182,17 @@ export type DelegatedUserId = z.infer<typeof delegatedUserIdSchema>;
 export type InferenceEnvironment = z.infer<typeof inferenceEnvironmentSchema>;
 export type ModelReference = z.infer<typeof modelReferenceSchema>;
 export type ModelId = z.infer<typeof modelIdSchema>;
+/**
+ * The economic tier of the provider capacity that funds a request, in the
+ * order Kaana spends it: `free` (costs nothing), `credit` (a promotional or
+ * trial grant, or a prepaid balance), `paid` (ordinary metered spend).
+ *
+ * Kaana owns provider keys, their economics and which key serves (Oxy ADR
+ * 0038, Kaana ADR 0001); Oxy owns what a customer may spend. The tier is the
+ * one economic fact the two exchange: Oxy BOUNDS a route by it
+ * (`maxFundingTier`), and Kaana REPORTS the tier that served
+ * (`normalizedUsageReportSchema.fundingTier`). No key id, label or price
+ * travels with it.
+ */
+export declare const inferenceFundingTierSchema: z.ZodEnum<["free", "credit", "paid"]>;
+export type InferenceFundingTier = z.infer<typeof inferenceFundingTierSchema>;

package/dist/types/inference/realtime.d.ts

@@ -970,6 +970,7 @@ export declare const realtimeSessionRequestSchema: z.ZodEffects<z.ZodObject<{
         modelReference: z.ZodString;
         provider: z.ZodString;
         regions: z.ZodArray<z.ZodString, "many">;
+        maxFundingTier: z.ZodOptional<z.ZodEnum<["free", "credit", "paid"]>>;
         customerProviderCredential: z.ZodOptional<z.ZodObject<{
             credentialHandle: z.ZodString;
             credentialRevision: z.ZodNumber;
@@ -996,6 +997,7 @@ export declare const realtimeSessionRequestSchema: z.ZodEffects<z.ZodObject<{
         deploymentId: string;
         regions: string[];
         substitution: "same_model";
+        maxFundingTier?: "free" | "credit" | "paid" | undefined;
         customerProviderCredential?: {
             environment: "development" | "staging" | "production";
             ownerAccountId: string & z.BRAND<"OxyAccountId">;
@@ -1009,6 +1011,7 @@ export declare const realtimeSessionRequestSchema: z.ZodEffects<z.ZodObject<{
         deploymentId: string;
         regions: string[];
         substitution: "same_model";
+        maxFundingTier?: "free" | "credit" | "paid" | undefined;
         customerProviderCredential?: {
             environment: "development" | "staging" | "production";
             ownerAccountId: string;
@@ -1022,6 +1025,7 @@ export declare const realtimeSessionRequestSchema: z.ZodEffects<z.ZodObject<{
         modelReference: z.ZodString;
         provider: z.ZodString;
         regions: z.ZodArray<z.ZodString, "many">;
+        maxFundingTier: z.ZodOptional<z.ZodEnum<["free", "credit", "paid"]>>;
         customerProviderCredential: z.ZodOptional<z.ZodObject<{
             credentialHandle: z.ZodString;
             credentialRevision: z.ZodNumber;
@@ -1049,6 +1053,7 @@ export declare const realtimeSessionRequestSchema: z.ZodEffects<z.ZodObject<{
         regions: string[];
         substitution: "cross_model";
         authorizedByPolicy: true;
+        maxFundingTier?: "free" | "credit" | "paid" | undefined;
         customerProviderCredential?: {
             environment: "development" | "staging" | "production";
             ownerAccountId: string & z.BRAND<"OxyAccountId">;
@@ -1063,6 +1068,7 @@ export declare const realtimeSessionRequestSchema: z.ZodEffects<z.ZodObject<{
         regions: string[];
         substitution: "cross_model";
         authorizedByPolicy: true;
+        maxFundingTier?: "free" | "credit" | "paid" | undefined;
         customerProviderCredential?: {
             environment: "development" | "staging" | "production";
             ownerAccountId: string;
@@ -1076,6 +1082,7 @@ export declare const realtimeSessionRequestSchema: z.ZodEffects<z.ZodObject<{
         deploymentId: string;
         regions: string[];
         substitution: "same_model";
+        maxFundingTier?: "free" | "credit" | "paid" | undefined;
         customerProviderCredential?: {
             environment: "development" | "staging" | "production";
             ownerAccountId: string & z.BRAND<"OxyAccountId">;
@@ -1090,6 +1097,7 @@ export declare const realtimeSessionRequestSchema: z.ZodEffects<z.ZodObject<{
         regions: string[];
         substitution: "cross_model";
         authorizedByPolicy: true;
+        maxFundingTier?: "free" | "credit" | "paid" | undefined;
         customerProviderCredential?: {
             environment: "development" | "staging" | "production";
             ownerAccountId: string & z.BRAND<"OxyAccountId">;
@@ -1103,6 +1111,7 @@ export declare const realtimeSessionRequestSchema: z.ZodEffects<z.ZodObject<{
         deploymentId: string;
         regions: string[];
         substitution: "same_model";
+        maxFundingTier?: "free" | "credit" | "paid" | undefined;
         customerProviderCredential?: {
             environment: "development" | "staging" | "production";
             ownerAccountId: string;
@@ -1117,6 +1126,7 @@ export declare const realtimeSessionRequestSchema: z.ZodEffects<z.ZodObject<{
         regions: string[];
         substitution: "cross_model";
         authorizedByPolicy: true;
+        maxFundingTier?: "free" | "credit" | "paid" | undefined;
         customerProviderCredential?: {
             environment: "development" | "staging" | "production";
             ownerAccountId: string;
@@ -1166,6 +1176,7 @@ export declare const realtimeSessionRequestSchema: z.ZodEffects<z.ZodObject<{
         deploymentId: string;
         regions: string[];
         substitution: "same_model";
+        maxFundingTier?: "free" | "credit" | "paid" | undefined;
         customerProviderCredential?: {
             environment: "development" | "staging" | "production";
             ownerAccountId: string & z.BRAND<"OxyAccountId">;
@@ -1180,6 +1191,7 @@ export declare const realtimeSessionRequestSchema: z.ZodEffects<z.ZodObject<{
         regions: string[];
         substitution: "cross_model";
         authorizedByPolicy: true;
+        maxFundingTier?: "free" | "credit" | "paid" | undefined;
         customerProviderCredential?: {
             environment: "development" | "staging" | "production";
             ownerAccountId: string & z.BRAND<"OxyAccountId">;
@@ -1272,6 +1284,7 @@ export declare const realtimeSessionRequestSchema: z.ZodEffects<z.ZodObject<{
         deploymentId: string;
         regions: string[];
         substitution: "same_model";
+        maxFundingTier?: "free" | "credit" | "paid" | undefined;
         customerProviderCredential?: {
             environment: "development" | "staging" | "production";
             ownerAccountId: string;
@@ -1286,6 +1299,7 @@ export declare const realtimeSessionRequestSchema: z.ZodEffects<z.ZodObject<{
         regions: string[];
         substitution: "cross_model";
         authorizedByPolicy: true;
+        maxFundingTier?: "free" | "credit" | "paid" | undefined;
         customerProviderCredential?: {
             environment: "development" | "staging" | "production";
             ownerAccountId: string;
@@ -1378,6 +1392,7 @@ export declare const realtimeSessionRequestSchema: z.ZodEffects<z.ZodObject<{
         deploymentId: string;
         regions: string[];
         substitution: "same_model";
+        maxFundingTier?: "free" | "credit" | "paid" | undefined;
         customerProviderCredential?: {
             environment: "development" | "staging" | "production";
             ownerAccountId: string & z.BRAND<"OxyAccountId">;
@@ -1392,6 +1407,7 @@ export declare const realtimeSessionRequestSchema: z.ZodEffects<z.ZodObject<{
         regions: string[];
         substitution: "cross_model";
         authorizedByPolicy: true;
+        maxFundingTier?: "free" | "credit" | "paid" | undefined;
         customerProviderCredential?: {
             environment: "development" | "staging" | "production";
             ownerAccountId: string & z.BRAND<"OxyAccountId">;
@@ -1484,6 +1500,7 @@ export declare const realtimeSessionRequestSchema: z.ZodEffects<z.ZodObject<{
         deploymentId: string;
         regions: string[];
         substitution: "same_model";
+        maxFundingTier?: "free" | "credit" | "paid" | undefined;
         customerProviderCredential?: {
             environment: "development" | "staging" | "production";
             ownerAccountId: string;
@@ -1498,6 +1515,7 @@ export declare const realtimeSessionRequestSchema: z.ZodEffects<z.ZodObject<{
         regions: string[];
         substitution: "cross_model";
         authorizedByPolicy: true;
+        maxFundingTier?: "free" | "credit" | "paid" | undefined;
         customerProviderCredential?: {
             environment: "development" | "staging" | "production";
             ownerAccountId: string;