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

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

@@ -530,12 +530,15 @@ export declare const subscriptionCreditGrantsResponseSchema: z.ZodObject<{
 }>;
 export declare const cancelProductSubscriptionSchema: z.ZodObject<{
     sourceId: z.ZodString;
+    actionId: z.ZodOptional<z.ZodString>;
     expectedSubjectAccountId: z.ZodOptional<z.ZodBranded<z.ZodString, "OxyAccountId">>;
 }, "strict", z.ZodTypeAny, {
     sourceId: string;
+    actionId?: string | undefined;
     expectedSubjectAccountId?: (string & z.BRAND<"OxyAccountId">) | undefined;
 }, {
     sourceId: string;
+    actionId?: string | undefined;
     expectedSubjectAccountId?: string | undefined;
 }>;
 export type ProductSubscriptionSummary = z.infer<typeof productSubscriptionSummarySchema>;

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

@@ -0,0 +1,60 @@
+import { z } from 'zod';
+export declare const personalPlanCheckoutRequestSchema: z.ZodObject<{
+    expectedSubjectAccountId: z.ZodBranded<z.ZodString, "OxyAccountId">;
+    offerId: z.ZodString;
+    offerVersion: z.ZodNumber;
+    idempotencyKey: z.ZodString;
+}, "strict", z.ZodTypeAny, {
+    idempotencyKey: string;
+    offerId: string;
+    offerVersion: number;
+    expectedSubjectAccountId: string & z.BRAND<"OxyAccountId">;
+}, {
+    idempotencyKey: string;
+    offerId: string;
+    offerVersion: number;
+    expectedSubjectAccountId: string;
+}>;
+/** No grant or subscription is created by checkout completion in the browser. */
+export declare const personalPlanCheckoutResultSchema: z.ZodDiscriminatedUnion<"state", [z.ZodObject<{
+    state: z.ZodLiteral<"unconfigured">;
+    reason: z.ZodEnum<["provider_unconfigured", "offer_unconfigured", "price_unconfigured"]>;
+}, "strict", z.ZodTypeAny, {
+    reason: "provider_unconfigured" | "offer_unconfigured" | "price_unconfigured";
+    state: "unconfigured";
+}, {
+    reason: "provider_unconfigured" | "offer_unconfigured" | "price_unconfigured";
+    state: "unconfigured";
+}>, z.ZodObject<{
+    state: z.ZodLiteral<"pending">;
+    intentId: z.ZodString;
+    checkoutUrl: z.ZodString;
+}, "strict", z.ZodTypeAny, {
+    state: "pending";
+    intentId: string;
+    checkoutUrl: string;
+}, {
+    state: "pending";
+    intentId: string;
+    checkoutUrl: string;
+}>, z.ZodObject<{
+    state: z.ZodLiteral<"closed">;
+    intentId: z.ZodString;
+}, "strict", z.ZodTypeAny, {
+    state: "closed";
+    intentId: string;
+}, {
+    state: "closed";
+    intentId: string;
+}>, z.ZodObject<{
+    state: z.ZodLiteral<"fulfilled">;
+    intentId: z.ZodString;
+}, "strict", z.ZodTypeAny, {
+    state: "fulfilled";
+    intentId: string;
+}, {
+    state: "fulfilled";
+    intentId: string;
+}>]>;
+export type PersonalPlanCheckoutRequest = z.infer<typeof personalPlanCheckoutRequestSchema>;
+export type PersonalPlanCheckoutResult = z.infer<typeof personalPlanCheckoutResultSchema>;

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

@@ -0,0 +1,319 @@
+import { z } from 'zod';
+/** Approved display terms never identify or activate a billing-provider price. */
+export declare const personalPlanDisplayPriceSchema: z.ZodObject<{
+    currency: z.ZodString;
+    amountMinorUnits: z.ZodNumber;
+    interval: z.ZodLiteral<"month">;
+    trial: z.ZodLiteral<"none">;
+    taxTreatment: z.ZodLiteral<"inclusive">;
+    merchantTotal: z.ZodLiteral<"final">;
+}, "strict", z.ZodTypeAny, {
+    currency: string;
+    amountMinorUnits: number;
+    interval: "month";
+    trial: "none";
+    taxTreatment: "inclusive";
+    merchantTotal: "final";
+}, {
+    currency: string;
+    amountMinorUnits: number;
+    interval: "month";
+    trial: "none";
+    taxTreatment: "inclusive";
+    merchantTotal: "final";
+}>;
+/** Public discovery is separate from customer access. No provider or owner IDs. */
+export declare const personalPlanCatalogueSchema: z.ZodEffects<z.ZodObject<{
+    schemaVersion: z.ZodLiteral<1>;
+    state: z.ZodEnum<["unconfigured", "configured"]>;
+    purchase: z.ZodLiteral<"unavailable">;
+    plans: z.ZodArray<z.ZodObject<{
+        offerId: z.ZodString;
+        offerVersion: z.ZodNumber;
+        displayName: z.ZodString;
+        audience: z.ZodLiteral<"personal">;
+        kind: z.ZodLiteral<"oxy_one">;
+        price: z.ZodOptional<z.ZodObject<{
+            currency: z.ZodString;
+            amountMinorUnits: z.ZodNumber;
+            interval: z.ZodLiteral<"month">;
+            trial: z.ZodLiteral<"none">;
+            taxTreatment: z.ZodLiteral<"inclusive">;
+            merchantTotal: z.ZodLiteral<"final">;
+        }, "strict", z.ZodTypeAny, {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        }, {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        }>>;
+        benefits: z.ZodArray<z.ZodObject<{
+            displayName: z.ZodString;
+            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";
+            }>]>;
+        }, "strict", z.ZodTypeAny, {
+            benefit: {
+                productId: string;
+                kind: "capability";
+                key: string;
+            } | {
+                productId: string;
+                kind: "quota";
+                key: string;
+                unit: string;
+                included: number;
+                combination: "maximum" | "sum" | "exclusive";
+            };
+            displayName: string;
+        }, {
+            benefit: {
+                productId: string;
+                kind: "capability";
+                key: string;
+            } | {
+                productId: string;
+                kind: "quota";
+                key: string;
+                unit: string;
+                included: number;
+                combination: "maximum" | "sum" | "exclusive";
+            };
+            displayName: string;
+        }>, "many">;
+    }, "strict", z.ZodTypeAny, {
+        kind: "oxy_one";
+        benefits: {
+            benefit: {
+                productId: string;
+                kind: "capability";
+                key: string;
+            } | {
+                productId: string;
+                kind: "quota";
+                key: string;
+                unit: string;
+                included: number;
+                combination: "maximum" | "sum" | "exclusive";
+            };
+            displayName: string;
+        }[];
+        offerId: string;
+        offerVersion: number;
+        displayName: string;
+        audience: "personal";
+        price?: {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        } | undefined;
+    }, {
+        kind: "oxy_one";
+        benefits: {
+            benefit: {
+                productId: string;
+                kind: "capability";
+                key: string;
+            } | {
+                productId: string;
+                kind: "quota";
+                key: string;
+                unit: string;
+                included: number;
+                combination: "maximum" | "sum" | "exclusive";
+            };
+            displayName: string;
+        }[];
+        offerId: string;
+        offerVersion: number;
+        displayName: string;
+        audience: "personal";
+        price?: {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        } | undefined;
+    }>, "many">;
+}, "strict", z.ZodTypeAny, {
+    schemaVersion: 1;
+    state: "unconfigured" | "configured";
+    purchase: "unavailable";
+    plans: {
+        kind: "oxy_one";
+        benefits: {
+            benefit: {
+                productId: string;
+                kind: "capability";
+                key: string;
+            } | {
+                productId: string;
+                kind: "quota";
+                key: string;
+                unit: string;
+                included: number;
+                combination: "maximum" | "sum" | "exclusive";
+            };
+            displayName: string;
+        }[];
+        offerId: string;
+        offerVersion: number;
+        displayName: string;
+        audience: "personal";
+        price?: {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        } | undefined;
+    }[];
+}, {
+    schemaVersion: 1;
+    state: "unconfigured" | "configured";
+    purchase: "unavailable";
+    plans: {
+        kind: "oxy_one";
+        benefits: {
+            benefit: {
+                productId: string;
+                kind: "capability";
+                key: string;
+            } | {
+                productId: string;
+                kind: "quota";
+                key: string;
+                unit: string;
+                included: number;
+                combination: "maximum" | "sum" | "exclusive";
+            };
+            displayName: string;
+        }[];
+        offerId: string;
+        offerVersion: number;
+        displayName: string;
+        audience: "personal";
+        price?: {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        } | undefined;
+    }[];
+}>, {
+    schemaVersion: 1;
+    state: "unconfigured" | "configured";
+    purchase: "unavailable";
+    plans: {
+        kind: "oxy_one";
+        benefits: {
+            benefit: {
+                productId: string;
+                kind: "capability";
+                key: string;
+            } | {
+                productId: string;
+                kind: "quota";
+                key: string;
+                unit: string;
+                included: number;
+                combination: "maximum" | "sum" | "exclusive";
+            };
+            displayName: string;
+        }[];
+        offerId: string;
+        offerVersion: number;
+        displayName: string;
+        audience: "personal";
+        price?: {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        } | undefined;
+    }[];
+}, {
+    schemaVersion: 1;
+    state: "unconfigured" | "configured";
+    purchase: "unavailable";
+    plans: {
+        kind: "oxy_one";
+        benefits: {
+            benefit: {
+                productId: string;
+                kind: "capability";
+                key: string;
+            } | {
+                productId: string;
+                kind: "quota";
+                key: string;
+                unit: string;
+                included: number;
+                combination: "maximum" | "sum" | "exclusive";
+            };
+            displayName: string;
+        }[];
+        offerId: string;
+        offerVersion: number;
+        displayName: string;
+        audience: "personal";
+        price?: {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        } | undefined;
+    }[];
+}>;
+export type PersonalPlanCatalogue = z.infer<typeof personalPlanCatalogueSchema>;