@oxy.so/contracts 4.14.0 → 4.15.0

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

@@ -6,14 +6,14 @@ export declare const productDefinitionSchema: z.ZodObject<{
     ownerAccountId: z.ZodBranded<z.ZodString, "OxyAccountId">;
     applicationId: z.ZodString;
 }, "strict", z.ZodTypeAny, {
+    id: string;
     schemaVersion: 1;
     ownerAccountId: string & z.BRAND<"OxyAccountId">;
-    id: string;
     applicationId: string;
 }, {
+    id: string;
     schemaVersion: 1;
     ownerAccountId: string;
-    id: string;
     applicationId: string;
 }>;
 export declare const subjectProductAccessQuerySchema: z.ZodObject<{
@@ -106,9 +106,9 @@ export declare const productOfferSchema: z.ZodEffects<z.ZodObject<{
     }>]>, "many">;
 }, "strict", z.ZodTypeAny, {
     kind: "bundle" | "individual";
+    id: string;
     schemaVersion: 1;
     version: number;
-    id: string;
     benefits: ({
         kind: "capability";
         key: string;
@@ -123,9 +123,9 @@ export declare const productOfferSchema: z.ZodEffects<z.ZodObject<{
     })[];
 }, {
     kind: "bundle" | "individual";
+    id: string;
     schemaVersion: 1;
     version: number;
-    id: string;
     benefits: ({
         kind: "capability";
         key: string;
@@ -140,9 +140,9 @@ export declare const productOfferSchema: z.ZodEffects<z.ZodObject<{
     })[];
 }>, {
     kind: "bundle" | "individual";
+    id: string;
     schemaVersion: 1;
     version: number;
-    id: string;
     benefits: ({
         kind: "capability";
         key: string;
@@ -157,9 +157,9 @@ export declare const productOfferSchema: z.ZodEffects<z.ZodObject<{
     })[];
 }, {
     kind: "bundle" | "individual";
+    id: string;
     schemaVersion: 1;
     version: number;
-    id: string;
     benefits: ({
         kind: "capability";
         key: string;
@@ -200,8 +200,8 @@ 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;
     id: string;
+    schemaVersion: 1;
     provider: "stripe" | "peable";
     cancelAtPeriodEnd: boolean;
     beneficiaryAccountId: string & z.BRAND<"OxyAccountId">;
@@ -213,8 +213,8 @@ export declare const productSubscriptionSourceSchema: z.ZodObject<{
     };
 }, {
     status: "active" | "incomplete" | "canceled" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
-    schemaVersion: 1;
     id: string;
+    schemaVersion: 1;
     provider: "stripe" | "peable";
     cancelAtPeriodEnd: boolean;
     beneficiaryAccountId: string;
@@ -251,8 +251,8 @@ export declare const productOfferSegmentSchema: z.ZodObject<{
         end: string;
     }>;
 }, "strict", z.ZodTypeAny, {
-    schemaVersion: 1;
     id: string;
+    schemaVersion: 1;
     beneficiaryAccountId: string & z.BRAND<"OxyAccountId">;
     period: {
         start: string;
@@ -263,8 +263,8 @@ export declare const productOfferSegmentSchema: z.ZodObject<{
     offerVersion: number;
     origin: "bundle" | "individual";
 }, {
-    schemaVersion: 1;
     id: string;
+    schemaVersion: 1;
     beneficiaryAccountId: string;
     period: {
         start: string;
@@ -336,8 +336,8 @@ export declare const productAccessGrantSchema: z.ZodObject<{
     }>;
     revokedAt: z.ZodNullable<z.ZodString>;
 }, "strict", z.ZodTypeAny, {
-    schemaVersion: 1;
     id: string;
+    schemaVersion: 1;
     revokedAt: string | null;
     beneficiaryAccountId: string & z.BRAND<"OxyAccountId">;
     period: {
@@ -361,8 +361,8 @@ export declare const productAccessGrantSchema: z.ZodObject<{
         combination: "maximum" | "sum" | "exclusive";
     };
 }, {
-    schemaVersion: 1;
     id: string;
+    schemaVersion: 1;
     revokedAt: string | null;
     beneficiaryAccountId: string;
     period: {
@@ -638,8 +638,8 @@ export declare const subjectProductGrantSnapshotSchema: z.ZodEffects<z.ZodObject
         }>;
         revokedAt: z.ZodNullable<z.ZodString>;
     }, "strict", z.ZodTypeAny, {
-        schemaVersion: 1;
         id: string;
+        schemaVersion: 1;
         revokedAt: string | null;
         beneficiaryAccountId: string & z.BRAND<"OxyAccountId">;
         period: {
@@ -663,8 +663,8 @@ export declare const subjectProductGrantSnapshotSchema: z.ZodEffects<z.ZodObject
             combination: "maximum" | "sum" | "exclusive";
         };
     }, {
-        schemaVersion: 1;
         id: string;
+        schemaVersion: 1;
         revokedAt: string | null;
         beneficiaryAccountId: string;
         period: {
@@ -713,8 +713,8 @@ export declare const subjectProductGrantSnapshotSchema: z.ZodEffects<z.ZodObject
         }[];
     };
     grants: {
-        schemaVersion: 1;
         id: string;
+        schemaVersion: 1;
         revokedAt: string | null;
         beneficiaryAccountId: string & z.BRAND<"OxyAccountId">;
         period: {
@@ -763,8 +763,8 @@ export declare const subjectProductGrantSnapshotSchema: z.ZodEffects<z.ZodObject
         }[];
     };
     grants: {
-        schemaVersion: 1;
         id: string;
+        schemaVersion: 1;
         revokedAt: string | null;
         beneficiaryAccountId: string;
         period: {
@@ -813,8 +813,8 @@ export declare const subjectProductGrantSnapshotSchema: z.ZodEffects<z.ZodObject
         }[];
     };
     grants: {
-        schemaVersion: 1;
         id: string;
+        schemaVersion: 1;
         revokedAt: string | null;
         beneficiaryAccountId: string & z.BRAND<"OxyAccountId">;
         period: {
@@ -863,8 +863,8 @@ export declare const subjectProductGrantSnapshotSchema: z.ZodEffects<z.ZodObject
         }[];
     };
     grants: {
-        schemaVersion: 1;
         id: string;
+        schemaVersion: 1;
         revokedAt: string | null;
         beneficiaryAccountId: string;
         period: {

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

@@ -21,6 +21,7 @@ export declare const productSubscriptionSummarySchema: z.ZodObject<{
     }>;
     cancelAtPeriodEnd: z.ZodBoolean;
     canCancel: z.ZodBoolean;
+    canRenew: z.ZodOptional<z.ZodBoolean>;
     offers: z.ZodArray<z.ZodObject<{
         segmentId: z.ZodString;
         offerId: z.ZodString;
@@ -48,11 +49,11 @@ export declare const productSubscriptionSummarySchema: z.ZodObject<{
             id: z.ZodString;
             displayName: z.ZodString;
         }, "strict", z.ZodTypeAny, {
-            displayName: string;
             id: string;
-        }, {
             displayName: string;
+        }, {
             id: string;
+            displayName: string;
         }>, "many">;
     }, "strict", z.ZodTypeAny, {
         displayName: string;
@@ -66,8 +67,8 @@ export declare const productSubscriptionSummarySchema: z.ZodObject<{
         segmentId: string;
         current: boolean;
         products: {
-            displayName: string;
             id: string;
+            displayName: string;
         }[];
     }, {
         displayName: string;
@@ -81,8 +82,8 @@ export declare const productSubscriptionSummarySchema: z.ZodObject<{
         segmentId: string;
         current: boolean;
         products: {
-            displayName: string;
             id: string;
+            displayName: string;
         }[];
     }>, "many">;
 }, "strict", z.ZodTypeAny, {
@@ -106,10 +107,11 @@ export declare const productSubscriptionSummarySchema: z.ZodObject<{
         segmentId: string;
         current: boolean;
         products: {
-            displayName: string;
             id: string;
+            displayName: string;
         }[];
     }[];
+    canRenew?: boolean | undefined;
 }, {
     status: "active" | "incomplete" | "canceled" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
     sourceId: string;
@@ -131,10 +133,11 @@ export declare const productSubscriptionSummarySchema: z.ZodObject<{
         segmentId: string;
         current: boolean;
         products: {
-            displayName: string;
             id: string;
+            displayName: string;
         }[];
     }[];
+    canRenew?: boolean | undefined;
 }>;
 export declare const productSubscriptionsResponseSchema: z.ZodObject<{
     subscriptions: z.ZodArray<z.ZodObject<{
@@ -158,6 +161,7 @@ export declare const productSubscriptionsResponseSchema: z.ZodObject<{
         }>;
         cancelAtPeriodEnd: z.ZodBoolean;
         canCancel: z.ZodBoolean;
+        canRenew: z.ZodOptional<z.ZodBoolean>;
         offers: z.ZodArray<z.ZodObject<{
             segmentId: z.ZodString;
             offerId: z.ZodString;
@@ -185,11 +189,11 @@ export declare const productSubscriptionsResponseSchema: z.ZodObject<{
                 id: z.ZodString;
                 displayName: z.ZodString;
             }, "strict", z.ZodTypeAny, {
-                displayName: string;
                 id: string;
-            }, {
                 displayName: string;
+            }, {
                 id: string;
+                displayName: string;
             }>, "many">;
         }, "strict", z.ZodTypeAny, {
             displayName: string;
@@ -203,8 +207,8 @@ export declare const productSubscriptionsResponseSchema: z.ZodObject<{
             segmentId: string;
             current: boolean;
             products: {
-                displayName: string;
                 id: string;
+                displayName: string;
             }[];
         }, {
             displayName: string;
@@ -218,8 +222,8 @@ export declare const productSubscriptionsResponseSchema: z.ZodObject<{
             segmentId: string;
             current: boolean;
             products: {
-                displayName: string;
                 id: string;
+                displayName: string;
             }[];
         }>, "many">;
     }, "strict", z.ZodTypeAny, {
@@ -243,10 +247,11 @@ export declare const productSubscriptionsResponseSchema: z.ZodObject<{
             segmentId: string;
             current: boolean;
             products: {
-                displayName: string;
                 id: string;
+                displayName: string;
             }[];
         }[];
+        canRenew?: boolean | undefined;
     }, {
         status: "active" | "incomplete" | "canceled" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
         sourceId: string;
@@ -268,10 +273,11 @@ export declare const productSubscriptionsResponseSchema: z.ZodObject<{
             segmentId: string;
             current: boolean;
             products: {
-                displayName: string;
                 id: string;
+                displayName: string;
             }[];
         }[];
+        canRenew?: boolean | undefined;
     }>, "many">;
 }, "strict", z.ZodTypeAny, {
     subscriptions: {
@@ -295,10 +301,11 @@ export declare const productSubscriptionsResponseSchema: z.ZodObject<{
             segmentId: string;
             current: boolean;
             products: {
-                displayName: string;
                 id: string;
+                displayName: string;
             }[];
         }[];
+        canRenew?: boolean | undefined;
     }[];
 }, {
     subscriptions: {
@@ -322,10 +329,11 @@ export declare const productSubscriptionsResponseSchema: z.ZodObject<{
             segmentId: string;
             current: boolean;
             products: {
-                displayName: string;
                 id: string;
+                displayName: string;
             }[];
         }[];
+        canRenew?: boolean | undefined;
     }[];
 }>;
 export declare const subscriptionCreditGrantSchema: z.ZodEffects<z.ZodObject<{
@@ -355,8 +363,8 @@ export declare const subscriptionCreditGrantSchema: z.ZodEffects<z.ZodObject<{
     promotionId: z.ZodNullable<z.ZodString>;
     createdAt: z.ZodString;
 }, "strict", z.ZodTypeAny, {
-    id: string;
     createdAt: string;
+    id: string;
     granted: number;
     remaining: number;
     period: {
@@ -369,8 +377,8 @@ export declare const subscriptionCreditGrantSchema: z.ZodEffects<z.ZodObject<{
     clawed: number;
     promotionId: string | null;
 }, {
-    id: string;
     createdAt: string;
+    id: string;
     granted: number;
     remaining: number;
     period: {
@@ -383,8 +391,8 @@ export declare const subscriptionCreditGrantSchema: z.ZodEffects<z.ZodObject<{
     clawed: number;
     promotionId: string | null;
 }>, {
-    id: string;
     createdAt: string;
+    id: string;
     granted: number;
     remaining: number;
     period: {
@@ -397,8 +405,8 @@ export declare const subscriptionCreditGrantSchema: z.ZodEffects<z.ZodObject<{
     clawed: number;
     promotionId: string | null;
 }, {
-    id: string;
     createdAt: string;
+    id: string;
     granted: number;
     remaining: number;
     period: {
@@ -439,8 +447,8 @@ export declare const subscriptionCreditGrantsResponseSchema: z.ZodObject<{
         promotionId: z.ZodNullable<z.ZodString>;
         createdAt: z.ZodString;
     }, "strict", z.ZodTypeAny, {
-        id: string;
         createdAt: string;
+        id: string;
         granted: number;
         remaining: number;
         period: {
@@ -453,8 +461,8 @@ export declare const subscriptionCreditGrantsResponseSchema: z.ZodObject<{
         clawed: number;
         promotionId: string | null;
     }, {
-        id: string;
         createdAt: string;
+        id: string;
         granted: number;
         remaining: number;
         period: {
@@ -467,8 +475,8 @@ export declare const subscriptionCreditGrantsResponseSchema: z.ZodObject<{
         clawed: number;
         promotionId: string | null;
     }>, {
-        id: string;
         createdAt: string;
+        id: string;
         granted: number;
         remaining: number;
         period: {
@@ -481,8 +489,8 @@ export declare const subscriptionCreditGrantsResponseSchema: z.ZodObject<{
         clawed: number;
         promotionId: string | null;
     }, {
-        id: string;
         createdAt: string;
+        id: string;
         granted: number;
         remaining: number;
         period: {
@@ -497,8 +505,8 @@ export declare const subscriptionCreditGrantsResponseSchema: z.ZodObject<{
     }>, "many">;
 }, "strict", z.ZodTypeAny, {
     grants: {
-        id: string;
         createdAt: string;
+        id: string;
         granted: number;
         remaining: number;
         period: {
@@ -513,8 +521,8 @@ export declare const subscriptionCreditGrantsResponseSchema: z.ZodObject<{
     }[];
 }, {
     grants: {
-        id: string;
         createdAt: string;
+        id: string;
         granted: number;
         remaining: number;
         period: {

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

@@ -58,3 +58,39 @@ export declare const personalPlanCheckoutResultSchema: z.ZodDiscriminatedUnion<"
 }>]>;
 export type PersonalPlanCheckoutRequest = z.infer<typeof personalPlanCheckoutRequestSchema>;
 export type PersonalPlanCheckoutResult = z.infer<typeof personalPlanCheckoutResultSchema>;
+/** Explicit individual product offer; still owned and paid through Oxy. */
+export declare const productPlanCheckoutRequestSchema: z.ZodObject<{
+    expectedSubjectAccountId: z.ZodBranded<z.ZodString, "OxyAccountId">;
+    offerId: z.ZodString;
+    offerVersion: z.ZodNumber;
+    idempotencyKey: z.ZodString;
+} & {
+    productId: z.ZodString;
+}, "strict", z.ZodTypeAny, {
+    idempotencyKey: string;
+    productId: string;
+    offerId: string;
+    offerVersion: number;
+    expectedSubjectAccountId: string & z.BRAND<"OxyAccountId">;
+}, {
+    idempotencyKey: string;
+    productId: string;
+    offerId: string;
+    offerVersion: number;
+    expectedSubjectAccountId: string;
+}>;
+export type ProductPlanCheckoutRequest = z.infer<typeof productPlanCheckoutRequestSchema>;
+export declare const productSubscriptionRenewalRequestSchema: z.ZodObject<{
+    expectedSubjectAccountId: z.ZodBranded<z.ZodString, "OxyAccountId">;
+    sourceId: z.ZodString;
+    idempotencyKey: z.ZodString;
+}, "strict", z.ZodTypeAny, {
+    sourceId: string;
+    idempotencyKey: string;
+    expectedSubjectAccountId: string & z.BRAND<"OxyAccountId">;
+}, {
+    sourceId: string;
+    idempotencyKey: string;
+    expectedSubjectAccountId: string;
+}>;
+export type ProductSubscriptionRenewalRequest = z.infer<typeof productSubscriptionRenewalRequestSchema>;

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

@@ -26,7 +26,7 @@ export declare const personalPlanDisplayPriceSchema: z.ZodObject<{
 export declare const personalPlanCatalogueSchema: z.ZodEffects<z.ZodObject<{
     schemaVersion: z.ZodLiteral<1>;
     state: z.ZodEnum<["unconfigured", "configured"]>;
-    purchase: z.ZodLiteral<"unavailable">;
+    purchase: z.ZodEnum<["unavailable", "available"]>;
     plans: z.ZodArray<z.ZodObject<{
         offerId: z.ZodString;
         offerVersion: z.ZodNumber;
@@ -121,8 +121,8 @@ export declare const personalPlanCatalogueSchema: z.ZodEffects<z.ZodObject<{
             };
         }>, "many">;
     }, "strict", z.ZodTypeAny, {
-        displayName: string;
         kind: "oxy_one";
+        displayName: string;
         audience: "personal";
         benefits: {
             displayName: string;
@@ -150,8 +150,8 @@ export declare const personalPlanCatalogueSchema: z.ZodEffects<z.ZodObject<{
             merchantTotal: "final";
         } | undefined;
     }, {
-        displayName: string;
         kind: "oxy_one";
+        displayName: string;
         audience: "personal";
         benefits: {
             displayName: string;
@@ -182,10 +182,10 @@ export declare const personalPlanCatalogueSchema: z.ZodEffects<z.ZodObject<{
 }, "strict", z.ZodTypeAny, {
     schemaVersion: 1;
     state: "unconfigured" | "configured";
-    purchase: "unavailable";
+    purchase: "unavailable" | "available";
     plans: {
-        displayName: string;
         kind: "oxy_one";
+        displayName: string;
         audience: "personal";
         benefits: {
             displayName: string;
@@ -216,10 +216,10 @@ export declare const personalPlanCatalogueSchema: z.ZodEffects<z.ZodObject<{
 }, {
     schemaVersion: 1;
     state: "unconfigured" | "configured";
-    purchase: "unavailable";
+    purchase: "unavailable" | "available";
     plans: {
-        displayName: string;
         kind: "oxy_one";
+        displayName: string;
         audience: "personal";
         benefits: {
             displayName: string;
@@ -250,10 +250,10 @@ export declare const personalPlanCatalogueSchema: z.ZodEffects<z.ZodObject<{
 }>, {
     schemaVersion: 1;
     state: "unconfigured" | "configured";
-    purchase: "unavailable";
+    purchase: "unavailable" | "available";
     plans: {
-        displayName: string;
         kind: "oxy_one";
+        displayName: string;
         audience: "personal";
         benefits: {
             displayName: string;
@@ -284,10 +284,10 @@ export declare const personalPlanCatalogueSchema: z.ZodEffects<z.ZodObject<{
 }, {
     schemaVersion: 1;
     state: "unconfigured" | "configured";
-    purchase: "unavailable";
+    purchase: "unavailable" | "available";
     plans: {
-        displayName: string;
         kind: "oxy_one";
+        displayName: string;
         audience: "personal";
         benefits: {
             displayName: string;
@@ -317,3 +317,100 @@ export declare const personalPlanCatalogueSchema: z.ZodEffects<z.ZodObject<{
     }[];
 }>;
 export type PersonalPlanCatalogue = z.infer<typeof personalPlanCatalogueSchema>;
+export declare const productPlanCatalogueSchema: z.ZodObject<{
+    schemaVersion: z.ZodLiteral<1>;
+    productId: z.ZodString;
+    purchase: z.ZodEnum<["unavailable", "available"]>;
+    plans: z.ZodArray<z.ZodObject<{
+        productId: z.ZodString;
+        offerId: z.ZodString;
+        offerVersion: z.ZodNumber;
+        displayName: z.ZodString;
+        price: z.ZodObject<{
+            currency: z.ZodString;
+            amountMinorUnits: z.ZodNumber;
+            trial: z.ZodLiteral<"none">;
+            taxTreatment: z.ZodLiteral<"inclusive">;
+            merchantTotal: z.ZodLiteral<"final">;
+        } & {
+            interval: z.ZodEnum<["month", "year"]>;
+        }, "strict", z.ZodTypeAny, {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "year" | "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        }, {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "year" | "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        }>;
+    }, "strict", z.ZodTypeAny, {
+        displayName: string;
+        price: {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "year" | "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        };
+        productId: string;
+        offerId: string;
+        offerVersion: number;
+    }, {
+        displayName: string;
+        price: {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "year" | "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        };
+        productId: string;
+        offerId: string;
+        offerVersion: number;
+    }>, "many">;
+}, "strict", z.ZodTypeAny, {
+    schemaVersion: 1;
+    purchase: "unavailable" | "available";
+    productId: string;
+    plans: {
+        displayName: string;
+        price: {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "year" | "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        };
+        productId: string;
+        offerId: string;
+        offerVersion: number;
+    }[];
+}, {
+    schemaVersion: 1;
+    purchase: "unavailable" | "available";
+    productId: string;
+    plans: {
+        displayName: string;
+        price: {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "year" | "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        };
+        productId: string;
+        offerId: string;
+        offerVersion: number;
+    }[];
+}>;
+export type ProductPlanCatalogue = z.infer<typeof productPlanCatalogueSchema>;