@oxyhq/contracts 0.28.0 → 0.30.0

package/dist/types/identity.d.ts

@@ -313,11 +313,68 @@ export interface ExportAttestation {
     signedAt: number;
 }
 export declare const exportAttestationSchema: z.ZodType<ExportAttestation>;
+/**
+ * One settled charge, as the account it was charged to may take it away.
+ *
+ * Amounts are EXACT DECIMAL STRINGS, never numbers — the same rule the ledger
+ * itself follows. A JSON number cannot represent `0.000000700000` and a bill a
+ * customer re-adds must reproduce the figure Oxy charged.
+ */
+export interface ExportUsageReceipt {
+    receiptId: string;
+    requestId: string;
+    settledAt: string;
+    billedAmount: string;
+    currency: string;
+    outcome: string;
+    resolvedModelReference: string;
+    servingProvider: string;
+    /** True when the charge is Oxy's fee on a BYOK request, not the model cost. */
+    platformFeeOnly: boolean;
+}
+export declare const exportUsageReceiptSchema: z.ZodType<ExportUsageReceipt>;
+/** One entry in the account's own journal. */
+export interface ExportLedgerEntry {
+    entryId: string;
+    kind: string;
+    currency: string;
+    createdAt: string;
+}
+export declare const exportLedgerEntrySchema: z.ZodType<ExportLedgerEntry>;
+/** One hold: money that was neither spent nor returned at the time it was taken. */
+export interface ExportUsageReservation {
+    reservationId: string;
+    requestId: string;
+    status: string;
+    reservedAmount: string;
+    currency: string;
+    createdAt: string;
+    expiresAt: string;
+}
+export declare const exportUsageReservationSchema: z.ZodType<ExportUsageReservation>;
+/**
+ * What the account was charged, in the subject-access export (#972 section 12).
+ *
+ * Scoped to the CALLING user's own account and read-only. It exists because a
+ * person exercising a subject-access request previously learned nothing about
+ * what they had been charged unless they also happened to be an account
+ * administrator hitting the enterprise reporting route — the deletion side of
+ * that checkbox preserved financial records the export then never disclosed.
+ *
+ * Empty arrays are the normal answer, and mean the account has no ledger history
+ * rather than that anything was withheld.
+ */
+export interface ExportFinancialSection {
+    receipts: ExportUsageReceipt[];
+    ledgerEntries: ExportLedgerEntry[];
+    reservations: ExportUsageReservation[];
+}
+export declare const exportFinancialSectionSchema: z.ZodType<ExportFinancialSection>;
 /**
  * The signed, open-format data-export bundle from `GET /users/me/export`. A
  * portable snapshot of the account: its DID document, profile, verified
  * domains, auth methods (no secrets), published signed records, per-app data,
- * and social graph.
+ * social graph, and what the account was charged.
  *
  * `attestation` is the Oxy custodial provenance signature. It is `null` only
  * when the Oxy custodial signing key (`OXY_PRIVATE_KEY`) is unset (dev /
@@ -338,6 +395,7 @@ export interface ExportBundle {
         following: string[];
         followers: string[];
     };
+    financial: ExportFinancialSection;
     attestation: ExportAttestation | null;
     proof?: ExportAttestation;
 }

package/dist/types/index.d.ts

@@ -23,8 +23,8 @@ export { OXY_USER_INVALIDATION_CHANNEL, OXY_USER_CHANGE_REASONS, OXY_PUBLISHED_U
 export type { OxyUserChangeReason, PublishedOxyUserChangeReason, OxyUserInvalidationEvent, } from './userInvalidation';
 export { recommendationExcludeTypeSchema, recommendationBoostSchema, recommendationSignalWeightsSchema, recommendationRequestSchema, recommendationCountSchema, recommendationItemSchema, recommendationResponseSchema, appEndorsementInputSchema, appInterestInputSchema, appUserSignalIngestSchema, appAffinityEventTypeSchema, appAffinityEventSchema, appAffinityEventsIngestSchema, } from './recommendations';
 export type { RecommendationExcludeType, RecommendationBoost, RecommendationSignalWeights, RecommendationRequest, RecommendationCount, RecommendationItem, RecommendationResponse, AppEndorsementInput, AppInterestInput, AppUserSignalIngest, AppAffinityEventType, AppAffinityEvent, AppAffinityEventsIngest, } from './recommendations';
-export { verificationMethodSchema, didServiceSchema, didDocumentSchema, signedRecordEnvelopeSchema, verifiedDomainSchema, domainVerificationRequestSchema, domainVerificationInstructionsSchema, authMethodEntrySchema, authMethodsResponseSchema, exportAttestationSchema, exportBundleSchema, } from './identity';
-export type { VerificationMethod, Secp256k1VerificationMethod, MultikeyVerificationMethod, DidService, DidDocument, SignedRecordEnvelope, VerifiedDomain, DomainVerificationRequest, DomainVerificationInstructions, AuthMethodEntry, AuthMethodsResponse, ExportAttestation, ExportBundle, } from './identity';
+export { verificationMethodSchema, didServiceSchema, didDocumentSchema, signedRecordEnvelopeSchema, verifiedDomainSchema, domainVerificationRequestSchema, domainVerificationInstructionsSchema, authMethodEntrySchema, authMethodsResponseSchema, exportAttestationSchema, exportUsageReceiptSchema, exportLedgerEntrySchema, exportUsageReservationSchema, exportFinancialSectionSchema, exportBundleSchema, } from './identity';
+export type { VerificationMethod, Secp256k1VerificationMethod, MultikeyVerificationMethod, DidService, DidDocument, SignedRecordEnvelope, VerifiedDomain, DomainVerificationRequest, DomainVerificationInstructions, AuthMethodEntry, AuthMethodsResponse, ExportAttestation, ExportUsageReceipt, ExportLedgerEntry, ExportUsageReservation, ExportFinancialSection, ExportBundle, } from './identity';
 export { oxySignedRecordTypeSchema, } from './oxyRecordTypes';
 export type { OxySignedRecordType, } from './oxyRecordTypes';
 export { chainHeadResponseSchema, logPageResponseSchema, } from './protocol';
@@ -61,7 +61,7 @@ export type { DevicePairingStatus, DeviceTransferInitRequest, DeviceTransferInit
 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, publisherSlugSchema, modelSlugSchema, modelIdSchema, modelRevisionLabelSchema, modelReferenceSchema, routingProfileSlugSchema, inferenceProviderSlugSchema, deploymentIdSchema, inferenceRegionSchema, RESERVED_ALIA_PUBLISHER, } from './inference/identifiers';
+export { oxyAccountIdSchema, delegatedUserIdSchema, oxyApplicationIdSchema, oxyCredentialIdSchema, requestIdSchema, generationIdSchema, idempotencyKeySchema, inferenceEnvironmentSchema, inferenceTimestampSchema, inferenceDateSchema, inferenceHttpsUrlSchema, sha256DigestSchema, publisherSlugSchema, modelSlugSchema, modelIdSchema, modelRevisionLabelSchema, modelReferenceSchema, routingProfileSlugSchema, inferenceProviderSlugSchema, deploymentIdSchema, inferenceRegionSchema, RESERVED_ALIA_PUBLISHER, } from './inference/identifiers';
 export type { OxyAccountId, DelegatedUserId, InferenceEnvironment, 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';
@@ -73,8 +73,10 @@ export { priceVersionStatusSchema, priceVersionSchema, priceSnapshotSchema, } fr
 export type { PriceVersionStatus, PriceVersion, PriceSnapshot, } from './inference/priceVersion';
 export { inferenceModalitySchema, modelCapabilitiesSchema, modelLicenseSchema, modelProvenanceSchema, inferenceDataPolicySchema, availabilityScopeSchema, commercialPermissionSchema, modelDeprecationSchema, modelEvaluationResultSchema, modelSafetyMetadataSchema, modelPublisherSchema, catalogueModelSchema, modelRevisionSchema, inferenceProviderSchema, modelDeploymentSchema, routingProfileCandidateSchema, routingProfileSchema, cataloguePublisherSummarySchema, catalogueServingProviderSummarySchema, modelCatalogueEntrySchema, } from './inference/catalogue';
 export type { InferenceModality, ModelCapabilities, ModelLicense, ModelProvenance, InferenceDataPolicy, AvailabilityScope, CommercialPermission, ModelDeprecation, ModelEvaluationResult, ModelSafetyMetadata, ModelPublisher, CatalogueModel, ModelRevision, InferenceProvider, ModelDeployment, RoutingProfileCandidate, RoutingProfile, CataloguePublisherSummary, CatalogueServingProviderSummary, ModelCatalogueEntry, } from './inference/catalogue';
-export { routingTargetSchema, routingPolicyScopeSchema, routingFallbackPolicySchema, routingPolicySchema, routingPolicyReferenceSchema, } from './inference/routingPolicy';
-export type { RoutingTarget, RoutingPolicyScope, RoutingFallbackPolicy, RoutingPolicy, RoutingPolicyReference, } from './inference/routingPolicy';
+export { routingTargetSchema, routingPolicyScopeSchema, routingFallbackPolicySchema, routingPolicySchema, routingPolicyReferenceSchema, authorizedRouteSchema, } from './inference/routingPolicy';
+export type { RoutingTarget, RoutingPolicyScope, RoutingFallbackPolicy, RoutingPolicy, RoutingPolicyReference, AuthorizedRoute, } from './inference/routingPolicy';
+export { aliaReleaseArtifactSchema, aliaReleaseSignatureSchema, aliaModelReleaseManifestSchema, } from './inference/aliaModelRelease';
+export type { AliaReleaseArtifact, AliaReleaseSignature, AliaModelReleaseManifest, } from './inference/aliaModelRelease';
 export { inferenceContentSourceSchema, inferenceContentPartSchema, inferenceToolCallSchema, inferenceMessageRoleSchema, inferenceMessageSchema, inferenceInputSchema, samplingParametersSchema, toolDefinitionSchema, toolChoiceSchema, responseFormatSchema, clientRequestMetadataSchema, inferenceRequestSchema, } from './inference/request';
 export type { InferenceContentSource, InferenceContentPart, InferenceToolCall, InferenceMessageRole, InferenceMessage, InferenceInput, SamplingParameters, ToolDefinition, ToolChoice, ResponseFormat, ClientRequestMetadata, InferenceRequest, } from './inference/request';
 export { inferenceStreamStartEventSchema, inferenceStreamDeltaEventSchema, inferenceStreamToolCallEventSchema, inferenceStreamUsageEventSchema, inferenceRouteSwitchDetailSchema, inferenceRouteSwitchReasonSchema, inferenceStreamRouteSwitchEventSchema, inferenceStreamErrorEventSchema, inferenceFinishReasonSchema, inferenceStreamDoneEventSchema, inferenceStreamEventSchema, } from './inference/streamEvents';

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

@@ -135,8 +135,8 @@ export declare const billingProfileSchema: z.ZodObject<{
     status: "active" | "suspended" | "closed";
     accountId: string & z.BRAND<"OxyAccountId">;
     updatedAt: string;
-    createdAt: string;
     currency: string;
+    createdAt: string;
     schemaVersion: 1;
     billingMode: "prepaid" | "invoiced";
     creditLimit: string & z.BRAND<"ExactDecimal">;
@@ -149,8 +149,8 @@ export declare const billingProfileSchema: z.ZodObject<{
     status: "active" | "suspended" | "closed";
     accountId: string;
     updatedAt: string;
-    createdAt: string;
     currency: string;
+    createdAt: string;
     schemaVersion: 1;
     billingMode: "prepaid" | "invoiced";
     creditLimit: string;
@@ -224,8 +224,8 @@ export declare const accountBillingStateSchema: z.ZodObject<{
         status: "active" | "suspended" | "closed";
         accountId: string & z.BRAND<"OxyAccountId">;
         updatedAt: string;
-        createdAt: string;
         currency: string;
+        createdAt: string;
         schemaVersion: 1;
         billingMode: "prepaid" | "invoiced";
         creditLimit: string & z.BRAND<"ExactDecimal">;
@@ -238,8 +238,8 @@ export declare const accountBillingStateSchema: z.ZodObject<{
         status: "active" | "suspended" | "closed";
         accountId: string;
         updatedAt: string;
-        createdAt: string;
         currency: string;
+        createdAt: string;
         schemaVersion: 1;
         billingMode: "prepaid" | "invoiced";
         creditLimit: string;
@@ -255,8 +255,8 @@ export declare const accountBillingStateSchema: z.ZodObject<{
         status: "active" | "suspended" | "closed";
         accountId: string & z.BRAND<"OxyAccountId">;
         updatedAt: string;
-        createdAt: string;
         currency: string;
+        createdAt: string;
         schemaVersion: 1;
         billingMode: "prepaid" | "invoiced";
         creditLimit: string & z.BRAND<"ExactDecimal">;
@@ -275,8 +275,8 @@ export declare const accountBillingStateSchema: z.ZodObject<{
         status: "active" | "suspended" | "closed";
         accountId: string;
         updatedAt: string;
-        createdAt: string;
         currency: string;
+        createdAt: string;
         schemaVersion: 1;
         billingMode: "prepaid" | "invoiced";
         creditLimit: string;
@@ -325,8 +325,8 @@ export declare const billingInvoiceSchema: z.ZodObject<{
     status: "void" | "open" | "draft" | "paid";
     accountId: string & z.BRAND<"OxyAccountId">;
     id: string;
-    periodEnd: string;
     currency: string;
+    periodEnd: string;
     schemaVersion: 1;
     periodStart: string;
     subtotalAmount: string & z.BRAND<"ExactDecimal">;
@@ -340,8 +340,8 @@ export declare const billingInvoiceSchema: z.ZodObject<{
     status: "void" | "open" | "draft" | "paid";
     accountId: string;
     id: string;
-    periodEnd: string;
     currency: string;
+    periodEnd: string;
     schemaVersion: 1;
     periodStart: string;
     subtotalAmount: string;
@@ -386,10 +386,10 @@ export declare const externalPaymentSchema: z.ZodObject<{
 }, "strict", z.ZodTypeAny, {
     accountId: string & z.BRAND<"OxyAccountId">;
     id: string;
-    occurredAt: string;
+    currency: string;
     createdAt: string;
+    occurredAt: string;
     amount: string & z.BRAND<"ExactDecimal">;
-    currency: string;
     provider: "stripe";
     externalKind: "payment_intent" | "invoice";
     externalRef: string;
@@ -397,10 +397,10 @@ export declare const externalPaymentSchema: z.ZodObject<{
 }, {
     accountId: string;
     id: string;
-    occurredAt: string;
+    currency: string;
     createdAt: string;
+    occurredAt: string;
     amount: string;
-    currency: string;
     provider: "stripe";
     externalKind: "payment_intent" | "invoice";
     externalRef: string;
@@ -437,8 +437,8 @@ export declare const autoRechargeAttemptSchema: z.ZodObject<{
     accountId: string & z.BRAND<"OxyAccountId">;
     updatedAt: string;
     id: string;
-    createdAt: string;
     currency: string;
+    createdAt: string;
     schemaVersion: 1;
     requestedAmount: string & z.BRAND<"ExactDecimal">;
     balanceAtTrigger: string & z.BRAND<"ExactDecimal">;
@@ -449,8 +449,8 @@ export declare const autoRechargeAttemptSchema: z.ZodObject<{
     accountId: string;
     updatedAt: string;
     id: string;
-    createdAt: string;
     currency: string;
+    createdAt: string;
     schemaVersion: 1;
     requestedAmount: string;
     balanceAtTrigger: string;
@@ -495,8 +495,8 @@ export declare const reconciliationDiscrepancySchema: z.ZodObject<{
 }, "strict", z.ZodTypeAny, {
     kind: "missing_in_ledger" | "missing_in_external" | "amount_mismatch" | "account_unresolved";
     id: string;
-    createdAt: string;
     currency: string;
+    createdAt: string;
     schemaVersion: 1;
     runId: string;
     accountId?: (string & z.BRAND<"OxyAccountId">) | undefined;
@@ -507,8 +507,8 @@ export declare const reconciliationDiscrepancySchema: z.ZodObject<{
 }, {
     kind: "missing_in_ledger" | "missing_in_external" | "amount_mismatch" | "account_unresolved";
     id: string;
-    createdAt: string;
     currency: string;
+    createdAt: string;
     schemaVersion: 1;
     runId: string;
     accountId?: string | undefined;
@@ -544,8 +544,8 @@ export declare const reconciliationRunSchema: z.ZodObject<{
 }, "strict", z.ZodTypeAny, {
     status: "completed" | "failed" | "running";
     id: string;
-    periodEnd: string;
     currency: string;
+    periodEnd: string;
     provider: "stripe";
     schemaVersion: 1;
     startedAt: string;
@@ -558,8 +558,8 @@ export declare const reconciliationRunSchema: z.ZodObject<{
 }, {
     status: "completed" | "failed" | "running";
     id: string;
-    periodEnd: string;
     currency: string;
+    periodEnd: string;
     provider: "stripe";
     schemaVersion: 1;
     startedAt: string;
@@ -592,8 +592,8 @@ export declare const reconciliationReportSchema: z.ZodObject<{
     }, "strict", z.ZodTypeAny, {
         status: "completed" | "failed" | "running";
         id: string;
-        periodEnd: string;
         currency: string;
+        periodEnd: string;
         provider: "stripe";
         schemaVersion: 1;
         startedAt: string;
@@ -606,8 +606,8 @@ export declare const reconciliationReportSchema: z.ZodObject<{
     }, {
         status: "completed" | "failed" | "running";
         id: string;
-        periodEnd: string;
         currency: string;
+        periodEnd: string;
         provider: "stripe";
         schemaVersion: 1;
         startedAt: string;
@@ -636,8 +636,8 @@ export declare const reconciliationReportSchema: z.ZodObject<{
     }, "strict", z.ZodTypeAny, {
         kind: "missing_in_ledger" | "missing_in_external" | "amount_mismatch" | "account_unresolved";
         id: string;
-        createdAt: string;
         currency: string;
+        createdAt: string;
         schemaVersion: 1;
         runId: string;
         accountId?: (string & z.BRAND<"OxyAccountId">) | undefined;
@@ -648,8 +648,8 @@ export declare const reconciliationReportSchema: z.ZodObject<{
     }, {
         kind: "missing_in_ledger" | "missing_in_external" | "amount_mismatch" | "account_unresolved";
         id: string;
-        createdAt: string;
         currency: string;
+        createdAt: string;
         schemaVersion: 1;
         runId: string;
         accountId?: string | undefined;
@@ -663,8 +663,8 @@ export declare const reconciliationReportSchema: z.ZodObject<{
     run: {
         status: "completed" | "failed" | "running";
         id: string;
-        periodEnd: string;
         currency: string;
+        periodEnd: string;
         provider: "stripe";
         schemaVersion: 1;
         startedAt: string;
@@ -678,8 +678,8 @@ export declare const reconciliationReportSchema: z.ZodObject<{
     discrepancies: {
         kind: "missing_in_ledger" | "missing_in_external" | "amount_mismatch" | "account_unresolved";
         id: string;
-        createdAt: string;
         currency: string;
+        createdAt: string;
         schemaVersion: 1;
         runId: string;
         accountId?: (string & z.BRAND<"OxyAccountId">) | undefined;
@@ -693,8 +693,8 @@ export declare const reconciliationReportSchema: z.ZodObject<{
     run: {
         status: "completed" | "failed" | "running";
         id: string;
-        periodEnd: string;
         currency: string;
+        periodEnd: string;
         provider: "stripe";
         schemaVersion: 1;
         startedAt: string;
@@ -708,8 +708,8 @@ export declare const reconciliationReportSchema: z.ZodObject<{
     discrepancies: {
         kind: "missing_in_ledger" | "missing_in_external" | "amount_mismatch" | "account_unresolved";
         id: string;
-        createdAt: string;
         currency: string;
+        createdAt: string;
         schemaVersion: 1;
         runId: string;
         accountId?: string | undefined;