@usestatemachines/sdk 0.8.0 → 0.9.0

package/openapi.json

@@ -153,6 +153,39 @@
         ],
         "type": "object"
       },
+      "BrowserCapability": {
+        "properties": {
+          "acceptsClients": {
+            "prefixItems": [
+              {
+                "pattern": "^[a-z0-9][a-z0-9.-]{0,63}$",
+                "type": "string"
+              }
+            ],
+            "type": "array"
+          },
+          "contract": {
+            "pattern": "^[a-z0-9][a-z0-9.-]{0,63}$",
+            "type": "string"
+          },
+          "documents": {
+            "prefixItems": [
+              {
+                "maxLength": 500,
+                "type": "string"
+              }
+            ],
+            "type": "array"
+          },
+          "entry": {
+            "maxLength": 500,
+            "minLength": 1,
+            "type": "string"
+          }
+        },
+        "required": ["contract", "acceptsClients", "documents", "entry"],
+        "type": "object"
+      },
       "CreateEnvironment": {
         "properties": {
           "apps": {
@@ -427,6 +460,25 @@
                 "appId": {
                   "type": "string"
                 },
+                "browserServices": {
+                  "items": {
+                    "properties": {
+                      "documents": {
+                        "items": {
+                          "type": "string"
+                        },
+                        "type": "array"
+                      },
+                      "id": {
+                        "pattern": "^[a-z][a-z0-9-]{0,39}$",
+                        "type": "string"
+                      }
+                    },
+                    "required": ["id", "documents"],
+                    "type": "object"
+                  },
+                  "type": "array"
+                },
                 "name": {
                   "pattern": "^[a-z][a-z0-9-]{0,39}$",
                   "type": "string"
@@ -584,6 +636,7 @@
                   "last_workspace",
                   "workspace_archived",
                   "version_in_use",
+                  "ui_disabled",
                   "body_too_large",
                   "version_unavailable",
                   "environment_limit_reached",
@@ -619,6 +672,41 @@
         "required": ["error"],
         "type": "object"
       },
+      "LaunchUiSession": {
+        "additionalProperties": false,
+        "properties": {
+          "actorId": {
+            "maxLength": 255,
+            "minLength": 1,
+            "type": "string"
+          },
+          "entryPath": {
+            "description": "The path the session opens first, with an optional query. It must match one of the service's document routes.",
+            "maxLength": 2048,
+            "type": "string"
+          },
+          "launcherOrigin": {
+            "description": "The exact origin of the page that posts the grant. The exchange refuses any other Origin, and an embedded session allows only this origin to frame it.",
+            "maxLength": 2048,
+            "type": "string"
+          },
+          "mode": {
+            "$ref": "#/components/schemas/UiSessionMode"
+          },
+          "serviceId": {
+            "pattern": "^[a-z][a-z0-9-]{0,39}$",
+            "type": "string"
+          }
+        },
+        "required": [
+          "serviceId",
+          "actorId",
+          "mode",
+          "launcherOrigin",
+          "entryPath"
+        ],
+        "type": "object"
+      },
       "McpServer": {
         "properties": {
           "name": {
@@ -1018,6 +1106,9 @@
       },
       "Service": {
         "properties": {
+          "browser": {
+            "$ref": "#/components/schemas/BrowserCapability"
+          },
           "description": {
             "type": "string"
           },
@@ -1186,6 +1277,93 @@
         "enum": ["saving", "ready", "failed", "deleted"],
         "type": "string"
       },
+      "UiSessionLaunch": {
+        "properties": {
+          "actorId": {
+            "type": "string"
+          },
+          "appName": {
+            "pattern": "^[a-z][a-z0-9-]{0,39}$",
+            "type": "string"
+          },
+          "entryPath": {
+            "type": "string"
+          },
+          "environmentId": {
+            "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$",
+            "type": "string"
+          },
+          "exchangeUrl": {
+            "type": "string"
+          },
+          "expiresAt": {
+            "format": "date-time",
+            "type": "string"
+          },
+          "grant": {
+            "type": "string"
+          },
+          "grantExpiresAt": {
+            "format": "date-time",
+            "type": "string"
+          },
+          "mode": {
+            "$ref": "#/components/schemas/UiSessionMode"
+          },
+          "origin": {
+            "type": "string"
+          },
+          "serviceId": {
+            "pattern": "^[a-z][a-z0-9-]{0,39}$",
+            "type": "string"
+          },
+          "sessionId": {
+            "pattern": "^uis_[0-9a-z]{26}$",
+            "type": "string"
+          }
+        },
+        "required": [
+          "sessionId",
+          "environmentId",
+          "appName",
+          "serviceId",
+          "actorId",
+          "mode",
+          "origin",
+          "exchangeUrl",
+          "grant",
+          "grantExpiresAt",
+          "expiresAt",
+          "entryPath"
+        ],
+        "type": "object"
+      },
+      "UiSessionMode": {
+        "enum": ["embedded", "page"],
+        "type": "string"
+      },
+      "UiSessionRevocation": {
+        "properties": {
+          "appName": {
+            "pattern": "^[a-z][a-z0-9-]{0,39}$",
+            "type": "string"
+          },
+          "environmentId": {
+            "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$",
+            "type": "string"
+          },
+          "revokedAt": {
+            "format": "date-time",
+            "type": "string"
+          },
+          "sessionId": {
+            "pattern": "^uis_[0-9a-z]{26}$",
+            "type": "string"
+          }
+        },
+        "required": ["sessionId", "environmentId", "appName", "revokedAt"],
+        "type": "object"
+      },
       "Version": {
         "properties": {
           "actors": {
@@ -2900,19 +3078,50 @@
         ]
       }
     },
-    "/v1/me": {
-      "get": {
-        "operationId": "getMe",
+    "/v1/environments/{environmentId}/apps/{appName}/ui-sessions": {
+      "post": {
+        "description": "Launches a browser session of one actor in an app's UI. The answer holds a one-use grant and no reusable credential. Return it only to the browser of the user it is for, which posts the grant to `exchangeUrl` from `launcherOrigin`.",
+        "operationId": "launchUiSession",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "environmentId",
+            "required": true,
+            "schema": {
+              "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$",
+              "type": "string"
+            }
+          },
+          {
+            "in": "path",
+            "name": "appName",
+            "required": true,
+            "schema": {
+              "pattern": "^[a-z][a-z0-9-]{0,39}$",
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/LaunchUiSession"
+              }
+            }
+          },
+          "required": true
+        },
         "responses": {
-          "200": {
+          "201": {
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Me"
+                  "$ref": "#/components/schemas/UiSessionLaunch"
                 }
               }
             },
-            "description": "The caller, its organization, permissions and limits"
+            "description": "A pending session and its one-use grant"
           },
           "400": {
             "content": {
@@ -3022,32 +3231,13 @@
         ]
       }
     },
-    "/v1/requests": {
-      "get": {
-        "operationId": "listRequests",
+    "/v1/environments/{environmentId}/apps/{appName}/ui-sessions/{sessionId}": {
+      "delete": {
+        "description": "Revokes a browser session that the caller's own credential launched. Revoking again answers the same result. Another credential's session is not found.",
+        "operationId": "revokeUiSession",
         "parameters": [
           {
-            "in": "query",
-            "name": "limit",
-            "required": false,
-            "schema": {
-              "default": 50,
-              "maximum": 100,
-              "minimum": 1,
-              "type": "integer"
-            }
-          },
-          {
-            "in": "query",
-            "name": "cursor",
-            "required": false,
-            "schema": {
-              "maxLength": 2048,
-              "type": "string"
-            }
-          },
-          {
-            "in": "query",
+            "in": "path",
             "name": "environmentId",
             "required": true,
             "schema": {
@@ -3056,67 +3246,360 @@
             }
           },
           {
-            "in": "query",
+            "in": "path",
             "name": "appName",
-            "required": false,
+            "required": true,
             "schema": {
               "pattern": "^[a-z][a-z0-9-]{0,39}$",
               "type": "string"
             }
           },
           {
-            "in": "query",
-            "name": "method",
-            "required": false,
+            "in": "path",
+            "name": "sessionId",
+            "required": true,
             "schema": {
-              "enum": [
-                "GET",
-                "HEAD",
-                "POST",
-                "PUT",
-                "PATCH",
-                "DELETE",
-                "OPTIONS",
-                "CONNECT",
-                "TRACE"
-              ],
+              "pattern": "^uis_[0-9a-z]{26}$",
               "type": "string"
             }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UiSessionRevocation"
+                }
+              }
+            },
+            "description": "The session is revoked"
           },
-          {
-            "in": "query",
-            "name": "responseStatus",
-            "required": false,
-            "schema": {
-              "maximum": 599,
-              "minimum": 100,
-              "type": "integer"
-            }
-          },
-          {
-            "in": "query",
-            "name": "statusClass",
-            "required": false,
-            "schema": {
-              "enum": ["2xx", "3xx", "4xx", "5xx"],
-              "type": "string"
-            }
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Invalid request"
           },
-          {
-            "in": "query",
-            "name": "writesOnly",
-            "required": false,
-            "schema": {
-              "type": "boolean"
-            }
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Authentication required"
           },
-          {
-            "in": "query",
-            "name": "service",
-            "required": false,
-            "schema": {
-              "pattern": "^[a-z][a-z0-9-]{0,39}$",
-              "type": "string"
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Permission denied"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Resource not found"
+          },
+          "409": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Conflicting request"
+          },
+          "413": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Request body too large"
+          },
+          "422": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Version unavailable"
+          },
+          "429": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Limit reached"
+          },
+          "500": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Unexpected failure"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Dependency unavailable"
+          }
+        },
+        "security": [
+          {
+            "bearerAuth": []
+          }
+        ]
+      }
+    },
+    "/v1/me": {
+      "get": {
+        "operationId": "getMe",
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Me"
+                }
+              }
+            },
+            "description": "The caller, its organization, permissions and limits"
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Invalid request"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Authentication required"
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Permission denied"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Resource not found"
+          },
+          "409": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Conflicting request"
+          },
+          "413": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Request body too large"
+          },
+          "422": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Version unavailable"
+          },
+          "429": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Limit reached"
+          },
+          "500": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Unexpected failure"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Dependency unavailable"
+          }
+        },
+        "security": [
+          {
+            "bearerAuth": []
+          }
+        ]
+      }
+    },
+    "/v1/requests": {
+      "get": {
+        "operationId": "listRequests",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "limit",
+            "required": false,
+            "schema": {
+              "default": 50,
+              "maximum": 100,
+              "minimum": 1,
+              "type": "integer"
+            }
+          },
+          {
+            "in": "query",
+            "name": "cursor",
+            "required": false,
+            "schema": {
+              "maxLength": 2048,
+              "type": "string"
+            }
+          },
+          {
+            "in": "query",
+            "name": "environmentId",
+            "required": true,
+            "schema": {
+              "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$",
+              "type": "string"
+            }
+          },
+          {
+            "in": "query",
+            "name": "appName",
+            "required": false,
+            "schema": {
+              "pattern": "^[a-z][a-z0-9-]{0,39}$",
+              "type": "string"
+            }
+          },
+          {
+            "in": "query",
+            "name": "method",
+            "required": false,
+            "schema": {
+              "enum": [
+                "GET",
+                "HEAD",
+                "POST",
+                "PUT",
+                "PATCH",
+                "DELETE",
+                "OPTIONS",
+                "CONNECT",
+                "TRACE"
+              ],
+              "type": "string"
+            }
+          },
+          {
+            "in": "query",
+            "name": "responseStatus",
+            "required": false,
+            "schema": {
+              "maximum": 599,
+              "minimum": 100,
+              "type": "integer"
+            }
+          },
+          {
+            "in": "query",
+            "name": "statusClass",
+            "required": false,
+            "schema": {
+              "enum": ["2xx", "3xx", "4xx", "5xx"],
+              "type": "string"
+            }
+          },
+          {
+            "in": "query",
+            "name": "writesOnly",
+            "required": false,
+            "schema": {
+              "type": "boolean"
+            }
+          },
+          {
+            "in": "query",
+            "name": "service",
+            "required": false,
+            "schema": {
+              "pattern": "^[a-z][a-z0-9-]{0,39}$",
+              "type": "string"
             }
           },
           {
@@ -3887,6 +4370,41 @@
               "maxItems": 4,
               "type": "array"
             }
+          },
+          {
+            "in": "query",
+            "name": "appId",
+            "required": false,
+            "schema": {
+              "items": {
+                "pattern": "^[a-z][a-z0-9-]{1,39}$",
+                "type": "string"
+              },
+              "maxItems": 20,
+              "type": "array"
+            }
+          },
+          {
+            "in": "query",
+            "name": "createdBy",
+            "required": false,
+            "schema": {
+              "items": {
+                "pattern": "^(user_[0-9A-Za-z]+|key_[0-9a-z]{16})$",
+                "type": "string"
+              },
+              "maxItems": 50,
+              "type": "array"
+            }
+          },
+          {
+            "in": "query",
+            "name": "search",
+            "required": false,
+            "schema": {
+              "maxLength": 120,
+              "type": "string"
+            }
           }
         ],
         "responses": {
@@ -4185,6 +4703,148 @@
         ]
       }
     },
+    "/v1/snapshots/creators": {
+      "get": {
+        "operationId": "listSnapshotCreators",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "workspaceId",
+            "required": false,
+            "schema": {
+              "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$",
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "properties": {
+                    "data": {
+                      "items": {
+                        "$ref": "#/components/schemas/Principal"
+                      },
+                      "type": "array"
+                    }
+                  },
+                  "required": ["data"],
+                  "type": "object"
+                }
+              }
+            },
+            "description": "Each principal that created a snapshot in the workspace, by name"
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Invalid request"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Authentication required"
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Permission denied"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Resource not found"
+          },
+          "409": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Conflicting request"
+          },
+          "413": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Request body too large"
+          },
+          "422": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Version unavailable"
+          },
+          "429": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Limit reached"
+          },
+          "500": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Unexpected failure"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Dependency unavailable"
+          }
+        },
+        "security": [
+          {
+            "bearerAuth": []
+          }
+        ]
+      }
+    },
     "/v1/snapshots/{snapshotId}": {
       "delete": {
         "operationId": "deleteSnapshot",