@oxy.so/contracts 4.8.0 → 4.9.1

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

@@ -0,0 +1,563 @@
+import { z } from 'zod';
+/** Self-service provenance; no payer/provider identifiers or balances in access metadata. */
+export declare const productSubscriptionSummarySchema: z.ZodObject<{
+    sourceId: 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;
+    canCancel: z.ZodBoolean;
+    offers: z.ZodArray<z.ZodObject<{
+        segmentId: z.ZodString;
+        offerId: z.ZodString;
+        offerVersion: z.ZodNumber;
+        displayName: z.ZodString;
+        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;
+        }>;
+        current: z.ZodBoolean;
+        products: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            displayName: z.ZodString;
+        }, "strict", z.ZodTypeAny, {
+            displayName: string;
+            id: string;
+        }, {
+            displayName: string;
+            id: string;
+        }>, "many">;
+    }, "strict", z.ZodTypeAny, {
+        displayName: string;
+        period: {
+            start: string;
+            end: string;
+        };
+        offerId: string;
+        offerVersion: number;
+        origin: "bundle" | "individual";
+        segmentId: string;
+        current: boolean;
+        products: {
+            displayName: string;
+            id: string;
+        }[];
+    }, {
+        displayName: string;
+        period: {
+            start: string;
+            end: string;
+        };
+        offerId: string;
+        offerVersion: number;
+        origin: "bundle" | "individual";
+        segmentId: string;
+        current: boolean;
+        products: {
+            displayName: string;
+            id: string;
+        }[];
+    }>, "many">;
+}, "strict", z.ZodTypeAny, {
+    status: "active" | "incomplete" | "canceled" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
+    sourceId: string;
+    cancelAtPeriodEnd: boolean;
+    period: {
+        start: string;
+        end: string;
+    };
+    canCancel: boolean;
+    offers: {
+        displayName: string;
+        period: {
+            start: string;
+            end: string;
+        };
+        offerId: string;
+        offerVersion: number;
+        origin: "bundle" | "individual";
+        segmentId: string;
+        current: boolean;
+        products: {
+            displayName: string;
+            id: string;
+        }[];
+    }[];
+}, {
+    status: "active" | "incomplete" | "canceled" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
+    sourceId: string;
+    cancelAtPeriodEnd: boolean;
+    period: {
+        start: string;
+        end: string;
+    };
+    canCancel: boolean;
+    offers: {
+        displayName: string;
+        period: {
+            start: string;
+            end: string;
+        };
+        offerId: string;
+        offerVersion: number;
+        origin: "bundle" | "individual";
+        segmentId: string;
+        current: boolean;
+        products: {
+            displayName: string;
+            id: string;
+        }[];
+    }[];
+}>;
+export declare const productSubscriptionsResponseSchema: z.ZodObject<{
+    subscriptions: z.ZodArray<z.ZodObject<{
+        sourceId: 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;
+        canCancel: z.ZodBoolean;
+        offers: z.ZodArray<z.ZodObject<{
+            segmentId: z.ZodString;
+            offerId: z.ZodString;
+            offerVersion: z.ZodNumber;
+            displayName: z.ZodString;
+            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;
+            }>;
+            current: z.ZodBoolean;
+            products: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                displayName: z.ZodString;
+            }, "strict", z.ZodTypeAny, {
+                displayName: string;
+                id: string;
+            }, {
+                displayName: string;
+                id: string;
+            }>, "many">;
+        }, "strict", z.ZodTypeAny, {
+            displayName: string;
+            period: {
+                start: string;
+                end: string;
+            };
+            offerId: string;
+            offerVersion: number;
+            origin: "bundle" | "individual";
+            segmentId: string;
+            current: boolean;
+            products: {
+                displayName: string;
+                id: string;
+            }[];
+        }, {
+            displayName: string;
+            period: {
+                start: string;
+                end: string;
+            };
+            offerId: string;
+            offerVersion: number;
+            origin: "bundle" | "individual";
+            segmentId: string;
+            current: boolean;
+            products: {
+                displayName: string;
+                id: string;
+            }[];
+        }>, "many">;
+    }, "strict", z.ZodTypeAny, {
+        status: "active" | "incomplete" | "canceled" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
+        sourceId: string;
+        cancelAtPeriodEnd: boolean;
+        period: {
+            start: string;
+            end: string;
+        };
+        canCancel: boolean;
+        offers: {
+            displayName: string;
+            period: {
+                start: string;
+                end: string;
+            };
+            offerId: string;
+            offerVersion: number;
+            origin: "bundle" | "individual";
+            segmentId: string;
+            current: boolean;
+            products: {
+                displayName: string;
+                id: string;
+            }[];
+        }[];
+    }, {
+        status: "active" | "incomplete" | "canceled" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
+        sourceId: string;
+        cancelAtPeriodEnd: boolean;
+        period: {
+            start: string;
+            end: string;
+        };
+        canCancel: boolean;
+        offers: {
+            displayName: string;
+            period: {
+                start: string;
+                end: string;
+            };
+            offerId: string;
+            offerVersion: number;
+            origin: "bundle" | "individual";
+            segmentId: string;
+            current: boolean;
+            products: {
+                displayName: string;
+                id: string;
+            }[];
+        }[];
+    }>, "many">;
+}, "strict", z.ZodTypeAny, {
+    subscriptions: {
+        status: "active" | "incomplete" | "canceled" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
+        sourceId: string;
+        cancelAtPeriodEnd: boolean;
+        period: {
+            start: string;
+            end: string;
+        };
+        canCancel: boolean;
+        offers: {
+            displayName: string;
+            period: {
+                start: string;
+                end: string;
+            };
+            offerId: string;
+            offerVersion: number;
+            origin: "bundle" | "individual";
+            segmentId: string;
+            current: boolean;
+            products: {
+                displayName: string;
+                id: string;
+            }[];
+        }[];
+    }[];
+}, {
+    subscriptions: {
+        status: "active" | "incomplete" | "canceled" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
+        sourceId: string;
+        cancelAtPeriodEnd: boolean;
+        period: {
+            start: string;
+            end: string;
+        };
+        canCancel: boolean;
+        offers: {
+            displayName: string;
+            period: {
+                start: string;
+                end: string;
+            };
+            offerId: string;
+            offerVersion: number;
+            origin: "bundle" | "individual";
+            segmentId: string;
+            current: boolean;
+            products: {
+                displayName: string;
+                id: string;
+            }[];
+        }[];
+    }[];
+}>;
+export declare const subscriptionCreditGrantSchema: z.ZodEffects<z.ZodObject<{
+    id: z.ZodString;
+    invoiceId: z.ZodString;
+    origin: z.ZodEnum<["subscription_payment", "subscription_proration", "subscription_promotional_grant"]>;
+    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;
+    }>;
+    granted: z.ZodNumber;
+    consumed: z.ZodNumber;
+    clawed: z.ZodNumber;
+    remaining: z.ZodNumber;
+    promotionId: z.ZodNullable<z.ZodString>;
+    createdAt: z.ZodString;
+}, "strict", z.ZodTypeAny, {
+    id: string;
+    createdAt: string;
+    granted: number;
+    remaining: number;
+    period: {
+        start: string;
+        end: string;
+    };
+    origin: "subscription_payment" | "subscription_proration" | "subscription_promotional_grant";
+    invoiceId: string;
+    consumed: number;
+    clawed: number;
+    promotionId: string | null;
+}, {
+    id: string;
+    createdAt: string;
+    granted: number;
+    remaining: number;
+    period: {
+        start: string;
+        end: string;
+    };
+    origin: "subscription_payment" | "subscription_proration" | "subscription_promotional_grant";
+    invoiceId: string;
+    consumed: number;
+    clawed: number;
+    promotionId: string | null;
+}>, {
+    id: string;
+    createdAt: string;
+    granted: number;
+    remaining: number;
+    period: {
+        start: string;
+        end: string;
+    };
+    origin: "subscription_payment" | "subscription_proration" | "subscription_promotional_grant";
+    invoiceId: string;
+    consumed: number;
+    clawed: number;
+    promotionId: string | null;
+}, {
+    id: string;
+    createdAt: string;
+    granted: number;
+    remaining: number;
+    period: {
+        start: string;
+        end: string;
+    };
+    origin: "subscription_payment" | "subscription_proration" | "subscription_promotional_grant";
+    invoiceId: string;
+    consumed: number;
+    clawed: number;
+    promotionId: string | null;
+}>;
+export declare const subscriptionCreditGrantsResponseSchema: z.ZodObject<{
+    grants: z.ZodArray<z.ZodEffects<z.ZodObject<{
+        id: z.ZodString;
+        invoiceId: z.ZodString;
+        origin: z.ZodEnum<["subscription_payment", "subscription_proration", "subscription_promotional_grant"]>;
+        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;
+        }>;
+        granted: z.ZodNumber;
+        consumed: z.ZodNumber;
+        clawed: z.ZodNumber;
+        remaining: z.ZodNumber;
+        promotionId: z.ZodNullable<z.ZodString>;
+        createdAt: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        id: string;
+        createdAt: string;
+        granted: number;
+        remaining: number;
+        period: {
+            start: string;
+            end: string;
+        };
+        origin: "subscription_payment" | "subscription_proration" | "subscription_promotional_grant";
+        invoiceId: string;
+        consumed: number;
+        clawed: number;
+        promotionId: string | null;
+    }, {
+        id: string;
+        createdAt: string;
+        granted: number;
+        remaining: number;
+        period: {
+            start: string;
+            end: string;
+        };
+        origin: "subscription_payment" | "subscription_proration" | "subscription_promotional_grant";
+        invoiceId: string;
+        consumed: number;
+        clawed: number;
+        promotionId: string | null;
+    }>, {
+        id: string;
+        createdAt: string;
+        granted: number;
+        remaining: number;
+        period: {
+            start: string;
+            end: string;
+        };
+        origin: "subscription_payment" | "subscription_proration" | "subscription_promotional_grant";
+        invoiceId: string;
+        consumed: number;
+        clawed: number;
+        promotionId: string | null;
+    }, {
+        id: string;
+        createdAt: string;
+        granted: number;
+        remaining: number;
+        period: {
+            start: string;
+            end: string;
+        };
+        origin: "subscription_payment" | "subscription_proration" | "subscription_promotional_grant";
+        invoiceId: string;
+        consumed: number;
+        clawed: number;
+        promotionId: string | null;
+    }>, "many">;
+}, "strict", z.ZodTypeAny, {
+    grants: {
+        id: string;
+        createdAt: string;
+        granted: number;
+        remaining: number;
+        period: {
+            start: string;
+            end: string;
+        };
+        origin: "subscription_payment" | "subscription_proration" | "subscription_promotional_grant";
+        invoiceId: string;
+        consumed: number;
+        clawed: number;
+        promotionId: string | null;
+    }[];
+}, {
+    grants: {
+        id: string;
+        createdAt: string;
+        granted: number;
+        remaining: number;
+        period: {
+            start: string;
+            end: string;
+        };
+        origin: "subscription_payment" | "subscription_proration" | "subscription_promotional_grant";
+        invoiceId: string;
+        consumed: number;
+        clawed: number;
+        promotionId: string | null;
+    }[];
+}>;
+export declare const cancelProductSubscriptionSchema: z.ZodObject<{
+    sourceId: z.ZodString;
+    expectedSubjectAccountId: z.ZodOptional<z.ZodBranded<z.ZodString, "OxyAccountId">>;
+}, "strict", z.ZodTypeAny, {
+    sourceId: string;
+    expectedSubjectAccountId?: (string & z.BRAND<"OxyAccountId">) | undefined;
+}, {
+    sourceId: string;
+    expectedSubjectAccountId?: string | undefined;
+}>;
+export type ProductSubscriptionSummary = z.infer<typeof productSubscriptionSummarySchema>;
+export type SubscriptionCreditGrant = z.infer<typeof subscriptionCreditGrantSchema>;
+/** Remote acceptance is distinct from completed local reconciliation. */
+export declare const productSubscriptionCancellationResultSchema: z.ZodUnion<[z.ZodObject<{
+    sourceId: z.ZodString;
+    cancelAtPeriodEnd: z.ZodLiteral<true>;
+}, "strict", z.ZodTypeAny, {
+    sourceId: string;
+    cancelAtPeriodEnd: true;
+}, {
+    sourceId: string;
+    cancelAtPeriodEnd: true;
+}>, z.ZodObject<{
+    sourceId: z.ZodString;
+    reconciliationPending: z.ZodLiteral<true>;
+}, "strict", z.ZodTypeAny, {
+    sourceId: string;
+    reconciliationPending: true;
+}, {
+    sourceId: string;
+    reconciliationPending: true;
+}>]>;
+export type ProductSubscriptionCancellationResult = z.infer<typeof productSubscriptionCancellationResultSchema>;

package/dist/types/recommendations.d.ts

@@ -124,8 +124,8 @@ export declare const recommendationRequestSchema: z.ZodObject<{
         affinity?: number | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
-    limit?: number | undefined;
     clientId?: string | undefined;
+    limit?: number | undefined;
     offset?: number | undefined;
     excludeTypes?: ("agent" | "federated" | "automated")[] | undefined;
     excludeIds?: string[] | undefined;
@@ -145,8 +145,8 @@ export declare const recommendationRequestSchema: z.ZodObject<{
         affinity?: number | undefined;
     } | undefined;
 }, {
-    limit?: number | undefined;
     clientId?: string | undefined;
+    limit?: number | undefined;
     offset?: number | undefined;
     excludeTypes?: ("agent" | "federated" | "automated")[] | undefined;
     excludeIds?: string[] | undefined;

package/dist/types/sessionStatus.d.ts

@@ -71,9 +71,9 @@ export declare const publicApplicationSchema: z.ZodObject<{
     type: "system" | "internal" | "first_party" | "third_party";
     name: string;
     id: string;
+    scopes: string[];
     isOfficial: boolean;
     isInternal: boolean;
-    scopes: string[];
     description?: string | undefined;
     icon?: string | undefined;
     websiteUrl?: string | undefined;
@@ -84,9 +84,9 @@ export declare const publicApplicationSchema: z.ZodObject<{
     type: "system" | "internal" | "first_party" | "third_party";
     name: string;
     id: string;
+    scopes: string[];
     isOfficial: boolean;
     isInternal: boolean;
-    scopes: string[];
     description?: string | undefined;
     icon?: string | undefined;
     websiteUrl?: string | undefined;
@@ -143,9 +143,9 @@ export declare const sessionStatusSchema: z.ZodObject<{
         type: "system" | "internal" | "first_party" | "third_party";
         name: string;
         id: string;
+        scopes: string[];
         isOfficial: boolean;
         isInternal: boolean;
-        scopes: string[];
         description?: string | undefined;
         icon?: string | undefined;
         websiteUrl?: string | undefined;
@@ -156,9 +156,9 @@ export declare const sessionStatusSchema: z.ZodObject<{
         type: "system" | "internal" | "first_party" | "third_party";
         name: string;
         id: string;
+        scopes: string[];
         isOfficial: boolean;
         isInternal: boolean;
-        scopes: string[];
         description?: string | undefined;
         icon?: string | undefined;
         websiteUrl?: string | undefined;
@@ -181,18 +181,18 @@ export declare const sessionStatusSchema: z.ZodObject<{
     status: string;
     purpose?: "device_sign_in" | "oauth_authorization" | undefined;
     expiresAt?: string | undefined;
-    publicKey?: string | null | undefined;
-    userId?: string | null | undefined;
     sessionId?: string | null | undefined;
+    userId?: string | null | undefined;
+    publicKey?: string | null | undefined;
     authorized?: boolean | undefined;
     sessionToken?: string | undefined;
     application?: {
         type: "system" | "internal" | "first_party" | "third_party";
         name: string;
         id: string;
+        scopes: string[];
         isOfficial: boolean;
         isInternal: boolean;
-        scopes: string[];
         description?: string | undefined;
         icon?: string | undefined;
         websiteUrl?: string | undefined;
@@ -206,18 +206,18 @@ export declare const sessionStatusSchema: z.ZodObject<{
     status: string;
     purpose?: "device_sign_in" | "oauth_authorization" | undefined;
     expiresAt?: string | undefined;
-    publicKey?: string | null | undefined;
-    userId?: string | null | undefined;
     sessionId?: string | null | undefined;
+    userId?: string | null | undefined;
+    publicKey?: string | null | undefined;
     authorized?: boolean | undefined;
     sessionToken?: string | undefined;
     application?: {
         type: "system" | "internal" | "first_party" | "third_party";
         name: string;
         id: string;
+        scopes: string[];
         isOfficial: boolean;
         isInternal: boolean;
-        scopes: string[];
         description?: string | undefined;
         icon?: string | undefined;
         websiteUrl?: string | undefined;

package/dist/types/signIn.d.ts

@@ -212,17 +212,17 @@ export declare const emailSignInLinkRequestSchema: z.ZodObject<{
         deviceSecret: string;
     }>;
 }, "strict", z.ZodTypeAny, {
-    token: string;
     device: {
         deviceId: string;
         deviceSecret: string;
     };
-}, {
     token: string;
+}, {
     device: {
         deviceId: string;
         deviceSecret: string;
     };
+    token: string;
 }>;
 export type EmailSignInLinkRequest = z.infer<typeof emailSignInLinkRequestSchema>;
 export interface EmailSignInLinkResponse {
@@ -365,15 +365,15 @@ export declare function isSecondFactorRequired(result: SignInStepResult | EmailS
  * What a re-verification email code confirms. The code is bound to it: a code
  * asked for one change never authorises another, and the email names it.
  */
-export declare const REAUTH_ACTIONS: readonly ["change_password", "totp", "link_commons", "delete_account"];
+export declare const REAUTH_ACTIONS: readonly ["change_password", "totp", "link_commons", "delete_account", "credentials_manage"];
 export type ReauthAction = (typeof REAUTH_ACTIONS)[number];
 /** `POST /users/me/reauth/email` */
 export declare const reauthEmailStartRequestSchema: z.ZodObject<{
-    action: z.ZodEnum<["change_password", "totp", "link_commons", "delete_account"]>;
+    action: z.ZodEnum<["change_password", "totp", "link_commons", "delete_account", "credentials_manage"]>;
 }, "strict", z.ZodTypeAny, {
-    action: "change_password" | "totp" | "link_commons" | "delete_account";
+    action: "change_password" | "totp" | "link_commons" | "delete_account" | "credentials_manage";
 }, {
-    action: "change_password" | "totp" | "link_commons" | "delete_account";
+    action: "change_password" | "totp" | "link_commons" | "delete_account" | "credentials_manage";
 }>;
 export type ReauthEmailStartRequest = z.infer<typeof reauthEmailStartRequestSchema>;
 /**