@oxy.so/contracts 4.9.1 → 4.11.0-oxy-one.0

package/dist/types/products/access.d.ts

@@ -7,13 +7,13 @@ export declare const productDefinitionSchema: z.ZodObject<{
     applicationId: z.ZodString;
 }, "strict", z.ZodTypeAny, {
     schemaVersion: 1;
-    ownerAccountId: string & z.BRAND<"OxyAccountId">;
     id: string;
+    ownerAccountId: string & z.BRAND<"OxyAccountId">;
     applicationId: string;
 }, {
     schemaVersion: 1;
-    ownerAccountId: string;
     id: string;
+    ownerAccountId: string;
     applicationId: string;
 }>;
 export declare const subjectProductAccessQuerySchema: z.ZodObject<{
@@ -35,13 +35,13 @@ export declare const productBenefitSchema: z.ZodDiscriminatedUnion<"kind", [z.Zo
     productId: z.ZodString;
     key: z.ZodString;
 }, "strict", z.ZodTypeAny, {
+    productId: string;
     kind: "capability";
     key: string;
-    productId: string;
 }, {
+    productId: string;
     kind: "capability";
     key: string;
-    productId: string;
 }>, z.ZodObject<{
     kind: z.ZodLiteral<"quota">;
     productId: z.ZodString;
@@ -50,18 +50,18 @@ export declare const productBenefitSchema: z.ZodDiscriminatedUnion<"kind", [z.Zo
     included: z.ZodNumber;
     combination: z.ZodEnum<["maximum", "sum", "exclusive"]>;
 }, "strict", z.ZodTypeAny, {
+    productId: string;
     kind: "quota";
     key: string;
     unit: string;
     included: number;
-    productId: string;
     combination: "maximum" | "sum" | "exclusive";
 }, {
+    productId: string;
     kind: "quota";
     key: string;
     unit: string;
     included: number;
-    productId: string;
     combination: "maximum" | "sum" | "exclusive";
 }>]>;
 /** A version names a frozen offer. An empty bundle grants nothing. */
@@ -75,13 +75,13 @@ export declare const productOfferSchema: z.ZodEffects<z.ZodObject<{
         productId: z.ZodString;
         key: z.ZodString;
     }, "strict", z.ZodTypeAny, {
+        productId: string;
         kind: "capability";
         key: string;
-        productId: string;
     }, {
+        productId: string;
         kind: "capability";
         key: string;
-        productId: string;
     }>, z.ZodObject<{
         kind: z.ZodLiteral<"quota">;
         productId: z.ZodString;
@@ -90,86 +90,86 @@ export declare const productOfferSchema: z.ZodEffects<z.ZodObject<{
         included: z.ZodNumber;
         combination: z.ZodEnum<["maximum", "sum", "exclusive"]>;
     }, "strict", z.ZodTypeAny, {
+        productId: string;
         kind: "quota";
         key: string;
         unit: string;
         included: number;
-        productId: string;
         combination: "maximum" | "sum" | "exclusive";
     }, {
+        productId: string;
         kind: "quota";
         key: string;
         unit: string;
         included: number;
-        productId: string;
         combination: "maximum" | "sum" | "exclusive";
     }>]>, "many">;
 }, "strict", z.ZodTypeAny, {
-    kind: "bundle" | "individual";
     schemaVersion: 1;
-    version: number;
     id: string;
+    kind: "individual" | "bundle";
+    version: number;
     benefits: ({
+        productId: string;
         kind: "capability";
         key: string;
-        productId: string;
     } | {
+        productId: string;
         kind: "quota";
         key: string;
         unit: string;
         included: number;
-        productId: string;
         combination: "maximum" | "sum" | "exclusive";
     })[];
 }, {
-    kind: "bundle" | "individual";
     schemaVersion: 1;
-    version: number;
     id: string;
+    kind: "individual" | "bundle";
+    version: number;
     benefits: ({
+        productId: string;
         kind: "capability";
         key: string;
-        productId: string;
     } | {
+        productId: string;
         kind: "quota";
         key: string;
         unit: string;
         included: number;
-        productId: string;
         combination: "maximum" | "sum" | "exclusive";
     })[];
 }>, {
-    kind: "bundle" | "individual";
     schemaVersion: 1;
-    version: number;
     id: string;
+    kind: "individual" | "bundle";
+    version: number;
     benefits: ({
+        productId: string;
         kind: "capability";
         key: string;
-        productId: string;
     } | {
+        productId: string;
         kind: "quota";
         key: string;
         unit: string;
         included: number;
-        productId: string;
         combination: "maximum" | "sum" | "exclusive";
     })[];
 }, {
-    kind: "bundle" | "individual";
     schemaVersion: 1;
-    version: number;
     id: string;
+    kind: "individual" | "bundle";
+    version: number;
     benefits: ({
+        productId: string;
         kind: "capability";
         key: string;
-        productId: string;
     } | {
+        productId: string;
         kind: "quota";
         key: string;
         unit: string;
         included: number;
-        productId: string;
         combination: "maximum" | "sum" | "exclusive";
     })[];
 }>;
@@ -199,31 +199,31 @@ export declare const productSubscriptionSourceSchema: z.ZodObject<{
     }>;
     cancelAtPeriodEnd: z.ZodBoolean;
 }, "strict", z.ZodTypeAny, {
-    status: "active" | "incomplete" | "canceled" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
     schemaVersion: 1;
+    status: "active" | "trialing" | "past_due" | "unpaid" | "canceled" | "paused" | "incomplete" | "incomplete_expired";
     id: string;
-    provider: "stripe" | "peable";
-    cancelAtPeriodEnd: boolean;
     beneficiaryAccountId: string & z.BRAND<"OxyAccountId">;
     payerAccountId: string & z.BRAND<"OxyAccountId">;
+    provider: "stripe" | "peable";
     providerSubscriptionId: string;
     period: {
         start: string;
         end: string;
     };
+    cancelAtPeriodEnd: boolean;
 }, {
-    status: "active" | "incomplete" | "canceled" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
     schemaVersion: 1;
+    status: "active" | "trialing" | "past_due" | "unpaid" | "canceled" | "paused" | "incomplete" | "incomplete_expired";
     id: string;
-    provider: "stripe" | "peable";
-    cancelAtPeriodEnd: boolean;
     beneficiaryAccountId: string;
     payerAccountId: string;
+    provider: "stripe" | "peable";
     providerSubscriptionId: string;
     period: {
         start: string;
         end: string;
     };
+    cancelAtPeriodEnd: boolean;
 }>;
 /** A frozen paid-period/offer segment; upgrades append, never rewrite it. */
 export declare const productOfferSegmentSchema: z.ZodObject<{
@@ -261,7 +261,7 @@ export declare const productOfferSegmentSchema: z.ZodObject<{
     subscriptionId: string;
     offerId: string;
     offerVersion: number;
-    origin: "bundle" | "individual";
+    origin: "individual" | "bundle";
 }, {
     schemaVersion: 1;
     id: string;
@@ -273,7 +273,7 @@ export declare const productOfferSegmentSchema: z.ZodObject<{
     subscriptionId: string;
     offerId: string;
     offerVersion: number;
-    origin: "bundle" | "individual";
+    origin: "individual" | "bundle";
 }>;
 /** Provenance survives cancellation: deactivate a source, never delete history. */
 export declare const productAccessGrantSchema: z.ZodObject<{
@@ -289,13 +289,13 @@ export declare const productAccessGrantSchema: z.ZodObject<{
         productId: z.ZodString;
         key: z.ZodString;
     }, "strict", z.ZodTypeAny, {
+        productId: string;
         kind: "capability";
         key: string;
-        productId: string;
     }, {
+        productId: string;
         kind: "capability";
         key: string;
-        productId: string;
     }>, z.ZodObject<{
         kind: z.ZodLiteral<"quota">;
         productId: z.ZodString;
@@ -304,18 +304,18 @@ export declare const productAccessGrantSchema: z.ZodObject<{
         included: z.ZodNumber;
         combination: z.ZodEnum<["maximum", "sum", "exclusive"]>;
     }, "strict", z.ZodTypeAny, {
+        productId: string;
         kind: "quota";
         key: string;
         unit: string;
         included: number;
-        productId: string;
         combination: "maximum" | "sum" | "exclusive";
     }, {
+        productId: string;
         kind: "quota";
         key: string;
         unit: string;
         included: number;
-        productId: string;
         combination: "maximum" | "sum" | "exclusive";
     }>]>;
     period: z.ZodEffects<z.ZodObject<{
@@ -338,7 +338,6 @@ export declare const productAccessGrantSchema: z.ZodObject<{
 }, "strict", z.ZodTypeAny, {
     schemaVersion: 1;
     id: string;
-    revokedAt: string | null;
     beneficiaryAccountId: string & z.BRAND<"OxyAccountId">;
     period: {
         start: string;
@@ -346,24 +345,24 @@ export declare const productAccessGrantSchema: z.ZodObject<{
     };
     offerId: string;
     offerVersion: number;
-    origin: "bundle" | "individual";
+    origin: "individual" | "bundle";
     sourceSegmentId: string;
     benefit: {
+        productId: string;
         kind: "capability";
         key: string;
-        productId: string;
     } | {
+        productId: string;
         kind: "quota";
         key: string;
         unit: string;
         included: number;
-        productId: string;
         combination: "maximum" | "sum" | "exclusive";
     };
+    revokedAt: string | null;
 }, {
     schemaVersion: 1;
     id: string;
-    revokedAt: string | null;
     beneficiaryAccountId: string;
     period: {
         start: string;
@@ -371,20 +370,21 @@ export declare const productAccessGrantSchema: z.ZodObject<{
     };
     offerId: string;
     offerVersion: number;
-    origin: "bundle" | "individual";
+    origin: "individual" | "bundle";
     sourceSegmentId: string;
     benefit: {
+        productId: string;
         kind: "capability";
         key: string;
-        productId: string;
     } | {
+        productId: string;
         kind: "quota";
         key: string;
         unit: string;
         included: number;
-        productId: string;
         combination: "maximum" | "sum" | "exclusive";
     };
+    revokedAt: string | null;
 }>;
 /** Access answers contain no payer, provider reference, price or account balance. */
 export declare const subjectProductAccessSchema: z.ZodObject<{
@@ -427,22 +427,22 @@ export declare const subjectProductAccessSchema: z.ZodObject<{
         grantIds: z.ZodArray<z.ZodString, "many">;
     }, "strict", z.ZodTypeAny, {
         key: string;
-        reason: "combination_mismatch" | "unit_mismatch" | "exclusive_overlap" | "unsafe_total";
         grantIds: string[];
+        reason: "combination_mismatch" | "unit_mismatch" | "exclusive_overlap" | "unsafe_total";
     }, {
         key: string;
-        reason: "combination_mismatch" | "unit_mismatch" | "exclusive_overlap" | "unsafe_total";
         grantIds: string[];
+        reason: "combination_mismatch" | "unit_mismatch" | "exclusive_overlap" | "unsafe_total";
     }>, "many">;
 }, "strict", z.ZodTypeAny, {
     schemaVersion: 1;
     subjectAccountId: string & z.BRAND<"OxyAccountId">;
+    productId: string;
+    evaluatedAt: string;
     capabilities: {
         key: string;
         grantIds: string[];
     }[];
-    evaluatedAt: string;
-    productId: string;
     quotas: {
         key: string;
         unit: string;
@@ -452,18 +452,18 @@ export declare const subjectProductAccessSchema: z.ZodObject<{
     }[];
     conflicts: {
         key: string;
-        reason: "combination_mismatch" | "unit_mismatch" | "exclusive_overlap" | "unsafe_total";
         grantIds: string[];
+        reason: "combination_mismatch" | "unit_mismatch" | "exclusive_overlap" | "unsafe_total";
     }[];
 }, {
     schemaVersion: 1;
     subjectAccountId: string;
+    productId: string;
+    evaluatedAt: string;
     capabilities: {
         key: string;
         grantIds: string[];
     }[];
-    evaluatedAt: string;
-    productId: string;
     quotas: {
         key: string;
         unit: string;
@@ -473,8 +473,8 @@ export declare const subjectProductAccessSchema: z.ZodObject<{
     }[];
     conflicts: {
         key: string;
-        reason: "combination_mismatch" | "unit_mismatch" | "exclusive_overlap" | "unsafe_total";
         grantIds: string[];
+        reason: "combination_mismatch" | "unit_mismatch" | "exclusive_overlap" | "unsafe_total";
     }[];
 }>;
 export type ProductBenefit = z.infer<typeof productBenefitSchema>;
@@ -485,3 +485,408 @@ export type ProductAccessGrant = z.infer<typeof productAccessGrantSchema>;
 export type SubjectProductAccess = z.infer<typeof subjectProductAccessSchema>;
 export type ProductDefinition = z.infer<typeof productDefinitionSchema>;
 export type SubjectProductAccessQuery = z.infer<typeof subjectProductAccessQuerySchema>;
+/** Active grant periods for metering adapters; no financial/provider identity. */
+export declare const subjectProductGrantSnapshotSchema: z.ZodEffects<z.ZodObject<{
+    schemaVersion: z.ZodLiteral<1>;
+    access: z.ZodObject<{
+        schemaVersion: z.ZodLiteral<1>;
+        subjectAccountId: z.ZodBranded<z.ZodString, "OxyAccountId">;
+        productId: z.ZodString;
+        evaluatedAt: z.ZodString;
+        capabilities: z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            grantIds: z.ZodArray<z.ZodString, "many">;
+        }, "strict", z.ZodTypeAny, {
+            key: string;
+            grantIds: string[];
+        }, {
+            key: string;
+            grantIds: string[];
+        }>, "many">;
+        quotas: z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            unit: z.ZodString;
+            included: z.ZodNumber;
+            combination: z.ZodEnum<["maximum", "sum", "exclusive"]>;
+            grantIds: z.ZodArray<z.ZodString, "many">;
+        }, "strict", z.ZodTypeAny, {
+            key: string;
+            unit: string;
+            included: number;
+            combination: "maximum" | "sum" | "exclusive";
+            grantIds: string[];
+        }, {
+            key: string;
+            unit: string;
+            included: number;
+            combination: "maximum" | "sum" | "exclusive";
+            grantIds: string[];
+        }>, "many">;
+        conflicts: z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            reason: z.ZodEnum<["combination_mismatch", "unit_mismatch", "exclusive_overlap", "unsafe_total"]>;
+            grantIds: z.ZodArray<z.ZodString, "many">;
+        }, "strict", z.ZodTypeAny, {
+            key: string;
+            grantIds: string[];
+            reason: "combination_mismatch" | "unit_mismatch" | "exclusive_overlap" | "unsafe_total";
+        }, {
+            key: string;
+            grantIds: string[];
+            reason: "combination_mismatch" | "unit_mismatch" | "exclusive_overlap" | "unsafe_total";
+        }>, "many">;
+    }, "strict", z.ZodTypeAny, {
+        schemaVersion: 1;
+        subjectAccountId: string & z.BRAND<"OxyAccountId">;
+        productId: string;
+        evaluatedAt: string;
+        capabilities: {
+            key: string;
+            grantIds: string[];
+        }[];
+        quotas: {
+            key: string;
+            unit: string;
+            included: number;
+            combination: "maximum" | "sum" | "exclusive";
+            grantIds: string[];
+        }[];
+        conflicts: {
+            key: string;
+            grantIds: string[];
+            reason: "combination_mismatch" | "unit_mismatch" | "exclusive_overlap" | "unsafe_total";
+        }[];
+    }, {
+        schemaVersion: 1;
+        subjectAccountId: string;
+        productId: string;
+        evaluatedAt: string;
+        capabilities: {
+            key: string;
+            grantIds: string[];
+        }[];
+        quotas: {
+            key: string;
+            unit: string;
+            included: number;
+            combination: "maximum" | "sum" | "exclusive";
+            grantIds: string[];
+        }[];
+        conflicts: {
+            key: string;
+            grantIds: string[];
+            reason: "combination_mismatch" | "unit_mismatch" | "exclusive_overlap" | "unsafe_total";
+        }[];
+    }>;
+    grants: z.ZodArray<z.ZodObject<{
+        schemaVersion: z.ZodLiteral<1>;
+        id: z.ZodString;
+        sourceSegmentId: z.ZodString;
+        beneficiaryAccountId: z.ZodBranded<z.ZodString, "OxyAccountId">;
+        offerId: z.ZodString;
+        offerVersion: z.ZodNumber;
+        origin: z.ZodEnum<["individual", "bundle"]>;
+        benefit: z.ZodDiscriminatedUnion<"kind", [z.ZodObject<{
+            kind: z.ZodLiteral<"capability">;
+            productId: z.ZodString;
+            key: z.ZodString;
+        }, "strict", z.ZodTypeAny, {
+            productId: string;
+            kind: "capability";
+            key: string;
+        }, {
+            productId: string;
+            kind: "capability";
+            key: string;
+        }>, z.ZodObject<{
+            kind: z.ZodLiteral<"quota">;
+            productId: z.ZodString;
+            key: z.ZodString;
+            unit: z.ZodString;
+            included: z.ZodNumber;
+            combination: z.ZodEnum<["maximum", "sum", "exclusive"]>;
+        }, "strict", z.ZodTypeAny, {
+            productId: string;
+            kind: "quota";
+            key: string;
+            unit: string;
+            included: number;
+            combination: "maximum" | "sum" | "exclusive";
+        }, {
+            productId: string;
+            kind: "quota";
+            key: string;
+            unit: string;
+            included: number;
+            combination: "maximum" | "sum" | "exclusive";
+        }>]>;
+        period: z.ZodEffects<z.ZodObject<{
+            start: z.ZodString;
+            end: z.ZodString;
+        }, "strict", z.ZodTypeAny, {
+            start: string;
+            end: string;
+        }, {
+            start: string;
+            end: string;
+        }>, {
+            start: string;
+            end: string;
+        }, {
+            start: string;
+            end: string;
+        }>;
+        revokedAt: z.ZodNullable<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        schemaVersion: 1;
+        id: string;
+        beneficiaryAccountId: string & z.BRAND<"OxyAccountId">;
+        period: {
+            start: string;
+            end: string;
+        };
+        offerId: string;
+        offerVersion: number;
+        origin: "individual" | "bundle";
+        sourceSegmentId: string;
+        benefit: {
+            productId: string;
+            kind: "capability";
+            key: string;
+        } | {
+            productId: string;
+            kind: "quota";
+            key: string;
+            unit: string;
+            included: number;
+            combination: "maximum" | "sum" | "exclusive";
+        };
+        revokedAt: string | null;
+    }, {
+        schemaVersion: 1;
+        id: string;
+        beneficiaryAccountId: string;
+        period: {
+            start: string;
+            end: string;
+        };
+        offerId: string;
+        offerVersion: number;
+        origin: "individual" | "bundle";
+        sourceSegmentId: string;
+        benefit: {
+            productId: string;
+            kind: "capability";
+            key: string;
+        } | {
+            productId: string;
+            kind: "quota";
+            key: string;
+            unit: string;
+            included: number;
+            combination: "maximum" | "sum" | "exclusive";
+        };
+        revokedAt: string | null;
+    }>, "many">;
+}, "strict", z.ZodTypeAny, {
+    schemaVersion: 1;
+    access: {
+        schemaVersion: 1;
+        subjectAccountId: string & z.BRAND<"OxyAccountId">;
+        productId: string;
+        evaluatedAt: string;
+        capabilities: {
+            key: string;
+            grantIds: string[];
+        }[];
+        quotas: {
+            key: string;
+            unit: string;
+            included: number;
+            combination: "maximum" | "sum" | "exclusive";
+            grantIds: string[];
+        }[];
+        conflicts: {
+            key: string;
+            grantIds: string[];
+            reason: "combination_mismatch" | "unit_mismatch" | "exclusive_overlap" | "unsafe_total";
+        }[];
+    };
+    grants: {
+        schemaVersion: 1;
+        id: string;
+        beneficiaryAccountId: string & z.BRAND<"OxyAccountId">;
+        period: {
+            start: string;
+            end: string;
+        };
+        offerId: string;
+        offerVersion: number;
+        origin: "individual" | "bundle";
+        sourceSegmentId: string;
+        benefit: {
+            productId: string;
+            kind: "capability";
+            key: string;
+        } | {
+            productId: string;
+            kind: "quota";
+            key: string;
+            unit: string;
+            included: number;
+            combination: "maximum" | "sum" | "exclusive";
+        };
+        revokedAt: string | null;
+    }[];
+}, {
+    schemaVersion: 1;
+    access: {
+        schemaVersion: 1;
+        subjectAccountId: string;
+        productId: string;
+        evaluatedAt: string;
+        capabilities: {
+            key: string;
+            grantIds: string[];
+        }[];
+        quotas: {
+            key: string;
+            unit: string;
+            included: number;
+            combination: "maximum" | "sum" | "exclusive";
+            grantIds: string[];
+        }[];
+        conflicts: {
+            key: string;
+            grantIds: string[];
+            reason: "combination_mismatch" | "unit_mismatch" | "exclusive_overlap" | "unsafe_total";
+        }[];
+    };
+    grants: {
+        schemaVersion: 1;
+        id: string;
+        beneficiaryAccountId: string;
+        period: {
+            start: string;
+            end: string;
+        };
+        offerId: string;
+        offerVersion: number;
+        origin: "individual" | "bundle";
+        sourceSegmentId: string;
+        benefit: {
+            productId: string;
+            kind: "capability";
+            key: string;
+        } | {
+            productId: string;
+            kind: "quota";
+            key: string;
+            unit: string;
+            included: number;
+            combination: "maximum" | "sum" | "exclusive";
+        };
+        revokedAt: string | null;
+    }[];
+}>, {
+    schemaVersion: 1;
+    access: {
+        schemaVersion: 1;
+        subjectAccountId: string & z.BRAND<"OxyAccountId">;
+        productId: string;
+        evaluatedAt: string;
+        capabilities: {
+            key: string;
+            grantIds: string[];
+        }[];
+        quotas: {
+            key: string;
+            unit: string;
+            included: number;
+            combination: "maximum" | "sum" | "exclusive";
+            grantIds: string[];
+        }[];
+        conflicts: {
+            key: string;
+            grantIds: string[];
+            reason: "combination_mismatch" | "unit_mismatch" | "exclusive_overlap" | "unsafe_total";
+        }[];
+    };
+    grants: {
+        schemaVersion: 1;
+        id: string;
+        beneficiaryAccountId: string & z.BRAND<"OxyAccountId">;
+        period: {
+            start: string;
+            end: string;
+        };
+        offerId: string;
+        offerVersion: number;
+        origin: "individual" | "bundle";
+        sourceSegmentId: string;
+        benefit: {
+            productId: string;
+            kind: "capability";
+            key: string;
+        } | {
+            productId: string;
+            kind: "quota";
+            key: string;
+            unit: string;
+            included: number;
+            combination: "maximum" | "sum" | "exclusive";
+        };
+        revokedAt: string | null;
+    }[];
+}, {
+    schemaVersion: 1;
+    access: {
+        schemaVersion: 1;
+        subjectAccountId: string;
+        productId: string;
+        evaluatedAt: string;
+        capabilities: {
+            key: string;
+            grantIds: string[];
+        }[];
+        quotas: {
+            key: string;
+            unit: string;
+            included: number;
+            combination: "maximum" | "sum" | "exclusive";
+            grantIds: string[];
+        }[];
+        conflicts: {
+            key: string;
+            grantIds: string[];
+            reason: "combination_mismatch" | "unit_mismatch" | "exclusive_overlap" | "unsafe_total";
+        }[];
+    };
+    grants: {
+        schemaVersion: 1;
+        id: string;
+        beneficiaryAccountId: string;
+        period: {
+            start: string;
+            end: string;
+        };
+        offerId: string;
+        offerVersion: number;
+        origin: "individual" | "bundle";
+        sourceSegmentId: string;
+        benefit: {
+            productId: string;
+            kind: "capability";
+            key: string;
+        } | {
+            productId: string;
+            kind: "quota";
+            key: string;
+            unit: string;
+            included: number;
+            combination: "maximum" | "sum" | "exclusive";
+        };
+        revokedAt: string | null;
+    }[];
+}>;
+export type SubjectProductGrantSnapshot = z.infer<typeof subjectProductGrantSnapshotSchema>;