@ellipsis-dev/sdk 0.38.0 → 0.43.0

package/schema/openapi.v1.json

@@ -13983,6 +13983,68 @@
         "title": "PatchAccountSettingsRequest",
         "type": "object"
       },
+      "PatchUserSettingsRequest": {
+        "additionalProperties": false,
+        "description": "Change the keys sent; every other key stays as it is.",
+        "properties": {
+          "web": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/PatchUserSettingsWeb"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "title": "PatchUserSettingsRequest",
+        "type": "object"
+      },
+      "PatchUserSettingsWeb": {
+        "additionalProperties": false,
+        "properties": {
+          "ui": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/PatchUserSettingsWebUi"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "title": "PatchUserSettingsWeb",
+        "type": "object"
+      },
+      "PatchUserSettingsWebUi": {
+        "additionalProperties": false,
+        "properties": {
+          "density": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/UiSize"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "font_size": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/UiSize"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "title": "PatchUserSettingsWebUi",
+        "type": "object"
+      },
       "PermissionsConfig-Input": {
         "additionalProperties": false,
         "description": "What the agent is allowed to touch, per credential the platform mints\ninto its session's environment. Distinct from `environment:`, which is\nwhere the agent runs; this is what it may do from there.\n\n`ellipsis` scopes the session's Ellipsis API token (`ELLIPSIS_API_TOKEN`,\nwhat the `ellipsis` CLI running inside the session authenticates with).\n`true` / the string `all` (the default) grant the full session token\nceiling \u2014 everything a session token can ever do. A map narrows it per\nresource (see `EllipsisPermissions`); the minted token carries\nthe intersection, so a config can only ever reduce access. `false` fails\nvalidation \u2014 an agent with no API token cannot report its own progress.\n\n`github` scopes the session's GitHub installation token (`GH_TOKEN`) \u2014\nsee `GithubPermissions`. GitHub enforces it at mint time.",
@@ -15737,6 +15799,11 @@
             "title": "Base Sha",
             "type": "string"
           },
+          "blocking": {
+            "description": "Blocking comments posted to GitHub.",
+            "title": "Blocking",
+            "type": "integer"
+          },
           "budget": {
             "description": "The reviewer sessions' spend budgets together, in millicents.",
             "title": "Budget",
@@ -15792,11 +15859,6 @@
             ],
             "title": "Finalized At"
           },
-          "findings": {
-            "description": "Comments the reviewers returned, posted to GitHub or not.",
-            "title": "Findings",
-            "type": "integer"
-          },
           "github_review_id": {
             "anyOf": [
               {
@@ -15818,6 +15880,11 @@
             "title": "Id",
             "type": "string"
           },
+          "non_blocking": {
+            "description": "Comments posted to GitHub that do not block.",
+            "title": "Non Blocking",
+            "type": "integer"
+          },
           "pull_request": {
             "anyOf": [
               {
@@ -15855,7 +15922,8 @@
           "base_sha",
           "head_sha",
           "status",
-          "findings",
+          "blocking",
+          "non_blocking",
           "created_at",
           "reviewers",
           "comments",
@@ -16208,6 +16276,11 @@
             "title": "Base Sha",
             "type": "string"
           },
+          "blocking": {
+            "description": "Blocking comments posted to GitHub.",
+            "title": "Blocking",
+            "type": "integer"
+          },
           "created_at": {
             "format": "date-time",
             "title": "Created At",
@@ -16247,11 +16320,6 @@
             ],
             "title": "Finalized At"
           },
-          "findings": {
-            "description": "Comments the reviewers returned, posted to GitHub or not.",
-            "title": "Findings",
-            "type": "integer"
-          },
           "github_review_id": {
             "anyOf": [
               {
@@ -16273,6 +16341,11 @@
             "title": "Id",
             "type": "string"
           },
+          "non_blocking": {
+            "description": "Comments posted to GitHub that do not block.",
+            "title": "Non Blocking",
+            "type": "integer"
+          },
           "pull_request": {
             "anyOf": [
               {
@@ -16299,7 +16372,8 @@
           "base_sha",
           "head_sha",
           "status",
-          "findings",
+          "blocking",
+          "non_blocking",
           "created_at"
         ],
         "title": "ReviewSummary",
@@ -19330,6 +19404,18 @@
       "SessionMessageImage": {
         "description": "One image on a message, metadata only. `index` is the N in the\n`[Image #N]` placeholder in the message body.",
         "properties": {
+          "id": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "description": "The image's ID. `GET /v1/sessions/{session_id}/images/{id}` returns its bytes. Null when the image can't be fetched.",
+            "title": "Id"
+          },
           "index": {
             "description": "1-based position: the N in `[Image #N]`.",
             "title": "Index",
@@ -21056,6 +21142,18 @@
         "title": "TokensInfo",
         "type": "object"
       },
+      "UiSize": {
+        "description": "A step on the dashboard's five-step scale, shared by every size setting.",
+        "enum": [
+          "xs",
+          "sm",
+          "md",
+          "lg",
+          "xl"
+        ],
+        "title": "UiSize",
+        "type": "string"
+      },
       "UninstallGithubAppRequest": {
         "properties": {
           "confirm_account_login": {
@@ -21255,17 +21353,35 @@
       },
       "UpdateSessionRequest": {
         "additionalProperties": false,
-        "description": "Set the session's archive state.",
+        "description": "Set the session's archive state, its summary, or both.",
         "properties": {
           "archived": {
+            "anyOf": [
+              {
+                "type": "boolean"
+              },
+              {
+                "type": "null"
+              }
+            ],
             "description": "True to archive the session; false to unarchive it.",
-            "title": "Archived",
-            "type": "boolean"
+            "title": "Archived"
+          },
+          "summary": {
+            "anyOf": [
+              {
+                "maxLength": 1000,
+                "minLength": 1,
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "description": "A name for the session. It becomes the summary with source `user`, and Ellipsis never replaces it with a generated one.",
+            "title": "Summary"
           }
         },
-        "required": [
-          "archived"
-        ],
         "title": "UpdateSessionRequest",
         "type": "object"
       },
@@ -21341,6 +21457,53 @@
         "title": "UserPlan",
         "type": "object"
       },
+      "UserSettings": {
+        "description": "One user's own settings.",
+        "properties": {
+          "web": {
+            "$ref": "#/components/schemas/UserSettingsWeb"
+          }
+        },
+        "required": [
+          "web"
+        ],
+        "title": "UserSettings",
+        "type": "object"
+      },
+      "UserSettingsWeb": {
+        "description": "Settings for the web dashboard.",
+        "properties": {
+          "ui": {
+            "$ref": "#/components/schemas/UserSettingsWebUi"
+          }
+        },
+        "required": [
+          "ui"
+        ],
+        "title": "UserSettingsWeb",
+        "type": "object"
+      },
+      "UserSettingsWebUi": {
+        "description": "How the web dashboard looks.",
+        "properties": {
+          "density": {
+            "$ref": "#/components/schemas/UiSize",
+            "default": "md",
+            "description": "How much padding the dashboard uses."
+          },
+          "font_size": {
+            "$ref": "#/components/schemas/UiSize",
+            "default": "md",
+            "description": "How large the dashboard's text is."
+          }
+        },
+        "required": [
+          "density",
+          "font_size"
+        ],
+        "title": "UserSettingsWebUi",
+        "type": "object"
+      },
       "UserTokenApi": {
         "description": "A user token as shown in listings -- never includes the secret.",
         "properties": {
@@ -31428,7 +31591,7 @@
         "x-ellipsis-sdk-method": "sessions.get"
       },
       "put": {
-        "description": "Archive or unarchive a session and return it.\n\nSet archived to true to record the current server time and the\nauthenticated GitHub user. API-key requests record no user.\nRepeated archive requests preserve the original time and user.\nArchiving stops the message in progress. An archived session takes\nno messages (409 `session_archived`), and a reply on the Slack\nthread, pull request, issue, or Linear issue it answers starts a\nnew session. A session is also archived when it closes and after\nthe account's `archive_inactive_sessions_days` without a message.\nWhen the account sets session log retention, the session's\nrecords, messages, and prompt are deleted that many days after it\nwas archived (`archived.deletes_at`). The session itself stays.\n\nSet archived to false to clear both fields and let the session\ntake messages again. 409 `session_superseded` when a newer session\nnow answers the same thread.\n\nChanges are delivered to session and session-list streams.",
+        "description": "Archive or unarchive a session, or set its summary, and return it.\n\nSet archived to true to record the current server time and the\nauthenticated GitHub user. API-key requests record no user.\nRepeated archive requests preserve the original time and user.\nArchiving stops the message in progress. An archived session takes\nno messages (409 `session_archived`), and a reply on the Slack\nthread, pull request, issue, or Linear issue it answers starts a\nnew session. A session is also archived when it closes and after\nthe account's `archive_inactive_sessions_days` without a message.\nWhen the account sets session log retention, the session's\nrecords, messages, and prompt are deleted that many days after it\nwas archived (`archived.deletes_at`). The session itself stays.\n\nSet archived to false to clear both fields and let the session\ntake messages again. 409 `session_superseded` when a newer session\nnow answers the same thread.\n\nSet summary to name the session. The summary's source becomes\n`user`, and Ellipsis never replaces it with a generated one. With\nboth fields, the archive change applies first, and a refused\narchive change leaves the summary as it was.\n\nChanges are delivered to session and session-list streams.",
         "operationId": "update_session",
         "parameters": [
           {
@@ -32874,6 +33037,400 @@
         "x-ellipsis-undocumented": true
       }
     },
+    "/v1/sessions/{session_id}/images/{id}": {
+      "get": {
+        "description": "Return an image sent with a message to the session.\n\nEach message lists its images, with their IDs, in `images`.",
+        "operationId": "get_session_image",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "session_id",
+            "required": true,
+            "schema": {
+              "title": "Session Id",
+              "type": "string"
+            }
+          },
+          {
+            "in": "path",
+            "name": "id",
+            "required": true,
+            "schema": {
+              "title": "Id",
+              "type": "string"
+            }
+          },
+          {
+            "in": "header",
+            "name": "user-agent",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "title": "User-Agent"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ImageAttachment"
+                }
+              }
+            },
+            "description": "Successful Response"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The bearer token is missing, invalid, or revoked."
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The credential may not perform this action, or the account is blocked."
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "No such session or image in your account."
+          },
+          "422": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            },
+            "description": "Validation Error"
+          }
+        },
+        "security": [
+          {
+            "HTTPBearer": []
+          }
+        ],
+        "summary": "Get Session Image",
+        "tags": [
+          "v1"
+        ],
+        "x-ellipsis-permissions": {
+          "constraints": [
+            {
+              "account_admin_fields": [],
+              "identity": null,
+              "sandbox_scope": null
+            }
+          ],
+          "description": "Required permissions: read:sessions.\nAPI key: Supported.\nCLI user token: Supported.\nSession token: Requires the ellipsis:api scope and the required grants in the token's permissions.ellipsis configuration.\nHigher permission levels include lower levels: read < write < delete.\nGrant match patterns can further restrict access to individual resources.",
+          "notes": [
+            "Higher permission levels include lower levels: read < write < delete.",
+            "Grant match patterns can further restrict access to individual resources."
+          ],
+          "required": [
+            {
+              "level": "read",
+              "resource": "sessions"
+            }
+          ],
+          "tokens": [
+            {
+              "available": true,
+              "conditions": [],
+              "kind": "api_key",
+              "label": "API key"
+            },
+            {
+              "available": true,
+              "conditions": [],
+              "kind": "user_token",
+              "label": "CLI user token"
+            },
+            {
+              "available": true,
+              "conditions": [
+                "Requires the ellipsis:api scope and the required grants in the token's permissions.ellipsis configuration."
+              ],
+              "kind": "sandbox_token",
+              "label": "Session token"
+            }
+          ]
+        },
+        "x-ellipsis-sdk-method": "sessions.image"
+      }
+    },
+    "/v1/user/settings": {
+      "get": {
+        "description": "Get the signed in user's own settings.",
+        "operationId": "get_user_settings",
+        "parameters": [
+          {
+            "in": "header",
+            "name": "user-agent",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "title": "User-Agent"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UserSettings"
+                }
+              }
+            },
+            "description": "Successful Response"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The bearer token is missing, invalid, or revoked."
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The credential may not perform this action, or the account is blocked."
+          },
+          "422": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            },
+            "description": "Validation Error"
+          }
+        },
+        "security": [
+          {
+            "HTTPBearer": []
+          }
+        ],
+        "summary": "Get User Settings",
+        "tags": [
+          "v1"
+        ],
+        "x-ellipsis-permissions": {
+          "constraints": [
+            {
+              "account_admin_fields": [],
+              "identity": "human",
+              "sandbox_scope": null
+            }
+          ],
+          "description": "Required permissions: read:user.\nAPI key: Requires a CLI user token.\nCLI user token: Supported.\nSession token: Not supported by session tokens, even with permissions.ellipsis enabled.\nHigher permission levels include lower levels: read < write < delete.",
+          "notes": [
+            "Higher permission levels include lower levels: read < write < delete."
+          ],
+          "required": [
+            {
+              "level": "read",
+              "resource": "user"
+            }
+          ],
+          "tokens": [
+            {
+              "available": false,
+              "conditions": [
+                "Requires a CLI user token."
+              ],
+              "kind": "api_key",
+              "label": "API key"
+            },
+            {
+              "available": true,
+              "conditions": [],
+              "kind": "user_token",
+              "label": "CLI user token"
+            },
+            {
+              "available": false,
+              "conditions": [
+                "Not supported by session tokens, even with permissions.ellipsis enabled."
+              ],
+              "kind": "sandbox_token",
+              "label": "Session token"
+            }
+          ]
+        },
+        "x-ellipsis-sdk-method": "user.settings.get",
+        "x-ellipsis-undocumented": true
+      },
+      "patch": {
+        "description": "Change the signed in user's own settings.\n\nOnly the keys sent change, and the response is every setting.",
+        "operationId": "patch_user_settings",
+        "parameters": [
+          {
+            "in": "header",
+            "name": "user-agent",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "title": "User-Agent"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/PatchUserSettingsRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UserSettings"
+                }
+              }
+            },
+            "description": "Successful Response"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The bearer token is missing, invalid, or revoked."
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The credential may not perform this action, or the account is blocked."
+          },
+          "422": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            },
+            "description": "Validation Error"
+          }
+        },
+        "security": [
+          {
+            "HTTPBearer": []
+          }
+        ],
+        "summary": "Patch User Settings",
+        "tags": [
+          "v1"
+        ],
+        "x-ellipsis-permissions": {
+          "constraints": [
+            {
+              "account_admin_fields": [],
+              "identity": "human",
+              "sandbox_scope": null
+            }
+          ],
+          "description": "Required permissions: write:user.\nAPI key: Requires a CLI user token.\nCLI user token: Supported.\nSession token: Not supported by session tokens, even with permissions.ellipsis enabled.\nHigher permission levels include lower levels: read < write < delete.",
+          "notes": [
+            "Higher permission levels include lower levels: read < write < delete."
+          ],
+          "required": [
+            {
+              "level": "write",
+              "resource": "user"
+            }
+          ],
+          "tokens": [
+            {
+              "available": false,
+              "conditions": [
+                "Requires a CLI user token."
+              ],
+              "kind": "api_key",
+              "label": "API key"
+            },
+            {
+              "available": true,
+              "conditions": [],
+              "kind": "user_token",
+              "label": "CLI user token"
+            },
+            {
+              "available": false,
+              "conditions": [
+                "Not supported by session tokens, even with permissions.ellipsis enabled."
+              ],
+              "kind": "sandbox_token",
+              "label": "Session token"
+            }
+          ]
+        },
+        "x-ellipsis-sdk-method": "user.settings.update",
+        "x-ellipsis-undocumented": true
+      }
+    },
     "/v1/user/tokens": {
       "get": {
         "operationId": "list_user_tokens",