@vrplatform/api 1.3.1-stage.4698 → 1.3.1-stage.4706

package/build/main/generated/v1.d.ts

@@ -1086,7 +1086,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** @description Exchange a single-use embedded bootstrap code for a short-lived session. */
+        /** @description Exchange a single-use embedded bootstrap code for a short-lived session. Successful responses use Cache-Control: no-store. */
         post: operations["exchangeEmbedSession"];
         delete?: never;
         options?: never;
@@ -2637,7 +2637,7 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * @description Create a one-time embedded-session bootstrap URL for a partner user.
+         * @description Create a one-time embedded-session bootstrap URL for a partner user. Successful responses use Cache-Control: no-store.
          *
          *     Required scope: embedded-sessions:issue
          */
@@ -2648,6 +2648,27 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/partner/embed-sessions/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * @description Revoke a pending bootstrap or active embedded session immediately.
+         *
+         *     Required scope: embedded-sessions:issue
+         */
+        delete: operations["revokeEmbedSession"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/partner/members": {
         parameters: {
             query?: never;
@@ -21335,6 +21356,7 @@ export interface operations {
         requestBody?: {
             content: {
                 "application/json": {
+                    /** @description One-time code from the embed URL fragment. */
                     code: string;
                 };
             };
@@ -21343,16 +21365,35 @@ export interface operations {
             /** @description Successful response */
             200: {
                 headers: {
+                    /** @description Prevents storage of the embedded bearer token. */
+                    "Cache-Control"?: "no-store";
                     [name: string]: unknown;
                 };
                 content: {
                     "application/json": {
+                        /** @description Short-lived embedded bearer token. */
                         accessToken: string;
+                        /** @description Embedded capability bundles granted to the session. */
                         bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1")[];
+                        /**
+                         * Format: date-time
+                         * @description Bearer-token expiration timestamp.
+                         */
                         expiresAt: string;
-                        /** Format: uuid */
+                        /**
+                         * Format: uuid
+                         * @description Session ID created by the partner backend.
+                         */
+                        sessionId: string;
+                        /**
+                         * Format: uuid
+                         * @description Team bound to the embedded session.
+                         */
                         teamId: string;
-                        /** Format: uuid */
+                        /**
+                         * Format: uuid
+                         * @description VRPlatform user bound to the session.
+                         */
                         userId: string;
                     };
                 };
@@ -42448,10 +42489,7 @@ export interface operations {
     };
     createEmbedSession: {
         parameters: {
-            query?: {
-                /** @description Create the embedded user and team membership on first use instead of failing when they do not exist. */
-                autoProvision?: boolean;
-            };
+            query?: never;
             header?: never;
             path?: never;
             cookie?: never;
@@ -42459,7 +42497,14 @@ export interface operations {
         requestBody?: {
             content: {
                 "application/json": {
+                    /**
+                     * @description Create the embedded user and team membership on first use instead of failing when they do not exist.
+                     * @default false
+                     */
+                    autoProvision?: boolean;
+                    /** @description Embedded capability bundles granted to the session. */
                     bundles: ("embed:exports:v1" | "embed:reports:v1" | "embed:statements:v1")[];
+                    /** @description Stable external user identifier in the partner system. */
                     sub: string;
                     /**
                      * Format: uuid
@@ -42475,16 +42520,41 @@ export interface operations {
             /** @description Successful response */
             200: {
                 headers: {
+                    /** @description Prevents storage of the bootstrap URL and one-time code. */
+                    "Cache-Control"?: "no-store";
                     [name: string]: unknown;
                 };
                 content: {
                     "application/json": {
-                        /** Format: uri */
+                        /**
+                         * Format: date-time
+                         * @description Deadline for exchanging the one-time bootstrap code.
+                         */
+                        bootstrapExpiresAt: string;
+                        /**
+                         * Format: uri
+                         * @description Ready-to-mount embedded application URL.
+                         */
                         embedUrl: string;
-                        expiresAt: string;
-                        /** Format: uuid */
+                        /**
+                         * Format: uuid
+                         * @description Session ID used for explicit revocation.
+                         */
+                        id: string;
+                        /**
+                         * @description Bearer-session lifetime, starting when the code is exchanged.
+                         * @constant
+                         */
+                        sessionTtlSeconds: 900;
+                        /**
+                         * Format: uuid
+                         * @description Team bound to the embedded session.
+                         */
                         teamId: string;
-                        /** Format: uuid */
+                        /**
+                         * Format: uuid
+                         * @description VRPlatform user bound to the session.
+                         */
                         userId: string;
                     };
                 };
@@ -42623,6 +42693,166 @@ export interface operations {
             };
         };
     };
+    revokeEmbedSession: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Session ID returned when the embed URL was issued. */
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** Format: uuid */
+                        id: string;
+                        /** @constant */
+                        status: "deleted";
+                    };
+                };
+            };
+            /** @description Bad request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Service unavailable */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+        };
+    };
     getPartnerMembers: {
         parameters: {
             query?: never;