@viceme-ai/sdk-poc 0.1.7-poc.1

package/dist/generated/public-contract.d.ts

@@ -0,0 +1,700 @@
+/**
+ * GENERATED FILE — DO NOT EDIT.
+ *
+ * Generated from contracts/public-capabilities.openapi.json
+ * (contractVersion 0.3.2, sha256 28f9b5cc1be61b33…)
+ * by scripts/generate-contracts.mjs. Regenerate with `pnpm contracts:generate`.
+ */
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/v1/public/v1/work-sessions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Establish a public visitor session for a Work
+         * @description Binds a short-lived capability token to the Work, the caller Origin, the enabled capability set, and an expiry. The workKey locates the Work; it is never an authorization credential. CORS accepts any browser Origin with credentials disabled; no creator-managed Origin allowlist is required.
+         */
+        post: operations["createWorkSession"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/public/v1/auth/wechat/authorize": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["authorizeWechat"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/public/v1/auth/exchange": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["exchangeWechatCode"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/public/v1/auth/phone/verification-codes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["sendPhoneVerificationCode"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/public/v1/auth/phone/login": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["loginWithPhoneVerificationCode"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/public/v1/auth/resume-codes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["createAuthResumeCode"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/public/v1/auth/resume": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["resumeAuthenticatedSession"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/public/v1/follow": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["getFollowState"];
+        put: operations["followWorkOwner"];
+        post?: never;
+        delete: operations["unfollowWorkOwner"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/public/v1/access/check": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["checkFeatureAccess"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/public/v1/checkout/sessions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["createCheckoutSession"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/public/v1/checkout/bootstrap": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["bootstrapEmbeddedCheckout"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /** @description Public opaque work key. */
+        WorkKey: string;
+        /** @description Enabled capability name for the work. */
+        CapabilityName: string;
+        CreateWorkSessionRequest: {
+            workKey: components["schemas"]["WorkKey"];
+        };
+        WorkDescriptor: {
+            key: components["schemas"]["WorkKey"];
+            capabilities: components["schemas"]["CapabilityName"][];
+        } & {
+            [key: string]: unknown;
+        };
+        /** @description Unknown additional fields are allowed and ignored by the SDK (forward compatibility). */
+        WorkSession: {
+            work: components["schemas"]["WorkDescriptor"];
+            /** @description Short-lived capability token; memory-only in the SDK. */
+            token?: string;
+            /** @description Epoch milliseconds when the token expires. */
+            expiresAt?: number;
+        } & {
+            [key: string]: unknown;
+        };
+        WorkUser: {
+            subject: string;
+            nickname: string | null;
+            /** Format: uri */
+            avatarUrl: string | null;
+        };
+        AuthAuthorizeRequest: {
+            codeChallenge: string;
+            channel: string;
+            /** @enum {string} */
+            clientType?: "h5" | "pc";
+        };
+        AuthAuthorizeResponse: {
+            /** Format: uri */
+            authorizationUrl: string;
+            /** Format: uri */
+            completionOrigin: string;
+        };
+        PhoneVerificationCodeRequest: {
+            phone: string;
+        };
+        PhoneLoginRequest: {
+            phone: string;
+            code: string;
+        };
+        VerificationCodeSentResponse: {
+            expiresInSeconds: number;
+            retryAfterSeconds: number;
+        };
+        AuthExchangeRequest: {
+            code: string;
+            codeVerifier: string;
+        };
+        AuthExchangeResponse: {
+            token: string;
+            expiresAt: number;
+            user: components["schemas"]["WorkUser"];
+        };
+        AuthResumeCodeResponse: {
+            code: string;
+            expiresAt: number;
+        };
+        AuthResumeRequest: {
+            code: string;
+        };
+        FollowState: {
+            following: boolean;
+            /** Format: date-time */
+            followedAt: string | null;
+            target: components["schemas"]["FollowTarget"];
+        };
+        FollowTarget: {
+            /** @enum {string} */
+            kind: "CREATOR" | "USER";
+            displayName: string;
+            /** Format: uri */
+            avatarUrl: string | null;
+            description: string | null;
+        };
+        AccessCheckRequest: {
+            featureKeys: string[];
+        };
+        AccessDecision: {
+            allowed: boolean;
+            /** @enum {string} */
+            reason: "OWNER" | "FOLLOWING" | "PURCHASED" | "AUTH_REQUIRED" | "FOLLOW_REQUIRED" | "PURCHASE_REQUIRED" | "FEATURE_NOT_FOUND" | "FEATURE_DISABLED" | "POLICY_UNSUPPORTED";
+            /** @enum {string|null} */
+            nextAction: "SIGN_IN" | "FOLLOW" | "CHECKOUT" | null;
+        };
+        AccessCheckResponse: {
+            decisions: {
+                [key: string]: components["schemas"]["AccessDecision"];
+            };
+        };
+        CheckoutRequest: {
+            /**
+             * @default zh-CN
+             * @enum {string}
+             */
+            locale: "zh-CN" | "en-US";
+            channel: string;
+        };
+        CheckoutResponse: {
+            /** Format: uri */
+            checkoutUrl: string;
+            alreadyOwned: boolean;
+            /** Format: uri */
+            completionOrigin: string;
+        };
+        CheckoutBootstrapRequest: {
+            code: string;
+        };
+        CheckoutBootstrapResponse: {
+            token: string;
+            /** Format: date-time */
+            expiresAt: string;
+            resumeCode: string;
+        };
+        ErrorBody: {
+            statusCode: number;
+            /** @enum {string} */
+            code: "CONFIG_INVALID" | "WORK_NOT_FOUND" | "CAPABILITY_DISABLED" | "SESSION_EXPIRED" | "AUTH_REQUIRED" | "SDK_AUTH_CODE_INVALID" | "RETURN_URL_NOT_ALLOWED" | "RATE_LIMITED" | "NETWORK_TIMEOUT" | "CHECKOUT_UNAVAILABLE" | "INTERNAL_ERROR";
+            message: string;
+            requestId: string;
+        };
+    };
+    responses: {
+        /** @description Public request rejected. */
+        PublicError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ErrorBody"];
+            };
+        };
+        /** @description Invalid configuration. */
+        ValidationError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ErrorBody"];
+            };
+        };
+        /** @description Unknown, private, or disabled work. */
+        WorkNotFound: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ErrorBody"];
+            };
+        };
+        /** @description Rate limit exceeded (retryable). */
+        RateLimited: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ErrorBody"];
+            };
+        };
+        /** @description Server error (retryable). */
+        InternalError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ErrorBody"];
+            };
+        };
+    };
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    createWorkSession: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateWorkSessionRequest"];
+            };
+        };
+        responses: {
+            /** @description Session established. */
+            201: {
+                headers: {
+                    /** @description Server request id for support correlation. */
+                    "x-request-id"?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["WorkSession"];
+                };
+            };
+            400: components["responses"]["ValidationError"];
+            404: components["responses"]["WorkNotFound"];
+            429: components["responses"]["RateLimited"];
+            "5xx": components["responses"]["InternalError"];
+        };
+    };
+    authorizeWechat: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AuthAuthorizeRequest"];
+            };
+        };
+        responses: {
+            /** @description Hosted WeChat authorization URL. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AuthAuthorizeResponse"];
+                };
+            };
+            "4xx": components["responses"]["PublicError"];
+            "5xx": components["responses"]["InternalError"];
+        };
+    };
+    exchangeWechatCode: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AuthExchangeRequest"];
+            };
+        };
+        responses: {
+            /** @description Authenticated work session. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AuthExchangeResponse"];
+                };
+            };
+            "4xx": components["responses"]["PublicError"];
+            "5xx": components["responses"]["InternalError"];
+        };
+    };
+    sendPhoneVerificationCode: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["PhoneVerificationCodeRequest"];
+            };
+        };
+        responses: {
+            /** @description Phone verification code sent. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["VerificationCodeSentResponse"];
+                };
+            };
+            "4xx": components["responses"]["PublicError"];
+            "5xx": components["responses"]["InternalError"];
+        };
+    };
+    loginWithPhoneVerificationCode: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["PhoneLoginRequest"];
+            };
+        };
+        responses: {
+            /** @description Authenticated work session. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AuthExchangeResponse"];
+                };
+            };
+            "4xx": components["responses"]["PublicError"];
+            "5xx": components["responses"]["InternalError"];
+        };
+    };
+    createAuthResumeCode: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Compatibility endpoint for restoring an authenticated work session. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AuthResumeCodeResponse"];
+                };
+            };
+            "4xx": components["responses"]["PublicError"];
+        };
+    };
+    resumeAuthenticatedSession: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AuthResumeRequest"];
+            };
+        };
+        responses: {
+            /** @description Restored authenticated work session. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AuthExchangeResponse"];
+                };
+            };
+            "4xx": components["responses"]["PublicError"];
+        };
+    };
+    getFollowState: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Current follow state. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["FollowState"];
+                };
+            };
+            "4xx": components["responses"]["PublicError"];
+        };
+    };
+    followWorkOwner: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Followed. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["FollowState"];
+                };
+            };
+            "4xx": components["responses"]["PublicError"];
+        };
+    };
+    unfollowWorkOwner: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Unfollowed. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["FollowState"];
+                };
+            };
+            "4xx": components["responses"]["PublicError"];
+        };
+    };
+    checkFeatureAccess: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AccessCheckRequest"];
+            };
+        };
+        responses: {
+            /** @description Access decisions. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AccessCheckResponse"];
+                };
+            };
+            "4xx": components["responses"]["PublicError"];
+        };
+    };
+    createCheckoutSession: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CheckoutRequest"];
+            };
+        };
+        responses: {
+            /** @description Embedded checkout URL resolved from the bound product. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CheckoutResponse"];
+                };
+            };
+            "4xx": components["responses"]["PublicError"];
+            "5xx": components["responses"]["InternalError"];
+        };
+    };
+    bootstrapEmbeddedCheckout: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CheckoutBootstrapRequest"];
+            };
+        };
+        responses: {
+            /** @description Memory-only bearer session for the embedded checkout. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CheckoutBootstrapResponse"];
+                };
+            };
+            "4xx": components["responses"]["PublicError"];
+        };
+    };
+}
+//# sourceMappingURL=public-contract.d.ts.map