@oxy.so/contracts 4.8.0 → 4.9.0

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

@@ -0,0 +1,487 @@
+import { z } from 'zod';
+/** Product ownership and audience are registered together; branding grants no trust. */
+export declare const productDefinitionSchema: z.ZodObject<{
+    schemaVersion: z.ZodLiteral<1>;
+    id: z.ZodString;
+    ownerAccountId: z.ZodBranded<z.ZodString, "OxyAccountId">;
+    applicationId: z.ZodString;
+}, "strict", z.ZodTypeAny, {
+    schemaVersion: 1;
+    ownerAccountId: string & z.BRAND<"OxyAccountId">;
+    id: string;
+    applicationId: string;
+}, {
+    schemaVersion: 1;
+    ownerAccountId: string;
+    id: string;
+    applicationId: string;
+}>;
+export declare const subjectProductAccessQuerySchema: z.ZodObject<{
+    schemaVersion: z.ZodLiteral<1>;
+    subjectAccountId: z.ZodBranded<z.ZodString, "OxyAccountId">;
+    productId: z.ZodString;
+}, "strict", z.ZodTypeAny, {
+    schemaVersion: 1;
+    subjectAccountId: string & z.BRAND<"OxyAccountId">;
+    productId: string;
+}, {
+    schemaVersion: 1;
+    subjectAccountId: string;
+    productId: string;
+}>;
+/** Every quota declares its combination rule; there is no commercial default. */
+export declare const productBenefitSchema: z.ZodDiscriminatedUnion<"kind", [z.ZodObject<{
+    kind: z.ZodLiteral<"capability">;
+    productId: z.ZodString;
+    key: z.ZodString;
+}, "strict", z.ZodTypeAny, {
+    kind: "capability";
+    key: string;
+    productId: string;
+}, {
+    kind: "capability";
+    key: string;
+    productId: 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, {
+    kind: "quota";
+    key: string;
+    unit: string;
+    included: number;
+    productId: string;
+    combination: "maximum" | "sum" | "exclusive";
+}, {
+    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. */
+export declare const productOfferSchema: z.ZodEffects<z.ZodObject<{
+    schemaVersion: z.ZodLiteral<1>;
+    id: z.ZodString;
+    version: z.ZodNumber;
+    kind: z.ZodEnum<["individual", "bundle"]>;
+    benefits: z.ZodArray<z.ZodDiscriminatedUnion<"kind", [z.ZodObject<{
+        kind: z.ZodLiteral<"capability">;
+        productId: z.ZodString;
+        key: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        kind: "capability";
+        key: string;
+        productId: string;
+    }, {
+        kind: "capability";
+        key: string;
+        productId: 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, {
+        kind: "quota";
+        key: string;
+        unit: string;
+        included: number;
+        productId: string;
+        combination: "maximum" | "sum" | "exclusive";
+    }, {
+        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;
+    benefits: ({
+        kind: "capability";
+        key: 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;
+    benefits: ({
+        kind: "capability";
+        key: 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;
+    benefits: ({
+        kind: "capability";
+        key: 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;
+    benefits: ({
+        kind: "capability";
+        key: string;
+        productId: string;
+    } | {
+        kind: "quota";
+        key: string;
+        unit: string;
+        included: number;
+        productId: string;
+        combination: "maximum" | "sum" | "exclusive";
+    })[];
+}>;
+export declare const productSubscriptionSourceSchema: z.ZodObject<{
+    schemaVersion: z.ZodLiteral<1>;
+    id: z.ZodString;
+    beneficiaryAccountId: z.ZodBranded<z.ZodString, "OxyAccountId">;
+    payerAccountId: z.ZodBranded<z.ZodString, "OxyAccountId">;
+    provider: z.ZodEnum<["stripe", "peable"]>;
+    providerSubscriptionId: z.ZodString;
+    status: z.ZodEnum<["active", "trialing", "past_due", "unpaid", "canceled", "paused", "incomplete", "incomplete_expired"]>;
+    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;
+    }>;
+    cancelAtPeriodEnd: z.ZodBoolean;
+}, "strict", z.ZodTypeAny, {
+    status: "active" | "incomplete" | "canceled" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
+    schemaVersion: 1;
+    id: string;
+    provider: "stripe" | "peable";
+    cancelAtPeriodEnd: boolean;
+    beneficiaryAccountId: string & z.BRAND<"OxyAccountId">;
+    payerAccountId: string & z.BRAND<"OxyAccountId">;
+    providerSubscriptionId: string;
+    period: {
+        start: string;
+        end: string;
+    };
+}, {
+    status: "active" | "incomplete" | "canceled" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
+    schemaVersion: 1;
+    id: string;
+    provider: "stripe" | "peable";
+    cancelAtPeriodEnd: boolean;
+    beneficiaryAccountId: string;
+    payerAccountId: string;
+    providerSubscriptionId: string;
+    period: {
+        start: string;
+        end: string;
+    };
+}>;
+/** A frozen paid-period/offer segment; upgrades append, never rewrite it. */
+export declare const productOfferSegmentSchema: z.ZodObject<{
+    schemaVersion: z.ZodLiteral<1>;
+    id: z.ZodString;
+    subscriptionId: z.ZodString;
+    beneficiaryAccountId: z.ZodBranded<z.ZodString, "OxyAccountId">;
+    offerId: z.ZodString;
+    offerVersion: z.ZodNumber;
+    origin: z.ZodEnum<["individual", "bundle"]>;
+    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;
+    }>;
+}, "strict", z.ZodTypeAny, {
+    schemaVersion: 1;
+    id: string;
+    beneficiaryAccountId: string & z.BRAND<"OxyAccountId">;
+    period: {
+        start: string;
+        end: string;
+    };
+    subscriptionId: string;
+    offerId: string;
+    offerVersion: number;
+    origin: "bundle" | "individual";
+}, {
+    schemaVersion: 1;
+    id: string;
+    beneficiaryAccountId: string;
+    period: {
+        start: string;
+        end: string;
+    };
+    subscriptionId: string;
+    offerId: string;
+    offerVersion: number;
+    origin: "bundle" | "individual";
+}>;
+/** Provenance survives cancellation: deactivate a source, never delete history. */
+export declare const productAccessGrantSchema: 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, {
+        kind: "capability";
+        key: string;
+        productId: string;
+    }, {
+        kind: "capability";
+        key: string;
+        productId: 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, {
+        kind: "quota";
+        key: string;
+        unit: string;
+        included: number;
+        productId: string;
+        combination: "maximum" | "sum" | "exclusive";
+    }, {
+        kind: "quota";
+        key: string;
+        unit: string;
+        included: number;
+        productId: string;
+        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;
+    revokedAt: string | null;
+    beneficiaryAccountId: string & z.BRAND<"OxyAccountId">;
+    period: {
+        start: string;
+        end: string;
+    };
+    offerId: string;
+    offerVersion: number;
+    origin: "bundle" | "individual";
+    sourceSegmentId: string;
+    benefit: {
+        kind: "capability";
+        key: string;
+        productId: string;
+    } | {
+        kind: "quota";
+        key: string;
+        unit: string;
+        included: number;
+        productId: string;
+        combination: "maximum" | "sum" | "exclusive";
+    };
+}, {
+    schemaVersion: 1;
+    id: string;
+    revokedAt: string | null;
+    beneficiaryAccountId: string;
+    period: {
+        start: string;
+        end: string;
+    };
+    offerId: string;
+    offerVersion: number;
+    origin: "bundle" | "individual";
+    sourceSegmentId: string;
+    benefit: {
+        kind: "capability";
+        key: string;
+        productId: string;
+    } | {
+        kind: "quota";
+        key: string;
+        unit: string;
+        included: number;
+        productId: string;
+        combination: "maximum" | "sum" | "exclusive";
+    };
+}>;
+/** Access answers contain no payer, provider reference, price or account balance. */
+export declare const subjectProductAccessSchema: 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;
+        reason: "combination_mismatch" | "unit_mismatch" | "exclusive_overlap" | "unsafe_total";
+        grantIds: string[];
+    }, {
+        key: string;
+        reason: "combination_mismatch" | "unit_mismatch" | "exclusive_overlap" | "unsafe_total";
+        grantIds: string[];
+    }>, "many">;
+}, "strict", z.ZodTypeAny, {
+    schemaVersion: 1;
+    subjectAccountId: string & z.BRAND<"OxyAccountId">;
+    capabilities: {
+        key: string;
+        grantIds: string[];
+    }[];
+    evaluatedAt: string;
+    productId: string;
+    quotas: {
+        key: string;
+        unit: string;
+        included: number;
+        combination: "maximum" | "sum" | "exclusive";
+        grantIds: string[];
+    }[];
+    conflicts: {
+        key: string;
+        reason: "combination_mismatch" | "unit_mismatch" | "exclusive_overlap" | "unsafe_total";
+        grantIds: string[];
+    }[];
+}, {
+    schemaVersion: 1;
+    subjectAccountId: string;
+    capabilities: {
+        key: string;
+        grantIds: string[];
+    }[];
+    evaluatedAt: string;
+    productId: string;
+    quotas: {
+        key: string;
+        unit: string;
+        included: number;
+        combination: "maximum" | "sum" | "exclusive";
+        grantIds: string[];
+    }[];
+    conflicts: {
+        key: string;
+        reason: "combination_mismatch" | "unit_mismatch" | "exclusive_overlap" | "unsafe_total";
+        grantIds: string[];
+    }[];
+}>;
+export type ProductBenefit = z.infer<typeof productBenefitSchema>;
+export type ProductOffer = z.infer<typeof productOfferSchema>;
+export type ProductSubscriptionSource = z.infer<typeof productSubscriptionSourceSchema>;
+export type ProductOfferSegment = z.infer<typeof productOfferSegmentSchema>;
+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>;