/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ export interface paths { "/api/test-runs": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List test runs * @description Returns a paginated list of test runs for the scoped project, with optional filtering by id, branch, state, result, environment, and time window. */ get: operations["listTestRuns"]; /** * Trigger a test run * @description Triggers a new end-to-end test run for the scoped project, optionally with a saved environment, resolving the branch/build and dispatching the run. */ put: operations["createTestRun"]; /** * ⚙️ Update a test run's state * @description Reports a run state transition from the run worker (looked up by run_id). Ingests the report summary on `ended`, applies the terminal-state guard, and fans out state-change effects. */ post: operations["updateTestRunState"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a test run * @description Retrieves a single test run by ID, including its project and per-test summary details. Access is derived from the run's project; inaccessible or unknown runs return 404. */ get: operations["getTestRun"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/{id}/artifacts": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List test run artifacts * @description Lists downloadable artifacts (traces, reports, screenshots, etc.) stored for a test run. Provide `key` for an exact lookup, or `prefix`/`suffix` to filter the listing. Returns an empty list when nothing matches. */ get: operations["listTestRunArtifacts"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/{id}/cancel": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Cancel a test run * @description Cancels an in-progress test run, recording an optional reason and the cancelling user. Returns 412 when the run is already in a terminal state. */ post: operations["cancelTestRun"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/{id}/re-run": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Re-run a test run * @description Re-triggers a test run from a source run's branch, build, and overrides. Optionally re-runs only the failed tests of a completed run. */ post: operations["rerunTestRun"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v1/test-runs/skip": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Skip a test run * @description Marks the Empirical check run on a commit as skipped. Callers authenticate with a project API key. */ post: operations["skipTestRun"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v2/test-runs/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get test run metadata * @description Returns Postgres-backed metadata for a test run. This endpoint does not read the run ledger or compose per-test results. */ get: operations["getTestRunV2"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/{id}/chat-sessions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List a test run's chat sessions * @description Every session linked to the run, most recently updated first, including closed ones. Each carries the tests it is scoped to. Only sessions created after links were introduced are returned. */ get: operations["listTestRunChatSessions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/{id}/ecs-task": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * ⚙️ Record a test run's ECS task id * @description Records the ECS task id assigned to a run (or one of its shards), keyed by the external run_id. */ patch: operations["updateTestRunEcsTask"]; trace?: never; }; "/api/test-runs/{id}/environment-variables": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get test run environment variables * @description Returns the resolved environment variables for a run (global, environment-specific, then run overrides), addressed by its external run_id. Used by the test-run-worker. */ get: operations["getTestRunEnvironmentVariables"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/{id}/linked-changes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ 🧪 Get linked test changes for a run * @description For a run triggered by an app pull request, evaluates the same-name test branch live on GitHub (the state behind the "Empirical linked test changes" check) and returns the latest check written for the PR. Addressed by the database id. Serves the dashboard UI. */ get: operations["getTestRunLinkedChanges"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/{id}/logs": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get test run logs * @description Returns CloudWatch logs for a run's ECS task, addressed by its database id. Optionally scoped to a single shard. Serves the dashboard UI. */ get: operations["getTestRunLogs"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/{id}/manifest-tests": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get test run manifest tests * @description Returns the per-shard manifest breakdown (scheduled tests, ran/pending) for a run, addressed by its database id. Serves the dashboard UI. */ get: operations["getTestRunManifestTests"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/{id}/run-manifest": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get test run manifest counts * @description Returns the interrupted-shard-adjusted scheduled counts for a run, addressed by its external run_id. Used by the test-run-worker. */ get: operations["getTestRunManifestCounts"]; put?: never; /** * ⚙️ Store a test run's run manifest * @description Stores the run manifest (scheduled tests) the run worker computed, keyed by the external run_id. */ post: operations["createTestRunManifest"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/{id}/shard-plan": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ 🧪 Store a test run's shard plan * @description Stores the partition of a run's test selection across its run_test shards, keyed by the external run_id. Each shard reads its own slice back from `/{id}/shards/{shard_index}/assigned-tests` to build a `--test-list`. Idempotent: the first plan for a run wins. */ post: operations["createTestRunShardPlan"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/{id}/shards": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List test run shards * @description Lists the shards for a run, addressed by its database id. Serves the dashboard UI. */ get: operations["listTestRunShards"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/{id}/shards/{shard_index}/assigned-tests": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ 🧪 Get test run shard assigned tests * @description Returns the duration-based shard plan's test-case ids for one shard, addressed by the run's external run_id. Used by the test-run-worker to build its `--test-list`. Returns 417 when the run has no plan, so the worker falls back to Playwright's `--shard=i/N` split. */ get: operations["getTestRunShardAssignedTests"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/{id}/shards/{shard_index}/resume": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get test run shard resume pointer * @description Returns the shard index a run_test shard resumes from, addressed by the run's external run_id. Used by the test-run-worker. */ get: operations["getTestRunShardResume"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/{id}/shards/{shard_index}/unrun-manifest": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get test run shard unrun manifest * @description Returns the gzip-compressed, newline-delimited list of unrun tests for a shard, addressed by the run's external run_id. Used by the test-run-worker; returns 417 when no manifest exists for the shard so the worker falls back. */ get: operations["getTestRunShardUnrunManifest"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/{id}/status": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get test run status * @description Returns the current state and key metadata for a run, addressed by its external run_id. Used by the test-run-worker and test-run package. */ get: operations["getTestRunStatus"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/{id}/stop-task": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Stop a test run's task * @description Sends SIGTERM to the run's ECS task (or a specific shard's task for sharded runs), stopping it via ECS StopTask or the local infra shim. */ post: operations["stopTestRunTask"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/{id}/test-case-durations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ 🧪 Get test case durations for shard planning * @description Returns the run's project's 7-day and last-day average duration per test case (skipped results excluded), keyed by the normalized 41-char Playwright test id, addressed by the run's external run_id. Used by the `run_setup` container to pack a shard plan: the analytics token is account-scoped and cannot be handed to a sandbox running customer test code, so the api-worker holds it and serves the numbers. Project-wide rather than per-run — the container filters to the tests it listed. A project with no history returns an empty object; a broken analytics query returns 503, so the container can tell the two apart and fall back rather than plan off nothing. */ get: operations["getTestRunTestCaseDurations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/{id}/triage-session": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get a test run's delegated triage session * @description Returns the newest delegated triage session whose source exactly matches the test run. Per-test fix sessions are excluded. */ get: operations["getTestRunTriageSession"]; put?: never; /** * ⚙️ Delegate a test run to triage * @description Creates the triage chat session for a test run and delivers its first message (awaited, so the 201 means the message landed). The session is stamped `purpose = "triage"` server-side for metering. Re-delegating creates a new session; the newest one is the run's live triage session. */ post: operations["createTestRunTriageSession"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/{id}/trigger-merge": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Trigger merge reports for a test run * @description Manually (re-)dispatches the merge-reports job for a sharded run whose shards have all completed. */ post: operations["triggerTestRunMerge"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/branch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List test run branches * @description Returns branch names with test runs in the last 30 days for the scoped project, newest first. */ get: operations["listTestRunBranches"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/history-chart": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Test run history chart * @description Returns per-run pass/fail/flaky aggregates for the scoped project over a time window, for charting. */ get: operations["getTestRunHistoryChart"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/summary-detail": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Test run summary detail * @description Returns per-test diagnosis details for a single run. Access is derived from the run's project; inaccessible or unknown runs return 404. */ get: operations["getTestRunSummaryDetail"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v2/test-cases": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List test cases * @description Returns a paginated list of the scoped project's test cases with optional filtering, along with the project's latest test-cases sync error. */ get: operations["listTestCases"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v2/test-cases/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a test case * @description Retrieves a single test case by its Playwright test ID. Access is derived from the test case's project, returning 403 when the caller cannot access it. */ get: operations["getTestCase"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update test case tags * @description Replaces the tags on a test case and attempts to update the source file. Access is derived from the test case's project, returning 403 when the caller cannot access it. */ patch: operations["updateTestCaseTags"]; trace?: never; }; "/api/v2/test-cases/tags": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List test case tags * @description Returns the distinct set of tags across the scoped project's active test cases (those present at the last synced commit; all synced test cases if the project has never synced). The response is a bare `{ tags }` object (no `data` envelope) and is cached for 5 minutes via a `Cache-Control` header. */ get: operations["listTestCaseTags"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v2/test-cases/playwright-projects": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List test case Playwright projects * @description Returns the distinct set of Playwright projects across the scoped project's active synced test cases. The response is a bare `{ playwright_projects }` object (no `data` envelope) and is cached for 5 minutes via a `Cache-Control` header. A Playwright project declared in `playwright.config.ts` but carrying no tests will not appear. */ get: operations["listTestCasePlaywrightProjects"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/environments": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create an environment * @description Creates an environment in the scoped project. Rejected for projects managed by environments.yaml. */ post: operations["createEnvironment"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/environments/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Delete an environment * @description Deletes an environment by ID and prunes environment-specific subscriptions. The project is derived from the entity. */ delete: operations["deleteEnvironment"]; options?: never; head?: never; /** * Update an environment * @description Updates an environment by ID. The project is derived from the entity. Returns the bare updated row (no `data` envelope), matching the dashboard settings UI it serves. */ patch: operations["updateEnvironment"]; trace?: never; }; "/api/environments/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List environments * @description Returns the scoped project's environments, optionally filtered by slug and disabled state. The run worker uses this to resolve env vars by slug. */ get: operations["listEnvironments"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/environments/sync": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Sync environments from YAML * @description Upserts the scoped project's environments from its environments.yaml file and flags the project as YAML-managed. */ post: operations["syncEnvironments"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/snoozes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List snoozes * @description Returns a paginated list of snoozes for the scoped project, with optional filtering by environment and status. */ get: operations["listSnoozes"]; put?: never; /** * Create a snooze * @description Creates a snooze to temporarily suppress failures for the given Playwright tests until `snooze_until`. */ post: operations["createSnooze"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/snoozes/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a snooze * @description Retrieves a single snooze by ID. */ get: operations["getSnooze"]; put?: never; post?: never; /** * Delete a snooze * @description Permanently deletes a snooze. */ delete: operations["deleteSnooze"]; options?: never; head?: never; /** * Update a snooze * @description Updates a snooze — extend it, change its tests/description, or expire it immediately with `expire_now`. */ patch: operations["updateSnooze"]; trace?: never; }; "/api/snoozes/{id}/add-test-cases": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Add tests to a snooze * @description Adds Playwright tests to an existing snooze. */ post: operations["addSnoozeTestCases"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v1/analytics/test-cases": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Test-case analytics with history * @deprecated * @description Returns aggregated test-case metrics including per-test execution history. The v2 endpoint omits history. */ get: operations["listTestCasesAnalyticsV1"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v1/analytics/test-count": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Test-count analytics * @deprecated * @description Returns the number of distinct test cases run per day for the scoped project. */ get: operations["getTestCountAnalyticsV1"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v1/analytics/test-runs": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Test-run analytics * @deprecated * @description Returns daily test-run statistics and a period summary for the scoped project. */ get: operations["listTestRunsAnalyticsV1"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v2/analytics/test-case-history/batch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Test-case execution history (batch) * @description Returns per-test-case execution history for the requested test cases, plus echoed query metadata. */ post: operations["getTestCaseHistoryBatch"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v2/analytics/test-case-last-pass-per-env": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Last passing run per environment * @description Returns the most recent passing run for a test case, grouped by environment. */ post: operations["getTestCaseLastPassPerEnv"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v2/analytics/test-cases": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Test-case analytics * @description Returns aggregated test-case metrics for the scoped project (without per-test history). */ get: operations["listTestCasesAnalyticsV2"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v2/analytics/test-count": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Test-count analytics * @description Returns the number of distinct test cases run per day for the scoped project. */ get: operations["getTestCountAnalyticsV2"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v2/analytics/test-runs": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Test-run analytics * @description Returns daily test-run statistics and a period summary for the scoped project. */ get: operations["listTestRunsAnalyticsV2"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/slack/admin/scope-refresh": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🛡️ Complete a Slack scope refresh * @description Exchanges the OAuth code from re-authorizing the Slack app on Empirical's own workspace, which applies newly requested scopes. The token is not stored. Super-admin only. */ post: operations["refreshSlackAppScopes"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/slack/auth-test": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Test the project's Slack token * @description Runs Slack auth.test using the scoped project's org Slack token to verify it is configured. */ post: operations["slackAuthTest"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/slack/installations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List Slack installs by org * @description Lists Slack app installs for an organisation. */ get: operations["listSlackInstallations"]; put?: never; /** * 🛡️ Create or update a Slack install * @description Creates a Slack app install for the org and team, or updates the existing one. A signed-in user sends the OAuth code and api-worker exchanges it; installs into Empirical's own workspace are not stored. */ post: operations["upsertSlackInstallation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/slack/installations/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get a Slack install * @description Retrieves a single Slack app install by ID. */ get: operations["getSlackInstallation"]; put?: never; post?: never; /** * ⚙️ Delete a Slack install * @description Deletes a Slack app install by ID. */ delete: operations["deleteSlackInstallation"]; options?: never; head?: never; /** * 🛡️ Update a Slack install * @description Updates fields on an existing Slack app install. */ patch: operations["updateSlackInstallation"]; trace?: never; }; "/api/slack/installations/by-team": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ List Slack installs by team * @description Lists Slack app installs for a Slack workspace (team). */ get: operations["listSlackInstallationsByTeam"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/slack/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Slack events webhook * @description Receives Slack Events API payloads directly from Slack (verified by the Slack request signature): answers the url_verification handshake and dispatches app mentions and thread replies. */ post: operations["slackEventsWebhook"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/slack/interactions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Slack interactions webhook * @description Receives Slack interactive payloads (block actions and view submissions) directly from Slack (verified by the Slack request signature). Responses are returned verbatim to Slack. */ post: operations["slackInteractionsWebhook"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/slack/files/{file_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🤖 Get Slack file metadata * @description Returns metadata for a Slack file accessible to the current sandbox-delegated chat session (private URLs stripped). */ get: operations["getSlackFileMetadata"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/slack/files/{file_id}/content": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🤖 Download Slack file content * @description Streams the content of a Slack file accessible to the current sandbox-delegated chat session. */ get: operations["getSlackFileContent"]; put?: never; post?: never; delete?: never; options?: never; /** * 🤖 Slack file content headers * @description Returns the content headers (type, disposition, length) for a Slack file without its body. */ head: operations["headSlackFileContent"]; patch?: never; trace?: never; }; "/api/slack/messages": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🤖 Post a Slack message * @description Posts Markdown to a Slack channel/thread, or a recipient-addressed DM, as the Empirical bot. Provide exactly one of channel, slack_user_id, or user_id. Recipient sends create a new DM root and require idempotency_key. Channel-wide mentions (, , ) are rejected; tag a subteam or users instead. Channel sends use the channel and root timestamp coordinates the agent was given. Sandbox-delegated principals only; the channel must be one the calling project can reach. Registered-root replies are recorded and de-duplicated by idempotency key for the sending session. New roots are registered and bound to the sending session after posting; if delivery or registration is uncertain, check Slack before retrying. */ post: operations["slackSendMessage"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/slack/messages/{channel}/{ts}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * 🤖 Delete a Slack message * @description Deletes a message the calling project's agent posted with POST /api/slack/messages. Deleting a thread root leaves its replies in place under Slack's deleted-message placeholder. Sandbox-delegated principals only. */ delete: operations["slackDeleteMessage"]; options?: never; head?: never; /** * 🤖 Edit a Slack message * @description Replaces the Markdown and buttons of a message the calling project's agent posted with POST /api/slack/messages. Messages whose input buttons were already selected cannot be edited. Channel-wide mentions are rejected. Sandbox-delegated principals only. */ patch: operations["slackUpdateMessage"]; trace?: never; }; "/api/slack/proxy": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🤖 Proxy a read-only Slack API request * @description Calls a read-only Slack Web API method with the workspace token and returns the response verbatim. Sandbox-delegated principals only; the `channel` or `file` argument must resolve to a channel the calling project can read. */ post: operations["slackProxy"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/slack/reactions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🤖 React to a Slack message * @description Adds or removes an emoji reaction on a Slack message, as the Empirical bot. Sandbox-delegated principals only; the message must live in a channel the calling project can read. Idempotent — re-adding an existing reaction succeeds. */ post: operations["slackReaction"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/slack/threads": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🤖 List registered Slack threads * @description Returns the Slack roots known to the scoped project's thread registry. Live threads are returned by default. Legacy roots created before registry adoption may be absent. */ get: operations["listSlackThreads"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/slack/threads/{id}/entity-links": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🤖 Link a Slack thread to an entity * @description Associates a registered Slack thread with a test run or failure group in the scoped project, so `GET /api/slack/threads?entity_type=&entity_id=` finds it. Idempotent: relinking returns the existing link, and only `is_canonical: true` changes its canonical flag. */ post: operations["createSlackThreadEntityLink"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/slack/threads/{id}/entity-links/{link_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * 🤖 Unlink a Slack thread from an entity * @description Removes an agent- or user-created entity link. System links (test-run notifications) cannot be removed. */ delete: operations["deleteSlackThreadEntityLink"]; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v2/slack/channels": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🤖 🧪 List canonical Slack channels * @description Lists active Slack channels registered for the scoped project's organization. Reporter configuration is intentionally not part of this resource. */ get: operations["listSlackChannelsV2"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v2/slack/channels/{id}/refresh": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🤖 🧪 Refresh a canonical Slack channel's name * @description Re-reads the channel from Slack and stores its current name when it changed. The canonical channel ID is stable, so environment reporter configs are unaffected. Access problems are reported in the validation result rather than as an error. */ post: operations["refreshSlackChannelV2"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v2/slack/channels/validate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🤖 🧪 Validate canonical Slack channels * @description Checks every active channel registered for the scoped project's organization against Slack. Validation is read-only and verifies bot access and the stored channel name. */ get: operations["validateSlackChannelsV2"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/slack/teams": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List Slack workspaces * @description Lists the Slack workspaces available to the scoped project: the shared default Empirical workspace plus any org-specific app installs. */ get: operations["listSlackTeams"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/slack/threads/{id}/preview": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Preview a registered Slack thread * @description Fetches a compact, on-demand preview of a Slack thread registered to the scoped project. */ get: operations["previewSlackThread"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/badges/projects/{project_slug}/environments/{environment_slug}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get an environment status badge * @description Renders an SVG status badge (passing/failing/running/etc.) for the latest test run of a project environment. Served unauthenticated for embedding in READMEs. */ get: operations["getEnvironmentBadge"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/failure-groups": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List failure groups * @description Returns a paginated list of failure groups for the scoped project, newest sighting first. Use this to match a failure against an existing group before creating a new one. */ get: operations["listFailureGroups"]; put?: never; /** * Create a failure group * @description Creates a durable failure group for a new failure mode. Labels are unique per project: if the label already exists the request fails with 409 and returns the existing group unchanged — inspect it (note its status) and either reuse it via PATCH/attach or create under a different label. */ post: operations["createFailureGroup"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/failure-groups/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a failure group * @description Retrieves a single failure group. Its members are served by `GET /api/failure-groups/{id}/members`. */ get: operations["getFailureGroup"]; put?: never; post?: never; /** * Delete a failure group * @description Deletes a failure group and its members. Its edit-history revisions survive. */ delete: operations["deleteFailureGroup"]; options?: never; head?: never; /** * Update a failure group * @description Updates a group's authored fields. `fingerprint`, when present, replaces the stored one; omit it to keep it. Latest write wins. Renaming to a label another group holds fails with 409 and returns that group — if the two are the same failure mode, merge them instead. */ patch: operations["updateFailureGroup"]; trace?: never; }; "/api/failure-groups/{id}/activity": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a failure group's activity * @description Returns the group's activity timeline (newest first): creation, authored edits, status changes, merges, member joins, repeat sightings, and removals. Derived from the revision trail and the membership-event log. */ get: operations["getFailureGroupActivity"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/failure-groups/{id}/members": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List a failure group's members * @description Returns the group's members (one entry per test, newest sighting first), derived from the membership-event log: state, provenance of the latest attach, first/last sighting, sighting count and environments. */ get: operations["listFailureGroupMembers"]; put?: never; /** * Attach a failing test to a failure group * @description Records that a run's failing test belongs to this group, refreshing the group's last-seen rollups, and returns the derived member entry. Idempotent: re-attaching an existing member refreshes its sighting (the entry's sighting_count and last_seen reflect it). An agent attach will not resurrect a membership a human detached. */ post: operations["attachFailureGroupMember"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/failure-groups/{id}/merge": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Merge a failure group into another * @description Moves this group's members into the target, unions fingerprints, and deletes this group. Returns the target. */ post: operations["mergeFailureGroup"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/failure-groups/members": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List a run's failure-group members * @description Returns one entry per failed test in the run that is attached to a failure group, with the group's content hydrated. Read from the canonical membership-event log; when several sources attached the same test, human wins over agent over machine. Dedupe on group_id for the run's distinct groups. */ get: operations["listFailureGroupMembersByTestRun"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/files": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List files * @description Returns the project's files, newest first. */ get: operations["listFiles"]; put?: never; /** * Create a file * @description Registers a file and returns its link plus a presigned `upload_url`. PUT the file body to `upload_url` with the same `Content-Type` as `mime_type`; the link serves the file once the upload finishes. */ post: operations["createFile"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/files/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a file * @description Returns one of the project's files by ID. */ get: operations["getFile"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Confirm a file upload * @description Marks a file `uploaded` after its body was PUT to `upload_url`. Checks the content is in storage and records its size. Safe to repeat. */ patch: operations["updateFile"]; trace?: never; }; "/api/reporters": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List reporters * @description Lists the reporters a reporter config can name for the scoped project, with whether each can post: the organization's registered Slack channels, the GitHub check and PR comment with the repositories the GitHub Reporter app covers, the email report, and the run-only Slack DM to whoever starts the run (whose status depends on the caller). Use the Slack channel ids and repositories here when setting an environment's `reporter_config` or a run's `reporters`. */ get: operations["listReporters"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/resources": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List resources * @deprecated * @description Returns a paginated list of uploaded resources for the project. */ get: operations["listProjectResources"]; put?: never; /** * Create a resource * @deprecated * @description Creates a resource. With `url`, creates a link-type file; otherwise creates a pending upload and returns a signed `upload_url` to stream the file into R2. */ post: operations["createProjectResource"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/resources/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a resource * @deprecated * @description Retrieves a single resource by ID, with a fresh download URL. */ get: operations["getProjectResource"]; put?: never; post?: never; /** * Delete a resource * @deprecated * @description Deletes a resource, removing its R2 object and stopping any active Drive watch. */ delete: operations["deleteProjectResource"]; options?: never; head?: never; /** * Update a resource * @deprecated * @description Updates a resource's name/description, or confirms a pending upload with `status: "uploaded"`. */ patch: operations["updateProjectResource"]; trace?: never; }; "/api/resources/{id}/content": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Download resource content * @deprecated * @description Streams an uploaded resource's content from R2. Authorized by the signed capability URL (HMAC in the query string), not bearer auth. */ get: operations["downloadResourceContent"]; /** * Upload resource content * @deprecated * @description Streams the request body into R2 for a pending resource. Authorized by the signed capability URL (HMAC in the query string), not bearer auth. */ put: operations["uploadResourceContent"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/infra/static-ips": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🧪 Get static egress IPs for a region * @description Returns the proxy endpoint and the egress IPs to allowlist for the given region. */ get: operations["getStaticIps"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/tasks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🧪 List tasks * @description Returns a paginated list of tasks for the scoped project. */ get: operations["listTasks"]; put?: never; /** * 🧪 Create a task * @description Creates a task for the scoped project. Every task is owed to a person: `created_by` defaults to the signed-in user or, for an agent, the person who started its session. An agent acting for someone else, such as the person who asked in Slack, passes their user ID as `created_by`. Track your own follow-ups elsewhere; a task with no person behind it is rejected. It does not start a chat session; use `POST /api/tasks/{id}/chat-sessions` for that. */ post: operations["createTask"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/tasks/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🧪 Get a task * @description Retrieves a single task by ID. */ get: operations["getTask"]; put?: never; post?: never; /** * 🧪 Delete a task * @description Permanently deletes a task. */ delete: operations["deleteTask"]; options?: never; head?: never; /** * 🧪 Update a task * @description Updates a task's title, description, or status. A draft → open transition spawns a chat session. */ patch: operations["updateTask"]; trace?: never; }; "/api/v1/telemetry/overlay-dismissals": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🧪 Overlay-dismissal summary * @description Returns aggregated overlay-dismissal metrics for the scoped project. */ get: operations["getOverlayDismissalSummary"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v1/telemetry/overlay-dismissals/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🧪 Overlay-dismissal events * @description Returns a paginated, filterable list of overlay-dismissal events for the scoped project. */ get: operations["getOverlayDismissalEvents"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v2/test-runs/{id}/cases": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🧪 List test run cases * @description Returns a paginated list of every case in a test run — passed, failed, flaky, and skipped — sourced from the run ledger. The project is derived from the run. */ get: operations["listTestRunCases"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v2/test-runs/{id}/cases/{case_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🧪 Get a test run case * @description Retrieves a single case in a test run by its Playwright test ID. The project is derived from the run. */ get: operations["getTestRunCase"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/alarms": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** 🤖 List a session's alarms */ get: operations["listChatSessionAlarms"]; put?: never; /** * 🤖 Create a session alarm * @description Creates a relative-delay, absolute-time, or recurring UTC alarm owned by the chat session. */ post: operations["createChatSessionAlarm"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/alarms/{alarm_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** 🤖 Delete a session alarm */ delete: operations["deleteChatSessionAlarm"]; options?: never; head?: never; /** 🤖 Update a session alarm */ patch: operations["updateChatSessionAlarm"]; trace?: never; }; "/api/chat-sessions/{id}/session-state": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🤖 Get a session's initial state * @description Returns a session's recent log entries, user messages, and current sandbox state, read from pi-worker over the service binding. */ get: operations["getChatSessionState"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/triggers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🤖 🧪 List a session's event triggers * @description Lists active event triggers owned by this chat session. One-shot triggers are consumed after they fire; recurring wildcard triggers remain active. */ get: operations["listChatSessionTriggers"]; put?: never; /** * 🤖 🧪 Create an event trigger * @description Creates a trigger that resumes this session after the selected event occurs. Supply entity_id for an exact one-shot trigger, or omit it to match every entity; wildcard triggers may use recurring cardinality. Optional payload_filter fields must be allowed by the event catalog. Registration is edge-only and does not match historical events, so an exact trigger on a test run that already finished is rejected with 409. */ post: operations["createChatSessionTrigger"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/triggers/{trigger_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** 🤖 🧪 Get an event trigger */ get: operations["getChatSessionTrigger"]; put?: never; post?: never; /** 🤖 🧪 Delete an event trigger */ delete: operations["deleteChatSessionTrigger"]; options?: never; head?: never; /** 🤖 🧪 Update an event trigger */ patch: operations["updateChatSessionTrigger"]; trace?: never; }; "/api/failure-groups/{id}/matcher-overlap": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🤖 Check a matcher against other groups' members * @description Runs a candidate matcher source for this group against the 2 most recently seen active members of every other open group in the project (round-robin, at most 40 cases) and reports the ones it returns true for. A claim means the matcher overlaps that group. Nothing is persisted. */ post: operations["checkFailureGroupMatcherOverlap"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/failure-groups/{id}/members/{test_case_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * 🤖 Detach a test from a failure group * @description Records that this test does not belong to the group. Detaching as an agent is a correction the agent may undo by attaching again. A human detach is sticky: agent attaches will not re-attach the test; only a later human attach supersedes it. */ delete: operations["detachFailureGroupMember"]; options?: never; head?: never; patch?: never; trace?: never; }; "/api/failure-groups/match": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🤖 Run failure-group matchers against a case * @description Runs every open group's matcher (or the given group_ids, or one dry-run source) against a failed or flaky case and reports which returned true. Nothing is persisted: attach the case with POST /{id}/members. Matchers run in an isolated Worker with network limited to report storage, under a per-matcher time limit and the isolate's memory and CPU limits. */ post: operations["matchFailureGroups"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/pr/convert-to-draft": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🤖 Convert a pull request to draft * @description Converts an open pull request to a draft, so it cannot be merged until it is marked ready for review. */ post: operations["convertPullRequestToDraft"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/pr/ready-for-review": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🤖 Mark a pull request ready for review * @description Converts an open draft pull request to ready for review. */ post: operations["markPullRequestReadyForReview"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/proxy": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🤖 Proxy a GitHub API request * @description Forwards an authenticated request to the GitHub API and returns the GitHub response verbatim. The request's project (bound token, or the `x-project-id`/`x-project-slug` header) picks the GitHub App: its own repo goes through the main App; another repo the project's org installed the reporter App on is read through the reporter App, and writes to it are rejected. Without a project, the main App is used. Merging a pull request with `merge_method` `squash` or `rebase` is rejected; only merge commits are allowed, and creating a draft pull request is rejected. Other writes to a project's default or protected branches are refused, as git-worker refuses the equivalent push. Project API keys are read-only. Sandbox-delegation principals are additionally constrained by per-session proxy rules. */ post: operations["githubProxy"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/gsheet/metadata": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🤖 Get spreadsheet metadata * @description Returns the title of a Google spreadsheet and the access level the service account has on it. */ get: operations["getGsheetMetadata"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/gsheet/proxy": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🤖 Proxy a Google API request * @description Forwards an authenticated request to an allowed Google API origin using the service account's credentials and returns the JSON response. */ post: operations["proxyGsheetRequest"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/playwright-versions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🤖 List supported Playwright versions * @description Returns the static list of supported Playwright versions and the default version. Public read — no authentication required. */ get: operations["listPlaywrightVersions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/traces/compare": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🤖 🧪 Compare a failed attempt with a passing one, step by step * @description Aligns the steps of a case's failed attempt with a passing attempt of the same test (the dashboard's Compare tab) and returns where they diverge: the step it failed on, steps that ran only on one side, steps that got much slower, and optionally the page as each side left that step. */ post: operations["compareTraceAgainstPass"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/traces/query": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🤖 Run a trace-utils function on a case's trace * @description Calls one trace-utils function on the trace of a run's case (by default its last attempt with a trace) and returns the result. The trace is read in an isolated Worker with ranged reads; nothing is downloaded or stored. */ post: operations["queryTrace"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/triage-statuses": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🤖 List a run's triage statuses * @description Returns one entry per failing test the agent has triaged (or is triaging) in the run, most recently updated first. */ get: operations["listTriageStatuses"]; put?: never; /** * 🤖 Upsert a triage status * @description Creates or updates the triage status for one failing test in a run, keyed by (test_run_id, pw_test_id) — latest write wins. Requires sandbox authentication; the owning chat session comes from the access token. An omitted `group_id` keeps the stored value. */ post: operations["upsertTriageStatus"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/users": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🤖 Search users * @description Searches users in the resolved project's organization, plus super admins, by name or email. The project is resolved from sandbox/project-api-key auth, x-project-id/x-project-slug, or single-project inference. */ get: operations["listUsers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/users/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🤖 Get a user * @description Returns a user's details along with their valid linked Slack and GitHub accounts. */ get: operations["getUser"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/activity": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ 🧪 List project activity * @description The scoped project's activity grouped by local day, newest first. Each day has a summary of its test runs and a list of sessions, pull requests, tasks and failure groups. A session appears once, at its latest state, with its pull request folded in. */ get: operations["listActivity"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/alarms": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Schedule a wake-up for the calling session (deprecated) * @deprecated * @description Deprecated compatibility endpoint for already-running agents. Use `POST /api/chat-sessions/{id}/alarms`. Schedules a one-time wake-up for the caller's own chat session, `delay` from now. */ post: operations["createAlarm"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/api-keys": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List API keys * @description Returns the scoped project's API keys, with secrets truncated to a preview. */ get: operations["listApiKeys"]; /** * Create an API key * @description Creates a new API key for the scoped project. The full secret is returned once in the response and cannot be retrieved again. */ put: operations["createApiKey"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/api-keys/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Delete an API key * @description Permanently deletes an API key. The project is derived from the key itself. */ delete: operations["deleteApiKey"]; options?: never; head?: never; /** * Enable or disable an API key * @description Enables or disables an API key. The project is derived from the key itself. */ patch: operations["updateApiKey"]; trace?: never; }; "/api/banners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ List the dashboard's warning banners * @description The warnings shown at the top of the dashboard for the scoped project's org (unpaid invoices, failed renewal, usage limit, no plan, Jira and Slack reconnects). Reads stored state only, so it is cheap enough to call while server-rendering a page. */ get: operations["listDashboardBanners"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/billing/month-summary": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ Get the org's usage and cost for a usage period * @description Org-wide usage across all of the scoped project's org projects, against the plan in effect: per-meter usage, overage so far, a period-end projection, and the usage limit. The period is a UTC calendar month, or the billing cycle for an org on a live Dodo subscription. */ get: operations["getBillingMonthSummary"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/billing/periods": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ List the org's usage periods * @description The org's usage periods up to the current one, latest first: billing cycles back to the subscription start for an org on a live Dodo subscription, calendar months otherwise and before that. */ get: operations["listBillingPeriods"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/billing/subscription/{subscription_id}/reconcile": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ 🧪 Compare a subscription's usage with Dodo's events * @description Compares our usage rows with the usage events Dodo has for the subscription's customer in one billing cycle, matched by event id: per-meter totals, plus events missing from Dodo, Dodo events with no usage row, and events whose quantity changed. Read-only; sends nothing. Defaults to the current cycle; a past cycle is named by its end (its renewal date) and starts a month earlier unless cycle_start is given. */ get: operations["reconcileSubscriptionUsage"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/billing/subscription/checkout": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🛡️ 🧪 Start a Dodo checkout for the org's plan * @description Creates a Dodo hosted checkout that subscribes the scoped project's org to the current Dodo plan (the newest active shared plan with a Dodo product). For orgs without a plan that are not billed in INR. The plan takes effect when Dodo confirms the subscription by webhook. */ post: operations["createSubscriptionCheckout"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/billing/subscription/end": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🛡️ 🧪 End the org's plan now * @description Ends the scoped project's org's Dodo subscription now, with no undo: sends Dodo the usage it is missing, then cancels the subscription, or pauses it when the cycle has usage beyond the plan's allowance (Dodo charges it on pausing; a cron cancels the subscription once that charge succeeds). The plan ends at once, and the org can subscribe again. Emails the org's members and billing contacts. For an active or past-due subscription; an on-hold one must pay first. */ post: operations["endSubscription"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/billing/subscription/offer": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ 🧪 Get the plan the org can subscribe to * @description Whether the scoped project's org can start a Dodo checkout now (same rules as the checkout endpoint), and the plan's terms if so. The billing page uses it to show its Continue to payment button. */ get: operations["getSubscriptionOffer"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/billing/subscription/portal": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🛡️ 🧪 Open the org's Dodo billing portal * @description Creates a Dodo customer portal session for the scoped project's org, where the customer updates their card and downloads Dodo's invoices. A new session per call; nothing is stored. For orgs that have subscribed through Dodo. */ post: operations["createSubscriptionPortalSession"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/billing/usage-limit": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * 🛡️ Set or remove the org's usage limit * @description Sets the most overage the org allows per usage month, in whole dollars as cents, or removes the limit with null. Takes effect right away: a limit at or below this month's overage pauses new work. */ put: operations["setUsageLimit"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/billing/usage-limit/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ List the usage limit's history * @description Changes to the org's usage limit and the alerts and blocks it caused, newest first. */ get: operations["listUsageLimitEvents"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List chat sessions * @description Returns a page of chat sessions in scope, each enriched with the creator's Supabase user details. */ get: operations["listChatSessions"]; put?: never; /** * ⚙️ Create a chat session * @description Creates a chat session in the scoped project for a Hive agent (`agent`, default `main`) and delivers its first message (awaited, so the 201 means the message landed). An agent or version Hive does not serve is rejected with a 400, and an organization that billing blocks with a 402, before anything is created. */ post: operations["createChatSession"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get a chat session * @description Retrieves a single chat session, enriched with creator details. */ get: operations["getChatSession"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * ⚙️ Update a chat session * @description Updates allowed fields on a chat session. Side effect: an `impacted_tests` change broadcasts a realtime update (best-effort). System-created session origin fields are server-controlled and immutable. */ patch: operations["patchChatSession"]; trace?: never; }; "/api/chat-sessions/{id}/branches": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get a session's branches and their pull requests * @description Returns every branch registered to the chat session (its own branch plus any the sandbox pushed), each with the pull requests opened from it. A branch with no pull requests has been pushed but has no PR yet. */ get: operations["getChatSessionBranches"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/close": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Close a chat session * @description Marks a chat session closed, closing its pull request and aborting any running agent (both best-effort). */ post: operations["closeChatSession"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/commit/{hash}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get a commit diff * @description Returns the unified diff for a single commit in the session. */ get: operations["getChatSessionCommitDiff"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/commits/diffs": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get multiple commit diffs * @description Returns unified diffs for a set of commit SHAs in the session. */ get: operations["getChatSessionCommitsDiffs"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/costs": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get a session's costs * @description Proxies the pi-worker session-costs endpoint, returning per-session cost and token totals. The upstream status code is passed through. */ get: operations["getChatSessionCosts"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/cumulative-diff": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get a cumulative diff * @description Returns the cumulative diff from the project's default branch to the given head SHA. */ get: operations["getChatSessionCumulativeDiff"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/diff": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get the session diff * @description Returns a diff for one explicitly selected registered branch or pull request. Exactly one of branch or pr_number is required. */ get: operations["getChatSessionDiff"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/entries": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ 🧪 Get session log entries by log_seq range * @description Returns the full log entries (tool arguments, results and media refs) between two log_seq values, for expanding a transcript row. */ get: operations["getChatSessionEntryRange"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/entries/{entry_id}/media/{media_index}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get inline media from one session entry * @description Authorizes access to the chat session, then streams one inline image from its durable session entry row. */ get: operations["getChatSessionEntryMedia"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/lineage": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ 🧪 Get a chat session lineage * @description Returns a bounded graph of manager handoffs and agent delegations around the selected session. */ get: operations["getChatSessionLineage"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/manager-handoff/confirm": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** 🛡️ 🧪 Close a manager session and start its successor */ post: operations["confirmManagerHandoff"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/manager-handoff/preview": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** 🛡️ 🧪 Generate an ephemeral manager handoff note */ post: operations["previewManagerHandoff"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/message": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Send a message to a chat session * @description Forwards a user message to the session's running pi-worker agent. */ post: operations["forwardChatSessionMessage"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/sandbox-logs": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get sandbox logs * @description Returns live sandbox logs when available, falling back to R2 logs drained during sandbox cleanup. */ get: operations["getChatSessionSandboxLogs"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/sandbox/commits/{sha}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ 🧪 Get a commit from the sandbox * @description Reads a commit's message, line stats and (optionally) diff from the attached sandbox's repository. Works for commits that have not been pushed; requires a running sandbox. */ get: operations["getChatSessionSandboxCommit"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/sandbox/control": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Pause, resume, or reprovision a sandbox * @description Pauses, resumes, or reprovisions the sandbox attached to a chat session. */ post: operations["controlChatSessionSandbox"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/sandbox/health": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get sandbox health * @description Proxies the attached sandbox's health payload. */ get: operations["getChatSessionSandboxHealth"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/sandbox/lifecycle": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Forward a sandbox lifecycle event * @description Forwards a sandbox lifecycle event (crashed/destroyed) to the session Durable Object. Internal/TOTP callers only. */ post: operations["applyChatSessionSandboxLifecycle"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/snapshot": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get a session's status snapshot * @description Returns the session's current sandbox status, agent lifecycle state, and user messages in one atomic response — the status-shaped subset of session-state, without the entry log. Backs `empirical session status`. */ get: operations["getChatSessionSnapshot"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/subagents": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ 🧪 Get a session's subagents * @description Returns each subagent's own log entries: the call that started it, its result, start, end and async-end entries, and only its latest message. */ get: operations["getChatSessionSubagents"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/subagents/{tool_call_id}/entries": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ 🧪 Get one subagent's log entries * @description Returns every log entry of one subagent, including all of its messages. */ get: operations["getChatSessionSubagentEntries"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/subscribe": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Wake the calling session when this session waits for input * @description Subscribes the caller's own chat session (from the sandbox-delegation principal) to the target session. When the target ends its turn and waits for input, a message is delivered into the caller's session, resuming it. Closing the target does not fire this subscription. One-shot: consumed when it fires. If the target is already waiting for input, no subscription is created and `already_waiting` is true. */ post: operations["subscribeChatSession"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/{id}/transcript": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ 🧪 Get a session's transcript rows * @description Returns the whole session as display rows (messages, condensed tool runs, cards), each with the log_seq range it covers. Tool arguments and results are not included; read them from the entries in a row's seq range. */ get: operations["getChatSessionTranscript"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/sandbox/branches": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Register branches pushed by the sandbox * @description Records branches the sandbox has pushed against its chat session so the GitHub proxy allows pull-request writes from them. The session is derived from the sandbox-delegation principal. */ post: operations["registerChatSessionSandboxBranches"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/sandbox/protected-branches": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List branches the sandbox may not push to * @description Returns the project's configured protected branches. The sandbox git proxy blocks pushes to these. The session is derived from the sandbox-delegation principal. */ get: operations["getChatSessionSandboxProtectedBranches"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/chat-sessions/users": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List chat-session creators * @description Returns the distinct users who created chat sessions in scope that were updated in the last 30 days, enriched with Supabase user details. */ get: operations["listChatSessionUsers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/credit-grants": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ List an organisation's credit grants * @description Returns the organisation's credit grants with what each has left, and the trial balance. */ get: operations["listCreditGrants"]; put?: never; /** * 🛡️ Grant trial credit to an organisation * @description Grants credit that the organisation's test runs and AI usage draw from. An organisation with no plan is started on `plan_id` as a trial that ends when the credit expires; a trial organisation's plan is extended to the latest expiry. Organisations on any other plan are refused. */ post: operations["createCreditGrant"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/credit-offers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ List credit offers * @description Returns every credit offer with its status, newest first. */ get: operations["listCreditOffers"]; put?: never; /** * 🛡️ Offer trial credit to an email, an email domain or all work domains * @description Reserves trial credit for a person who has no organisation yet. When someone the offer covers creates an organisation, it is granted the credit for `duration_days` on `plan_id`. An email or domain offer is claimed once, and an email or domain has at most one open offer. A `work_domains` offer stays open and grants once per work email domain, to callers with no email or domain offer; at most one is open. */ post: operations["createCreditOffer"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/credit-offers/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * 🛡️ Revoke a credit offer * @description Revokes an open offer so creating an organisation no longer claims it. Claimed offers can't be revoked; their credit is a grant on the organisation. Revoking a `work_domains` offer keeps the grants it already made. */ delete: operations["revokeCreditOffer"]; options?: never; head?: never; patch?: never; trace?: never; }; "/api/dodo/webhook": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Dodo Payments webhook * @description Receives signature-verified Dodo events. subscription.* events re-fetch the subscription from Dodo and mirror it, with the org's plan assignment. Other events are acknowledged and ignored. */ post: operations["dodoPaymentsWebhook"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/environment-variables": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List environment variables * @description Lists the scoped project's environment variables, enriched with the last editor's user details. */ get: operations["listEnvironmentVariables"]; put?: never; /** * ⚙️ Create an environment variable * @description Creates an environment variable for the scoped project. */ post: operations["createEnvironmentVariable"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/environment-variables/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * ⚙️ Delete an environment variable * @description Deletes a single environment variable by ID. The project is derived from the entity. */ delete: operations["deleteEnvironmentVariable"]; options?: never; head?: never; /** * ⚙️ Update an environment variable * @description Updates a single environment variable by ID. The project is derived from the entity. */ patch: operations["updateEnvironmentVariable"]; trace?: never; }; "/api/environment-variables/bulk": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * ⚙️ Bulk-delete environment variables * @description Deletes multiple environment variables. Every id must belong to an accessible project. */ delete: operations["bulkDeleteEnvironmentVariables"]; options?: never; head?: never; /** * ⚙️ Bulk-update environment variable scoping * @description Updates the environment scoping (all_environments / environment_ids) of multiple environment variables. Every id must belong to an accessible project. */ patch: operations["bulkUpdateEnvironmentVariables"]; trace?: never; }; "/api/environment-variables/merge": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Merge environment variables * @description Merges environment-scoped variables that share the same project, name, and value into one row by concatenating their environment_ids. Every id must belong to an accessible project. */ post: operations["mergeEnvironmentVariables"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/files/loom": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ 🧪 Import a Loom video * @description Downloads a Loom share video and stores it as a file. */ post: operations["importLoomFile"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/flags": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Evaluate feature flags * @description Evaluates the requested Flagship feature flags against a server-derived targeting context (worker env, the caller's principal, and the project-slug header). Unresolved flags are omitted from the response. */ get: operations["evaluateFlags"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github-rate-limit": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ GitHub rate-limit report * @description Returns the current GitHub API rate limits for the main app installation and every installed reporter app installation. Per-installation failures are reported inline as `error` strings rather than failing the report. */ get: operations["getGithubRateLimitReport"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/admin-app/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Receive an admin App webhook * @description Receives a GitHub admin App webhook directly from GitHub, verified by the webhook signature. The admin App subscribes to no events today; this acknowledges deliveries (including GitHub's `ping` handshake). */ post: operations["receiveAdminGithubEvent"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/branches": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Search repository branches * @description Searches branch names server-side through GitHub and returns a bounded result set. */ get: operations["searchRepositoryBranches"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/commit/diff": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get a commit diff * @description Returns the unified diff for a commit ref. */ get: operations["getCommitDiff"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Receive a GitHub webhook * @description Receives a raw GitHub webhook and processes installation, PR, and push events asynchronously. The delivery is verified by the GitHub webhook signature. */ post: operations["receiveGithubEvent"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/files": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get a file's contents * @description Returns the decoded contents of a file at a ref. */ get: operations["getRepoFile"]; /** * ⚙️ Create or update a file * @description Creates or updates a file via the GitHub contents API. */ put: operations["putRepoFile"]; post?: never; /** * ⚙️ Delete a file * @description Deletes a file via the GitHub contents API. */ delete: operations["deleteRepoFile"]; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/main-app/installations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List main App installations * @description Lists main App installations for the org owning the given project, refreshing each from GitHub. */ get: operations["listMainInstallations"]; put?: never; /** * ⚙️ Upsert a main App installation * @description Records or updates a main App installation for an org the caller can access. */ post: operations["upsertMainInstallation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/main-app/installations/{app_installation_id}/metadata": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get main App installation metadata * @description Fetches live GitHub metadata for a main App installation. */ get: operations["getMainInstallationMetadata"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/pr/close": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Close a pull request * @description Closes an open pull request without merging. */ post: operations["closePullRequest"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/pr/impacted-tests": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ 🧪 Get impacted tests for a pull request * @description Returns the tests impacted by the pull request's diff against its merge base. Computed on every head push; the first read of an unseen pull request queues the computation and returns status `pending`. */ get: operations["getPullRequestImpactedTests"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/pr/merge": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Merge a pull request * @description Merges an open, mergeable pull request with a merge commit. */ post: operations["mergePullRequest"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/pr/mergeability": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get pull request mergeability * @description Returns the computed mergeability status of a pull request. */ get: operations["getPullRequestMergeability"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/pr/review": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get a pull request review * @description Returns PR-scoped status, metadata, refs, and diff without requiring an owning chat session. */ get: operations["getPullRequestReview"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/pr/review-target": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Resolve the session that owns a pull request * @description Returns the chat session whose review sheet should display this pull request. */ get: operations["getPullRequestReviewTarget"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/reporter-app/deliveries": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List reporter deliveries * @description Lists the check runs, PR comments and linked test changes checks the reporter App delivered for a project, newest first. Each row is the latest state of one check run (per test run), one PR comment (per PR + environment) or one linked test changes check (per app PR). */ get: operations["listReporterDeliveries"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/reporter-app/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Receive a reporter App webhook * @description Receives a GitHub reporter App webhook and processes it asynchronously. The delivery is verified by the GitHub webhook signature. */ post: operations["receiveReporterGithubEvent"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/reporter-app/installations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List reporter installations * @description Lists reporter App installations for the org owning the given project. */ get: operations["listReporterInstallations"]; put?: never; /** * ⚙️ Create a reporter installation * @description Records a reporter App installation for an org the caller can access. */ post: operations["createReporterInstallation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/reporter-app/installations/{app_installation_id}/metadata": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get reporter installation metadata * @description Fetches live GitHub metadata for a reporter App installation, reconciling it with the stored record. */ get: operations["getReporterInstallationMetadata"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/reporter-app/installations/merge": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🛡️ Merge reporter installations * @description Merges an unlinked reporter installation into an existing one. */ post: operations["mergeReporterInstallations"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/reporter-app/installations/merge-candidates": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List reporter merge candidates * @description Lists reporter installations missing an org link that could be merged into the given project's org. */ get: operations["listReporterMergeCandidates"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/reporter-app/pull-request": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get a delivery's pull request * @description Reads an app PR live from GitHub through the project org's reporter App installation, and compares its current head with the commit a delivery was written on. */ get: operations["getReporterPullRequest"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/github/tree": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get a repository tree * @description Returns the recursive git tree for a ref. */ get: operations["getRepoTree"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/hive/agents": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List Hive agents * @description Returns the Hive agents a chat session can be created with, each at its `@latest` version. Prompts and tool lists stay in Hive. */ get: operations["listHiveAgents"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/hive/models": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List Hive models * @description Returns the catalog of models available from the Hive agent registry, proxied through the api worker. */ get: operations["listHiveModels"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/inbox/proxy": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Proxy an Inbox request * @description Forwards a request to the Inbox email-testing worker, injecting the configured API key. */ post: operations["proxyInbox"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/internal/fixture-emails/login": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Send a fixture app login email * @description Sends a login code and magic link for a fixture app (such as magic-link-app) used by e2e tests. Recipients outside @empiricalrun.email are rejected. */ post: operations["sendFixtureLoginEmail"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/internal/request-ingestion/jira/webhook": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Jira webhook * @description Receives a Jira webhook, resolves the install and project, and ingests issues carrying the `empirical` label as Empirical tasks. */ post: operations["jiraWebhook"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/internal/request-ingestion/linear/webhook": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Linear webhook * @description Receives a Linear webhook, validates its signature, and ingests labelled issues into the resolved project as Empirical tasks. */ post: operations["linearWebhook"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/internal/sandbox-auth/refresh": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Refresh a sandbox access token * @description Exchanges a sandbox refresh token (Bearer `sbx_rt_…`) for a new short-lived access token. Authenticated by the refresh token itself, so no principal/bearer guard applies. */ post: operations["refreshSandboxToken"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/internal/scheduler/snooze-expiry": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Schedule a snooze expiry alarm * @description Registers a one-time scheduler alarm that fires the snooze expiry callback at `snooze_until`. */ post: operations["scheduleSnoozeExpiry"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/internal/seed/chat-sessions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ 🧪 Seed a chat session with messages (preview only) * @description Creates a chat session in the scoped project whose history is the given messages, without starting an agent turn or checking billing. For e2e tests that need an ongoing session, such as the in-session billing block. Returns 404 outside preview and local. */ post: operations["seedChatSession"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/internal/service-tokens": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ List service tokens * @description Returns all internal service tokens, newest first. */ get: operations["listServiceTokens"]; put?: never; /** * 🛡️ Issue a service token * @description Issues a new internal service token. The full secret value is returned only in this response. */ post: operations["createServiceToken"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/internal/service-tokens/{id}/revoke": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🛡️ Revoke a service token * @description Revokes a service token by ID, preventing further use. */ post: operations["revokeServiceToken"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/internal/spot-interruptions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Handle an ECS spot-interruption event * @description Re-dispatches the interrupted task's shard to the on-demand queue when the shard is still queued with no registered worker (a spot interruption between task launch and job pickup). Any other shard state is reported as `skipped`. */ post: operations["handleSpotInterruption"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/internal/test-cases-sync": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Enqueue a test cases sync * @description Enqueues a background job that syncs a project's Playwright test cases from the given commit. Processed asynchronously by the jobs queue consumer. */ post: operations["enqueueTestCasesSync"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/invoices": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ List invoices * @description Returns a paginated list of invoices with their organisations, optionally filtered by organisation, paid status, or issue month. */ get: operations["listInvoices"]; put?: never; /** * 🛡️ Create an invoice * @description Creates a new invoice for an existing organisation. Refused for an org with a live Dodo subscription, which Dodo bills instead. */ post: operations["createInvoice"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/invoices/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ Get an invoice * @description Retrieves a single invoice with its organisation by ID. */ get: operations["getInvoice"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * 🛡️ Update an invoice * @description Updates fields on an existing invoice. Moving it to an org with a live Dodo subscription is refused. */ patch: operations["updateInvoice"]; trace?: never; }; "/api/invoices/{id}/billing-lines": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ List invoice billing lines * @description Returns the billing lines (with metered usage) for an invoice. */ get: operations["listInvoiceBillingLines"]; /** * 🛡️ Replace invoice billing lines * @description Replaces all billing lines on an invoice with the supplied set. */ put: operations["replaceInvoiceBillingLines"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/invoices/{id}/email-preview": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ Preview an invoice email * @description Renders the invoice email exactly as `POST /{id}/send` would send it, without sending anything. */ get: operations["previewInvoiceEmail"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/invoices/{id}/generate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🛡️ Generate an invoice PDF * @description Renders the invoice to PDF via the invoice-gen worker, stores it in R2, updates the invoice, and returns the PDF as an attachment. */ post: operations["generateInvoicePdf"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/invoices/{id}/payment-status": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * 🛡️ Set invoice payment status * @description Declaratively mirrors reconciled payment status (from fin) onto an invoice. Idempotent: a PUT of the same state is a no-op. Handles marking paid, partial payments, and reverting a premature paid. */ put: operations["setInvoicePaymentStatus"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/invoices/{id}/pdf": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ Get an invoice PDF download URL * @description Returns an absolute URL for downloading the invoice's PDF. */ get: operations["getInvoicePdfDownloadUrl"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/invoices/{id}/pdf/download": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ Download an invoice PDF * @description Streams the stored invoice PDF with an inline content disposition. */ get: operations["downloadInvoicePdf"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/invoices/{id}/send": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🛡️ Send an invoice * @description Emails the invoice PDF to the organisation's billing contacts and marks it as sent (unless `is_test_email` is set). On a real send, an unpaid INR invoice without a payment link gets a Razorpay-hosted payment link, stored on the invoice and included in the email. Refused for an org with a live Dodo subscription, which Dodo bills instead. */ post: operations["sendInvoice"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/invoices/org": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ List the org's invoices * @description Returns all of the scoped project's org's sent invoices (paid and unpaid) and, for orgs billed through Dodo, Dodo's invoices for their successful payments, newest first, with document availability flags. If Dodo can't be reached, only our invoices are returned. */ get: operations["listOrgInvoices"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/invoices/org/{id}/pdf/download": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ Download an invoice PDF * @description Streams the PDF of one of the scoped project's org's sent invoices. */ get: operations["downloadOrgInvoicePdf"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/invoices/org/{id}/razorpay-order": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🛡️ Create a Razorpay order to pay an INR invoice * @description Creates a Razorpay order for the outstanding amount of one of the scoped project's org's sent INR invoices. The browser opens Razorpay Standard Checkout with the returned order and key ids; the resulting payment is confirmed via the razorpay-verify endpoint. Orders are not stored; a new one is created per attempt. */ post: operations["createInvoiceRazorpayOrder"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/invoices/org/{id}/razorpay-verify": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🛡️ Verify a Razorpay payment and settle the invoice * @description Verifies the Standard Checkout signature for a payment on one of the scoped project's org's sent invoices, cross-checks the order and payment against Razorpay's API, and mirrors the payment onto the invoice (paid status, paid amount, payment ref). Idempotent per payment: redelivering a settled payment is a no-op. */ post: operations["verifyInvoiceRazorpayPayment"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/invoices/reminders/upcoming": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ List upcoming invoice reminders * @description Returns read-only invoice reminder candidates for the next window. This endpoint does not send emails or stamp reminder timestamps. */ get: operations["listUpcomingInvoiceReminders"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/jira/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Receive a Jira webhook * @description Receives a Jira webhook delivery, resolves the install and project, and ingests issues carrying the `empirical` label as Empirical tasks. */ post: operations["receiveJiraWebhook"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/jira/installations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List Jira installations * @description Lists Jira app installations for an organisation. */ get: operations["listJiraInstallations"]; put?: never; /** * ⚙️ Create or reauthorize a Jira installation * @description Stores a Jira app installation, or reauthorizes the existing site while preserving mappings, and optionally registers its webhook. A signed-in user sends the OAuth code and api-worker exchanges it. */ post: operations["createJiraInstallation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/jira/installations/{id}/project-mappings": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * ⚙️ Update Jira project mappings * @description Replaces the Jira-to-Empirical project mappings for an installation. */ put: operations["updateJiraProjectMappings"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/jira/installations/{id}/refresh-webhook": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Refresh a Jira webhook * @description Re-registers the Jira webhook and extends its expiry for an installation. */ post: operations["refreshJiraWebhook"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/jira/installations/{id}/revoke": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Revoke a Jira installation * @description Deletes a Jira app installation. */ post: operations["revokeJiraInstallation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/jira/installations/{id}/validate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Validate a Jira installation * @description Validates the stored Jira token against Atlassian and reports webhook status. */ get: operations["validateJiraInstallation"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/jira/installations/{id}/webhook-expires-at": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * ⚙️ Update Jira webhook expiry * @description Sets the webhook expiry timestamp for an installation. */ patch: operations["updateJiraWebhookExpiresAt"]; trace?: never; }; "/api/linear/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Receive a Linear webhook * @description Receives a Linear webhook delivery, verified by its `linear-signature` header, and ingests labelled issues into the resolved project as Empirical tasks. */ post: operations["receiveLinearWebhook"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/linear/installations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List Linear installations * @description Lists Linear app installations for an organization. */ get: operations["listLinearInstallations"]; put?: never; /** * ⚙️ Create a Linear installation * @description Creates or reauthorizes a Linear installation and stores its OAuth tokens. A signed-in user sends the OAuth code and api-worker exchanges it. */ post: operations["createLinearInstallation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/linear/installations/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * ⚙️ Delete a Linear installation * @description Deletes a stored Linear app installation. */ delete: operations["deleteLinearInstallation"]; options?: never; head?: never; patch?: never; trace?: never; }; "/api/linear/installations/{id}/project-mappings": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * ⚙️ Update Linear project mappings * @description Updates the Linear team key → Empirical project id mappings for an installation. */ put: operations["updateLinearProjectMappings"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/linear/installations/{id}/revoke": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Revoke a Linear installation * @description Revokes the stored Linear OAuth token and deletes the installation. */ post: operations["revokeLinearInstallation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/linear/installations/{id}/validate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Validate a Linear installation * @description Validates the stored Linear token and backfills cached metadata if missing. */ get: operations["validateLinearInstallation"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/mailosaur/proxy": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Proxy a Mailosaur request * @description Forwards a request to the Mailosaur API, injecting the configured API key as HTTP basic auth. */ post: operations["proxyMailosaur"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/memories": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List memories * @description Returns the scoped project's memories, most recently updated first. */ get: operations["listMemories"]; put?: never; /** * ⚙️ Create a memory * @description Creates a memory in the scoped project and records its first version. */ post: operations["createMemory"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/memories/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get a memory * @description Returns a single memory by ID. The project is derived from the entity. */ get: operations["getMemory"]; put?: never; post?: never; /** * ⚙️ Delete a memory * @description Soft-deletes a memory by ID: it stops appearing in listings and prompt context, but its version history is retained. The project is derived from the entity. */ delete: operations["deleteMemory"]; options?: never; head?: never; /** * ⚙️ Update a memory * @description Updates a memory by ID and appends a new version. The project is derived from the entity. */ patch: operations["updateMemory"]; trace?: never; }; "/api/memories/{id}/versions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List a memory's versions * @description Returns the edit history of a memory, newest version first. */ get: operations["listMemoryVersions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/memories/activity": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ 🧪 Memory activity across projects * @description Returns every memory across all projects (soft-deleted included, content omitted) with edit statistics from its version history, plus daily create/edit/delete counts per project. */ get: operations["listMemoryActivity"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/memories/changes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ 🧪 Memory changes made by a chat session * @description Returns every create, update and delete one chat session made to the scoped project's memories, oldest first, with the reason given for each, the previous version for updates, and live memory counts before and after. */ get: operations["listMemoryChanges"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/memories/classifications": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ 🧪 Memory classifications across projects * @description Returns every stored JEV classification under one vocabulary version, for all versions of all memories (soft-deleted included). A memory's current labels are the row for its latest version; rows for older versions mean it was edited since. */ get: operations["listMemoryClassifications"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/memories/usage": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ 🧪 Most read and most edited memories * @description Returns the scoped project's most read memories (read_memory calls, counted by Hive from agent sessions) and most edited memories over a recent window. */ get: operations["getMemoryUsage"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/notifications": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List my notifications * @description Returns the signed-in user's unread notifications and their most recent read ones, limited to projects they can still access. */ get: operations["listNotifications"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/notifications/{id}/read": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Mark a notification read * @description Marks one of the signed-in user's notifications as read. */ post: operations["markNotificationRead"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/notifications/dummy": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🧪 Create a dummy notification (non-production only) * @description Creates an unread notification for the signed-in user about the project's latest chat session or test run, and pushes it on the user's realtime channel. Not available in production. */ post: operations["createDummyNotification"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/notifications/read-all": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Mark all my notifications read * @description Marks every unread notification of the signed-in user as read. */ post: operations["markAllNotificationsRead"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/oauth/authorize-url": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get an OAuth authorize URL * @description Builds the provider authorize URL (client ID and scopes) for connecting Slack, Linear, Jira or the GitHub reporter app. The caller keeps the state and redirects to the URL. */ get: operations["getOAuthAuthorizeUrl"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/oauth/clients/{client_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get an app asking to access Empirical * @description Describes an OAuth client of Empirical's sign-in (e.g. an MCP client) for the consent screen: its self-chosen name, whether Empirical registered it, and where it receives tokens. */ get: operations["getOAuthClient"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/order-forms": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ List order forms * @description Returns a paginated list of order forms with their organisation and pricing lines, optionally filtered by organisation, status, or pricing model. */ get: operations["listOrderForms"]; put?: never; /** * 🛡️ Create an order form * @description Creates an order form for an organisation along with its pricing lines. */ post: operations["createOrderForm"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/order-forms/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ Get an order form * @description Retrieves a single order form by ID, including its organisation and pricing lines. */ get: operations["getOrderForm"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * 🛡️ Update an order form * @description Updates an order form's fields and, when `lines` is provided, replaces its pricing lines. */ patch: operations["updateOrderForm"]; trace?: never; }; "/api/order-forms/{id}/pdf": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🛡️ Upload an order form PDF * @description Uploads a base64-encoded signed PDF for the order form, stores it in R2, and returns the updated order form. */ post: operations["uploadOrderFormPdf"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/order-forms/{id}/pdf/download": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ Download an order form PDF * @description Streams the stored signed PDF for the order form with an inline content disposition. */ get: operations["downloadOrderFormPdf"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/orgs": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ List organizations * @description Lists organizations with their projects. Super admins and internal services see all orgs; other principals see only the orgs they belong to. */ get: operations["listOrgs"]; put?: never; /** * Create an organization * @description Creates an organization and adds the caller as its first member. If a credit offer is open for the caller's email or email domain, the organization claims it and starts a trial with that credit. Otherwise a caller with a work email gets the open offer for work email domains, once per domain. Create projects in it with `POST /api/projects`. */ post: operations["createOrg"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/orgs/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * 🛡️ Update an organization * @description Updates editable organization fields (name, email domains, billing details). Restricted to org members, super admins, and system callers. */ patch: operations["updateOrg"]; trace?: never; }; "/api/orgs/{id}/invites": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ List organization invites * @description Lists invites for the organization, newest first. Restricted to org members and super admins. */ get: operations["listOrgInvites"]; put?: never; /** * 🛡️ Invite a user to an organization * @description Creates an email-bound invite: the recipient joins by signing in with the invited email address. Restricted to org members and super admins. */ post: operations["createOrgInvite"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/orgs/{id}/invites/{invite_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * 🛡️ Revoke a pending invite * @description Revokes a pending invite so signing in with that email no longer joins the organization. Restricted to org members and super admins. */ delete: operations["revokeOrgInvite"]; options?: never; head?: never; patch?: never; trace?: never; }; "/api/orgs/{id}/members": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ List organization members * @description Returns a paginated, searchable list of users belonging to the organization. Restricted to org members, super admins, and system callers. */ get: operations["listOrgMembers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/orgs/{id}/members/{user_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * 🛡️ Remove a member from an organization * @description Removes the user's membership in the organization; access ends on their next request. Restricted to org members and super admins. */ delete: operations["removeOrgMember"]; options?: never; head?: never; patch?: never; trace?: never; }; "/api/orgs/by-email-domain": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List organizations by email domain * @description Maps an email domain to the organizations that claim it. Used by the dashboard auth callback/confirm flow; system-to-system callers only. */ get: operations["listOrgsByEmailDomain"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/orgs/resolve-membership": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Resolve org membership for a signed-in user * @description Grants super-admin to staff emails; for users with no org yet, accepts pending invites for the email and matches org email domains. Returns the user's memberships and super-admin flag. A signed-in user resolves their own membership and needs a confirmed email; system callers name the user in the body. */ post: operations["resolveMembership"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/plan-assignments": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ List plan assignments * @description Returns a paginated list of plan assignments, optionally filtered by organisation and plan. */ get: operations["listPlanAssignments"]; put?: never; /** * 🛡️ Create a plan assignment * @description Puts an existing organisation on a plan from `effective_from`. A trial the organisation is on ends then, with its credit. */ post: operations["createPlanAssignment"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/plan-assignments/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ Get a plan assignment * @description Retrieves a single plan assignment by ID. */ get: operations["getPlanAssignmentById"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * 🛡️ Update a plan assignment * @description Updates fields on an existing plan assignment. */ patch: operations["updatePlanAssignment"]; trace?: never; }; "/api/plan-assignments/org": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ Get the org's plan * @description Returns whether the scoped project's org is on a plan (now, or during `month` or `period`), and the plan's terms when it is a shared plan. */ get: operations["getOrgPlan"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/plans": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ List plans * @description Returns the shared plans with their meters, or one organisation's custom plans. */ get: operations["listPlans"]; put?: never; /** * 🛡️ Create a shared plan * @description Creates a shared plan and its meters. With `dodo_sync` and no `dodo_product_id`, its Dodo product is created (or an existing one for the key is linked) in the same request; if that fails, nothing is saved. Plans are immutable once created, apart from `name`, `status` and `dodo_sync`: to change a price, create a new plan with a new key and retire the old one. Custom plans are created through order forms. */ post: operations["createPlan"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/plans/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ Get a plan * @description Retrieves a single plan with its meters. */ get: operations["getPlanById"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * 🛡️ Update a plan's name, status or Dodo sync * @description Sets a plan's `name`, `status` or `dodo_sync`. Plans are immutable apart from these: any other field is rejected. None of them touches existing assignments, which stay on the plan. A new name is applied to the plan's Dodo product first, and turning `dodo_sync` on creates the product if there is none; if Dodo refuses either, nothing changes. */ patch: operations["updatePlan"]; trace?: never; }; "/api/project-addons": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ 🧪 List add-ons for the scoped project * @description Returns every known add-on with its current state, plus the full period history for this project. */ get: operations["listProjectAddons"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/project-addons/{addon}/disable": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🧪 Disable an add-on * @description Closes the open period, preserving it as history. Returns 409 when the add-on was not enabled, or when the add-on is still in use — repo ownership cannot be turned off while the repository lives outside Empirical's GitHub org. */ post: operations["disableProjectAddon"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/project-addons/{addon}/enable": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🧪 Enable an add-on * @description Opens a new period effective now. Returns 409 when the add-on is already enabled, so a double submit cannot create overlapping periods. */ post: operations["enableProjectAddon"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List projects * @description Lists the projects accessible to the caller. */ get: operations["listProjects"]; put?: never; /** * ⚙️ Create a project * @description Creates a new project in an organisation the caller belongs to (super admins can create in any org). */ post: operations["createProject"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get a project * @description Retrieves a single project by ID. */ get: operations["getProject"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * ⚙️ Update a project * @description Updates editable fields on a project. */ patch: operations["updateProject"]; trace?: never; }; "/api/projects/{id}/branch/rename": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Rename a branch * @description Renames a branch in the project's repository. */ post: operations["renameProjectBranch"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects/{id}/branches": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List recent branches * @description Lists recent branches with test-run activity. */ get: operations["listProjectBranches"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects/{id}/branches/compare": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Compare two branches * @description Compares two branches in the project's repository. */ get: operations["compareProjectBranches"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects/{id}/manager-session": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Get or create the project's manager session * @description Returns the project's manager session, creating it if there isn't one. A project has at most one open manager session, enforced by a partial unique index; the session is stamped `purpose = "manager"` server-side. Safe to call concurrently — the loser of the race returns the winner. */ post: operations["getOrCreateProjectManagerSession"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects/{id}/merge-requests": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List merge requests * @description Lists a project's merge requests (paginated). */ get: operations["listProjectMergeRequests"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects/{id}/org": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get a project's organisation * @description Retrieves the organisation that owns a project. */ get: operations["getProjectOrg"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects/{id}/repo-exists": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Check repository exists * @description Checks whether the project's GitHub repository exists. */ get: operations["checkProjectRepoExists"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects/{id}/repo-settings-check": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Check test repository settings * @description Checks the project's GitHub repository (or a repo transfer destination) against the settings Empirical needs: merge commits only, app access, and a matching default branch. Also reports the rulesets and classic protection on the default branch. */ get: operations["checkProjectRepoSettings"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects/{id}/test-cases-sync/trigger": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Trigger a test-cases sync * @description Enqueues a background job to sync the project's test cases from the default branch's latest commit. */ post: operations["triggerProjectTestCasesSync"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects/{id}/transfers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List repo transfers * @description Returns all repo transfers for a project, newest first. */ get: operations["listRepoTransfers"]; put?: never; /** * ⚙️ Start a repo transfer * @description Starts mirroring the project's repository to a target GitHub org/repo and enqueues the transfer job. Fails if a transfer is already in progress or the GitHub App is not installed with access to the target repo. */ post: operations["startRepoTransfer"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects/{id}/transfers/{transfer_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get a repo transfer * @description Retrieves a single repo transfer for a project by ID. */ get: operations["getRepoTransfer"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects/branches/check": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Check if a branch exists * @description Checks whether a branch exists in the given GitHub repository. */ get: operations["checkBranchExists"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects/by-repo-name": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get project by repo name * @description Looks up a project by its repository name. */ get: operations["getProjectByRepoName"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects/by-slug": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get project by slug * @description Looks up a project by its slug. */ get: operations["getProjectBySlug"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects/check-slug": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Check slug availability * @description Reports whether a project slug is free. */ get: operations["checkProjectSlug"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects/clone": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ Get project clone URL * @description Returns the scoped project's repository URL on git.empirical.run. Authenticate with an Empirical credential as the HTTP password (the CLI's git credential helper does this for you). Access is read-only. No GitHub token is issued. */ get: operations["getProjectClone"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects/git-token": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Get git credentials * @description Returns a repo-scoped GitHub installation token for the scoped project, used by the sandbox git proxy. */ post: operations["getProjectGitToken"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects/kv": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Read project KV value * @description Reads a value from the scoped project's KV namespace. */ get: operations["getProjectKv"]; put?: never; /** * ⚙️ Write project KV value * @description Writes a value into the scoped project's KV namespace with a bounded TTL. */ post: operations["setProjectKv"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects/merge-branches": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Merge branches * @description Merges a head branch into a base branch for the scoped project, creating a pull request as needed. */ post: operations["mergeBranches"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects/npm-snapshot-urls": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🧪 Presign node_modules snapshot URLs * @description Returns presigned S3 URLs for the scoped project's node_modules tarball for a lockfile hash. Sandboxes restore from them at boot and upload after an npm ci on a miss. */ post: operations["getProjectNpmSnapshotUrls"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/projects/static-ip-proxy-token": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Mint a static IP proxy token * @description Mints a short-lived, project-scoped static-IP proxy credential for the scoped project. Used by the sandbox token refresher. */ post: operations["getProjectStaticIpProxyToken"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/razorpay/webhook": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Razorpay payments webhook * @description Receives signature-verified Razorpay events. payment.captured events whose order notes contain an invoice_id reconcile that payment onto the invoice. Other events are acknowledged and ignored. */ post: operations["razorpayPaymentsWebhook"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/realtime/token": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Issue a channel-scoped realtime token * @description Mints a short-lived token (1 hour TTL) that opens only the requested realtime-worker WebSocket channels the caller may read: project channels for projects the caller can access, test-run channels for runs in those projects, and the signed-in user's own user channel. Inaccessible or unknown channels are left out of the token; if none remain the request is refused. */ post: operations["createRealtimeToken"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/recent-pages": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List recently viewed pages * @description Returns the user's 10 most recently viewed accessible dashboard destinations from the last 14 days. */ get: operations["listRecentPages"]; /** * Record a recently viewed page * @description Records or refreshes one project/page destination with a sliding 14-day expiry. */ put: operations["recordRecentPage"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/runner-backends/claim": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🧪 Call home from an installation's stack * @description Called by the registration Lambda in a Private Runner stack. On Create and Update it records the stack's resources and versions and verifies them; a pending backend that passes becomes active. Delete always succeeds: it releases an unverified claim so the link can be reused, or disables an active backend and moves its projects back to Empirical-hosted runs. */ post: operations["claimRunnerBackend"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/runner-backends/project": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🧪 Get the scoped project's runner backend * @description Returns the runner backend the scoped project is linked to, including its verification status, or null when the project runs on Empirical-hosted infrastructure. */ get: operations["getProjectRunnerBackend"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/runner-backends/project/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * 🧪 Remove a private runner * @description Deletes an unfinished setup or a disconnected runner of the scoped project's organisation that no project uses. Its CloudFormation stack, if one exists, stays in the AWS account until deleted there. */ delete: operations["removeProjectRunnerBackend"]; options?: never; head?: never; /** * 🧪 Rename a private runner * @description Renames a runner backend of the scoped project's organisation. */ patch: operations["renameProjectRunnerBackend"]; trace?: never; }; "/api/runner-backends/project/{id}/disconnect": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🧪 Disconnect a private runner * @description Stops sending runs to a runner backend of the scoped project's organisation and moves every project on it back to Empirical-hosted runs. The stack stays in the AWS account; delete it there to remove it. Re-enable restores the runner, but not the projects' links. */ post: operations["disconnectProjectRunnerBackend"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/runner-backends/project/{id}/enable": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🧪 Re-enable a disconnected private runner * @description Verifies a disabled runner backend of the scoped project's organisation and makes it active again if every check passes. Projects are not re-linked. */ post: operations["enableProjectRunnerBackend"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/runner-backends/project/{id}/registration": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🧪 Create a new setup link * @description Mints a new quick-create link for a pending runner backend of the scoped project's organisation, replacing any earlier unused link. */ post: operations["createProjectRunnerBackendRegistration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/runner-backends/project/available": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🧪 List the organisation's runner backends * @description Every runner backend of the scoped project's organisation, in any status, so a project can use one another project set up or resume a setup in progress. */ get: operations["listProjectOrgRunnerBackends"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/runner-backends/project/runner-backend": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * 🧪 Choose where the project's runs execute * @description Sends the scoped project's new runs to an active runner backend of its organisation, or back to Empirical-hosted infrastructure with null. Runs already created keep their placement. */ put: operations["setScopedProjectRunnerBackend"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/runner-backends/project/setup": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🧪 Start setting up a private runner * @description Registers a pending runner backend for the scoped project's organisation in the given AWS account and region, or reuses one whose stack hasn't called home yet or was deleted, and returns a quick-create link for it. The stack activates the backend when it is created. */ post: operations["setupProjectRunnerBackend"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/runner-backends/project/verify": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🧪 Re-check the scoped project's runner backend * @description Assumes the role of the backend the scoped project is linked to, makes one read-only call to each queue, the cluster and the log group, and records the result, so a customer can confirm a fix to their role or stack. It never changes the backend's status; use `enable` for a disabled one. */ post: operations["verifyProjectRunnerBackend"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/sandbox-snapshots/sources/upsert": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Upsert sandbox snapshot sources * @description Upserts one or more snapshot source rows; called by sandbox-template CI. */ post: operations["upsertSandboxSnapshotSources"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/system-messages": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** 🛡️ 🧪 List system messages with delivery and ack counts */ get: operations["listSystemMessages"]; put?: never; /** * 🛡️ 🧪 Broadcast a system message to manager sessions * @description Persists the message and delivers it to project manager sessions. With `project_ids`, every listed project gets a recipient row, and one without an open manager is recorded as failed. Without it, the message goes to every project with an open manager, and active projects without one are returned in `skipped_project_ids` (not persisted). Delivery is attempted before responding. Managers acknowledge through `POST /api/system-messages/{id}/ack`. */ post: operations["createSystemMessage"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/system-messages/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** 🛡️ 🧪 Get a system message's per-project delivery and ack status */ get: operations["getSystemMessage"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/system-messages/{id}/ack": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🧪 Acknowledge a system message from a manager session * @description Records the calling manager session's acknowledgement for its project. Any manager session of the project may ack, so a successor can answer a message its predecessor received. Re-acking overwrites the previous status and note. */ post: operations["ackSystemMessage"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/tasks/{id}/chat-sessions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List a task's chat sessions * @description Returns the chat sessions spawned from a task. */ get: operations["listTaskChatSessions"]; put?: never; /** * ⚙️ Create a chat session for a task * @description Starts a new chat session tied to a task. */ post: operations["createTaskChatSession"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-reports/upload-urls": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ 🧪 Create report upload URLs * @description Returns presigned PUT URLs for files of a Playwright report under the project's report folder `//`. */ post: operations["createTestReportUploadUrls"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * ⚙️ Ingest a test-case run-end event * @description Ingests a per-test-case run-end event from the Playwright reporter (EmpiricalReporter in packages/playwright-utils): processes retries, triggers the failure-diagnosis workflow, and updates realtime test-run counts. Port of the dashboard's PUT /api/test-runs/events. */ put: operations["ingestTestCaseRunEndEvent"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/events/begin": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * ⚙️ Ingest a test-case run-begin event * @description Records when a test attempt starts on the runner, so the run manifest shows in-flight tests and how long they have been running. Sent by EmpiricalReporter in packages/playwright-utils. */ put: operations["ingestTestCaseRunBeginEvent"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/test-runs/shards": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Update a shard's state * @description Records a shard state transition from the test-run worker: shard write plus terminal guard, parent start on first shard start, resume dispatch for interrupted shards, merge orchestration once all shards complete, and parent finalization plus report ingestion when the merge job ends. */ post: operations["updateTestRunShardState"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/twocaptcha/proxy": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Proxy a 2Captcha request * @description Forwards a request to the 2Captcha API, injecting the configured `clientKey` into the payload. */ post: operations["proxyTwoCaptcha"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/ui/v1/test-runs/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get test run detail (UI) * @description Returns everything the test-run detail page renders in one call: the enriched run, the first page of its cases, the test cases those rows reference, and the resolved created-by / cancelled-by users. */ get: operations["getUiTestRunDetail"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/ui/v1/test-runs/{id}/live": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Refresh a live test run (UI) * @description Returns only test-run fields that can change while the hydrated dashboard page is open. It deliberately omits ledger cases, test-case rows, static run metadata, user lookups, pull-request resolution, and chat-session lookup. */ get: operations["getUiLiveTestRun"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/users/github-link": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List my GitHub links * @description Returns the GitHub accounts linked to the current user. */ get: operations["listMyGithubLinks"]; put?: never; /** * ⚙️ Upsert a GitHub link * @description Creates or updates a GitHub account link. A signed-in user links their own account to the GitHub user who authorized `code`; system callers pass the user and profile directly. */ post: operations["upsertGithubLink"]; /** * ⚙️ Delete my GitHub link * @description Deletes a GitHub link owned by the current user. */ delete: operations["deleteMyGithubLink"]; options?: never; head?: never; patch?: never; trace?: never; }; "/api/users/me": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the current user * @description Returns the signed-in user's id, email, org memberships and super-admin flag as used for authorization. */ get: operations["getCurrentUser"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/users/me/announcements-seen": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get when the current user last saw announcements * @description Returns the time up to which the signed-in user has seen dashboard announcements, falling back to their signup time. */ get: operations["getMyAnnouncementsSeen"]; /** * Mark announcements as seen for the current user * @description Moves the signed-in user's announcement seen time forward to the given time, or to now. */ put: operations["markMyAnnouncementsSeen"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/users/me/memberships": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Join organizations from pending invites * @description Creates org memberships for the current user by accepting every pending invite addressed to their verified email. */ post: operations["createMyMemberships"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/users/me/onboarding": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get my onboarding checklist * @description The steps to get a user from sign-up to a merged first test and Slack, with each step's status worked out from data. Each item's `action` says how to do it: an API call (with the inputs to ask the user for) or a browser URL. Call it, do `next_item_id`, and call it again. Pass `-p ` (`x-project-slug`) once a project exists. */ get: operations["getMyOnboarding"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/users/slack-link": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ List my Slack links * @description Returns the Slack accounts linked to the current user. */ get: operations["listMySlackLinks"]; put?: never; post?: never; /** * ⚙️ Delete my Slack link * @description Deletes a Slack link owned by the current user. */ delete: operations["deleteMySlackLink"]; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v1/telemetry/track": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Track a telemetry event * @description Records a test-run telemetry event for the scoped project. Delivery is best-effort. */ post: operations["trackTelemetryEvent"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v2/projects/{id}/usage": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * ⚙️ Get customer-visible usage for a project * @description Usage for a UTC time window, defaulting to the current calendar month-to-date. Returns AI sessions, total tokens, and credits by usage type, daily credit totals, and test execution duration with UTC daily totals split by environment. Provider costs and internal attribution dimensions are omitted. */ get: operations["getProjectUsageV2"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/webhook-site/proxy": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * ⚙️ Proxy a Webhook.site request * @description Forwards a request to the Webhook.site API, injecting the configured API key. */ post: operations["proxyWebhookSite"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/webhooks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * 🛡️ List webhooks * @description Returns the scoped project's webhooks, with secrets omitted. */ get: operations["listWebhooks"]; put?: never; /** * 🛡️ Create a webhook * @description Creates a webhook for the scoped project. The signing secret is returned once in the response and cannot be retrieved again. */ post: operations["createWebhook"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/webhooks/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * 🛡️ Delete a webhook * @description Permanently deletes a webhook. The project is derived from the webhook itself. */ delete: operations["deleteWebhook"]; options?: never; head?: never; /** * 🛡️ Update a webhook * @description Updates a webhook's URL, events, or active state. The project is derived from the webhook itself. */ patch: operations["updateWebhook"]; trace?: never; }; "/api/webhooks/{id}/test": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * 🛡️ Send a test webhook * @description Delivers a `webhook.test` event to the webhook's endpoint and returns the delivery result. The project is derived from the webhook itself. */ post: operations["testWebhook"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; } export type webhooks = Record; export interface components { schemas: { AckSystemMessageRequest: { /** @enum {string} */ status: "accepted" | "declined"; note?: string; }; AckSystemMessageResponse: { data: { system_message_id: number; project_id: number; /** @enum {string} */ ack_status: "accepted" | "declined"; acked_at: string; }; }; ActivityDay: { /** @description Local date, YYYY-MM-DD. */ date: string; /** @description Every test run created that day, summarized by its latest state. */ test_runs: { count: number; outcomes: { running: number; failed: number; errored: number; interrupted: number; passed: number; cancelled: number; ended: number; }; /** @description When the day's newest run was created. */ occurred_at: string; /** @description When the day's oldest run was created. */ since: string; locations: { environment_id: number | null; environment: string | null; count: number; outcomes: { running: number; failed: number; errored: number; interrupted: number; passed: number; cancelled: number; ended: number; }; }[]; } | null; items: components["schemas"]["ActivityItem"][]; /** @description Items past the per-day limit, not listed in `items`. */ more_items: number; }; ActivityItem: { id: string; occurred_at: string; actor: { id: string; name: string; picture: string | null; } | null; /** @enum {string} */ kind: "chat_session"; /** * @description The session's latest state: started, closed, or what happened to its pull request. * @enum {string} */ action: "created" | "closed" | "pr_opened" | "pr_reopened" | "pr_merged" | "pr_closed"; chat_session: { id: number; title: string | null; }; pull_request: { number: number; url: string | null; } | null; } | { id: string; occurred_at: string; actor: { id: string; name: string; picture: string | null; } | null; /** @enum {string} */ kind: "pull_request"; /** @enum {string} */ action: "opened" | "reopened" | "closed" | "merged"; pull_request: { number: number; url: string | null; repo: string; head_branch: string; }; } | { id: string; occurred_at: string; actor: { id: string; name: string; picture: string | null; } | null; /** @enum {string} */ kind: "task"; /** @enum {string} */ action: "created"; task: { id: number; title: string; source: string; status: string; }; } | { id: string; occurred_at: string; actor: { id: string; name: string; picture: string | null; } | null; /** @enum {string} */ kind: "failure_group"; /** @enum {string} */ action: "created"; failure_group: { id: string; label: string; type: string; status: string; }; }; ActivityResponse: { /** @description Response payload. */ data: { days: components["schemas"]["ActivityDay"][]; /** @description Pass as `before` to load older days. */ next_cursor: string | null; }; }; AddSnoozeTestCasesRequest: { /** @description Playwright test IDs to add to the snooze. */ test_ids: string[]; }; /** @enum {string} */ AiUsageType: "manager" | "manager_initiated" | "user_initiated" | "triage"; AlarmResponse: { /** @description Response payload. */ data: { /** @description Opaque id of the scheduled alarm. */ alarm_id: string; /** @description The resolved wake-up time, as an ISO 8601 timestamp. */ wake_at: string; }; }; AnalyticsDaily: { /** @description Date in YYYY-MM-DD format. */ date: string; /** @description Total number of test runs on this date. */ run_count: number; /** @description Number of passed test runs. */ passed_runs: number; /** @description Number of failed test runs. */ failed_runs: number; /** @description Number of test runs that errored. */ error_runs: number; /** @description Number of cancelled test runs. */ cancelled_runs: number; /** @description Number of reruns on this date. */ rerun_count: number; /** @description Total number of tests executed. */ total_tests: number; /** @description Number of passed tests. */ passed_tests: number; /** @description Number of failed tests. */ failed_tests: number; /** @description Number of failed tests after applying snoozes. */ failed_tests_after_snooze: number; /** @description Number of flaky tests. */ flaky_tests: number; }; AnalyticsErrorResponse: { /** @description Human-readable error message. */ error: string; }; AnalyticsRunsSummary: { /** @description Total number of test runs in the period. */ total_runs: number; /** @description Number of passed test runs. */ passed_runs: number; /** @description Number of failed test runs. */ failed_runs: number; /** @description Number of test runs that errored. */ error_runs: number; /** @description Pass rate as a percentage (0-100). */ pass_rate: number; /** @description Average number of tests per run. */ avg_tests_per_run: number; /** @description Total number of reruns. */ rerun_count: number; /** @description Rerun rate as a percentage (0-100). */ rerun_rate: number; }; AnalyticsTestCase: { /** @description Unique identifier for the test case. */ test_case_id: string; /** @description Name of the test case. */ test_name: string; /** @description File path of the test case. */ file_path: string; /** @description Name of the project the test belongs to. */ project_name: string; /** @description Array of tags associated with the test case. */ tags: string[]; /** @description ISO 8601 timestamp of the last time this test was run. */ last_run_at: string; /** @description Aggregated metrics for this test case. */ metrics: { /** @description Total number of runs for this test case. */ total_runs: number; /** @description Number of times the test passed. */ pass_count: number; /** @description Number of times the test failed. */ fail_count: number; /** @description Number of times the test was flaky. */ flaky_count: number; /** @description Pass rate as a percentage (0-100). */ pass_rate: number; /** @description Fail rate as a percentage (0-100). */ fail_rate: number; /** @description Flaky rate as a percentage (0-100). */ flaky_rate: number; }; /** @description History of test executions for this test case. */ history: components["schemas"]["TestCaseHistoryEntry"][]; }; AnalyticsTestCaseV2: { /** @description Unique identifier for the test case. */ test_case_id: string; /** @description Name of the test case. */ test_name: string; /** @description File path of the test case. */ file_path: string; /** @description Name of the project the test belongs to. */ project_name: string; /** @description Array of tags associated with the test case. */ tags: string[]; /** @description ISO 8601 timestamp of the last time this test was run. */ last_run_at: string; /** @description Aggregated metrics for this test case. */ metrics: { /** @description Total number of runs for this test case. */ total_runs: number; /** @description Number of times the test passed. */ pass_count: number; /** @description Number of times the test failed. */ fail_count: number; /** @description Number of times the test was flaky. */ flaky_count: number; /** @description Pass rate as a percentage (0-100). */ pass_rate: number; /** @description Fail rate as a percentage (0-100). */ fail_rate: number; /** @description Flaky rate as a percentage (0-100). */ flaky_rate: number; }; }; AnalyticsTestCasesResponse: { /** @description Response payload. */ data: { test_cases: components["schemas"]["AnalyticsTestCase"][]; summary: components["schemas"]["AnalyticsTestCasesSummary"]; }; }; AnalyticsTestCasesSummary: { /** @description Total number of test cases. */ total_test_cases: number; /** @description Number of test cases that have execution history. */ test_cases_with_history: number; }; AnalyticsTestCasesV2Response: { /** @description Response payload. */ data: { test_cases: components["schemas"]["AnalyticsTestCaseV2"][]; summary: components["schemas"]["AnalyticsTestCasesSummary"]; }; }; AnalyticsTestCountResponse: { /** @description Response payload. */ data: { daily: components["schemas"]["TestCountByDayEntry"][]; summary: components["schemas"]["TestCountSummary"]; }; }; AnalyticsTestRunsResponse: { /** @description Response payload. */ data: { daily: components["schemas"]["AnalyticsDaily"][]; summary: components["schemas"]["AnalyticsRunsSummary"]; }; }; AnnouncementsSeenResponse: { /** @description Response payload. */ data: { /** @description Announcements created at or before this time count as seen. Defaults to the user's signup time. */ seen_at: string; }; }; ApiKeyCreateResponse: { /** @description Response payload. */ data: { /** @description The created API key(s), with full secret. */ api_keys: components["schemas"]["CreatedProjectApiKey"][]; }; }; ApiKeyListResponse: { /** @description Response payload. */ data: { /** @description The project's API keys (secrets truncated). */ api_keys: components["schemas"]["TruncatedProjectApiKey"][]; }; }; ApiKeySuccessResponse: { /** @description Response payload. */ data: { /** * @description Always true on success. * @enum {boolean} */ success: true; }; }; Artifact: { /** @description Artifact path relative to the test run. */ key: string; /** @description HTTP URL to download the artifact. */ url: string; /** @description File size in bytes. */ size: number; /** @description ISO 8601 timestamp of when the artifact was last modified. */ last_modified: string; }; AttachFailureGroupMemberRequest: { /** @description The run in which this failure was observed. */ test_run_id: number; /** @description Test case ID (normalized 41-character Playwright test id) of the failing test. */ test_case_id?: string; /** * @deprecated * @description Deprecated alias of `test_case_id`. */ pw_test_id?: string; }; AvailableReporter: { /** * @description Posts run status updates to Slack channels. * @enum {string} */ reporter_type: "slack_run_status"; /** * @description `available` when the organization has at least one registered Slack channel; otherwise `not_connected`. * @enum {string} */ status: "available" | "not_connected"; /** @description The organization's registered, unarchived Slack channels a reporter config can name. */ slack_channels: components["schemas"]["ReporterSlackChannel"][]; } | { /** * @description Posts a GitHub check run on the build commit. * @enum {string} */ reporter_type: "github_check"; /** * @description `available`: the GitHub Reporter app is installed with the permission this reporter needs. `not_installed`: no install for the organization. `install_requested`: an install is waiting for a GitHub owner's approval. `missing_permission`: installed, but without the permission this reporter needs (`checks` for check runs and the linked test changes check, `pull_requests` for PR comments). * @enum {string} */ status: "available" | "not_installed" | "install_requested" | "missing_permission"; /** @description Repositories (`owner/name`) the install covers. The reporter posts only for runs whose `build.repo` is one of these. */ repositories: string[]; } | { /** * @description Posts (and updates) a comment on the pull request for the build branch. * @enum {string} */ reporter_type: "github_pr_comment"; /** * @description `available`: the GitHub Reporter app is installed with the permission this reporter needs. `not_installed`: no install for the organization. `install_requested`: an install is waiting for a GitHub owner's approval. `missing_permission`: installed, but without the permission this reporter needs (`checks` for check runs and the linked test changes check, `pull_requests` for PR comments). * @enum {string} */ status: "available" | "not_installed" | "install_requested" | "missing_permission"; /** @description Repositories (`owner/name`) the install covers. The reporter posts only for runs whose `build.repo` is one of these. */ repositories: string[]; } | { /** * @description Tracks the test branch of the app pull request a run was triggered for, and keeps the linked test changes check on that pull request up to date. * @enum {string} */ reporter_type: "github_linked_changes"; /** * @description `available`: the GitHub Reporter app is installed with the permission this reporter needs. `not_installed`: no install for the organization. `install_requested`: an install is waiting for a GitHub owner's approval. `missing_permission`: installed, but without the permission this reporter needs (`checks` for check runs and the linked test changes check, `pull_requests` for PR comments). * @enum {string} */ status: "available" | "not_installed" | "install_requested" | "missing_permission"; /** @description Repositories (`owner/name`) the install covers. The reporter posts only for runs whose `build.repo` is one of these. */ repositories: string[]; } | { /** * @description Emails a report when the run ends to every user whose email domain is one of the organization's email domains. * @enum {string} */ reporter_type: "email_run_report"; /** * @description Always `available`. * @enum {string} */ status: "available"; } | { /** * @description Sends a Slack DM to whoever started the run when it ends. Runs only: environments cannot hold it. * @enum {string} */ reporter_type: "slack_creator_dm"; /** * @description For runs triggered by the caller: `available` when the person the run would be attributed to (the signed-in user, or an agent session's creator) has a linked Slack account; `not_linked` when they have none; `no_creator` for callers such as project API keys, whose runs have no one to DM. * @enum {string} */ status: "available" | "not_linked" | "no_creator"; }; BillingMeterSummary: { /** @enum {string} */ meter: "ai_credits" | "test_minutes"; included_qty: number | null; overage_price_cents: number | null; /** @description Units used so far this period. */ used: number; /** @description Projected units at month end (trailing 7-day pace); null when too early to project. */ projected: number | null; /** @description Usage beyond the allowance, priced at the overage rate. On a trial, credits pay for it. */ overage_cents: number; projected_overage_cents: number | null; }; BillingMonthSummaryResponse: { /** @description Response payload. */ data: { /** @description Usage month, YYYY-MM (UTC). For a billing cycle, the month it starts in. */ month: string; /** @description The period's key (YYYY-MM-DD), to pass as `period`: the 1st for a calendar month, the scheduled start date for a billing cycle. */ period_key: string; /** * @description `month`: a UTC calendar month. `cycle`: a Dodo billing cycle [previous_billing_date, next_billing_date). * @enum {string} */ period_kind: "month" | "cycle"; period_start: string; /** @description Exclusive (ISO 8601). */ period_end: string; /** @description Whether this is the current period (month or cycle). */ is_current_month: boolean; /** @description The shared plan in effect; null for no plan or a custom contract. */ plan: { name: string; currency: string; base_price_cents: number; /** @description Whether the org is on a trial, where usage draws from credits instead of being billed. */ trial: boolean; } | null; meters: components["schemas"]["BillingMeterSummary"][]; projects: { project_id: number; name: string; slug: string; ai_credits: number; test_minutes: number; }[]; /** @description Overage billed on top of the plan so far. 0 on a trial, where credits pay for usage. */ overage_cents: number; projected_overage_cents: number | null; /** @description The trial's credit, for the current period of an org on a trial; null otherwise. */ credits: { /** @description Total credit granted to the org, in US cents. */ granted_cents: number; /** @description Credit used so far, in US cents. */ used_cents: number; /** @description Credit left on grants active now, in US cents. The trial ends at 0. */ balance_cents: number; /** @description When the last active grant expires (ISO 8601); null when none is active. */ expires_at: string | null; } | null; /** @description Overage of the previous usage period, as a guide when picking a limit. Current period only. */ last_month_overage_cents: number | null; usage_limit: components["schemas"]["UsageLimit"]; }; }; BillingPeriod: { /** @description Pass as `period` to the month summary (YYYY-MM-DD). */ key: string; /** * @description `month`: a UTC calendar month. `cycle`: a Dodo billing cycle [previous_billing_date, next_billing_date). * @enum {string} */ kind: "month" | "cycle"; /** @description Inclusive (ISO 8601). */ start: string; /** @description Exclusive (ISO 8601). */ end: string; is_current: boolean; }; BillingPeriodsResponse: { /** @description Response payload. */ data: components["schemas"]["BillingPeriod"][]; }; BranchExistsResponse: { /** @description Whether the branch exists. */ exists: boolean; }; CancelTestRunFailureResponse: { /** @description Reason the test run could not be cancelled. */ message: string; }; CancelTestRunRequest: { /** @description Optional reason for cancelling the test run. Recorded for auditing purposes. */ reason?: string; }; CancelTestRunResponse: { /** @description Confirmation message indicating the test run was cancelled. */ message: string; }; ChatSession: { /** @description Chat session ID. */ id: number; /** @description Session title. */ title: string | null; /** @description Creator user ID. */ created_by: string | null; /** @description Creation timestamp (ISO). */ created_at: string; /** @description Last update timestamp (ISO). */ updated_at: string; /** @description Owning project ID. */ project_id: number; /** @description Hive agent ref the session runs (`` or `@`). The legacy values `chat` and `triage` mean the default agent, `main`. */ mode: string; /** * @description Workload class, assigned server-side; null for an ordinary user chat. Read-only — no request body accepts it. * @enum {string|null} */ purpose?: "triage" | "manager" | null; /** @description Requested model. */ model: string | null; /** @description Tests impacted by this session. */ impacted_tests: { test_case: { name: string; suites: string[]; file_path: string; start_line: number; end_line: number; }; /** @enum {string} */ type: "added" | "removed" | "modified"; modified_by: { file_path: string; line: { number: number; /** @enum {string} */ type: "added" | "removed" | "modified"; }; }[] | null; }[]; /** @description Whether the agent is awaiting user input. */ ask_user_for_input: boolean | null; /** @description Langfuse trace ID. */ langfuse_trace_id: string | null; /** @description Whether the session is closed. */ is_closed: boolean; /** @description For a manager closed by rollover, the manager session that took over. */ superseded_by_session_id: number | null; /** @description The session this one was spawned from: the agent session that delegated it, or the manager it took over from. */ parent_chat_session_id?: number | null; /** * @description How this session came from its parent. * @enum {string|null} */ parent_relationship?: "delegation" | "manager_handoff" | null; /** @description Feature flags enabled for the session. */ feature_flags: string[]; /** @description Durable outbox row for the first message. */ pending_first_message?: unknown; }; ChatSessionBranch: { /** @description Branch name. */ branch_name: string; /** @description Repository host. */ repo_host: string; /** @description Repository owner. */ repo_owner: string; /** @description Repository name. */ repo_name: string; /** @description When the branch was registered (ISO). */ created_at: string; /** @description Pull requests opened from this branch, oldest first. Empty when no PR exists yet. */ pull_requests: components["schemas"]["ChatSessionBranchPullRequest"][]; }; ChatSessionBranchPullRequest: { /** @description Pull request number. */ number: number; /** * @description Current pull request status. * @enum {string} */ status: "unopened" | "open" | "opened" | "closed" | "merged"; /** @description Pull request URL. */ url: string; /** @description Branch the pull request merges into. */ base_branch: string; /** @description Merge timestamp (ISO), null if not merged. */ merged_at: string | null; /** @description When the head branch was deleted (ISO), null while it exists. */ head_branch_deleted_at: string | null; /** @description Creation timestamp (ISO). */ created_at: string; /** @description Last update timestamp (ISO). */ updated_at: string; }; ChatSessionBranchesResponse: { /** @description Response payload. */ data: components["schemas"]["ChatSessionBranch"][]; }; /** @description One-shot subscription that wakes the calling agent session when this session next waits for input; null when none was created. */ ChatSessionCallerSubscription: { /** @description Subscription ID. */ id: number; } | null; ChatSessionCloseResponse: { /** @description Response payload. */ data: { chat_session: components["schemas"]["ChatSession"]; }; }; ChatSessionCommitDiffResponse: { /** @description Response payload. */ data: { /** @description Unified diff for the commit. */ diff: string; /** @description Commit SHA. */ commit: string; }; }; ChatSessionCommitsDiffsResponse: { /** @description Response payload. */ data: { /** @description Diffs keyed by commit SHA. */ diffs: { [key: string]: { /** @description Commit SHA. */ commit: string; /** @description Unified diff, or null if unavailable. */ diff: string | null; }; }; }; }; ChatSessionCostTotals: { /** @description Main-agent cost. */ main: number; /** @description Sub-agent cost. */ subagent: number; /** @description Manager handoff-note cost. */ handoff: number; /** @description Total cost (main + subagent + handoff). */ total: number; /** @description Input-token cost. */ costInput: number; /** @description Output-token cost. */ costOutput: number; /** @description Cache-read cost. */ costCacheRead: number; /** @description Cache-write cost. */ costCacheWrite: number; /** @description Input tokens consumed. */ tokensIn: number; /** @description Output tokens produced. */ tokensOut: number; /** @description Cache-read tokens. */ cacheRead: number; /** @description Cache-write tokens. */ cacheWrite: number; /** @description Cache hit rate, or null when no prompt input. */ cacheHitRate: number | null; }; ChatSessionCostsResponse: { data: components["schemas"]["ChatSessionCostTotals"]; /** @description Number of session entries summed. */ entries_count: number; }; ChatSessionCreateResponse: { /** @description Response payload. */ data: { chat_session: components["schemas"]["ChatSession"]; subscription: components["schemas"]["ChatSessionCallerSubscription"]; }; }; ChatSessionCumulativeDiffResponse: { /** @description Response payload. */ data: { /** @description Cumulative diff from base branch to head. */ diff: string | null; }; }; ChatSessionDetailResponse: { /** @description Response payload. */ data: { chat_session: components["schemas"]["ChatSessionWithUser"]; }; }; ChatSessionDiffResponse: { /** @description Response payload. */ data: { /** @description Working diff. */ diff: string | null; /** @description SHA of the last commit. */ last_commit: string | null; /** @description Timestamp of the last commit (ISO). */ last_commit_at: string | null; /** @description Associated pull request metadata, if any. */ pull_request: { /** @description Pull request title. */ title: string; /** @description Pull request description. */ description: string; } | null; /** @description Base ref of the comparison. */ base_ref?: string; /** @description Head ref of the comparison. */ head_ref?: string; }; }; ChatSessionEntryRange: { /** @description Session log entries in log_seq order. */ entries: unknown[]; /** @description from_seq for the next page when the range holds more than `limit` entries, else null. */ next_from_seq: number | null; }; ChatSessionEntryRangeResponse: { data: components["schemas"]["ChatSessionEntryRange"]; }; ChatSessionForwardMessageResponse: { /** @description Response payload. */ data: { chat_session: components["schemas"]["ChatSession"]; subscription: components["schemas"]["ChatSessionCallerSubscription"]; }; }; ChatSessionListItem: { /** @description Chat session ID. */ id: number; /** @description Session title. */ title: string | null; /** @description Creator user ID. */ created_by: string | null; /** @description Creation timestamp (ISO). */ created_at: string; /** @description Last update timestamp (ISO). */ updated_at: string; /** @description Owning project ID. */ project_id: number; /** @description Hive agent ref the session runs (`` or `@`). The legacy values `chat` and `triage` mean the default agent, `main`. */ mode: string; /** * @description Workload class, assigned server-side; null for an ordinary user chat. Read-only — no request body accepts it. * @enum {string|null} */ purpose?: "triage" | "manager" | null; /** @description Requested model. */ model: string | null; /** @description Whether the agent is awaiting user input. */ ask_user_for_input: boolean | null; /** @description Langfuse trace ID. */ langfuse_trace_id: string | null; /** @description Whether the session is closed. */ is_closed: boolean; /** @description For a manager closed by rollover, the manager session that took over. */ superseded_by_session_id: number | null; /** @description The session this one was spawned from: the agent session that delegated it, or the manager it took over from. */ parent_chat_session_id?: number | null; /** * @description How this session came from its parent. * @enum {string|null} */ parent_relationship?: "delegation" | "manager_handoff" | null; /** @description Feature flags enabled for the session. */ feature_flags: string[]; /** @description Resolved Supabase details for the creator. */ created_by_user_detail?: { /** @description Supabase user ID. */ id: string; /** @description User email. */ email: string; /** @description Display name. */ name: string; /** @description Avatar URL. */ picture: string; } | null; /** @description Number of the session's most recently updated PR, if any. */ pr_number: number | null; /** * @description Status of the session's most recently updated PR ('unopened' when it has none). * @enum {string} */ pr_status: "unopened" | "open" | "opened" | "closed" | "merged"; /** @description Name of the owning project. */ project_name: string | null; /** @description Repository name of the owning project. */ project_repo_name: string | null; /** @description Repository owner of the owning project. */ project_repo_owner: string | null; }; ChatSessionListResponse: { /** @description The page of chat sessions. */ data: components["schemas"]["ChatSessionListItem"][]; /** @description Pagination + resolved filter state. */ pagination: { /** @description Current page. */ page: number; /** @description Items per page. */ per_page: number; /** @description Resolved filter state for the query. */ filter_state: { showClosed: boolean; filterState: { field: string; /** @enum {string} */ operator: "eq" | "neq" | "in" | "nin" | "gt" | "gte" | "lt" | "lte" | "contains" | "startsWith"; value: string | number | boolean | (string | number | boolean)[]; }[]; userIds: string[]; /** @enum {string} */ category?: "executor" | "user"; }; }; }; ChatSessionPatchResponse: { /** @description Response payload. */ data: { chat_session: components["schemas"]["ChatSession"]; }; }; ChatSessionSeedRequest: { /** @description Hive agent recorded on the session, as `` or `@`. Defaults to `main`. */ agent?: string | null; messages: { /** @enum {string} */ role: "user" | "assistant"; text: string; }[]; }; ChatSessionSeedResponse: { /** @description Response payload. */ data: { chat_session: components["schemas"]["ChatSession"]; }; }; ChatSessionSnapshot: { /** @description Current sandbox status event. */ sandbox?: unknown; /** @description Agent lifecycle state (active run ids, is_working). */ lifecycle?: unknown; /** @description All user messages for the session. */ user_messages: unknown[]; }; ChatSessionSnapshotResponse: { data: components["schemas"]["ChatSessionSnapshot"]; }; ChatSessionState: { /** @description Recent session log entries. */ entries: unknown[]; /** @description User messages for the session. */ user_messages: unknown[]; /** @description Current sandbox state, or null when none. */ sandbox?: unknown; }; ChatSessionStateResponse: { data: components["schemas"]["ChatSessionState"]; pagination: components["schemas"]["Pagination"]; }; ChatSessionSubagentEntries: { /** @description Session log entries in log_seq order. */ entries: unknown[]; }; ChatSessionSubagentEntriesResponse: { data: components["schemas"]["ChatSessionSubagentEntries"]; }; ChatSessionSubagents: { subagents: { /** @description Tool call that started the subagent. */ tool_call_id: string; /** @description Session log entries in log_seq order. */ entries: unknown[]; }[]; }; ChatSessionSubagentsResponse: { data: components["schemas"]["ChatSessionSubagents"]; }; ChatSessionTranscriptResponse: { data: components["schemas"]["SessionTranscript"]; }; ChatSessionUserDetail: { /** @description Supabase user ID. */ id: string; /** @description User email. */ email: string; /** @description Display name. */ name: string; /** @description Avatar URL. */ picture: string; }; ChatSessionUsersResponse: { /** @description Response payload. */ data: components["schemas"]["ChatSessionUserDetail"][]; }; ChatSessionWithUser: { /** @description Chat session ID. */ id: number; /** @description Session title. */ title: string | null; /** @description Creator user ID. */ created_by: string | null; /** @description Creation timestamp (ISO). */ created_at: string; /** @description Last update timestamp (ISO). */ updated_at: string; /** @description Owning project ID. */ project_id: number; /** @description Hive agent ref the session runs (`` or `@`). The legacy values `chat` and `triage` mean the default agent, `main`. */ mode: string; /** * @description Workload class, assigned server-side; null for an ordinary user chat. Read-only — no request body accepts it. * @enum {string|null} */ purpose?: "triage" | "manager" | null; /** @description Requested model. */ model: string | null; /** @description Tests impacted by this session. */ impacted_tests: { test_case: { name: string; suites: string[]; file_path: string; start_line: number; end_line: number; }; /** @enum {string} */ type: "added" | "removed" | "modified"; modified_by: { file_path: string; line: { number: number; /** @enum {string} */ type: "added" | "removed" | "modified"; }; }[] | null; }[]; /** @description Whether the agent is awaiting user input. */ ask_user_for_input: boolean | null; /** @description Langfuse trace ID. */ langfuse_trace_id: string | null; /** @description Whether the session is closed. */ is_closed: boolean; /** @description For a manager closed by rollover, the manager session that took over. */ superseded_by_session_id: number | null; /** @description The session this one was spawned from: the agent session that delegated it, or the manager it took over from. */ parent_chat_session_id?: number | null; /** * @description How this session came from its parent. * @enum {string|null} */ parent_relationship?: "delegation" | "manager_handoff" | null; /** @description Feature flags enabled for the session. */ feature_flags: string[]; /** @description Durable outbox row for the first message. */ pending_first_message?: unknown; /** @description Resolved Supabase details for the creator. */ created_by_user_detail?: { /** @description Supabase user ID. */ id: string; /** @description User email. */ email: string; /** @description Display name. */ name: string; /** @description Avatar URL. */ picture: string; } | null; }; CheckSlugResponse: { /** @description Response payload. */ data: { /** @description Whether the slug is free. */ available: boolean; }; }; ClaimRunnerBackendBody: { /** @description The token from the installation's registration link. */ registration_token: string; /** * @description The CloudFormation event the stack is handling. * @enum {string} */ request_type: "Create" | "Update" | "Delete"; /** @description ARN of the calling stack. */ stack_id: string; /** @description The stack's control-plane role. */ role_arn: string; /** @description The stack's ECS cluster. */ cluster_name: string; /** @description The stack's worker log group. */ log_group_name: string; /** @description The stack's job queue prefix. */ queue_prefix: string; /** @description Template release. */ stack_version: string; /** * Format: date-time * @description When the template release was published. */ stack_released_at?: string; /** @description Worker image. */ worker_version: string; /** @description Job protocol version. */ protocol_version: string; /** @description Optional features the template supports. */ capabilities: string[]; }; ClaimRunnerBackendResponse: { /** @description Response payload. */ data: { /** @description The registered backend, or null when nothing matched. */ runner_backend_id: number | null; /** @enum {string|null} */ status: "pending" | "active" | "disabled" | null; /** @description What the call did. */ message: string; }; }; CompareBranchesResponse: { /** @description Commits head is ahead by. */ ahead: number; /** @description Commits head is behind by. */ behind: number; /** @description Number of files changed. */ files_changed: number; /** @description Number of commits in the comparison. */ total_commits: number; /** @description GitHub compare URL. */ comparison_url: string; }; ConnectedGithubAccount: { /** @description GitHub numeric user ID. */ user_id: string; /** @description GitHub login/username. */ username: string; /** @description GitHub display name. */ display_name: string | null; /** @description GitHub avatar URL. */ avatar_url: string | null; }; ConnectedSlackAccount: { /** @description Slack user ID. */ user_id: string; /** @description Slack username. */ user_name: string | null; /** @description Slack real name. */ real_name: string | null; /** @description Slack display name. */ display_name: string | null; /** @description Slack avatar image URL. */ image_url: string | null; /** @description Slack team (workspace) ID. */ team_id: string; }; CreateAlarmRequest: { /** @description Why the alarm fires, in at most 200 characters, e.g. "check run 152810 finished". It is set once and cannot be edited. Keep state and rules out of it. */ message: string; /** @description Whole minutes, hours or days (m/h/d), e.g. "15m", "2h", "1d" or "1h30m", between 5m and 72h. Seconds are not supported: use "5m", not "90s" or "300s". */ delay: string; }; CreateApiKeyRequest: { /** @description Human-readable name for the API key. */ name: string; }; CreateCreditGrantRequest: { /** @description Organisation to grant credit to. */ org_id: number; /** @description Credit to grant, in US cents (5000 = $50). */ amount_cents: number; /** * Format: date-time * @description When the credit expires. The trial plan is extended to this time if it ends earlier. */ expires_at: string | null; /** @description Lowercase slug that groups grants for comparison, e.g. `admin_trial`, `high_risk_trial`, `trial_extension`. */ campaign: string; /** @description Free-text note on why the credit is granted. */ reason?: string; /** @description Trial plan to start the organisation on. Required when it has no trial; omit it when extending one. */ plan_id?: number; }; CreateCreditOfferRequest: { /** * Format: email * @description Email to reserve the credit for. Pass exactly one of `email`, `email_domain` and `all_work_domains`. */ email?: string; /** @description Work email domain to reserve the credit for, e.g. `acme.com`. Public providers like gmail.com are refused. */ email_domain?: string; /** * @description Offer the credit to the first organisation created at every work email domain that hasn't had a trial. One such offer can be open at a time. * @enum {boolean} */ all_work_domains?: true; /** @description Credit to grant, in US cents (5000 = $50). */ amount_cents: number; /** @description Days the credit lasts, counted from the claim. */ duration_days: number; /** @description Trial plan to start the organisation on. */ plan_id: number; /** @description Lowercase slug the resulting grant is recorded under, e.g. `admin_trial`. */ campaign: string; /** @description Free-text note on why the offer is made. */ reason?: string; /** * Format: date-time * @description Deadline to claim the offer. Omit for no deadline. */ claim_by?: string | null; }; CreateDummyNotificationBody: { project_id: number; /** * @default chat_session_waiting * @enum {string} */ kind: "chat_session_waiting" | "test_run"; }; CreateEnvironmentRequest: { /** @description Display name. */ name: string; /** @description URL-friendly identifier; unique within the project. */ slug: string; /** @description Playwright project names to include. Items must not start with '!'. */ playwright_projects_match?: string[]; /** @description Playwright project names to exclude. */ playwright_projects_ignore?: string[]; /** @description Cron expression for scheduled triggers, or null. */ scheduled_trigger?: string | null; /** @description Concurrency group and policy scheduled runs are triggered with. Omit to keep the current value; null to fall back to the project's legacy concurrency setting. */ scheduled_concurrency?: { /** @description Free-form group key, scoped to the project. */ group: string; /** * @description `cancel` cancels the group's active run and starts; `wait` queues behind it. * @enum {string} */ on_conflict: "cancel" | "wait"; } | null; /** @description Reporter configuration for the environment. Slack channels (`slack_channels` or `slack_channel_ids`) must be active registered channels of the project's organization (GET /api/v2/slack/channels); they are stored as registered ids. */ reporter_config?: { /** * @description Reporter config schema version. Always `1`. * @enum {number} */ schema_version: 1; /** @description Reporters, at most one per `reporter_type`. Replaces the stored list on write; an empty array disables them. */ reporters: ({ /** * @description Posts run status updates to Slack channels. * @enum {string} */ reporter_type: "slack_run_status"; /** @description Slack channel ids (`C…`), as shown in Slack's channel details. Shared (Slack Connect) channels have the same id in every workspace. Each must be a registered, unarchived channel of the project's organization. */ slack_channels?: string[]; /** @description Registered Slack channel ids from `GET /api/v2/slack/channels` (the numeric `id`). Can be combined with `slack_channels`. */ slack_channel_ids?: number[]; } | { /** * @description Posts a GitHub check run on the build commit. Needs `build` with a repository the GitHub Reporter app is installed on. * @enum {string} */ reporter_type: "github_check"; } | { /** * @description Posts (and updates) a comment on the pull request for the build branch. Needs `build` with a repository the GitHub Reporter app is installed on. * @enum {string} */ reporter_type: "github_pr_comment"; } | { /** * @description Tracks the test branch named after the head branch of the app pull request the run was triggered for (`trigger.event` `pull_request`), and keeps the `Empirical linked test changes` check on that pull request up to date: it passes when the test branch has nothing left to merge and fails while it has unmerged commits. The pull request's latest run decides whether it is tracked. Does nothing for runs not triggered by a pull request. Needs `build` with a repository the GitHub Reporter app is installed on. * @enum {string} */ reporter_type: "github_linked_changes"; } | { /** * @description Emails a report when the run ends to every user whose email domain is one of the organization's email domains. * @enum {string} */ reporter_type: "email_run_report"; })[]; }; }; CreateFailureGroupRequest: { /** @description Human label for the failure mode (the group_key). */ label: string; /** * @description app or test issue. * @enum {string} */ type: "app" | "test"; /** @description Markdown root-cause summary. */ diagnosis: string; /** @description What to do next. */ recommendation: string; /** @description Identifying signals for future matching. */ fingerprint?: { signals: { kind: string; value: string; /** @enum {string} */ match?: "exact" | "contains" | "glob" | "regex"; weight?: number; /** @enum {string} */ source: "machine" | "agent" | "human"; data?: { [key: string]: unknown; }; }[]; } | null; /** @description The group's matcher function for future auto-matching. Attribution is derived from the caller, never the body. */ matcher?: { /** @description Plain-JS async function source: `async ({ testRun, testCase, traceUtils }) => boolean`. */ source: string; /** @description Human-readable summary of what the matcher matches and why; re-articulated on every edit. */ description: string; /** * @description Input-contract version the source was written against. * @default 1 */ contract_version: number; } | null; /** @description Run this diagnosis is based on (provenance). */ source_run_id?: number | null; }; CreateFileRequest: { /** @description File name. */ name: string; /** * @description MIME type. The upload must send the same `Content-Type` header. * @default application/octet-stream */ mime_type: string; /** @description File size in bytes. */ size_bytes?: number; /** @description Tool call that produced the file, when an agent uploads it. The chat session is taken from the caller's credentials. */ origin_tool_call_id?: string; }; CreateFileResponse: { /** @description Response payload. */ data: { file: components["schemas"]["File"]; /** @description Presigned PUT URL, valid for 1 hour. Send the file body with the same `Content-Type` as `mime_type`. */ upload_url: string; }; }; CreateJiraInstallationRequest: { /** @description Organisation the installation belongs to. */ org_id: number; /** @description OAuth code from Atlassian's redirect. Required for a signed-in user. */ code?: string; /** * Format: uri * @description Redirect URI the authorize request used; Atlassian requires it to match. Required with `code`. */ redirect_uri?: string; /** @description Atlassian cloud ID. System callers only. */ jira_cloud_id?: string; /** * Format: uri * @description Base URL of the Jira site. System callers only. */ jira_site_url?: string; /** @description OAuth access token. System callers only. */ jira_access_token?: string; /** @description OAuth refresh token. System callers only. */ jira_refresh_token?: string; /** * Format: date-time * @description Expiry of the access token. System callers only. */ jira_access_token_expires_at?: string | null; /** @description When true, register the Jira webhook after install. */ register_webhook?: boolean; }; CreateMemoryRequest: { /** @description Memory content (markdown). */ content: string; /** @description Content format version. Defaults to 1. */ format_version?: number; /** @description Display name (v2). */ name?: string | null; /** @description Short description (v2). */ description?: string | null; /** @description Origin of the memory. Free text; "app_knowledge" marks rows migrated from the pre-rename App Knowledge files. */ source?: string | null; /** @description Source file path for file-sourced memories; unique within the project. */ source_path?: string | null; /** @description Why this change was made (max 500 characters). Shown in the session's memory change report. */ reason?: string | null; }; CreateOrderFormRequest: { org_id: number; /** @enum {string} */ pricing_model: "slab" | "fixed"; form_date?: string | null; subscription_start_date?: string | null; term_months?: number | null; end_date?: string | null; status?: string; /** Format: date-time */ signed_at?: string | null; contract_currency?: string; pdf_r2_key?: string | null; lines: { /** @enum {string} */ kind?: "tier" | "addon"; tier?: string | null; label?: string | null; base_price_cents: number; meters?: { /** @enum {string} */ meter: "test_suite_size" | "ai_credits" | "test_minutes" | "test_run_duration"; included_qty?: number | null; overage_price_cents?: number | null; }[]; }[]; }; CreateOrgInviteRequest: { /** * Format: email * @description Email address to invite. */ email: string; }; CreatePlanAssignmentBadRequest: components["schemas"]["ErrorResponse"] | { /** @description Reason the assignment could not be created. */ error: string; }; CreatePlanAssignmentRequest: { /** @description Organisation this plan assignment belongs to. */ org_id: number; /** @description Plan the organisation is on. */ plan_id: number; /** * Format: date-time * @description When the assignment starts being effective (timestamptz). */ effective_from: string | null; /** * Format: date-time * @description When the assignment stops being effective, or null for open-ended. */ effective_to?: string | null; /** * @description Origin of the assignment. Defaults to `manual`. * @enum {string} */ source?: "order_form" | "derived_from_invoice" | "manual"; }; CreatePlanRequest: { /** @description Stable unique key, e.g. `managed`. */ key: string; /** @description Display name. */ name: string; /** * @description Currency the plan is priced in. Defaults to `usd`. * @enum {string} */ currency?: "usd" | "inr" | "aed"; /** @description Monthly base price in cents of `currency`. */ base_price_cents: number; /** @description Dodo product that bills this plan by subscription, in this environment's Dodo mode. New Dodo checkouts use the newest active `dodo_sync` plan that has one. */ dodo_product_id?: string; /** @description Sell the plan through Dodo: its Dodo product is created now if `dodo_product_id` is unset, and it is offered at checkout. Defaults to `false`. */ dodo_sync?: boolean; /** * @description Metered allowances, in display order. * @default [] */ meters: { /** * @description Meter key from the meter registry. Its unit applies to both `included_qty` and `overage_price_cents`. * @enum {string} */ meter: "test_suite_size" | "ai_credits" | "test_minutes" | "test_run_duration"; /** @description Units included each month. */ included_qty?: number | null; /** @description Price per unit above the allowance, in cents; may be fractional. */ overage_price_cents?: number | null; }[]; }; CreateProjectResourceRequest: { /** @description Display name for the file. */ name: string; /** @description MIME type of the file. */ mime_type?: string; /** @description File size in bytes. */ size_bytes?: number; /** @description External URL (e.g. a Google Sheet link). When provided, creates a link-type file with no R2 upload. */ url?: string; /** @description Description for the file. */ description?: string; }; CreateProjectResourceResponse: { /** @description Response payload. */ data: { resource: components["schemas"]["ResourceWithUploadUrl"]; }; }; CreateProjectResponse: { /** @description Response payload. */ data: { /** @description The created project. */ project: { /** @description Project ID. */ id: number; /** @description Project name. */ name: string; /** @description Repository name. */ repo_name: string; /** @description Organisation ID. */ org_id: number; /** @description Project slug. */ slug: string; }; /** @description Whether the backing GitHub repo was created. When false the project exists but repo provisioning failed and needs a retry. */ repo_created: boolean; }; }; CreateRealtimeTokenBody: { /** @description Channel names to subscribe to, e.g. `chat-sessions-project--`, `test-run--` or `user--`. */ channels: string[]; }; CreateSlackThreadEntityLinkRequest: { /** * @description Entity type to link. * @enum {string} */ entity_type: "test_run" | "failure_group"; /** @description Test run ID or failure group ID in the scoped project. */ entity_id: string; /** * @description Make this thread the preferred thread for the entity in its channel, replacing any previous canonical thread there. * @default false */ is_canonical: boolean; }; CreateSnoozeRequest: { /** @description Array of Playwright test IDs (41-character hashes) to snooze. */ test_ids: string[]; /** @description ISO 8601 timestamp for when the snooze should expire. */ snooze_until: string; /** @description Optional description explaining why the tests are being snoozed. */ description?: string; /** @description Optional user identifier for the snooze creator. Set automatically for dashboard users. */ created_by?: string; /** @description Environment ID to scope the snooze to. If omitted, applies to all environments. */ scoped_to_environment_id?: number; /** @description ID of the test run this snooze was created from, if applicable. */ created_from_test_run_id?: string | number; }; CreateSystemMessageRequest: { body: string; project_ids?: number[]; }; CreateSystemMessageResponse: { data: { system_message: components["schemas"]["SystemMessage"]; recipients: components["schemas"]["SystemMessageRecipient"][]; skipped_project_ids: number[]; }; }; CreateTaskError: { /** @description Always null for error responses. */ data: unknown; /** @description Error details. */ error: { /** @description Human-readable error message. */ message: string; /** @description Required fields that were missing or empty. */ missingFields?: string[]; }; }; CreateTaskRequest: { /** @description Task title. */ title: string; /** @description Task description (Markdown). */ description: string; /** @description Where the task came from, e.g. `linear` or `dashboard`. */ source: string; /** @description Identifier of the task in its source system. */ source_identifier: string; /** * @description Initial status; defaults to `open`. * @enum {string} */ status?: "draft" | "open" | "in-review" | "closed" | "resolved"; /** @description User ID of the person the task is for. Defaults to the signed-in user, or to the person who started the calling agent's session. Pass it when acting for someone else; there must be a person. */ created_by?: string; }; CreateTaskResponse: { /** @description Response payload. */ data: { task: components["schemas"]["Task"]; }; }; CreateTestReportUploadUrlsRequest: { /** @description Report run ID (the folder under the project). */ run_id: string; files: { /** @description Path inside the run's report folder, e.g. `data/abc.png`. */ path: string; /** * @description MIME type the upload sends as `Content-Type`. * @default application/octet-stream */ content_type: string; /** * @description Storage class. When set, the upload must send the same `x-amz-storage-class` header. * @enum {string} */ storage_class?: "STANDARD" | "STANDARD_IA"; }[]; }; CreateTestReportUploadUrlsResponse: { /** @description Response payload. */ data: { files: { path: string; /** @description Presigned PUT URL, valid for 1 hour. */ upload_url: string; }[]; }; }; CreateTestRunResponse: { data: { trigger: { /** @description Whether the test run was triggered successfully. */ success: boolean; }; test_run: { /** @description Unique identifier for the test run. */ id: number; /** @description Current state of the test run. */ state: string; /** @description Normalized error code when branch resolution or execution failed. */ error_code: string | null; /** @description Git branch being tested. */ test_run_branch: string; /** @description ISO 8601 timestamp when the run was created. */ created_at: string; /** @description Concurrency group and policy the run was created with, or null when no limit applied. */ concurrency: { /** @description Concurrency group the run was scoped to. Runs in the same group are limited to one in progress at a time. */ group: string; /** * @description What this run did when the group already had an active run: `cancel` cancelled it, `wait` queued behind it. * @enum {string} */ on_conflict: "cancel" | "wait"; } | null; /** @description Requested, resolved, and executed test-repository code. */ test_code: { requested: { branch: string; /** @enum {string} */ source: "explicit" | "build" | "project_default" | "legacy"; /** @enum {string} */ if_missing: "error" | "use_default" | "create"; }; resolved: { branch: string | null; sha: string | null; /** @enum {string|null} */ fallback_reason: "requested_branch_missing" | null; }; execution: { ref: string | null; sha: string | null; /** @enum {string|null} */ ref_kind: "branch" | "temporary_merge" | null; }; merge_base: { branch: string; sha: string | null; } | null; /** @enum {string} */ resolution_status: "pending" | "resolved" | "branch_missing" | "merge_conflict" | "provider_error"; resolution_error_code: string | null; } | null; /** @description The `trigger` the run was created with, or null when none was sent. */ trigger: { /** * @description Event that produced the run. * @enum {string} */ event: "pull_request"; /** @description Pull request under test. */ pull_request: { /** @description Pull request number in the application repository. */ number?: number; /** @description Head branch. */ head: string; /** @description Base branch. */ base: string; }; } | null; }; }; }; CreateWebhookRequest: { /** * Format: uri * @description HTTPS endpoint that will receive event payloads. */ url: string; /** @description Event names this webhook subscribes to. */ events: string[]; }; CreatedProjectApiKey: { /** @description API key ID. */ id: number; /** @description Project the key belongs to. */ project_id: number | null; /** @description Human-readable name for the key. */ name: string; /** @description User ID of the creator, if known. */ created_by: string | null; /** @description ISO 8601 creation timestamp. */ created_at: string | null; /** @description ISO 8601 timestamp the key was last updated. */ updated_at: string | null; /** @description User ID of the last updater, if known. */ updated_by: string | null; /** @description ISO 8601 timestamp the key was last used. */ last_used_at: string | null; /** @description Whether the key is disabled. */ is_disabled: boolean | null; /** @description Whether the key is an internal service key. */ is_internal: boolean | null; /** @description Resolved details for the creating user, if available. */ created_by_user_detail: { /** @description User ID. */ id: string; /** @description User email. */ email: string; /** @description User display name. */ name: string; /** @description User avatar URL. */ picture: string; } | null; /** @description Resolved details for the last updating user, if available. */ updated_by_user_detail: { /** @description User ID. */ id: string; /** @description User email. */ email: string; /** @description User display name. */ name: string; /** @description User avatar URL. */ picture: string; } | null; /** @description The full API key secret (returned only once). */ api_key: string; }; CreatedWebhook: { /** @description Webhook ID. */ id: number; /** @description Project the webhook belongs to. */ project_id: number; /** @description Endpoint that receives event payloads. */ url: string; /** @description Event names this webhook subscribes to. */ events: string[]; /** @description Whether the webhook is active. */ is_active: boolean; /** @description ISO 8601 creation timestamp. */ created_at: string; /** @description ISO 8601 last-update timestamp. */ updated_at: string; /** @description Signing secret (returned only on creation). */ secret: string; }; CreditGrant: { /** @description Credit grant ID. */ id: number; /** @description Organisation the credit was granted to. */ org_id: number; /** @description Credit granted, in US cents. */ amount_cents: number; /** @description ISO-8601 timestamp the credit starts. */ starts_at: string; /** @description ISO-8601 timestamp the credit expires. */ expires_at: string; /** @description Slug that groups grants for comparison, e.g. `admin_trial` or `trial_extension`. */ campaign: string; /** @description Free-text note on why the credit was granted. */ reason: string | null; /** @description ID of the user or service that granted it. */ granted_by: string | null; /** @description Usage taken from this grant, in US cents; null when the organisation isn't on a trial. */ used_cents: number | null; /** @description Credit left on this grant, in US cents; null when the organisation isn't on a trial. */ remaining_cents: number | null; /** @description ISO-8601 creation timestamp. */ created_at: string; }; CreditGrantListResponse: { /** @description Response payload. */ data: { /** @description The organisation's grants, oldest first. */ credit_grants: components["schemas"]["CreditGrant"][]; /** @description Credit left on grants active now, in US cents; null when the organisation isn't on a trial. */ balance_cents: number | null; /** @description Trial usage beyond every grant, in US cents; null when the organisation isn't on a trial. */ uncovered_cents: number | null; }; }; CreditGrantResponse: { /** @description Response payload. */ data: { credit_grant: components["schemas"]["CreditGrant"]; /** @description ISO-8601 timestamp the organisation's trial plan now ends, or null for open-ended. */ trial_ends_at: string | null; }; }; CreditOffer: { /** @description Credit offer ID. */ id: number; audience: components["schemas"]["CreditOfferAudience"]; /** @description Email the offer is for; null unless `audience` is `email`. */ email: string | null; /** @description Email domain the offer is for; null unless `audience` is `email_domain`. The first organisation created by anyone at the domain claims it. */ email_domain: string | null; /** @description Credit to grant, in US cents. */ amount_cents: number; /** @description Days the credit lasts, counted from the claim. */ duration_days: number; /** @description Trial plan the organisation starts on. */ plan_id: number; /** @description Campaign slug the resulting grant is recorded under. */ campaign: string; /** @description Free-text note on why the offer was made. */ reason: string | null; /** @description ISO-8601 timestamp after which the offer can't be claimed, or null for no deadline. */ claim_by: string | null; status: components["schemas"]["CreditOfferStatus"]; /** @description ID of the user or service that made the offer. */ created_by: string | null; /** @description ISO-8601 creation timestamp. */ created_at: string; /** @description ISO-8601 timestamp the offer was revoked. */ revoked_at: string | null; /** @description ISO-8601 timestamp the offer was claimed. A `work_domains` offer is never claimed; each grant it makes links back to it. */ claimed_at: string | null; /** @description Organisation that claimed the offer. */ claimed_org_id: number | null; /** @description Credit grant created by the claim. */ claimed_grant_id: number | null; }; /** * @description Who the offer covers: one `email`, one `email_domain`, or `work_domains`, every email domain that isn't a public provider and hasn't had a trial yet. * @enum {string} */ CreditOfferAudience: "email" | "email_domain" | "work_domains"; CreditOfferListResponse: { /** @description Response payload. */ data: { /** @description All credit offers, newest first. */ credit_offers: components["schemas"]["CreditOffer"][]; }; }; CreditOfferResponse: { /** @description Response payload. */ data: { credit_offer: components["schemas"]["CreditOffer"]; }; }; /** @enum {string} */ CreditOfferStatus: "open" | "claimed" | "revoked" | "expired"; CurrentUserResponse: { /** @description Response payload. */ data: { /** @description User ID. */ id: string; /** @description Email address on the session. */ email: string | null; /** @description Organizations the user belongs to. */ org_ids: number[]; /** @description Whether the user can access every org. */ is_super_admin: boolean; }; }; DashboardBanner: { /** @enum {string} */ kind: "unpaid_invoices"; params: { /** @description Sent invoices still unpaid at least a day past their due date. */ overdue_count: number; /** @description How many of those are past the billing gate's overdue threshold. */ escalated_count: number; }; /** @description Higher shows first; the dashboard shows one at a time. */ priority: number; /** @description Null when the banner can't be dismissed. */ dismissal: { /** @description Stable for the fact the banner is about; a new fact (period, limit, missing scopes) makes a new key. */ key: string; /** @description How long a dismissal lasts; null means until the key changes. */ ttl_seconds: number | null; } | null; desktop_only: boolean; } | { /** @enum {string} */ kind: "renewal_failed"; params: Record; /** @description Higher shows first; the dashboard shows one at a time. */ priority: number; /** @description Null when the banner can't be dismissed. */ dismissal: { /** @description Stable for the fact the banner is about; a new fact (period, limit, missing scopes) makes a new key. */ key: string; /** @description How long a dismissal lasts; null means until the key changes. */ ttl_seconds: number | null; } | null; desktop_only: boolean; } | { /** @enum {string} */ kind: "usage_limit_reached"; params: { /** @description The limit as a bill: plan price + cap. */ limit_bill_cents: number; }; /** @description Higher shows first; the dashboard shows one at a time. */ priority: number; /** @description Null when the banner can't be dismissed. */ dismissal: { /** @description Stable for the fact the banner is about; a new fact (period, limit, missing scopes) makes a new key. */ key: string; /** @description How long a dismissal lasts; null means until the key changes. */ ttl_seconds: number | null; } | null; desktop_only: boolean; } | { /** @enum {string} */ kind: "usage_limit_warning"; params: { /** @description Plan price + overage so far, as last evaluated. */ bill_cents: number; /** @description The limit as a bill: plan price + cap. */ limit_bill_cents: number; /** @enum {string} */ period_kind: "month" | "cycle"; period_start: string; /** @description Exclusive (ISO 8601). */ period_end: string; }; /** @description Higher shows first; the dashboard shows one at a time. */ priority: number; /** @description Null when the banner can't be dismissed. */ dismissal: { /** @description Stable for the fact the banner is about; a new fact (period, limit, missing scopes) makes a new key. */ key: string; /** @description How long a dismissal lasts; null means until the key changes. */ ttl_seconds: number | null; } | null; desktop_only: boolean; } | { /** @enum {string} */ kind: "jira_reauthorization"; params: { installation_id: number; }; /** @description Higher shows first; the dashboard shows one at a time. */ priority: number; /** @description Null when the banner can't be dismissed. */ dismissal: { /** @description Stable for the fact the banner is about; a new fact (period, limit, missing scopes) makes a new key. */ key: string; /** @description How long a dismissal lasts; null means until the key changes. */ ttl_seconds: number | null; } | null; desktop_only: boolean; } | { /** @enum {string} */ kind: "slack_permissions"; params: { team_id: string; missing_scopes: string[]; }; /** @description Higher shows first; the dashboard shows one at a time. */ priority: number; /** @description Null when the banner can't be dismissed. */ dismissal: { /** @description Stable for the fact the banner is about; a new fact (period, limit, missing scopes) makes a new key. */ key: string; /** @description How long a dismissal lasts; null means until the key changes. */ ttl_seconds: number | null; } | null; desktop_only: boolean; } | { /** @enum {string} */ kind: "no_billing_plan"; params: { /** @description Whether the org's last plan was a trial that has ended. */ trial_ended: boolean; }; /** @description Higher shows first; the dashboard shows one at a time. */ priority: number; /** @description Null when the banner can't be dismissed. */ dismissal: { /** @description Stable for the fact the banner is about; a new fact (period, limit, missing scopes) makes a new key. */ key: string; /** @description How long a dismissal lasts; null means until the key changes. */ ttl_seconds: number | null; } | null; desktop_only: boolean; }; DashboardBannersResponse: { /** @description Response payload. */ data: { /** @description Active banners, highest priority first. */ banners: components["schemas"]["DashboardBanner"][]; }; }; DeleteFailureGroupResponse: { /** @description Response payload. */ data: { id: string; deleted: boolean; }; }; DeleteMemoryRequest: { /** @description Why this change was made (max 500 characters). Shown in the session's memory change report. */ reason?: string | null; }; DeleteProjectResourceResponse: { /** @description Response payload. */ data: { result: { /** @description Whether the deletion was successful. */ success: boolean; }; }; }; DeletedTaskResponse: { /** @description Response payload. */ data: { /** @description The deleted task. */ task: { /** @description Deleted task ID. */ id: number; }; }; }; DisconnectRunnerBackendResponse: { /** @description Response payload. */ data: { runner_backend: components["schemas"]["RunnerBackend"]; /** @description Projects moved back to Empirical-hosted runs. */ unlinked_project_ids: number[]; }; }; DodoOrgInvoice: { /** * @description An invoice Dodo issued for a payment. (enum property replaced by openapi-typescript) * @enum {string} */ source: "dodo"; /** @description Dodo payment ID. */ id: string; /** @description Dodo invoice ID. */ number: string; /** @description ISO 8601 payment date. */ issue_date: string; /** @description Payment currency code. */ currency: string; /** @description Amount paid in minor units, tax included. */ amount_in_cents: number; /** @description ISO 8601 payment date. */ paid_at: string; /** @description Dodo's invoice PDF URL. */ pdf_url: string | null; }; DodoWebhookAckResponse: { /** @description Acknowledgement. */ message: string; }; DummyNotificationResponse: { /** @description Response payload. */ data: { id: number; }; }; EmpiricalOrgInvoice: { /** * @description An invoice we issued (order-form billing). (enum property replaced by openapi-typescript) * @enum {string} */ source: "empirical"; /** @description Invoice ID. */ id: number; /** @description Invoice number. */ number: string; /** @description ISO 8601 issue date. */ issue_date: string | null; /** @description ISO 8601 due date. */ due_date: string | null; /** @description Invoice currency code. */ currency: string; /** @description Invoice amount in minor units. */ amount_in_cents: number; /** @description Payment status (`paid`, `outstanding`, …). */ paid_status: string; /** @description ISO 8601 timestamp when fully paid. */ paid_at: string | null; /** @description Whether the invoice PDF is available. */ has_pdf: boolean; /** @description Whether this invoice can be paid online (unpaid and in a supported currency). */ payable: boolean; /** * @description Which provider pays this invoice's currency (INR via Razorpay Standard Checkout), or null if none does. Drives the Pay button's checkout flow. * @enum {string|null} */ payment_provider: "razorpay" | null; /** @description Whether an unpaid invoice is past its due date plus the reminder grace period. Always false for paid invoices. */ past_reminder_date: boolean; }; EnableProjectAddonRequest: { /** * Format: date-time * @description Backdate the period to this ISO timestamp. Super admin only; defaults to now. */ effective_from?: string; /** @description Add-on plan (kind='addon') this period bills against. Super admin only. */ plan_id?: number; }; EnqueueTestCasesSyncRequest: { /** @description Project whose test cases should be synced. */ project_id: number; /** @description Commit SHA to sync test cases from. */ commit_sha: string; /** @description Base branch the commit belongs to. */ base_branch: string; }; EnqueueTestCasesSyncResponse: { /** @description Response payload. */ data: { /** @description Always true once the job is enqueued. */ queued: boolean; }; }; EnrichedEnvironmentVariable: { /** @description Environment variable ID. */ id: number; /** @description ID of the project the variable belongs to. */ project_id: number; /** @description Variable name. */ name: string; /** @description Human-readable description. */ description: string; /** @description Variable value. */ value: string; /** @description ISO 8601 creation timestamp. */ created_at: string; /** @description ISO 8601 last-update timestamp. */ updated_at: string; /** @description Supabase user ID of the last editor, or null. */ updated_by: string | null; /** @description Whether the variable applies to all environments. */ all_environments: boolean; /** @description Environment IDs this variable is scoped to. */ environment_ids: number[]; /** @description Details of the last editor, or null if unknown. */ updated_by_user: { /** @description User ID. */ id: string; /** @description User email address. */ email: string; /** @description User display name. */ name: string; /** @description URL to user avatar image. */ picture: string; } | null; }; EnrichedTestRun: { /** @description Test run database ID. */ id: number; /** @description External run_id, if assigned. */ run_id: number | null; /** @description ECS task ID running the run, if dispatched. */ ecs_task_id: string | null; /** @description AWS region of the ECS task, if dispatched. */ ecs_task_region: string | null; /** @description Owning project ID. */ project_id: number; /** @description Total number of test cases. */ total_count: number | null; /** @description Number of unique test cases. */ unique_count: number | null; /** @description Number of passed tests. */ success_count: number | null; /** @description Number of failed tests. */ failed_count: number | null; /** @description Failed tests remaining after applying snoozes. */ failed_count_after_snoozing: number | null; /** @description Number of skipped tests. */ skipped_count: number | null; /** @description Number of flaky tests. */ flaky_count: number | null; /** @description ISO 8601 timestamp when tests started. */ run_started_at: string | null; /** @description ISO 8601 timestamp when tests ended. */ run_ended_at: string | null; /** @description Run duration in milliseconds. */ duration: number | null; /** @description Test repo branch the run executed. */ test_run_branch: string; /** @description Head commit SHA of the test repo. */ test_run_head_sha: string | null; /** @description Structured test-code provenance. Null for runs created before provenance capture shipped. */ test_code: { requested: { branch: string; /** @enum {string} */ source: "explicit" | "build" | "project_default" | "legacy"; /** @enum {string} */ if_missing: "error" | "use_default" | "create"; }; resolved: { branch: string | null; sha: string | null; /** @enum {string|null} */ fallback_reason: "requested_branch_missing" | null; }; execution: { ref: string | null; sha: string | null; /** @enum {string|null} */ ref_kind: "branch" | "temporary_merge" | null; }; merge_base: { branch: string; sha: string | null; } | null; /** @enum {string} */ resolution_status: "pending" | "resolved" | "branch_missing" | "merge_conflict" | "provider_error"; resolution_error_code: string | null; } | null; /** @description URL of the Playwright JSON report. */ summary_url: string | null; /** @description Current run state (queued, started, ended, ...). */ state: string | null; /** @description Associated build row ID, if any. */ build_id: number | null; /** @description Environment row ID, if any. */ environment_id: number | null; /** @description Arbitrary run metadata key/value pairs. */ metadata: { [key: string]: string; } | null; /** @description ISO 8601 timestamp the run was created. */ created_at: string | null; /** @description User ID that created the run. */ created_by: string | null; /** @description User agent that created the run. */ created_by_user_agent: string | null; /** @description Environment display name. */ environment_name: string | null; /** @description Environment slug. */ environment_slug: string | null; /** @description Build commit SHA. */ commit: string | null; /** @description Build branch name. */ branch: string | null; /** @description Build repository in `org/repo` form. */ repo: string | null; /** @description Git branch of the build. */ build_branch: string | null; /** @description URL of the deployment tested, i.e. the run's resolved `BUILD_URL` environment variable. */ build_url: string | null; /** @description GitHub actor that triggered the run. */ github_actor: string | null; /** @description Run-level environment variable overrides. */ environment_variables_overrides: { name: string; value: string; }[] | null; /** @description Head branch of the merge commit, if any. */ merge_commit_head_branch: string | null; /** @description Base branch of the merge commit, if any. */ merge_commit_base_branch: string | null; /** @description Whether the merge commit succeeded. */ merge_commit_successful: boolean | null; /** @description Error code if the run failed. */ error_code: string | null; /** @description Reason the run was cancelled, if any. */ cancellation_reason: string | null; /** @description User ID that cancelled the run, if any. */ cancelled_by_user_id: string | null; /** @description ID of the run this run is a rerun of, if any. */ rerun_source_id: number | null; /** @description Whether the rerun re-ran only failed tests. */ rerun_only_failed: boolean | null; /** @description Feature flags active for this run. */ feature_flags: string[]; /** @description Artifact storage bucket for the run. */ storage_bucket: string | null; /** @description ID of the run that supersedes this one, if any. */ superseded_by_test_run_id: number | null; /** @description Tags applied to the run. */ tags: string[] | null; /** @description Tags whose tests the run skips. */ exclude_tags: string[] | null; /** @description Specific test case ids (Playwright test.id) to run. */ test_case_ids: string[] | null; /** @description Concurrency group and policy the run was created with; null when no limit applied. */ concurrency: { /** @description Concurrency group the run was scoped to. */ group: string; /** * @description Policy toward an active run in the group: cancel it, or wait behind it. * @enum {string} */ on_conflict: "cancel" | "wait"; } | null; /** @description The `trigger` the run was created with, or null when none was sent. */ trigger: { /** * @description Event that produced the run. * @enum {string} */ event: "pull_request"; /** @description Pull request under test. */ pull_request: { /** @description Pull request number in the application repository. */ number?: number; /** @description Head branch. */ head: string; /** @description Base branch. */ base: string; }; } | null; /** @description Resolved details for the user that created the run. */ created_by_user_detail: { /** @description Supabase user ID. */ id: string; /** @description User email address. */ email: string; /** @description User display name. */ name: string; /** @description User avatar URL. */ picture: string; } | null; }; Environment: { /** @description Unique identifier. */ id: number; /** @description Project identifier. */ project_id: number; /** @description URL-friendly identifier. */ slug: string; /** @description Display name. */ name: string; /** @description Playwright project names to match. */ playwright_projects_match: string[]; /** @description Playwright project names to ignore. */ playwright_projects_ignore: string[]; /** @description Whether the environment is disabled. */ is_disabled: boolean | null; /** @description Environment file paths. */ env_files: string[]; /** @description Cron expression for scheduled triggers. */ scheduled_trigger: string | null; /** @description Concurrency group and policy scheduled runs are triggered with; null uses the project's legacy concurrency setting. */ scheduled_concurrency: { /** @description Concurrency group key. */ group: string; /** * @description Policy toward an active run in the group. * @enum {string} */ on_conflict: "cancel" | "wait"; } | null; /** @description Reporter configuration for runs in this environment. */ reporter_config: { /** * @description Reporter config schema version. Always `1`. * @enum {number} */ schema_version: 1; /** @description Reporters, at most one per `reporter_type`. Replaces the stored list on write; an empty array disables them. */ reporters: ({ /** * @description Posts run status updates to Slack channels. * @enum {string} */ reporter_type: "slack_run_status"; /** @description Registered Slack channel ids from `GET /api/v2/slack/channels` (the numeric `id`, not the Slack `C…` channel id). Must belong to the project's organization and not be archived. Deduplicated and sorted on save. */ slack_channel_ids: number[]; } | { /** * @description Posts a GitHub check run on the build commit. Needs `build` with a repository the GitHub Reporter app is installed on. * @enum {string} */ reporter_type: "github_check"; } | { /** * @description Posts (and updates) a comment on the pull request for the build branch. Needs `build` with a repository the GitHub Reporter app is installed on. * @enum {string} */ reporter_type: "github_pr_comment"; } | { /** * @description Tracks the test branch named after the head branch of the app pull request the run was triggered for (`trigger.event` `pull_request`), and keeps the `Empirical linked test changes` check on that pull request up to date: it passes when the test branch has nothing left to merge and fails while it has unmerged commits. The pull request's latest run decides whether it is tracked. Does nothing for runs not triggered by a pull request. Needs `build` with a repository the GitHub Reporter app is installed on. * @enum {string} */ reporter_type: "github_linked_changes"; } | { /** * @description Emails a report when the run ends to every user whose email domain is one of the organization's email domains. * @enum {string} */ reporter_type: "email_run_report"; })[]; }; /** @description ISO 8601 timestamp. */ created_at: string | null; /** @description ISO 8601 timestamp. */ updated_at: string | null; }; EnvironmentDeleteResponse: { /** @description Always true on success. */ success: boolean; }; EnvironmentMutationError: { /** @description Error, returned as a bare string or a `{ message }` object (legacy shape). */ error: string | { /** @description Error message. */ message: string; }; }; EnvironmentResponse: { /** @description Response payload. */ data: { environment: components["schemas"]["Environment"]; }; }; EnvironmentSyncResponse: { /** @description Response payload. */ data: { /** @description Always true on success. */ success: boolean; }; }; EnvironmentVariable: { /** @description Environment variable ID. */ id: number; /** @description ID of the project the variable belongs to. */ project_id: number; /** @description Variable name. */ name: string; /** @description Human-readable description. */ description: string; /** @description Variable value. */ value: string; /** @description ISO 8601 creation timestamp. */ created_at: string; /** @description ISO 8601 last-update timestamp. */ updated_at: string; /** @description Supabase user ID of the last editor, or null. */ updated_by: string | null; /** @description Whether the variable applies to all environments. */ all_environments: boolean; /** @description Environment IDs this variable is scoped to. */ environment_ids: number[]; }; EnvironmentVariableListResponse: { /** @description Response payload. */ data: { /** @description The project's environment variables. */ environment_variables: components["schemas"]["EnrichedEnvironmentVariable"][]; }; }; EnvironmentVariableResponse: { /** @description Response payload. */ data: { environment_variable: components["schemas"]["EnvironmentVariable"]; }; }; EnvironmentVariableSuccessResponse: { /** @description Response payload. */ data: { /** @description Always true on success. */ success: boolean; }; }; EnvironmentVariablesResponse: { /** @description Response payload. */ data: { /** @description The resulting environment variables. */ environment_variables: components["schemas"]["EnvironmentVariable"][]; }; }; ErrorResponse: { /** @description Always null for error responses. */ data: unknown; /** @description Error details. */ error: { /** @description Human-readable error message. */ message: string; }; }; FailureGroup: { id: string; project_id: number; label: string; /** @enum {string} */ type: "app" | "test" | "unknown"; /** @enum {string} */ status: "open" | "resolved"; diagnosis: string | null; recommendation: string | null; fingerprint: components["schemas"]["Fingerprint"]; matcher: components["schemas"]["FailureGroupMatcher"]; resolved_at: string | null; first_seen_at: string; last_seen_at: string; last_test_run_id: number | null; created_at: string; updated_at: string; }; FailureGroupActivityEvent: { id: string; /** @enum {string} */ type: "created" | "edited" | "status_changed" | "merged" | "member_added" | "member_seen" | "member_removed"; at: string; source_run_id: number | null; changed_fields: string[] | null; from_status: string | null; to_status: string | null; merged_from_group_id: string | null; merged_from_label: string | null; member: { /** @description Test case ID (normalized 41-character Playwright test id). */ test_case_id: string; environment_id: number | null; match_source: string | null; match_score: number | null; /** @description For agent-attached members, the chat session that decided the attach. */ chat_session_id: number | null; } | null; /** @description Who authored the change. Null on machine-driven member events and on changes made before attribution existed. */ actor: { /** @enum {string} */ kind: "user" | "agent" | "api_key" | "system"; id: string | null; name: string | null; email: string | null; } | null; }; FailureGroupActivityResponse: { /** @description Response payload. */ data: { events: components["schemas"]["FailureGroupActivityEvent"][]; }; }; FailureGroupConflictResponse: { data: { failure_group: components["schemas"]["FailureGroup"]; }; error: { message: string; }; }; FailureGroupDetachMemberResponse: { /** @description Response payload. */ data: { group_id: string; test_case_id: string; detached: boolean; }; }; FailureGroupListResponse: { data: { failure_groups: components["schemas"]["FailureGroup"][]; }; pagination: components["schemas"]["Pagination"]; }; FailureGroupMatcher: { /** @description Plain-JS async function source: `async ({ testRun, testCase, traceUtils }) => boolean`. */ source: string; /** @description Human-readable summary of what the matcher matches and why; re-articulated on every edit. */ description: string; /** * @description Input-contract version the source was written against. * @default 1 */ contract_version: number; } | null; FailureGroupMemberEntry: { /** @description Test case ID (normalized 41-character Playwright test id). */ test_case_id: string; /** @enum {string} */ state: "active" | "detached"; /** @enum {string} */ source: "machine" | "agent" | "human" | "system"; first_seen_at: string; first_test_run_id: number | null; last_seen_at: string; last_test_run_id: number | null; last_environment_id: number | null; environments: number[]; sighting_count: number; chat_session_id: number | null; match_run_id: string | null; actor_id: string | null; detached_at: string | null; detached_by: string | null; }; FailureGroupMemberResponse: { /** @description Response payload. */ data: { member: components["schemas"]["FailureGroupMemberEntry"]; }; }; FailureGroupMembersResponse: { /** @description Response payload. */ data: { members: components["schemas"]["FailureGroupMemberEntry"][]; total: number; page: number; per_page: number; }; }; FailureGroupResponse: { /** @description Response payload. */ data: { failure_group: components["schemas"]["FailureGroup"]; }; }; File: { /** @description File ID. */ id: number; /** @description Stored file name. */ name: string; /** @description Link to the file. */ url: string; /** @description MIME type. */ mime_type: string | null; /** @description File size in bytes, when known. */ size_bytes: number | null; /** * @description `pending` until the upload to `upload_url` is confirmed with `PATCH /api/files/{id}`. * @enum {string} */ status: "pending" | "uploaded"; /** @description Chat session the file came from, if an agent created it. */ origin_chat_session_id: number | null; /** @description Tool call that produced the file, when known. */ origin_tool_call_id: string | null; /** @description ISO 8601 creation time. */ created_at: string; }; FileResponse: { /** @description Response payload. */ data: { file: components["schemas"]["File"]; }; }; Fingerprint: { signals: { kind: string; value: string; /** @enum {string} */ match?: "exact" | "contains" | "glob" | "regex"; weight?: number; /** @enum {string} */ source: "machine" | "agent" | "human"; data?: { [key: string]: unknown; }; }[]; } | null; FixtureLoginEmailRequest: { /** * Format: email * @description Recipient; must be an @empiricalrun.email address. */ to: string; /** @description Six-digit login code. */ code: string; /** * Format: uri * @description Magic link that signs the recipient in. */ link: string; }; FixtureLoginEmailResponse: { /** @description Response payload. */ data: { /** @description Resend email id. */ email_id: string; }; }; FlagsResponse: { /** @description Response payload. */ data: { [key: string]: boolean | string; }; }; GetTestCaseResponse: { /** @description Response payload. */ data: { test_case: components["schemas"]["TestCase"]; }; }; GetTestRunCaseResponse: { /** @description Response payload. */ data: { /** @description Playwright test ID; the case's URL id. Null for a ledger row that never matched a scheduled entry. */ pw_test_id: string | null; /** @description Shard index (1+) for a sharded run; null for a non-sharded run. */ shard_index: number | null; /** @description ID of the parent test run. */ test_run_id: string; /** * @description Outcome of the case. Provisional while `is_retrying` is true. * @enum {string} */ status: "passed" | "failed" | "flaky" | "skipped"; /** @description True when the case has retries outstanding: `status`, `retries` and `retry_details` reflect only the attempts so far. Only returned with `include_retrying=true`. */ is_retrying: boolean; /** @description Run-time path `[file, ...suites, title]`. */ nesting: string[]; /** @description Playwright project the case ran under. */ test_project: string | null; /** @description Number of retries; null when not recorded. */ retries: number | null; /** @description Total duration in milliseconds. */ total_duration: number | null; /** @description Expected (7-day average) duration in ms. */ expected_duration_ms: number | null; /** @description Raw Playwright retry details; null if absent. */ retry_details: { /** @description Per-attempt retry details. */ retries: components["schemas"]["TestRunCaseRetryDetail"][]; } | null; /** @description Failing source line derived from retry details. */ failing_line: string | null; /** @description ISO 8601 test completion time from the run ledger. */ created_at: string | null; /** @description SHA of the last commit before the run started. */ last_commit_before_run_started_at: string | null; /** @description Snoozes matching this case at read time. */ snooze_info: components["schemas"]["TestRunCaseSnoozeInfo"][]; /** @description Attempts that never ran because an earlier member of this case's Playwright serial group failed on the same attempt. Null when the case is not in a snapshotted group or when nothing was blocked. */ skipped_attempts: components["schemas"]["TestRunCaseSkippedAttempt"][] | null; }; }; GetTestRunResponse: { data: { test_run: { project: { /** @description Project ID. */ id: number; /** @description Project name. */ name: string; /** @description Repository name for the project. */ repo_name: string; }; testRun: components["schemas"]["TestRunDetail"]; /** @description Detailed results for each test case. */ flattenedSummaryDetails: unknown[]; }; }; }; GetTestRunTriageSessionResponse: { /** @description Response payload. */ data: { chat_session: components["schemas"]["ChatSession"] & unknown; }; }; GetTestRunV2Response: { /** @description Response payload. */ data: { /** @description Test run database ID. */ id: number; /** @description Owning project ID. */ project_id: number; /** @description Current run state. */ state: string | null; /** @description External run identifier, if one was assigned. */ run_id: number | null; total_count: number | null; unique_count: number | null; success_count: number | null; failed_count: number | null; failed_count_after_snoozing: number | null; skipped_count: number | null; flaky_count: number | null; duration: number | null; created_at: string | null; run_started_at: string | null; run_ended_at: string | null; test_run_branch: string; test_run_head_sha: string | null; summary_url: string | null; /** @description Environment ID, if one was selected. */ environment_id: number | null; /** @description Environment slug, if one was selected. */ environment_slug: string | null; /** @description Environment name, if one was selected. */ environment_name: string | null; /** @description Per-run environment variable overrides. */ environment_variables_overrides: { name: string; value: string; }[] | null; build_url: string | null; build_branch: string | null; commit: string | null; repo: string | null; error_code: string | null; cancellation_reason: string | null; cancelled_by_user_id: string | null; superseded_by_test_run_id: number | null; }; }; GhMainAppInstall: { id: number; org_id: number; app_installation_id: string; gh_organization: string | null; gh_repos: { id: number; node_id: string; name: string; full_name: string; private: boolean; }[] | null; created_at: string | null; updated_at: string | null; }; GhMainInstallListResponse: { /** @description Response payload. */ data: { /** @description Main App installation rows. */ gh_app_installs: components["schemas"]["GhMainAppInstall"][]; }; }; GhMainInstallResponse: { /** @description Response payload. */ data: { /** @description The main App installation row, or null if the write matched nothing. */ installation: { id: number; org_id: number; app_installation_id: string; gh_organization: string | null; gh_repos: { id: number; node_id: string; name: string; full_name: string; private: boolean; }[] | null; created_at: string | null; updated_at: string | null; } | null; }; }; GhMainMetadataResponse: { /** @description Response payload. */ data: { ghAppMetadata: { /** @description GitHub App permissions. */ permissions?: unknown; ghRepos: { id: number; node_id: string; name: string; full_name: string; private: boolean; }[]; ghOrganization: string | null; }; }; }; GhReporterAppInstall: { id: number; org_id: number | null; app_installation_id: string | null; gh_organization: string | null; gh_repos: { id: number; node_id: string; name: string; full_name: string; private: boolean; }[] | null; /** @enum {string|null} */ installation_status: "requested" | "installed" | null; permissions: { /** @enum {string} */ metadata: "read"; /** @enum {string} */ checks?: "write" | "read"; /** @enum {string} */ pull_requests?: "write" | "read"; /** @enum {string} */ contents?: "write" | "read"; /** @enum {string} */ issues?: "write" | "read"; /** @enum {string} */ merge_queues?: "write" | "read"; /** @enum {string} */ repository_custom_properties?: "write" | "read"; } & { [key: string]: unknown; }; created_at: string | null; updated_at: string | null; }; GhReporterCheckRunDelivery: { id: number; test_run_id: number; environment_name: string | null; repo_owner: string; repo_name: string; head_sha: string | null; /** @description Null when GitHub never accepted the check run. */ check_run_id: number | null; check_run_url: string | null; status: string | null; conclusion: string | null; /** @description Error from the most recent delivery attempt; cleared on success. */ last_error: string | null; created_at: string; updated_at: string; }; GhReporterDeliveriesResponse: { /** @description Response payload. */ data: { check_runs: components["schemas"]["GhReporterCheckRunDelivery"][]; pr_comments: components["schemas"]["GhReporterPrCommentDelivery"][]; linked_changes: components["schemas"]["GhReporterLinkedChangesDelivery"][]; }; }; GhReporterInstallListResponse: { /** @description Response payload. */ data: { /** @description Reporter App installation rows. */ gh_app_installs: components["schemas"]["GhReporterAppInstall"][]; }; }; GhReporterInstallResponse: { /** @description Response payload. */ data: { /** @description The reporter App installation row, or null if the write matched nothing. */ installation: { id: number; org_id: number | null; app_installation_id: string | null; gh_organization: string | null; gh_repos: { id: number; node_id: string; name: string; full_name: string; private: boolean; }[] | null; /** @enum {string|null} */ installation_status: "requested" | "installed" | null; permissions: { /** @enum {string} */ metadata: "read"; /** @enum {string} */ checks?: "write" | "read"; /** @enum {string} */ pull_requests?: "write" | "read"; /** @enum {string} */ contents?: "write" | "read"; /** @enum {string} */ issues?: "write" | "read"; /** @enum {string} */ merge_queues?: "write" | "read"; /** @enum {string} */ repository_custom_properties?: "write" | "read"; } & { [key: string]: unknown; }; created_at: string | null; updated_at: string | null; } | null; }; }; GhReporterLinkedChangesDelivery: { id: number; /** @description The app PR's run the check links to (latest write). */ test_run_id: number; repo_owner: string; repo_name: string; /** @description The app PR's head branch. */ pr_head: string; pr_number: number | null; /** @description App commit the check was last written on. */ head_sha: string; test_branch: string; /** @description Null when GitHub never accepted the check run. */ check_run_id: number | null; check_run_url: string | null; /** @description Linked changes state, e.g. no_test_branch, pr_open, nothing_to_merge. */ state: string | null; status: string | null; conclusion: string | null; title: string | null; /** @description Error from the most recent delivery attempt; cleared on success. */ last_error: string | null; created_at: string; updated_at: string; }; GhReporterMetadataResponse: { /** @description Response payload. */ data: { /** @description GitHub installation metadata (permissions, repos, organization). */ ghAppMetadata?: unknown; }; }; GhReporterPrCommentDelivery: { id: number; environment_name: string | null; repo_owner: string; repo_name: string; pr_number: number; comment_id: number; comment_url: string | null; last_test_run_id: number | null; last_status: string | null; last_error: string | null; created_at: string; updated_at: string; }; GhReporterPullRequestResponse: { /** @description Response payload. */ data: { /** @description Null when no PR contains head_sha. */ pull_request: { number: number; title: string; state: string; merged: boolean; head_ref: string; head_sha: string; html_url: string; updated_at: string; } | null; /** @description Whether head_sha is the PR's current head commit. */ delivered_sha_is_head: boolean | null; /** @description Commits on the PR head after head_sha. Null when head_sha is not an ancestor of the head (e.g. after a force push) or not given. */ commits_since_delivered: number | null; }; }; GhReporterWebhookAck: { /** @description Response payload. */ data: { /** @description Always true; the event was accepted for async processing. */ received: boolean; }; }; GithubActionError: { /** @description Null when present. */ data?: unknown; /** @description Error message. */ error: string; }; GithubAdminWebhookAck: { /** @description Response payload. */ data: { /** @description Always true; the event was accepted. */ received: boolean; }; }; GithubBranchSearchResponse: { /** @description Response payload. */ data: { /** @description Matching branch names, capped by `limit`. */ branches: string[]; }; }; GithubCommitDiffResponse: { /** @description Response payload. */ data: { /** @description Unified diff for the commit. */ diff: string; /** @description Resolved commit ref. */ commit: string; }; }; GithubFileContentsResponse: { /** @description Response payload. */ data: { fileContents: { /** @description Decoded file contents. */ content: string; /** @description Always true when present. */ available: boolean; /** @description Blob SHA of the file. */ sha: string; }; }; }; GithubFileMutationResponse: { /** @description Raw GitHub content mutation response. */ file?: unknown; }; GithubLinkListResponse: { /** @description Response payload. */ data: components["schemas"]["GithubUserLink"][]; }; GithubLinkUpsertResponse: { /** @description Response payload. */ data: { /** @description The created or updated GitHub link. */ link: { /** @description Link ID. */ id: number; /** @description Supabase user ID. */ user_id: string; /** @description GitHub numeric user ID. */ github_user_id: string; /** @description GitHub login/username. */ github_username: string; /** @description GitHub display name. */ github_display_name: string | null; /** @description GitHub avatar URL. */ github_avatar_url: string | null; /** @description GitHub account email. */ github_email: string | null; /** @description Whether the link is currently valid. */ is_link_valid: boolean | null; /** @description ISO 8601 timestamp the link was last validated. */ last_validated_at: string | null; /** @description ISO 8601 timestamp the link was created. */ created_at: string; /** @description ISO 8601 timestamp the link was last updated. */ updated_at: string; } | null; }; }; GithubPrCloseResponse: { data: { /** @description Whether the PR was closed. */ closed: boolean; /** @description Human-readable status. */ message: string; }; error: unknown; }; GithubPrConvertToDraftResponse: { data: { /** @description Whether the PR is now a draft. */ draft: boolean; /** @description Human-readable status. */ message: string; }; error: unknown; }; GithubPrImpactedTestsResponse: { /** @description Response payload. */ data: { /** * @description Computation state for the current head commit. * @enum {string} */ status: "pending" | "completed" | "failed"; /** @description Pull request head commit the result belongs to. */ head_sha: string; /** @description Tests impacted by the pull request diff. */ impacted_tests: { test_case: { name: string; suites: string[]; file_path: string; start_line: number; end_line: number; }; /** @enum {string} */ type: "added" | "removed" | "modified"; modified_by: { file_path: string; line: { number: number; /** @enum {string} */ type: "added" | "removed" | "modified"; }; }[] | null; }[] | null; /** @description Failure reason when status is failed. */ error: string | null; /** * Format: date-time * @description When the result last changed. */ updated_at: string; }; }; GithubPrMergeResponse: { data: { /** @description Whether the PR was merged. */ merged: boolean; /** @description Human-readable status. */ message: string; }; error: unknown; }; GithubPrMergeabilityResponse: { data: { /** * @description Computed mergeability status. * @enum {string} */ status: "not_open" | "mergeable" | "not_mergeable" | "calculating"; /** @description GitHub's mergeable_state value. */ mergeable_state: string; /** @description Whether the PR is a draft. */ draft: boolean; /** @description Base branch of the PR. */ base: string; }; error: unknown; }; GithubPrReadyForReviewResponse: { data: { /** @description Whether the PR is now ready for review. */ ready: boolean; /** @description Human-readable status. */ message: string; }; error: unknown; }; GithubPrReviewResponse: { /** @description Response payload. */ data: { /** @description Repository owner. */ owner: string; /** @description Repository name. */ repo: string; number: number; /** @enum {string} */ status: "open" | "closed" | "merged"; /** @description Whether the PR is a draft. */ draft: boolean; url: string; title: string; description: string; /** @description Unified pull request diff. */ diff: string; /** @description False when the PR is over GitHub's diff limit: the diff is rebuilt from per-file patches, and files GitHub returns without a patch have headers but no hunks. Empty when even that failed. */ diff_complete: boolean; /** @description Pull request head SHA. */ last_commit: string; last_commit_at: string; /** @description Base commit SHA. */ base_ref: string; /** @description Head commit SHA. */ head_ref: string; base_branch: string; head_branch: string; merged_at: string | null; }; }; GithubPrReviewTargetResponse: { /** @description Response payload. */ data: { /** @description Chat session that owns the pull request. */ chat_session_id: number; /** @description Resolved pull request number. */ pr_number: number; }; }; GithubProxyError: { /** @description Error message. */ error: string; }; GithubRateLimitReportEntry: { /** * @description Which GitHub app the installation belongs to. * @enum {string} */ app_type: "main" | "reporter"; /** @description GitHub app installation ID, or null when unknown. */ installation_id?: string | null; /** @description GitHub organization for reporter installations. */ gh_organization?: string | null; /** @description Per-resource rate limits keyed by resource name. */ rate?: { [key: string]: components["schemas"]["GithubRateResource"]; }; /** @description Error message when this installation could not be queried. */ error?: string; }; GithubRateLimitReportResponse: { /** @description Response payload. */ data: components["schemas"]["GithubRateLimitReportEntry"][]; }; GithubRateResource: { /** @description Maximum requests allowed in the window. */ limit?: number; /** @description Requests already consumed in the window. */ used?: number; /** @description Requests remaining in the window. */ remaining?: number; /** @description Unix epoch (seconds) when the window resets. */ reset?: number; /** @description ISO 8601 timestamp derived from `reset`. */ reset_iso_datetime?: string; /** @description Minutes from now until `reset`, rounded. */ reset_mins_from_now?: number; } & { [key: string]: unknown; }; GithubTreeResponse: { /** @description Response payload. */ data: { /** @description Raw GitHub git tree object. */ tree?: unknown; }; }; GithubUserLink: { /** @description Link ID. */ id: number; /** @description Supabase user ID. */ user_id: string; /** @description GitHub numeric user ID. */ github_user_id: string; /** @description GitHub login/username. */ github_username: string; /** @description GitHub display name. */ github_display_name: string | null; /** @description GitHub avatar URL. */ github_avatar_url: string | null; /** @description GitHub account email. */ github_email: string | null; /** @description Whether the link is currently valid. */ is_link_valid: boolean | null; /** @description ISO 8601 timestamp the link was last validated. */ last_validated_at: string | null; /** @description ISO 8601 timestamp the link was created. */ created_at: string; /** @description ISO 8601 timestamp the link was last updated. */ updated_at: string; }; GithubWebhookAck: { /** @description Response payload. */ data: { /** @description Always true; the event was accepted for async processing. */ received: boolean; }; }; GsheetMetadataResponse: { /** @description Response payload. */ data: { /** @description Title of the spreadsheet. */ title: string; /** * @description Access the service account has on the spreadsheet: none, read, or read_write. * @enum {string} */ access_level: "none" | "read" | "read_write"; }; }; GsheetPlainError: { /** @description Human-readable error message. */ error: string; }; GsheetProxyBadRequest: components["schemas"]["ErrorResponse"] | components["schemas"]["GsheetPlainError"]; GsheetProxyResponse: { /** @description Response payload. */ data?: unknown; }; HiveAgentSummary: { /** @description Agent name; pass as `agent` (optionally `@`) when creating a chat session. */ name: string; /** @description What the agent is for, from its `@latest` version. */ description: string | null; /** @description Version that `` (and `@latest`) resolves to. */ latest_version: number; /** * @description Where the `@latest` version runs: `sandbox` (VM with a repo and shell) or `worker` (no filesystem). * @enum {string} */ runtime: "sandbox" | "worker"; /** @description Model the `@latest` version pins, before any override. */ model: string; }; HiveAgentsResponse: { /** @description Response payload. */ data: components["schemas"]["HiveAgentSummary"][]; }; HiveModel: { /** @description Canonical id, e.g. "anthropic/claude-sonnet-4-5-20250929". */ id: string; /** @description Human-friendly label, e.g. "Claude Sonnet 4.5 (Vertex)". */ label: string; /** @description Provider portion of the id, e.g. "anthropic" or "vertex-anthropic". */ provider: string; /** @description Context window in tokens, from the provider catalog. Optional so clients keep working against Hive deployments that predate the field. */ context_window?: number; }; HiveModelsResponse: { /** @description Response payload. */ data: components["schemas"]["HiveModel"][]; }; ImportLoomFileRequest: { /** @description Loom share URL (loom.com/share/). */ url: string; }; ImportLoomFileResponse: { /** @description Response payload. */ data: { file: components["schemas"]["File"]; }; }; IngestTestCaseRunEndEventResponse: { /** @description Empty acknowledgement payload. */ data?: Record; /** @description Present only when the event was rejected without a retry (e.g. missing `runId`). */ error?: { /** @description Reason the event was rejected. */ message: string; }; }; InvoiceBillingLine: { /** @description Billing line ID. */ id: number; /** @description Parent invoice ID. */ invoice_id: number; /** @description Project this charge belongs to, if any. */ project_id: number | null; /** @description Usage month this charge covers (YYYY-MM-DD). */ period_month: string | null; /** @description Contract-to-billing FX rate (null if same currency). */ fx_rate: number | null; /** @description Billing line kind (`tier` or `addon`). */ kind: string; /** @description Plan this charge was billed from, if any. */ plan_id: number | null; /** @description Tier name, if applicable. */ tier: string | null; /** @description Display label. */ label: string | null; /** @description Base price in cents. */ base_price_cents: number; /** @description Currency of this line. */ currency: string; /** @description Display order within the invoice. */ sort_order: number; /** @description Metered usage rows for this billing line. */ meters: components["schemas"]["InvoiceBillingLineMeter"][]; }; InvoiceBillingLineMeter: { /** @description Meter row ID. */ id: number; /** @description Parent billing line ID. */ invoice_billing_line_id: number; /** @description Meter name. */ meter: string; /** @description Quantity included before overage. */ included_qty: number | null; /** @description Billed overage quantity (may be fractional). */ billed_overage_qty: number | null; /** @description Per-unit overage price in cents. */ overage_price_cents: number | null; /** @description Display order within the billing line. */ sort_order: number; }; InvoiceBillingLinesResponse: { /** @description Response payload. */ data: { /** @description The invoice's billing lines. */ billing_lines: components["schemas"]["InvoiceBillingLine"][]; }; }; InvoiceCreditRef: { /** @description fin ledger row id — the pointer + proof. */ fin_ledger_id: string; /** @description Date of the bank credit (YYYY-MM-DD). */ date: string; /** @description UTR / instrument number from the statement. */ reference: string | null; /** @description Currency of the credit (e.g. INR). */ currency: string; /** @description Full credit amount in `currency` minor units. */ amount_minor: number; /** @description Portion allocated to this invoice, minor units. */ allocated_minor: number; /** @description Settlement rail, if known. */ rail: string | null; /** @description Remitter name, if known. */ remitter: string | null; /** @description When fin made this allocation (ISO). */ matched_at?: string; }; InvoiceGenerateError: { /** @description Error message. */ error: string; /** @description Upstream response body, if any. */ details: string; }; InvoiceLineItem: { /** @description Line item name. */ item_name: string; /** @description Sub-item name shown under the line item. */ sub_item_name: string; /** @description SAC/HSN tax code. */ sac_hsn: string; /** @description Quantity billed. */ quantity: number; /** @description Unit price (in cents/paisa). */ unit_price: number; }; InvoiceListResponse: { /** @description The page of invoices. */ data: { /** @description The page of invoices. */ invoices: components["schemas"]["InvoiceWithOrg"][]; }; pagination: components["schemas"]["Pagination"]; }; InvoicePaymentStatusResponse: { /** @description Response payload. */ data: { invoice: components["schemas"]["InvoiceWithOrg"]; }; }; InvoicePdfDownloadUrlResponse: { /** @description Absolute URL to download the invoice PDF. */ download_url: string; }; InvoiceRazorpayOrderResponse: { /** @description Response payload. */ data: { /** @description Razorpay order ID. */ order_id: string; /** @description Order amount in paise (the outstanding amount). */ amount: number; /** @description Order currency (INR). */ currency: string; /** @description Publishable Razorpay key id the browser passes to Standard Checkout. */ key_id: string; /** @description Org billing email, for checkout prefill. */ billing_email: string | null; /** @description Org name, for checkout prefill. */ org_name: string | null; }; }; InvoiceResponse: { /** @description Response payload. */ data: { invoice: components["schemas"]["InvoiceWithOrg"]; }; }; InvoiceSimpleError: { /** @description Human-readable error message. */ error: string; }; InvoiceTaxDetail: { /** @description Tax name. */ tax_name: string; /** @description Tax rate as a percentage applied to the amount. */ tax_percentage: number; }; InvoiceWithOrg: { /** @description Invoice ID. */ id: number; /** @description Human-readable invoice number. */ number: string; /** @description ID of the organisation being billed. */ org_id: number; /** @description ISO 8601 creation timestamp. */ created_at: string; /** @description ISO 8601 last-update timestamp. */ updated_at: string; /** @description ISO 8601 issue date, if set. */ issue_date: string | null; /** @description ISO 8601 due date, if set. */ due_date: string | null; /** @description Invoice currency. */ currency: string; /** @description Total invoice amount in cents. */ amount_in_cents: number; /** @description R2 file key for the generated PDF, if any. */ invoice_pdf_url: string | null; /** @description Payment link that can be used to pay this invoice. */ payment_link: string | null; /** @description Delivery status (e.g. `sent`). */ send_status: string; /** @description Payment status (e.g. `paid`). */ paid_status: string; /** @description ISO 8601 timestamp when paid, if applicable. */ paid_at: string | null; /** @description Σ of allocated credit amounts in minor units; null if unreconciled. */ paid_minor: number | null; /** @description Bank credits (from fin) that settle this invoice. */ credit_refs: components["schemas"]["InvoiceCreditRef"][]; /** @description Invoice line items. */ line_items: components["schemas"]["InvoiceLineItem"][]; /** @description Tax details applied to the invoice. */ tax_details: components["schemas"]["InvoiceTaxDetail"][]; /** @description ISO 8601 timestamp of the first reminder. */ first_reminder_sent_at: string | null; /** @description ISO 8601 timestamp of the second reminder. */ second_reminder_sent_at: string | null; /** @description The billed organisation, or null if not loaded. */ org: { /** @description Organisation ID. */ id: number; /** @description Organisation name. */ name: string; /** @description Email domains associated with the org. */ email_domains: string[]; /** @description ISO 8601 creation timestamp. */ created_at: string | null; /** @description ISO 8601 last-update timestamp. */ updated_at: string | null; /** @description User who last updated the org. */ updated_by: string | null; /** @description Billing contact emails. */ billing_emails: string[]; /** @description Default billing currency. */ billing_currency: string; /** @description Key identifying the deposit bank account. */ deposit_bank_key: string; /** @description Legal billing name. */ billing_name: string | null; /** @description Billing address lines. */ billing_address_lines: string | null; /** @description GSTIN tax identifier. */ billing_gstin: string | null; /** @description Place of supply for tax purposes. */ place_of_supply: string | null; /** @description Net payment terms in days. */ payment_terms_days: number | null; } | null; }; JiraAppInstall: { /** @description Installation ID. */ id: number; /** @description Organisation ID. */ org_id: number; /** @description Atlassian cloud ID. */ jira_cloud_id: string; /** @description Jira site base URL. */ jira_site_url: string; /** @description Map of Jira project key to Empirical project ID. */ project_mappings: { [key: string]: number; } | null; /** @description Access token expiry (ISO 8601). */ jira_access_token_expires_at: string; /** @description Webhook expiry (ISO 8601), or null. */ webhook_expires_at: string | null; /** @description When Jira OAuth reauthorization became required (ISO 8601), or null. */ reauthorization_required_at: string | null; /** @description Machine-readable reason reauthorization is required. */ reauthorization_reason: string | null; /** @description Creation timestamp (ISO 8601), or null. */ created_at: string | null; /** @description Alias of `jira_access_token_expires_at` (ISO 8601). */ expires_at: string; /** @description Whether the access token has not yet expired. */ is_active: boolean; }; JiraInstallationListResponse: { /** @description Jira app installations for the organisation. */ data: components["schemas"]["JiraAppInstall"][]; /** @description Number of installations. */ count: number; }; JiraInstallationRecordResponse: { /** * @description Always true on success. * @enum {boolean} */ success: true; /** @description The updated installation row, or null if not found. */ data: { /** @description Installation ID. */ id: number; /** @description Organisation ID. */ org_id: number; /** @description Atlassian cloud ID. */ jira_cloud_id: string; /** @description Jira site base URL. */ jira_site_url: string; /** @description OAuth access token. */ jira_access_token: string; /** @description OAuth refresh token. */ jira_refresh_token: string; /** @description Access token expiry (ISO 8601). */ jira_access_token_expires_at: string; /** @description Map of Jira project key to Empirical project ID. */ project_mappings: { [key: string]: number; } | null; /** @description Webhook expiry (ISO 8601), or null. */ webhook_expires_at: string | null; /** @description When Jira OAuth reauthorization became required (ISO 8601), or null. */ reauthorization_required_at: string | null; /** @description Machine-readable reason reauthorization is required. */ reauthorization_reason: string | null; /** @description Creation timestamp (ISO 8601), or null. */ created_at: string | null; } | null; }; JiraInstallationResponse: { /** * @description Always true on success. * @enum {boolean} */ success: true; data: components["schemas"]["JiraAppInstall"]; }; JiraSuccessResponse: { /** * @description Always true on success. * @enum {boolean} */ success: true; }; JiraValidationResponse: { /** * @description Always true on success. * @enum {boolean} */ success: true; /** * @description Current state of the registered webhook. * @enum {string} */ webhookStatus: "active" | "expired" | "missing"; /** @description Webhook expiry (ISO 8601), or null. */ webhookExpiresAt: string | null; }; JiraWebhookResponse: { /** @description Whether ingestion succeeded. */ success?: boolean; /** @description True when the issue lacks the `empirical` trigger label. */ skipped?: boolean; /** @description ID of the created/existing request. */ requestId?: number; /** @description ID of the created chat session. */ sessionId?: number; /** @description Ingestion step reached, when reported. */ step?: string; /** @description Error detail when ingestion fails. */ error?: unknown; }; LastPassPerEnvEntry: { /** @description Environment ID the test last passed in. */ environment_id: string; /** @description ID of the test run in which it last passed. */ test_run_id: string; /** @description Epoch timestamp (ms) of the last passing run. */ executed_at: number; }; LastPassPerEnvRequest: { /** @description Test case ID to look up. */ test_case_id: string; /** @description Project ID (ignored; the project comes from auth scope). */ project_id?: number; /** @description Look-back window in days (default 30). */ days?: number; /** @description Anchor the lookup to this point in time (ISO 8601); returns the last pass as of then. */ before?: string; }; LastPassPerEnvResponse: { /** @description Response payload. */ data: components["schemas"]["LastPassPerEnvEntry"][]; }; LinearAppInstall: { /** @description Installation ID. */ id: number; /** @description Organization ID. */ org_id: number; /** @description Linear app user (actor) id. */ linear_app_user_id: string; /** @description Linear organization id. */ linear_organization_id: string; /** @description Map of Linear team key to Empirical project id. */ project_mappings: { [key: string]: number; }; /** @description ISO 8601 timestamp the installation was created. */ created_at: string | null; /** @description ISO 8601 expiry of the stored access token. */ expires_at: string; /** @description Whether the access token is still valid or can be refreshed. */ is_active: boolean; /** @description Actor name (only when metadata is cached). */ linear_app_user_name?: string; /** @description Organization name (only when metadata is cached). */ linear_organization_name?: string; /** @description Organization URL key (only when metadata is cached). */ linear_organization_url_key?: string; /** @description Linear teams (only when metadata is cached). */ teams?: components["schemas"]["LinearTeamRef"][]; }; LinearInstallCreateResponse: { /** @description Always true when the installation was stored. */ success: boolean; /** @description The created or reauthorized installation. */ data: { /** @description Installation ID. */ id: number; /** @description Organization ID. */ org_id: number; /** @description Linear app user (actor) id. */ linear_app_user_id: string; /** @description Linear organization id. */ linear_organization_id: string; /** @description Map of Linear team key to Empirical project id. */ project_mappings: { [key: string]: number; }; /** @description ISO 8601 timestamp the installation was created. */ created_at: string | null; /** @description ISO 8601 expiry of the stored access token. */ expires_at: string; /** @description Whether the access token is still valid or can be refreshed. */ is_active: boolean; /** @description Actor name (only when metadata is cached). */ linear_app_user_name?: string; /** @description Organization name (only when metadata is cached). */ linear_organization_name?: string; /** @description Organization URL key (only when metadata is cached). */ linear_organization_url_key?: string; /** @description Linear teams (only when metadata is cached). */ teams?: components["schemas"]["LinearTeamRef"][]; }; }; LinearInstallListResponse: { /** @description Installations for the organization. */ data: components["schemas"]["LinearAppInstall"][]; /** @description Number of installations. */ count: number; }; LinearProjectMappingsResponse: { /** @description Always true when the mappings were updated. */ success: boolean; /** @description The updated installation, or null if it disappeared. */ data: { /** @description Installation ID. */ id: number; /** @description Organization ID. */ org_id: number; /** @description Linear app user (actor) id. */ linear_app_user_id: string; /** @description Linear organization id. */ linear_organization_id: string; /** @description Map of Linear team key to Empirical project id. */ project_mappings: { [key: string]: number; }; /** @description ISO 8601 timestamp the installation was created. */ created_at: string | null; /** @description ISO 8601 expiry of the stored access token. */ expires_at: string; /** @description Whether the access token is still valid or can be refreshed. */ is_active: boolean; /** @description Actor name (only when metadata is cached). */ linear_app_user_name?: string; /** @description Organization name (only when metadata is cached). */ linear_organization_name?: string; /** @description Organization URL key (only when metadata is cached). */ linear_organization_url_key?: string; /** @description Linear teams (only when metadata is cached). */ teams?: components["schemas"]["LinearTeamRef"][]; } | null; }; LinearSuccessResponse: { /** @description Always true when the operation succeeded. */ success: boolean; }; LinearTeamRef: { /** @description Linear team id. */ id: string; /** @description Linear team key (e.g. "EMP"). */ key: string; /** @description Linear team name. */ name: string; }; LinearValidateResponse: { /** @description Validation result. */ data: { /** @description Always true when the token is valid. */ success: boolean; /** @description Whether cached metadata was backfilled. */ backfilled: boolean; }; }; LinearWebhookResponse: { /** @description Whether the webhook was accepted. */ success: boolean; }; ListArtifactsResponse: { data: { artifacts: components["schemas"]["Artifact"][]; }; }; ListEnvironmentsResponse: { /** @description Response payload. */ data: { environments: components["schemas"]["Environment"][]; }; }; ListFilesResponse: { /** @description The page of files, newest first. */ data: { files: components["schemas"]["File"][]; }; pagination: components["schemas"]["Pagination"]; }; ListProjectAddonsResponse: { /** @description Response payload. */ data: { addons: components["schemas"]["ProjectAddonState"][]; /** @description Every period for this project, newest first. */ history: components["schemas"]["ProjectAddonPeriod"][]; }; }; ListReportersResponse: { /** @description Response payload. */ data: { /** @description Every reporter a reporter config can name (Slack run status, GitHub check, GitHub PR comment, email report and, for runs, the Slack DM), with whether it can post for this project. */ reporters: components["schemas"]["AvailableReporter"][]; }; }; ListTestRunCasesResponse: { /** @description The page of test run cases. */ data: components["schemas"]["TestRunCase"][]; pagination: components["schemas"]["Pagination"]; }; ListTestRunChatSessionsResponse: { /** @description Response payload. */ data: { chat_sessions: components["schemas"]["TestRunChatSession"][]; }; }; LiveTestRun: { /** @description Test run database ID. */ id: number; /** @description External run_id, if assigned. */ run_id: number | null; /** @description ECS task ID running the run, if dispatched. */ ecs_task_id: string | null; /** @description AWS region of the ECS task, if dispatched. */ ecs_task_region: string | null; /** @description Total number of test cases. */ total_count: number | null; /** @description Number of unique test cases. */ unique_count: number | null; /** @description Number of passed tests. */ success_count: number | null; /** @description Number of failed tests. */ failed_count: number | null; /** @description Failed tests remaining after applying snoozes. */ failed_count_after_snoozing: number | null; /** @description Number of skipped tests. */ skipped_count: number | null; /** @description Number of flaky tests. */ flaky_count: number | null; /** @description ISO 8601 timestamp when tests started. */ run_started_at: string | null; /** @description ISO 8601 timestamp when tests ended. */ run_ended_at: string | null; /** @description Run duration in milliseconds. */ duration: number | null; /** @description URL of the Playwright JSON report. */ summary_url: string | null; /** @description Current run state (queued, started, ended, ...). */ state: string | null; /** @description Head commit SHA of the test repo. */ test_run_head_sha: string | null; /** @description Head branch of the merge commit, if any. */ merge_commit_head_branch: string | null; /** @description Base branch of the merge commit, if any. */ merge_commit_base_branch: string | null; /** @description Whether the merge commit succeeded. */ merge_commit_successful: boolean | null; /** @description Error code if the run failed. */ error_code: string | null; /** @description Reason the run was cancelled, if any. */ cancellation_reason: string | null; /** @description User ID that cancelled the run, if any. */ cancelled_by_user_id: string | null; /** @description Artifact storage bucket for the run. */ storage_bucket: string | null; /** @description ID of the run that supersedes this one, if any. */ superseded_by_test_run_id: number | null; }; MarkAnnouncementsSeenRequest: { /** * Format: date-time * @description Mark announcements up to this time as seen. Defaults to now; never moves the seen time backwards or past now. */ seen_at?: string; }; MemberByTestRun: { /** @description Test case ID (normalized 41-character Playwright test id). */ test_case_id: string; group_id: string; label: string | null; /** @enum {string|null} */ type: "app" | "test" | null; /** @enum {string|null} */ status: "open" | "resolved" | null; diagnosis: string | null; recommendation: string | null; /** @enum {string|null} */ match_source: "machine" | "agent" | "human" | "system" | null; match_score: number | null; chat_session_id: number | null; matched_at: string | null; detached_at: string | null; }; MembersByTestRunResponse: { /** @description Response payload. */ data: { members: components["schemas"]["MemberByTestRun"][]; }; }; MembershipListResponse: { /** @description Response payload. */ data: { /** @description Memberships created from pending invites. */ memberships: { /** @description Organization joined. */ org_id: number; }[]; }; }; Memory: { id: number; project_id: number; format_version: number; name: string | null; description: string | null; content: string; source: string | null; source_path: string | null; /** @description ID of the chat session the memory was created in, or null if not written from a sandbox session. */ source_chat_session_id: number | null; created_by: string | null; updated_by: string | null; /** @description ISO 8601 timestamp. */ created_at: string; /** @description ISO 8601 timestamp. */ updated_at: string; /** @description ISO 8601 timestamp when the memory was soft-deleted, or null if live. */ deleted_at: string | null; /** @description User who deleted the memory, or null. */ deleted_by: string | null; /** @description Chat session that deleted the memory, or null if not deleted from a sandbox session. */ deleted_by_chat_session_id: number | null; /** @description Reason given for the delete, or null. */ delete_reason: string | null; }; MemoryActivity: { id: number; project_id: number; name: string | null; description: string | null; source: string | null; /** @description Chat session the memory was created in, if any. */ source_chat_session_id: number | null; /** @description Length of the current content in characters. */ content_length: number; /** @description ISO 8601 timestamp. */ created_at: string; /** @description ISO 8601 timestamp. */ updated_at: string; /** @description ISO 8601 timestamp of the soft delete, or null if live. */ deleted_at: string | null; /** @description Total versions, including the initial create (v1). */ version_count: number; /** @description Edits (versions after v1) in the last 7 days. */ edits_7d: number; /** @description Edits (versions after v1) in the last 30 days. */ edits_30d: number; /** @description Distinct chat sessions that edited the memory after v1. */ edit_session_count: number; /** @description ISO 8601 timestamp of the latest edit, or null if never edited. */ last_edited_at: string | null; }; MemoryActivityDay: { /** @description UTC day, YYYY-MM-DD. */ date: string; project_id: number; created: number; edited: number; deleted: number; }; MemoryActivityResponse: { /** @description Response payload. */ data: { memories: components["schemas"]["MemoryActivity"][]; daily: components["schemas"]["MemoryActivityDay"][]; }; }; MemoryChange: { /** @enum {string} */ kind: "create" | "update" | "delete"; memory_id: number; name: string | null; description: string | null; content: string; reason: string | null; /** @description ISO 8601 timestamp of the change. */ at: string; /** @description Version written by the change; null for a delete. For a delete, name/description/content are the memory's last content. */ version: number | null; /** @description The version immediately before an update; null for creates and deletes. */ previous: { version: number; name: string | null; description: string | null; content: string; } | null; }; MemoryChangeSummary: { created: number; updated: number; deleted: number; /** @description Live memories in the project just before the first change; null when there are no changes. */ live_before: number | null; /** @description Live memories in the project right after the last change; null when there are no changes. */ live_after: number | null; }; MemoryChangesResponse: { /** @description Response payload. */ data: { changes: components["schemas"]["MemoryChange"][]; summary: components["schemas"]["MemoryChangeSummary"]; }; }; MemoryClassification: { memory_id: number; /** @description Memory version number the labels apply to (v1 = create). */ version: number; vocabulary_version: number; project_id: number; /** @description JEV model that answered, e.g. "jev-1.13.0". */ model: string; retention: string; retention_confidence: number; subject: string; subject_confidence: number; role: string; role_confidence: number; /** @description Per-option probabilities for each axis. */ probabilities: { [key: string]: { [key: string]: number; }; }; /** @description ISO 8601 timestamp. */ classified_at: string; }; MemoryClassificationsResponse: { /** @description Response payload. */ data: { vocabulary_version: number; classifications: components["schemas"]["MemoryClassification"][]; }; }; MemoryDeleteResponse: { /** @description Response payload. */ data: { /** @description Always true on success. */ success: boolean; }; }; MemoryEditUsage: { memory_id: number; name: string | null; deleted: boolean; /** @description Versions saved after the initial create. */ edits: number; /** @description Distinct chat sessions that made those edits. */ sessions: number; }; MemoryListResponse: { data: { memories: components["schemas"]["Memory"][]; }; pagination: components["schemas"]["Pagination"]; }; MemoryReadUsage: { /** @description Live memory the name resolves to now, or null if it was renamed or deleted since. */ memory_id: number | null; name: string; /** @description read_memory calls. */ reads: number; /** @description Distinct sessions that read it. */ sessions: number; /** @description UTC day, YYYY-MM-DD. */ last_read: string; }; MemoryResponse: { /** @description Response payload. */ data: { memory: components["schemas"]["Memory"]; }; }; MemoryUsageResponse: { /** @description Response payload. */ data: { days: number; /** @description Most read memories (read_memory calls counted by Hive from agent sessions), or null when Hive is unavailable. */ most_read: components["schemas"]["MemoryReadUsage"][] | null; most_edited: components["schemas"]["MemoryEditUsage"][]; }; }; MemoryVersion: { id: number; memory_id: number; version: number; format_version: number; name: string | null; description: string | null; content: string; /** @description ID of the chat session that produced this version, or null if not written from a sandbox session. */ source_chat_session_id: number | null; created_by: string | null; /** @description Reason given for the write that produced this version. */ reason: string | null; /** @description ISO 8601 timestamp. */ created_at: string; }; MemoryVersionListResponse: { /** @description Response payload. */ data: { versions: components["schemas"]["MemoryVersion"][]; }; }; MemoryWriteRejectedResponse: { data: unknown; error: { /** @description Why the write was refused. */ message: string; gate: components["schemas"]["MemoryWriteVerdict"]; }; }; MemoryWriteResponse: { /** @description Response payload. */ data: { memory: components["schemas"]["Memory"]; /** @description Memory write gate verdict for agent writes; null when the write was not classified. */ gate: { /** * @description `rejected` = classified as failure/incident state; `error` = classification failed and the write was not checked. * @enum {string} */ decision: "accepted" | "rejected" | "error"; /** * @description `shadow` saves regardless of the decision; `enforce` refuses rejected writes. * @enum {string} */ mode: "shadow" | "enforce"; /** @description True when the write was refused. */ blocked: boolean; reason: string; model: string | null; vocabulary_version: number | null; retention: string | null; retention_confidence: number | null; /** @description Probability of the failure/incident retention class; the write is rejected at or above the gate's threshold. */ failure_incident_probability: number | null; subject: string | null; role: string | null; } | null; }; }; MemoryWriteVerdict: { /** * @description `rejected` = classified as failure/incident state; `error` = classification failed and the write was not checked. * @enum {string} */ decision: "accepted" | "rejected" | "error"; /** * @description `shadow` saves regardless of the decision; `enforce` refuses rejected writes. * @enum {string} */ mode: "shadow" | "enforce"; /** @description True when the write was refused. */ blocked: boolean; reason: string; model: string | null; vocabulary_version: number | null; retention: string | null; retention_confidence: number | null; /** @description Probability of the failure/incident retention class; the write is rejected at or above the gate's threshold. */ failure_incident_probability: number | null; subject: string | null; role: string | null; }; MergeBranchesResponse: { /** @description Response payload. */ data: { /** @description Whether the merge happened. */ merged?: boolean; /** @description Human-readable result. */ message: string; /** @description URL of the PR, when one was created. */ pull_request_url?: string; }; }; MergeFailureGroupRequest: { /** @description Target group id; this group merges into it. */ into_group_id: string; }; MergeRequest: { /** @description Merge request ID. */ id: number; /** @description Owning project ID. */ project_id: number; /** @description Branch merged into. */ base_branch: string; /** @description Branch merged from. */ branch_to_merge: string; /** * @description Merge request status. * @enum {string} */ status: "requested" | "merged" | "deleted_with_no_changes" | "created_pr_but_merged_failed" | "error"; /** @description GitHub pull request number, if created. */ pr_number: number | null; /** @description ISO 8601 creation timestamp. */ created_at: string; /** @description ISO 8601 last-update timestamp. */ updated_at: string; }; MergeRequestsResponse: { /** @description The page of merge requests. */ data: components["schemas"]["MergeRequest"][]; pagination: components["schemas"]["Pagination"]; }; Notification: { id: number; /** @enum {string} */ kind: "chat_session_waiting" | "test_run"; project_id: number; project_slug: string; /** @enum {string} */ entity_type: "chat_session" | "test_run"; entity_id: number; payload: { [key: string]: unknown; }; created_at: string; read_at: string | null; resolved_at: string | null; }; NotificationListResponse: { /** @description Response payload. */ data: { /** @description Unread notifications (newest 100) followed by the most recent read ones. */ notifications: components["schemas"]["Notification"][]; /** @description Total unread notifications. */ unread_count: number; }; }; NotificationReadResponse: { /** @description Response payload. */ data: { id: number; read_at: string; }; }; NotificationsReadAllResponse: { /** @description Response payload. */ data: { /** @description Notifications newly marked read. */ updated: number; }; }; OnboardingChecklistResponse: { /** @description Response payload. */ data: { email: string; email_domain: string; /** @description Whether a new org may claim the caller's email domain for auto-join. */ domain_join_available: boolean; invites: { id: number; org_id: number; org_name: string; }[]; /** @description Trial credit the org they create will get: an offer for the caller's email or email domain, else the offer for work email domains that haven't had a trial. `null` once they belong to an org or when no offer applies. */ credit_offer: { /** @description Trial credit, in US cents. */ amount_cents: number; /** @description Days the credit lasts, counted from org creation. */ duration_days: number; } | null; /** @description Why the org they create gets no trial credit while there is a work email domains offer: `public_email` (a work email would get it) or `domain_trial_used` (ask a teammate for an invite). `null` when `credit_offer` is set, once they belong to an org, or when there's no work email domains offer. */ credit_unavailable: ({ /** @enum {string} */ reason: "public_email"; /** @description Trial credit a work email would get, in US cents. */ amount_cents: number; /** @description Days that credit lasts. */ duration_days: number; } | { /** @enum {string} */ reason: "domain_trial_used"; /** @description Work email domain that already had a trial. */ domain: string; }) | null; /** @description Why `project`'s organization can't start agent sessions, from its billing; `null` when it can or without a `project`. While set, `first_test` points at the billing page. */ sessions_blocked: { /** @enum {string} */ reason: "overdue_invoice" | "subscription_on_hold" | "no_active_plan" | "spend_cap_reached"; message: string; } | null; /** @description Project the project items describe: the one in `x-project-slug` / `x-project-id`, or the caller's only project. */ project: { id: number; slug: string; name: string; org_id: number; } | null; /** @description The caller's projects. With more than one, pass a project header to get project items. */ projects: { id: number; slug: string; }[]; /** @description `null` without a `project`. */ slack: { /** @description Slack workspaces the project's org installed the Empirical app in. */ workspaces: { team_id: string; team_name: string; }[]; /** @description Channels registered to the project's org, by mentioning @Empirical in them. */ channels: { id: number; name: string | null; team_name: string | null; }[]; } | null; /** * @description First required item still to do; `null` when onboarded. * @enum {string|null} */ next_item_id: "create_org" | "create_project" | "first_test" | "connect_slack" | null; /** @description Listed in the order to do them. */ items: components["schemas"]["OnboardingItem"][]; }; }; OnboardingItem: { /** @enum {string} */ id: "create_org" | "create_project" | "first_test" | "connect_slack"; /** @enum {string} */ scope: "account" | "org" | "project"; title: string; description: string; /** * @description Worked out from data. `blocked` until every `depends_on` item is done. * @enum {string} */ status: "done" | "todo" | "blocked"; /** @description Optional items can be skipped or dismissed. */ required: boolean; depends_on: ("create_org" | "create_project" | "first_test" | "connect_slack")[]; /** @description How to do the item now; `null` when done or blocked. */ action: ({ /** @enum {string} */ kind: "api"; /** @description OpenAPI operation to call; read its body schema from `GET /api/endpoints`. */ operation_id: string; /** @enum {string} */ method: "POST"; path: string; headers?: { [key: string]: string; }; body_example: { [key: string]: unknown; }; inputs: { /** @description Field to ask the user for. */ name: string; /** @description What to ask. */ description: string; required: boolean; /** @description Sample answers to show the user. */ examples?: string[]; }[]; } | { /** @enum {string} */ kind: "browser"; url: string; /** @description Why this needs a person. */ reason: string; }) | null; }; OrderFormLine: { /** @description Order form line ID. */ id: number; /** @description ID of the parent order form. */ order_form_id: number; /** @description Line kind, e.g. `tier` or `addon`. */ kind: string; /** @description Pricing tier name. */ tier: string | null; /** @description Display label. */ label: string | null; /** @description Base price for the line in cents. */ base_price_cents: number; /** @description Ordering of the line within the order form. */ sort_order: number; /** @description Metering rows attached to this line. */ meters: components["schemas"]["OrderFormLineMeter"][]; }; OrderFormLineMeter: { /** @description Meter row ID. */ id: number; /** @description ID of the order form line this meter belongs to. */ order_form_line_id: number; /** @description Meter name. */ meter: string; /** @description Quantity included before overage applies. */ included_qty: number | null; /** @description Per-unit overage price in cents. */ overage_price_cents: number | null; /** @description Ordering of the meter within its line. */ sort_order: number; }; OrderFormListResponse: { /** @description The page of order forms. */ data: { order_forms: components["schemas"]["OrderFormWithDetail"][]; }; pagination: components["schemas"]["Pagination"]; }; OrderFormOrgNotFoundError: { /** @description Human-readable error message. */ error: string; }; OrderFormPdfUploadRequest: { pdf_base64: string; }; OrderFormResponse: { /** @description Response payload. */ data: { order_form: components["schemas"]["OrderFormWithDetail"]; }; }; OrderFormWithDetail: { /** @description Order form ID. */ id: number; /** @description Owning organisation ID. */ org_id: number; /** @description Pricing model, e.g. `slab` or `fixed`. */ pricing_model: string; /** @description R2 object key of the uploaded signed PDF. */ pdf_r2_key: string | null; /** @description Order form date (YYYY-MM-DD). */ form_date: string | null; /** @description Subscription start date (YYYY-MM-DD). */ subscription_start_date: string | null; /** @description Contract term length in months. */ term_months: number | null; /** @description Contract end date (YYYY-MM-DD). */ end_date: string | null; /** @description Order form status. */ status: string; /** @description ISO 8601 timestamp the order form was signed. */ signed_at: string | null; /** @description Currency of the contract. */ contract_currency: string; /** @description ISO 8601 creation timestamp. */ created_at: string; /** @description ISO 8601 last-update timestamp. */ updated_at: string; /** @description The owning organisation, if it still exists. */ org: { /** @description Organisation ID. */ id: number; /** @description Organisation name. */ name: string; /** @description Email domains owned by the organisation. */ email_domains: string[]; /** @description ISO 8601 creation timestamp. */ created_at: string | null; /** @description ISO 8601 last-update timestamp. */ updated_at: string | null; /** @description User who last updated the organisation. */ updated_by: string | null; /** @description Billing contact emails. */ billing_emails: string[]; /** @description Default billing currency. */ billing_currency: string; /** @description Key identifying the deposit bank account. */ deposit_bank_key: string; /** @description Legal billing name. */ billing_name: string | null; /** @description Billing address. */ billing_address_lines: string | null; /** @description GSTIN tax identifier. */ billing_gstin: string | null; /** @description Place of supply for tax purposes. */ place_of_supply: string | null; /** @description Payment terms in days. */ payment_terms_days: number | null; } | null; /** @description Pricing lines on the order form. */ lines: components["schemas"]["OrderFormLine"][]; }; OrgCreateRequest: { /** @description Organization display name. */ name: string; /** @description Let anyone with the caller's (non-public) email domain auto-join the org on sign-in. The domain is derived server-side from the caller's verified email; it is never accepted as input. Ignored when another org already claims the domain. */ allow_domain_join?: boolean; }; OrgCreateResponse: { /** @description Response payload. */ data: { org: components["schemas"]["Organization"]; /** @description Trial credit from the credit offer the organization claimed, or null when none applied. */ credit_grant: { /** @description Trial credit granted, in US cents. */ amount_cents: number; /** @description ISO-8601 timestamp the credit expires. */ expires_at: string; } | null; }; }; OrgInvite: { /** @description Invite ID. */ id: number; /** @description Organization ID. */ org_id: number; /** @description Invited email (lowercased). */ email: string; /** @description User id of the inviting member. */ invited_by: string; /** * @description Invite lifecycle status. * @enum {string} */ status: "pending" | "accepted" | "revoked"; /** @description Creation timestamp (ISO 8601). */ created_at: string; /** @description Acceptance timestamp (ISO 8601), if accepted. */ accepted_at: string | null; }; OrgInviteListResponse: { /** @description Response payload. */ data: { invites: components["schemas"]["OrgInvite"][]; }; }; OrgInviteResponse: { /** @description Response payload. */ data: { invite: components["schemas"]["OrgInvite"]; /** @description Whether the invite email was delivered. */ email_sent: boolean; }; }; OrgInviteRevokeResponse: { /** @description Response payload. */ data: { invite: components["schemas"]["OrgInvite"]; }; }; OrgInvoice: components["schemas"]["EmpiricalOrgInvoice"] | components["schemas"]["DodoOrgInvoice"]; OrgInvoiceListResponse: { /** @description Response payload. */ data: { invoices: components["schemas"]["OrgInvoice"][]; }; }; OrgListResponse: { /** @description Response payload. */ data: { orgs: components["schemas"]["OrganizationWithProjects"][]; }; }; OrgMember: { /** @description User ID. */ id: string; /** @description User email address. */ email: string; /** @description Display name (falls back to email). */ name: string; /** @description Avatar URL (may be empty). */ picture: string; /** @description Account creation timestamp (ISO 8601). */ created_at: string | null; /** @description Last sign-in timestamp (ISO 8601). */ last_sign_in_at: string | null; }; OrgMembersResponse: { /** @description The page of org members. */ data: { members: components["schemas"]["OrgMember"][]; }; pagination: components["schemas"]["Pagination"]; }; OrgPlanResponse: { /** @description Response payload. */ data: { /** @description Whether the org has a plan assignment in effect now. */ has_plan: boolean; /** @description The shared plan in effect, or null when the org has no plan or is on a custom plan. */ plan: { /** @description Plan name, as shown to customers. */ name: string; /** @description Currency of the prices below, e.g. `usd`. */ currency: string; /** @description Monthly base price in cents of `currency`. */ base_price_cents: number; /** @description Metered allowances and overage rates. */ meters: { /** @description Meter key, e.g. `ai_credits` or `test_minutes`. */ meter: string; /** @description Units included each month. */ included_qty: number | null; /** @description Price per unit above the allowance, in cents of `currency`; may be fractional. */ overage_price_cents: number | null; }[]; } | null; /** @description Whether the plan in effect is a trial, where usage draws from credits. The month summary has the credit. */ trial: boolean; /** @description The org's live Dodo subscription now, or null when it's billed by invoice or has none. */ subscription: { /** * @description `past_due` / `on_hold`: the last renewal payment failed and is being retried. A paused subscription, or one whose plan was ended (End plan) whatever its Dodo status, holds no plan, so `subscription` is null. * @enum {string} */ status: "active" | "past_due" | "on_hold"; /** @description When the subscription next renews (ISO 8601). */ next_billing_date: string; } | null; }; }; OrgProject: { /** @description Project ID. */ id: number; /** @description Owning organization ID. */ org_id: number; /** @description Project display name. */ name: string; /** @description URL slug for the project. */ slug: string; /** @description Backing repository name. */ repo_name: string; /** @description Repository owner/org. */ repo_owner: string; /** * @description Repository host. * @enum {string} */ repo_host: "github" | "pierre_code_storage"; /** @description Default branch name. */ default_branch: string; /** * @description Concurrency scope for test runs. * @enum {string} */ test_run_concurrency_limit: "none" | "project" | "environment" | "branch_environment"; /** * @description Behavior when the concurrency limit is hit. * @enum {string} */ test_run_concurrency_behavior: "cancel_previous" | "queue_new"; /** * @description Region test runs execute in. * @enum {string} */ test_run_region: "us-east-1" | "ap-south-1"; /** @description Fixed shard count, if configured. */ test_run_shards: number | null; /** @description Project icon URL. */ profile_icon_url: string | null; /** @description Raw owners.yaml contents. */ owners_yaml_raw: string | null; /** @description Whether the repo defines environments.yaml. */ has_environments_yaml: boolean | null; /** @description Whether the project is active. */ is_active: boolean; /** @description Commit SHA of the last test-case sync. */ last_synced_test_cases_commit_sha: string | null; /** @description Last test-case sync error, if any. */ test_cases_sync_error: string | null; /** @description When the last sync error occurred (ISO 8601). */ test_cases_sync_error_at: string | null; }; OrgRunnerBackendListResponse: { /** @description Response payload. */ data: { runner_backends: { /** @description Runner backend ID. */ id: number; /** @description Organisation that owns the installation. */ org_id: number; /** @description Human-readable name. */ name: string; /** @description AWS account the installation runs in. */ aws_account_id: string; /** @description AWS region of the installation. */ region: string; /** @description Role api-worker assumes to drive the plane. */ role_arn: string; /** @description ECS cluster name. */ cluster_name: string; /** @description CloudWatch log group of the worker. */ log_group_name: string; /** @description Worker container name. */ container_name: string; /** @description Job queue URLs are `${queue_prefix}-${machineSize}`. */ queue_prefix: string; /** * @description `pending` until verified; only `active` backends receive runs. * @enum {string} */ status: "pending" | "active" | "disabled"; /** @description ISO-8601 time of the last successful verify. */ last_verified_at: string | null; /** @description ISO-8601 time of the last verify, manual or scheduled, whatever its outcome. */ last_checked_at: string | null; /** @description Outcome of the last verify; null if never run. */ last_check_ok: boolean | null; /** @description Every check from the last verify. */ last_check_results: components["schemas"]["RunnerBackendCheck"][] | null; /** @description ISO-8601 start of the current run of failed checks; null while passing. A failing check does not change `status`. */ check_failing_since: string | null; /** @description Release of the CloudFormation template the installation runs, as its stack last reported. */ stack_version: string | null; /** @description ISO-8601 time that release was published, if known. */ stack_released_at: string | null; /** @description Worker image the installation runs. */ worker_version: string | null; /** @description Job protocol version the installation speaks. */ protocol_version: string | null; /** @description Optional features the installation supports. */ capabilities: string[]; /** @description ARN of the CloudFormation stack that registered the installation. */ stack_id: string | null; /** @description ISO-8601 time the installation's stack first called home; null until then. */ registration_claimed_at: string | null; /** @description ISO-8601 expiry of the current registration link, if one was minted. Ignored once claimed. */ registration_token_expires_at: string | null; /** @description ISO-8601 creation time. */ created_at: string; /** @description ISO-8601 last-update time. */ updated_at: string; /** @description Projects whose new runs use this runner. */ projects: { id: number; name: string; slug: string; }[]; }[]; }; }; OrgUpdateRequest: { /** @description Organization display name. */ name?: string; /** @description Email domains that map users to this org. */ email_domains?: string[]; /** @description Recipients for billing communication. */ billing_emails?: string[]; /** @description Billing currency (e.g. `usd`, `inr`). */ billing_currency?: string; /** @description Deposit bank account key. */ deposit_bank_key?: string; /** @description Legal billing name, or `null` to clear. */ billing_name?: string | null; /** @description Billing address, or `null` to clear. */ billing_address_lines?: string | null; /** @description GSTIN, or `null` to clear. */ billing_gstin?: string | null; /** @description Place of supply, or `null` to clear. */ place_of_supply?: string | null; /** @description Payment terms in days, or `null` to clear. */ payment_terms_days?: number | null; }; OrgUpdateResponse: { /** @description Response payload. */ data: { org: components["schemas"]["Organization"] & unknown; }; }; Organisation: { /** @description Organisation ID. */ id: number; /** @description Organisation name. */ name: string; /** @description Email domains associated with the org. */ email_domains: string[]; /** @description ISO 8601 creation timestamp. */ created_at: string | null; /** @description ISO 8601 last-update timestamp. */ updated_at: string | null; /** @description Who last updated the org. */ updated_by: string | null; /** @description Billing contact emails. */ billing_emails: string[]; /** @description Billing currency (e.g. usd, inr). */ billing_currency: string; /** @description Deposit bank account key. */ deposit_bank_key: string; /** @description Billing legal name. */ billing_name: string | null; /** @description Billing address. */ billing_address_lines: string | null; /** @description Billing GSTIN. */ billing_gstin: string | null; /** @description Place of supply (tax). */ place_of_supply: string | null; /** @description Payment terms in days. */ payment_terms_days: number | null; }; Organization: { /** @description Organization ID. */ id: number; /** @description Organization display name. */ name: string; /** @description Email domains that map users to this org. */ email_domains: string[]; /** @description Creation timestamp (ISO 8601). */ created_at: string | null; /** @description Last update timestamp (ISO 8601). */ updated_at: string | null; /** @description User/system id that last updated the org. */ updated_by: string | null; /** @description Recipients for billing communication. */ billing_emails: string[]; /** @description Billing currency (e.g. `usd`, `inr`). */ billing_currency: string; /** @description Deposit bank account key. */ deposit_bank_key: string; /** @description Legal billing name. */ billing_name: string | null; /** @description Billing address. */ billing_address_lines: string | null; /** @description GSTIN. */ billing_gstin: string | null; /** @description Place of supply. */ place_of_supply: string | null; /** @description Payment terms in days. */ payment_terms_days: number | null; }; OrganizationWithProjects: { /** @description Organization ID. */ id: number; /** @description Organization display name. */ name: string; /** @description Email domains that map users to this org. */ email_domains: string[]; /** @description Creation timestamp (ISO 8601). */ created_at: string | null; /** @description Last update timestamp (ISO 8601). */ updated_at: string | null; /** @description User/system id that last updated the org. */ updated_by: string | null; /** @description Recipients for billing communication. */ billing_emails: string[]; /** @description Billing currency (e.g. `usd`, `inr`). */ billing_currency: string; /** @description Deposit bank account key. */ deposit_bank_key: string; /** @description Legal billing name. */ billing_name: string | null; /** @description Billing address. */ billing_address_lines: string | null; /** @description GSTIN. */ billing_gstin: string | null; /** @description Place of supply. */ place_of_supply: string | null; /** @description Payment terms in days. */ payment_terms_days: number | null; /** @description Projects belonging to the organization. */ projects: components["schemas"]["OrgProject"][]; }; OrgsByEmailDomainResponse: { /** @description Response payload. */ data: { organisations: { /** @description Organization ID. */ id: number; /** @description Organization name. */ name: string; }[]; }; }; OverlayDismissalEvent: { /** @description ISO 8601 timestamp of the event. */ timestamp: string; /** @description Environment the test ran in. */ environment: string | null; /** @description Repository the test belongs to. */ repo_name: string | null; /** @description Project name. */ project_name: string | null; /** @description ID of the test run. */ test_run_id: string | null; /** @description Name of the test. */ test_name: string | null; /** @description Whether the dismissal succeeded. */ success: boolean | null; /** @description Whether the result was served from cache. */ cache_hit: boolean | null; /** @description Dismissal duration in milliseconds. */ duration_ms: number | null; /** @description Description of the dismissed overlay. */ overlay_description: string | null; /** @description Visible text of the dismissed overlay. */ overlay_text: string | null; /** @description Original locator that was occluded. */ original_locator: string | null; /** @description Input tokens consumed. */ tokens_input: number | null; /** @description Output tokens produced. */ tokens_output: number | null; /** @description Cost of input tokens. */ cost_input: number | null; /** @description Cost of output tokens. */ cost_output: number | null; }; OverlayDismissalEventsResponse: { /** @description Project reference and the page of events. */ data: { project: components["schemas"]["TelemetryProjectRef"]; /** @description The page of overlay-dismissal events. */ events: components["schemas"]["OverlayDismissalEvent"][]; }; pagination: components["schemas"]["Pagination"]; }; OverlayDismissalSummary: { /** @description Total overlay-dismissal events in the window. */ total: number; /** @description Number of successful dismissals. */ success_count: number; /** @description Success rate as a percentage (0-100). */ success_rate: number; /** @description Number of dismissals served from cache. */ cache_hit_count: number; /** @description Cache-hit rate as a percentage (0-100). */ cache_hit_rate: number; /** @description Average dismissal duration in milliseconds. */ avg_duration_ms: number; /** @description Total cost across all dismissals. */ total_cost: number; }; OverlayDismissalSummaryResponse: { /** @description Response payload. */ data: { project: components["schemas"]["TelemetryProjectRef"]; summary: components["schemas"]["OverlayDismissalSummary"]; }; }; /** @description Pagination metadata. */ Pagination: { /** @description Current page (1-indexed). */ page: number; /** @description Items per page. */ per_page: number; /** @description Total number of items. */ total: number; /** @description Total number of pages. */ total_pages: number; }; PatchFailureGroupRequest: { label?: string; /** @enum {string} */ type?: "app" | "test"; /** @enum {string} */ status?: "open" | "resolved"; diagnosis?: string; recommendation?: string; /** @description Present → replaces the stored fingerprint wholesale; omit to keep it. */ fingerprint?: { signals: { kind: string; value: string; /** @enum {string} */ match?: "exact" | "contains" | "glob" | "regex"; weight?: number; /** @enum {string} */ source: "machine" | "agent" | "human"; data?: { [key: string]: unknown; }; }[]; } | null; /** @description Present → replaces the stored matcher wholesale (null clears it); omit to keep it. Re-submitting an identical source + description is a no-op (no revision). */ matcher?: { /** @description Plain-JS async function source: `async ({ testRun, testCase, traceUtils }) => boolean`. */ source: string; /** @description Human-readable summary of what the matcher matches and why; re-articulated on every edit. */ description: string; /** * @description Input-contract version the source was written against. * @default 1 */ contract_version: number; } | null; source_run_id?: number | null; }; PatchProjectResponse: { /** @description Always true. */ success: boolean; /** @description The updated project. */ project: { /** @description Project ID. */ id: number; /** @description Organisation that owns the project. */ org_id: number; /** @description Project display name. */ name: string; /** @description Unique project slug. */ slug: string; /** @description Repository name. */ repo_name: string; /** @description Repository owner. */ repo_owner: string; /** * @description Repository host. * @enum {string} */ repo_host: "github" | "pierre_code_storage"; /** @description Default branch of the repository. */ default_branch: string; /** @description Branches that may not be pushed to through Empirical. Always includes the default branch. */ protected_branches: string[]; /** * @description Concurrency limit scope for test runs. * @enum {string} */ test_run_concurrency_limit: "none" | "project" | "environment" | "branch_environment"; /** * @description Behaviour when the concurrency limit is hit. * @enum {string} */ test_run_concurrency_behavior: "cancel_previous" | "queue_new"; /** * @description Region test runs execute in. * @enum {string} */ test_run_region: "us-east-1" | "ap-south-1"; /** @description Number of shards to split test runs into. */ test_run_shards: number | null; /** @description URL of the project profile icon. */ profile_icon_url: string | null; /** @description Raw owners.yaml contents. */ owners_yaml_raw: string | null; /** @description Whether the repo defines environments.yaml. */ has_environments_yaml: boolean | null; /** @description Whether the project is active. */ is_active: boolean; /** @description Commit SHA of the last successful test-cases sync. */ last_synced_test_cases_commit_sha: string | null; /** @description Error message of the last failed sync, if any. */ test_cases_sync_error: string | null; /** @description ISO 8601 timestamp of the last sync error. */ test_cases_sync_error_at: string | null; } | null; }; Plan: { /** @description Plan ID. */ id: number; /** @description Organisation a custom plan belongs to; null for a shared plan. */ org_id: number | null; /** @description Order form a custom plan comes from, if any. */ order_form_id: number | null; /** @description `tier` or `addon`. */ kind: string; /** @description Stable unique key of a shared plan, e.g. `managed`. */ key: string | null; /** @description Display name, as shown to customers. */ name: string | null; /** @description Currency the plan is priced in, e.g. `usd`. */ currency: string; /** @description Monthly base price in cents of `currency`. */ base_price_cents: number; /** @description `active` or `retired`. Retired plans keep existing assignments. */ status: string; /** @description Dodo product that bills this plan by subscription; null when it isn't sold through Dodo. */ dodo_product_id: string | null; /** @description Whether the plan is sold through Dodo. Only these plans get a Dodo product and are offered at checkout. */ dodo_sync: boolean; /** @description ISO-8601 creation timestamp. */ created_at: string; /** @description Metered allowances and overage rates. */ meters: components["schemas"]["PlanMeter"][]; }; PlanAssignment: { /** @description Plan assignment ID. */ id: number; /** @description Organisation this assignment belongs to. */ org_id: number; /** @description Plan the organisation is on. */ plan_id: number; /** @description ISO-8601 timestamp the assignment starts. */ effective_from: string; /** @description ISO-8601 timestamp the assignment ends, or null for open-ended. */ effective_to: string | null; /** @description Origin: `order_form`, `derived_from_invoice`, `manual`, `trial` or `dodo`. */ source: string; /** @description ISO-8601 creation timestamp. */ created_at: string; /** @description ISO-8601 last-update timestamp. */ updated_at: string; }; PlanAssignmentListResponse: { /** @description The page of plan assignments. */ data: { plan_assignments: components["schemas"]["PlanAssignment"][]; }; pagination: components["schemas"]["Pagination"]; }; PlanAssignmentResponse: { /** @description Response payload. */ data: { plan_assignment: components["schemas"]["PlanAssignment"]; }; }; PlanListResponse: { /** @description Response payload. */ data: { plans: components["schemas"]["Plan"][]; }; }; PlanMeter: { /** @description Plan meter ID. */ id: number; /** @description Plan this meter belongs to. */ plan_id: number; /** @description Meter key, e.g. `ai_credits` or `test_minutes`. */ meter: string; /** @description Units included in the base price each month. */ included_qty: number | null; /** @description Price per unit above the included quantity, in cents of the plan currency. May be fractional (0.5 = $0.005). Null means usage above the allowance is not billed. */ overage_price_cents: number | null; /** @description Display order. */ sort_order: number; }; PlanResponse: { /** @description Response payload. */ data: { plan: components["schemas"]["Plan"]; }; }; PlaywrightUtilsProxyError: { /** @description Error message — the provider API key is not configured, or the proxied request failed. */ error: string; }; PlaywrightUtilsProxyRequest: { /** @description HTTP method to forward to the upstream provider. */ method: string; /** @description Provider path (and query string) to call, starting with `/`. Appended to the provider's base URL. */ path: string; /** @description Optional JSON body to forward to the upstream provider. */ body?: unknown; }; PlaywrightUtilsProxyResponse: { /** @description Parsed JSON body returned by the upstream provider, or null when the response was not JSON. */ data?: unknown; /** @description Response headers returned by the upstream provider. */ headers: { [key: string]: string; }; }; PlaywrightVersionsResponse: { /** @description Response payload. */ data: { /** @description Supported Playwright versions, newest first. */ versions: string[]; /** @description The Playwright version used when none is chosen. */ default_version: string; }; }; PostShardPlanRequest: { /** @description Shard count this partition was built for. Stored on every row and checked against the shard's own total_shards when the plan is read. */ total_shards: number; /** @description One entry per run_test shard. */ shards: { /** @description 1-based index of the run_test shard. Index 0 is the run_setup job and never carries an assignment. */ shard_index: number; /** @description Tests assigned to this shard. */ tests: { /** @description Playwright test id (`pw_test_id`) assigned to this shard. */ id: string; /** @description Scheduled test line (`[project] › file › suite › title`). Not stored yet; the server-written run manifest is its consumer. */ name: string; }[]; }[]; /** @description How the partition was chosen, stored verbatim for provenance (e.g. `equal split over the canonical listing`). */ reason?: string; /** @description Modelled wall-clock of the slowest shard, in ms. */ predicted_makespan_ms?: number; /** @description Modelled wall-clock at the ceiling — what the run would have done without the reduction, in ms. */ baseline_makespan_ms?: number; /** @description Heaviest single schedulable unit, in ms. The floor no shard count can beat. */ longest_unit_ms?: number; /** @description Fraction of planned tests that had a real historical duration. */ coverage?: number; }; Project: { /** @description Project ID. */ id: number; /** @description Organisation that owns the project. */ org_id: number; /** @description Project display name. */ name: string; /** @description Unique project slug. */ slug: string; /** @description Repository name. */ repo_name: string; /** @description Repository owner. */ repo_owner: string; /** * @description Repository host. * @enum {string} */ repo_host: "github" | "pierre_code_storage"; /** @description Default branch of the repository. */ default_branch: string; /** @description Branches that may not be pushed to through Empirical. Always includes the default branch. */ protected_branches: string[]; /** * @description Concurrency limit scope for test runs. * @enum {string} */ test_run_concurrency_limit: "none" | "project" | "environment" | "branch_environment"; /** * @description Behaviour when the concurrency limit is hit. * @enum {string} */ test_run_concurrency_behavior: "cancel_previous" | "queue_new"; /** * @description Region test runs execute in. * @enum {string} */ test_run_region: "us-east-1" | "ap-south-1"; /** @description Number of shards to split test runs into. */ test_run_shards: number | null; /** @description URL of the project profile icon. */ profile_icon_url: string | null; /** @description Raw owners.yaml contents. */ owners_yaml_raw: string | null; /** @description Whether the repo defines environments.yaml. */ has_environments_yaml: boolean | null; /** @description Whether the project is active. */ is_active: boolean; /** @description Commit SHA of the last successful test-cases sync. */ last_synced_test_cases_commit_sha: string | null; /** @description Error message of the last failed sync, if any. */ test_cases_sync_error: string | null; /** @description ISO 8601 timestamp of the last sync error. */ test_cases_sync_error_at: string | null; }; ProjectAddonPeriod: { id: number; /** * @description Add-on identifier. * @enum {string} */ addon: "static_ip_proxy" | "repo_ownership"; /** @description ISO timestamp the add-on became active. */ effective_from: string; /** @description ISO timestamp it was turned off; null while active. */ effective_to: string | null; /** @description Add-on plan this period bills against, when a priced one exists. Null for add-ons that are free today. */ plan_id: number | null; created_by: string | null; ended_by: string | null; }; ProjectAddonResponse: { /** @description Response payload. */ data: { addon: components["schemas"]["ProjectAddonPeriod"]; }; }; ProjectAddonState: { /** * @description Add-on identifier. * @enum {string} */ key: "static_ip_proxy" | "repo_ownership"; name: string; description: string; /** @description Copy for the enable-confirmation dialog. Null when the add-on has nothing to warn about. */ billing_note: string | null; /** @description True when there is an open period for this add-on. */ enabled: boolean; /** @description effective_from of the open period, or null when disabled. */ active_since: string | null; }; ProjectAiUsageByType: { type: components["schemas"]["AiUsageType"]; sessions: number; /** @description Input, output, cache-read, and cache-write tokens combined. */ tokens: number; credits: number; }; ProjectBranchesResponse: { /** @description Response payload. */ data: { /** @description Recent branches with test-run activity. */ branches: components["schemas"]["RecentBranch"][]; /** @description Total matching branches. */ total: number; }; }; ProjectCloneResponse: { /** @description Response payload. */ data: { /** @description Repository URL on git.empirical.run. Authenticate with an Empirical credential (session token or project API key) as the HTTP password. */ clone_url: string; /** @description HTTP Basic username git-worker expects. */ username: string; /** @description Repository name. */ name: string; /** @description Default branch of the repository. */ default_branch: string; }; }; ProjectDailyAiUsage: { /** @description UTC date (YYYY-MM-DD). */ date: string; type: components["schemas"]["AiUsageType"]; credits: number; }; ProjectDailyTestUsage: { /** @description UTC date (YYYY-MM-DD). */ date: string; duration_ms: number; }; ProjectDailyTestUsageByEnvironment: { /** @description UTC date (YYYY-MM-DD). */ date: string; duration_ms: number; environment_id: number | null; environment_name: string | null; }; ProjectGitTokenResponse: { /** @description Response payload. */ data: { /** @description Installation access token. */ token: string; /** @description Git host (github.com). */ host: string; /** @description Username to use with the token. */ username: string; }; }; ProjectKvGetResponse: { /** @description Response payload. */ data: { /** @description The key read. */ key: string; /** @description The stored value, if any. */ value?: unknown; }; }; ProjectKvSetResponse: { /** @description Response payload. */ data: { /** @description The key written. */ key: string; /** @description Always true. */ success: boolean; }; }; ProjectListResponse: { /** @description Response payload. */ data: { projects: components["schemas"]["Project"][]; }; }; ProjectManagerSessionResponse: { /** @description Response payload. */ data: { chat_session: components["schemas"]["ChatSession"]; /** @description True when this request created the session, false when it returned the existing one. */ created: boolean; }; }; ProjectNpmSnapshotUrlsBody: { /** @description Hex SHA-256 of the repo's package-lock.json. */ lockfile_sha256: string; /** @description `-abi` of the sandbox, e.g. `linux-abi127`. */ runtime: string; }; ProjectNpmSnapshotUrlsResponse: { /** @description Response payload. */ data: { /** @description Presigned GETs to try in order. Per bucket, nearest to the sandboxes first: the tarball test runs share across projects, then this project's own. */ restore_urls: string[]; /** @description Presigned PUT for this project's tarball in the bucket nearest the sandboxes. */ upload_url: string; }; }; ProjectOrgResponse: { /** @description Response payload. */ data: { org: components["schemas"]["Organisation"]; }; }; ProjectResourceListResponse: { /** @description The page of resources. */ data: { resources: components["schemas"]["Resource"][]; }; pagination: components["schemas"]["Pagination"]; }; ProjectResourceResponse: { /** @description Response payload. */ data: { resource: components["schemas"]["Resource"]; }; }; ProjectResponse: { /** @description Response payload. */ data: { /** @description Project ID. */ id: number; /** @description Organisation that owns the project. */ org_id: number; /** @description Project display name. */ name: string; /** @description Unique project slug. */ slug: string; /** @description Repository name. */ repo_name: string; /** @description Repository owner. */ repo_owner: string; /** * @description Repository host. * @enum {string} */ repo_host: "github" | "pierre_code_storage"; /** @description Default branch of the repository. */ default_branch: string; /** @description Branches that may not be pushed to through Empirical. Always includes the default branch. */ protected_branches: string[]; /** * @description Concurrency limit scope for test runs. * @enum {string} */ test_run_concurrency_limit: "none" | "project" | "environment" | "branch_environment"; /** * @description Behaviour when the concurrency limit is hit. * @enum {string} */ test_run_concurrency_behavior: "cancel_previous" | "queue_new"; /** * @description Region test runs execute in. * @enum {string} */ test_run_region: "us-east-1" | "ap-south-1"; /** @description Number of shards to split test runs into. */ test_run_shards: number | null; /** @description URL of the project profile icon. */ profile_icon_url: string | null; /** @description Raw owners.yaml contents. */ owners_yaml_raw: string | null; /** @description Whether the repo defines environments.yaml. */ has_environments_yaml: boolean | null; /** @description Whether the project is active. */ is_active: boolean; /** @description Commit SHA of the last successful test-cases sync. */ last_synced_test_cases_commit_sha: string | null; /** @description Error message of the last failed sync, if any. */ test_cases_sync_error: string | null; /** @description ISO 8601 timestamp of the last sync error. */ test_cases_sync_error_at: string | null; }; }; ProjectRunnerBackendDetailResponse: { /** @description Response payload. */ data: { /** @description The backend the project's new runs are placed on, or null for Empirical-hosted. */ runner_backend: { /** @description Runner backend ID. */ id: number; /** @description Organisation that owns the installation. */ org_id: number; /** @description Human-readable name. */ name: string; /** @description AWS account the installation runs in. */ aws_account_id: string; /** @description AWS region of the installation. */ region: string; /** @description Role api-worker assumes to drive the plane. */ role_arn: string; /** @description ECS cluster name. */ cluster_name: string; /** @description CloudWatch log group of the worker. */ log_group_name: string; /** @description Worker container name. */ container_name: string; /** @description Job queue URLs are `${queue_prefix}-${machineSize}`. */ queue_prefix: string; /** * @description `pending` until verified; only `active` backends receive runs. * @enum {string} */ status: "pending" | "active" | "disabled"; /** @description ISO-8601 time of the last successful verify. */ last_verified_at: string | null; /** @description ISO-8601 time of the last verify, manual or scheduled, whatever its outcome. */ last_checked_at: string | null; /** @description Outcome of the last verify; null if never run. */ last_check_ok: boolean | null; /** @description Every check from the last verify. */ last_check_results: components["schemas"]["RunnerBackendCheck"][] | null; /** @description ISO-8601 start of the current run of failed checks; null while passing. A failing check does not change `status`. */ check_failing_since: string | null; /** @description Release of the CloudFormation template the installation runs, as its stack last reported. */ stack_version: string | null; /** @description ISO-8601 time that release was published, if known. */ stack_released_at: string | null; /** @description Worker image the installation runs. */ worker_version: string | null; /** @description Job protocol version the installation speaks. */ protocol_version: string | null; /** @description Optional features the installation supports. */ capabilities: string[]; /** @description ARN of the CloudFormation stack that registered the installation. */ stack_id: string | null; /** @description ISO-8601 time the installation's stack first called home; null until then. */ registration_claimed_at: string | null; /** @description ISO-8601 expiry of the current registration link, if one was minted. Ignored once claimed. */ registration_token_expires_at: string | null; /** @description ISO-8601 creation time. */ created_at: string; /** @description ISO-8601 last-update time. */ updated_at: string; } | null; }; }; ProjectRunnerBackendResponse: { /** @description Response payload. */ data: { project_id: number; runner_backend_id: number | null; }; }; ProjectStaticIpProxyTokenResponse: { /** @description Response payload. */ data: { /** @description Static-IP proxy access token, HMAC signed. */ token: string; /** @description Unix seconds at which the token stops being accepted. */ expires_at: number; }; }; ProjectUsageV2Response: { /** @description Response payload. */ data: { project_id: number; /** @description Window start actually used (ISO 8601, UTC). */ start_date: string; /** @description Window end actually used (ISO 8601, UTC). */ end_date: string; ai_usage: { by_type: components["schemas"]["ProjectAiUsageByType"][]; by_day: components["schemas"]["ProjectDailyAiUsage"][]; }; test_usage: { /** @description Sum of all attempt durations for completed non-skipped tests, in milliseconds. */ duration_ms: number; by_day: components["schemas"]["ProjectDailyTestUsage"][]; by_day_and_environment: components["schemas"]["ProjectDailyTestUsageByEnvironment"][]; }; }; }; ProjectWrappedResponse: { /** @description Response payload. */ data: { project: components["schemas"]["Project"]; }; }; ProtectionRuleset: { id: number; name: string; /** @description Where the ruleset is defined: `Repository`, `Organization` or `Enterprise`. */ source_type: string | null; /** @description The repository, organization or enterprise defining it. */ source: string | null; html_url: string; /** * @description Whether the Empirical GitHub App is on the ruleset's bypass list, and in which mode. `unknown` when GitHub did not say. * @enum {string} */ bypass: "always" | "pull_requests_only" | "never" | "exempt" | "unknown"; /** @description Rules that hold back pull requests Empirical merges into the default branch, e.g. "Requires 1 approval": approvals, status checks, required workflows and scans, restricted updates, linear history, signed commits and commit patterns. */ rules: string[]; /** @description Rules that do not affect how Empirical merges, e.g. "Blocks force pushes". */ other_rules: string[]; }; PutRunManifestRequest: { /** @description Structured scheduled tests. */ tests: { /** @description Full test title. */ name: string; /** @description Playwright test id, if known. */ pw_test_id?: string | null; /** @description Duration (ms) the run worker scheduled this test with, if it had history. */ expected_duration_ms?: number | null; }[]; /** @description Scheduled dependency groups (serial blocks). */ dependency_groups?: { /** @description Stable group id. */ id: string; /** * @description Only Playwright serial groups today. * @enum {string} */ kind: "playwright_serial"; /** @description Members in execution order. */ members: { /** @description Playwright test id of the member. */ test_case_id: string; /** @description 0-based execution order within the group. */ dependency_order: number; }[]; }[]; /** @description Zero-based shard index, when the run is sharded. */ shard_index?: number; /** @description Total number of shards, when the run is sharded. */ total_shards?: number; }; RazorpayWebhookAckResponse: { /** @description Acknowledgement. */ message: string; }; RealtimeUnavailableResponse: { /** @description Reason the realtime service is unavailable. */ error: string; }; RecentBranch: { /** @description Branch name. */ name: string; /** @description ID of the latest test run on the branch. */ latest_run_id: number; /** @description ISO 8601 timestamp of the latest run. */ latest_run_date: string | null; /** @description Head commit SHA of the latest run. */ latest_commit_sha: string | null; /** @description Number of runs in the window. */ run_count: number; /** @description GitHub actor of the latest run. */ latest_github_actor: string | null; }; RecentPage: { page_id: string; project_id: number | null; path: string | null; title: string | null; viewed_at: string; }; RecentPagesResponse: { /** @description Response payload. */ data: { recent_pages: components["schemas"]["RecentPage"][]; }; }; RecordRecentPageRequest: { /** @description Stable dashboard page ID. */ page_id: string; /** @description Project for a project-scoped page; null for global pages. */ project_id?: number | null; /** @description Exact project-relative pathname, or absolute pathname for a global page. */ path?: string; /** @description Current document title for this exact destination. */ title?: string; }; RecordRecentPageResponse: { /** @description Response payload. */ data: { recent_page: components["schemas"]["RecentPage"]; }; }; RemoveMemberResponse: { /** @description Response payload. */ data: { removed: boolean; }; }; RemoveRunnerBackendResponse: { /** @description Response payload. */ data: { /** @enum {boolean} */ removed: true; }; }; RenameBranchResponse: { /** @description Always true. */ success: boolean; /** @description Human-readable result. */ message: string; }; RenameRunnerBackendBody: { /** @description Name shown for the runner in Empirical. */ name: string; }; ReplaceInvoiceBillingLinesRequest: { billing_lines: { period_month?: string | null; fx_rate?: number | null; /** @enum {string} */ kind?: "tier" | "addon"; project_id?: number | null; plan_id?: number | null; tier?: string | null; label?: string | null; base_price_cents: number; currency?: string; meters: { meter: string; included_qty?: number | null; billed_overage_qty?: number | null; overage_price_cents?: number | null; }[]; }[]; }; RepoExistsErrorResponse: { /** @description Error message. */ error: string; /** @description Existence (false) on error. */ data: { exists: boolean; }; }; RepoExistsResponse: { /** @description Response payload. */ data: { /** @description Whether the repository exists. */ exists: boolean; }; }; RepoSettingsCheck: { /** @description Stable check id. */ id: string; /** * @description `error`: Empirical breaks without it. `warning`: recommended. * @enum {string} */ level: "error" | "warning"; /** * @description `unknown` when GitHub did not let the Empirical app read what the check needs. * @enum {string} */ status: "pass" | "fail" | "unknown"; /** @description What was found, e.g. "Squash merging is on". Worded the same way whether the check passes or fails. */ title: string; /** @description Why it matters, or what could not be read. */ detail: string; /** @description Where to change it in GitHub, in plain language. */ fix_hint: string | null; }; RepoSettingsCheckResponse: { /** @description Response payload. */ data: { repo: { owner: string; name: string; html_url: string; }; checks: components["schemas"]["RepoSettingsCheck"][]; /** @description Null when the repository could not be read. */ default_branch_protection: { branch: string; rulesets: { /** @enum {string} */ kind: "ok"; items: components["schemas"]["ProtectionRuleset"][]; } | { /** @enum {string} */ kind: "unavailable"; } | { /** @enum {string} */ kind: "error"; message: string; }; classic: { /** @enum {string} */ kind: "ok"; rules: string[]; } | { /** @enum {string} */ kind: "none"; } | { /** @enum {string} */ kind: "unavailable"; } | { /** @enum {string} */ kind: "unreadable"; }; } | null; }; }; RepoTransfer: { /** @description Repo transfer ID. */ id: number; /** @description ID of the project being transferred. */ project_id: number; /** @description ID of the org that owns the project. */ org_id: number; /** @description Current GitHub org/owner of the repo. */ source_repo_owner: string; /** @description Current repository name. */ source_repo_name: string; /** @description Destination GitHub org/owner. */ target_repo_owner: string; /** @description Destination repository name. */ target_repo_name: string; /** * @description Current status of the transfer. * @enum {string} */ status: "pending" | "mirroring" | "flipping" | "done" | "failed"; /** @description Completion percentage (0-100). */ progress_percent: number; /** @description Human-readable progress message, if any. */ progress_message: string | null; /** @description Error message when the transfer failed. */ error_message: string | null; /** @description ISO 8601 timestamp the transfer started. */ started_at: string | null; /** @description ISO 8601 timestamp the transfer completed. */ completed_at: string | null; /** @description ISO 8601 creation timestamp. */ created_at: string | null; /** @description ISO 8601 last-update timestamp. */ updated_at: string | null; }; RepoTransferCodedError: { /** @description Human-readable error message. */ error: string; /** @description Machine-readable error code, when applicable. */ code?: string; }; RepoTransferConflict: { /** @description Human-readable error message. */ error: string; /** @description The transfer already in progress for the project. */ data: { /** @description Repo transfer ID. */ id: number; /** @description ID of the project being transferred. */ project_id: number; /** @description ID of the org that owns the project. */ org_id: number; /** @description Current GitHub org/owner of the repo. */ source_repo_owner: string; /** @description Current repository name. */ source_repo_name: string; /** @description Destination GitHub org/owner. */ target_repo_owner: string; /** @description Destination repository name. */ target_repo_name: string; /** * @description Current status of the transfer. * @enum {string} */ status: "pending" | "mirroring" | "flipping" | "done" | "failed"; /** @description Completion percentage (0-100). */ progress_percent: number; /** @description Human-readable progress message, if any. */ progress_message: string | null; /** @description Error message when the transfer failed. */ error_message: string | null; /** @description ISO 8601 timestamp the transfer started. */ started_at: string | null; /** @description ISO 8601 timestamp the transfer completed. */ completed_at: string | null; /** @description ISO 8601 creation timestamp. */ created_at: string | null; /** @description ISO 8601 last-update timestamp. */ updated_at: string | null; }; }; RepoTransferError: { /** @description Human-readable error message. */ error: string; }; RepoTransferListResponse: { /** @description Response payload. */ data: components["schemas"]["RepoTransfer"][]; }; RepoTransferResponse: { /** @description Response payload. */ data: { /** @description Repo transfer ID. */ id: number; /** @description ID of the project being transferred. */ project_id: number; /** @description ID of the org that owns the project. */ org_id: number; /** @description Current GitHub org/owner of the repo. */ source_repo_owner: string; /** @description Current repository name. */ source_repo_name: string; /** @description Destination GitHub org/owner. */ target_repo_owner: string; /** @description Destination repository name. */ target_repo_name: string; /** * @description Current status of the transfer. * @enum {string} */ status: "pending" | "mirroring" | "flipping" | "done" | "failed"; /** @description Completion percentage (0-100). */ progress_percent: number; /** @description Human-readable progress message, if any. */ progress_message: string | null; /** @description Error message when the transfer failed. */ error_message: string | null; /** @description ISO 8601 timestamp the transfer started. */ started_at: string | null; /** @description ISO 8601 timestamp the transfer completed. */ completed_at: string | null; /** @description ISO 8601 creation timestamp. */ created_at: string | null; /** @description ISO 8601 last-update timestamp. */ updated_at: string | null; }; }; ReporterSlackChannel: { /** @description Registered channel id, as used in `slack_channel_ids` of a reporter config. */ id: number; /** @description Slack channel id (`C…`), as used in `slack_channels` of a reporter config. */ channel_id: string; /** @description Channel name without the `#`, if known. */ name: string | null; }; RequestIngestionProviderPayload: { [key: string]: unknown; }; RequestIngestionWebhook: { /** @description Raw provider webhook payload (JSON object). */ payload: { [key: string]: unknown; }; /** @description Raw request body, used for signature validation. */ body: string; /** @description Provider signature header for the delivery. */ signature?: string | null; }; RerunTestRunRequest: { /** @description When true, re-run only the failed tests from the source run. The source run must be completed. */ only_failed?: boolean; /** @description Reporters for the re-run, in the same shape as on trigger. Defaults to the source run's reporters. */ reporters?: ({ /** * @description Posts run status updates to Slack channels. * @enum {string} */ reporter_type: "slack_run_status"; /** @description Slack channel ids (`C…`), as shown in Slack's channel details. Shared (Slack Connect) channels have the same id in every workspace. Each must be a registered, unarchived channel of the project's organization. */ slack_channels?: string[]; /** @description Registered Slack channel ids from `GET /api/v2/slack/channels` (the numeric `id`). Can be combined with `slack_channels`. */ slack_channel_ids?: number[]; } | { /** * @description Posts a GitHub check run on the build commit. Needs `build` with a repository the GitHub Reporter app is installed on. * @enum {string} */ reporter_type: "github_check"; } | { /** * @description Posts (and updates) a comment on the pull request for the build branch. Needs `build` with a repository the GitHub Reporter app is installed on. * @enum {string} */ reporter_type: "github_pr_comment"; } | { /** * @description Tracks the test branch named after the head branch of the app pull request the run was triggered for (`trigger.event` `pull_request`), and keeps the `Empirical linked test changes` check on that pull request up to date: it passes when the test branch has nothing left to merge and fails while it has unmerged commits. The pull request's latest run decides whether it is tracked. Does nothing for runs not triggered by a pull request. Needs `build` with a repository the GitHub Reporter app is installed on. * @enum {string} */ reporter_type: "github_linked_changes"; } | { /** * @description Emails a report when the run ends to every user whose email domain is one of the organization's email domains. * @enum {string} */ reporter_type: "email_run_report"; } | { /** * @description Sends a Slack DM to whoever started the run (from the dashboard, the CLI or an agent session) when it ends, if their Slack account is linked. Runs triggered with a project API key have no one to DM. * @enum {string} */ reporter_type: "slack_creator_dm"; })[]; }; ResolveMembershipRequest: { /** * Format: email * @description Verified email of the user. Required for system callers; ignored for a signed-in user, whose confirmed email is read server-side. */ email?: string; /** @description Supabase user id to grant membership to. Required for system callers; ignored for a signed-in user, who resolves their own. */ user_id?: string; }; ResolveMembershipResponse: { /** @description Response payload. */ data: { /** @description All org ids the user belongs to after resolution. */ org_ids: number[]; /** @description Whether the user is a super admin. */ is_super_admin: boolean; }; }; Resource: { /** @description Unique identifier. */ id: number; /** @description File name. */ name: string; /** @description Download URL. For uploaded files, a signed URL that expires in 1 hour. For link-type files, the stored external URL. */ url: string; /** @description Resource description. */ description: string | null; /** @description MIME type. */ mime_type: string | null; /** @description File size in bytes. */ size_bytes: number | null; /** * @description `pending` until confirmed via PATCH, then `uploaded`. * @enum {string} */ status: "pending" | "uploaded"; /** @description For link-type files (e.g. Google Sheets): "read_write", "read", or "none". Null for uploaded files. */ access_level: string | null; /** @description User ID of the creator. */ created_by: string | null; /** @description ISO 8601 timestamp. */ created_at: string; /** @description ISO 8601 timestamp. */ updated_at: string; }; ResourceUploadContentResponse: { /** @description Response payload. */ data: { /** @description Whether the upload was stored. */ success: boolean; }; }; ResourceWithUploadUrl: { /** @description Unique identifier. */ id: number; /** @description File name. */ name: string; /** @description Download URL. For uploaded files, a signed URL that expires in 1 hour. For link-type files, the stored external URL. */ url: string; /** @description Resource description. */ description: string | null; /** @description MIME type. */ mime_type: string | null; /** @description File size in bytes. */ size_bytes: number | null; /** * @description `pending` until confirmed via PATCH, then `uploaded`. * @enum {string} */ status: "pending" | "uploaded"; /** @description For link-type files (e.g. Google Sheets): "read_write", "read", or "none". Null for uploaded files. */ access_level: string | null; /** @description User ID of the creator. */ created_by: string | null; /** @description ISO 8601 timestamp. */ created_at: string; /** @description ISO 8601 timestamp. */ updated_at: string; /** @description Presigned URL for uploading the file via PUT. Expires in 1 hour. */ upload_url: string; }; RetryAttachment: { /** @description Attachment name. */ name: string; /** @description Storage path of the attachment. */ path: string; /** @description MIME type of the attachment. */ contentType: string; /** @description URL to download the attachment. */ url: string; }; RetryDetail: { /** @description 0-based attempt index for the retry. */ retryIndex: number; /** * @description Final status of the retry attempt. * @enum {string} */ status: "passed" | "failed" | "timedOut" | "skipped" | "interrupted"; /** @description Expected status of the retry. */ expectedStatus: string; /** @description Duration of the retry in milliseconds. */ duration: number; /** @description ISO 8601 timestamp when the retry started. */ startTime: string; /** @description Error details if the retry failed. */ error?: { /** @description Error message. */ message: string; /** @description Full error stack. */ stack: string; /** @description Source location of the error. */ location?: { /** @description Source file of the error. */ file: string; /** @description Line number of the error. */ line: number; /** @description Column number of the error. */ column: number; }; }; /** @description Attachments captured during the retry (screenshots, traces, videos). */ attachments?: components["schemas"]["RetryAttachment"][]; /** @description The source line that triggered the failure. */ failingLine?: string; /** @description Playwright annotations for the attempt (static + runtime). Absent on rows recorded before annotations were captured. */ annotations?: { /** @description Annotation type. */ type: string; /** @description Annotation description, if any. */ description?: string; }[]; }; RunManifestResponse: { /** @description Response payload. */ data: { /** @description Whether the run manifest was stored. */ created: boolean; }; }; RunnerBackend: { /** @description Runner backend ID. */ id: number; /** @description Organisation that owns the installation. */ org_id: number; /** @description Human-readable name. */ name: string; /** @description AWS account the installation runs in. */ aws_account_id: string; /** @description AWS region of the installation. */ region: string; /** @description Role api-worker assumes to drive the plane. */ role_arn: string; /** @description ECS cluster name. */ cluster_name: string; /** @description CloudWatch log group of the worker. */ log_group_name: string; /** @description Worker container name. */ container_name: string; /** @description Job queue URLs are `${queue_prefix}-${machineSize}`. */ queue_prefix: string; /** * @description `pending` until verified; only `active` backends receive runs. * @enum {string} */ status: "pending" | "active" | "disabled"; /** @description ISO-8601 time of the last successful verify. */ last_verified_at: string | null; /** @description ISO-8601 time of the last verify, manual or scheduled, whatever its outcome. */ last_checked_at: string | null; /** @description Outcome of the last verify; null if never run. */ last_check_ok: boolean | null; /** @description Every check from the last verify. */ last_check_results: components["schemas"]["RunnerBackendCheck"][] | null; /** @description ISO-8601 start of the current run of failed checks; null while passing. A failing check does not change `status`. */ check_failing_since: string | null; /** @description Release of the CloudFormation template the installation runs, as its stack last reported. */ stack_version: string | null; /** @description ISO-8601 time that release was published, if known. */ stack_released_at: string | null; /** @description Worker image the installation runs. */ worker_version: string | null; /** @description Job protocol version the installation speaks. */ protocol_version: string | null; /** @description Optional features the installation supports. */ capabilities: string[]; /** @description ARN of the CloudFormation stack that registered the installation. */ stack_id: string | null; /** @description ISO-8601 time the installation's stack first called home; null until then. */ registration_claimed_at: string | null; /** @description ISO-8601 expiry of the current registration link, if one was minted. Ignored once claimed. */ registration_token_expires_at: string | null; /** @description ISO-8601 creation time. */ created_at: string; /** @description ISO-8601 last-update time. */ updated_at: string; }; RunnerBackendCheck: { /** @description `assume_role`, `job_queue`, `scaler_trigger_queue`, `ecs_cluster`, `ecs_tasks` or `worker_logs`. */ name: string; /** @description Whether the check passed. */ ok: boolean; /** @description The resource checked, or the AWS error. */ detail: string; }; RunnerBackendRegistrationResponse: { /** @description Response payload. */ data: { /** @description Credential the installation's stack calls home with. Shown once; Empirical keeps only its hash. */ registration_token: string; /** @description ISO-8601 time the link stops working if unused. */ expires_at: string; /** @description Release of the template the link installs. */ stack_version: string; /** @description The template the link installs. */ template_url: string; /** @description AWS console link that opens CloudFormation with the template and Empirical's parameters filled in. */ quick_create_url: string; }; }; RunnerBackendResponse: { /** @description Response payload. */ data: { runner_backend: components["schemas"]["RunnerBackend"]; }; }; RunnerBackendVerifyResponse: { /** @description Response payload. */ data: { /** @description True when every check passed. */ verified: boolean; checks: components["schemas"]["RunnerBackendCheck"][]; runner_backend: components["schemas"]["RunnerBackend"]; }; }; SandboxActionSuccess: { /** @description Always true when the action succeeded. */ success: boolean; }; SandboxAuthRefreshError: { /** @description Machine-readable failure reason. */ error: string; }; SandboxAuthRefreshResponse: { /** @description Newly minted short-lived sandbox access token. */ access_token: string; /** @description Access token lifetime in seconds. */ expires_in: number; /** @description ISO 8601 timestamp when the auth session expires. */ expires_at: string; /** @description Project the refreshed token is scoped to. */ project_id: number; }; SandboxBranchesRegistered: { /** @description Count of branches newly registered. */ registered: number; }; SandboxCommit: { commit: { /** @description Full commit SHA. */ sha: string; /** @description First parent SHA; null for a root commit. */ parent_sha: string | null; /** @description Full commit message. */ message: string; /** @description Files changed. */ files_changed: number; /** @description Lines added. */ additions: number; /** @description Lines deleted. */ deletions: number; /** @description Unified diff against the first parent, when requested. */ diff: string | null; /** @description Whether the diff was cut at a file boundary for size. */ diff_truncated: boolean; }; }; SandboxErrorMessage: { /** @description Human-readable error message. */ error: string; }; SandboxHealthResult: { /** @description Sandbox health payload. */ health: { /** @description Sandbox health status. */ status: string; /** @description Sandbox agent version. */ version: string; /** @description Status of the pi agent process. */ pi_process?: { /** @description Whether the pi process is running. */ running: boolean; /** @description Process ID, if running. */ pid: number | null; /** @description Exit code, if the process has exited. */ exit_code: number | null; /** @description Termination signal, if any. */ signal: string | null; /** @description ISO 8601 process start time. */ started_at: string | null; }; }; }; /** @description Opaque result forwarded from the session Durable Object. */ SandboxLifecycleResult: { [key: string]: unknown; }; SandboxProtectedBranches: { /** @description Branch names the sandbox must not push to. */ branches: string[]; }; SandboxSnapshot: { /** @description Snapshot row ID. */ id: number; /** @description Project the snapshot belongs to, or null. */ project_id: number | null; /** @description Sandbox provider (e.g. `e2b`). */ provider: string; /** @description Snapshot source identifier. */ source_name: string; /** @description Playwright version the snapshot was built with. */ playwright_version: string; /** @description Hash of the package lockfile, if known. */ package_lock_hash: string | null; /** @description Base branch the snapshot was built from. */ base_branch: string | null; /** @description Base template the snapshot was built from. */ base_template: string | null; /** @description Head commit SHA the snapshot was built from. */ head_sha: string | null; /** @description ISO 8601 creation timestamp. */ created_at: string; /** @description ISO 8601 last-update timestamp. */ updated_at: string; } | null; SandboxSnapshotSourcesUpsertResponse: { /** @description Response payload. */ data: { /** @description Number of sources upserted. */ source_count: number; /** @description The upserted snapshot source rows. */ sources: components["schemas"]["SandboxSnapshot"][]; }; }; ScheduleSnoozeExpiryRequest: { /** @description ID of the snooze whose expiry alarm to register. */ snooze_id: number; /** @description ISO timestamp at which the snooze expires and the callback fires. */ snooze_until: string; }; ScheduleSnoozeExpiryResponse: { /** @description Response payload. */ data: { /** * @description Always true when the alarm was registered. * @enum {boolean} */ scheduled: true; }; }; ScopedRealtimeTokenResponse: { /** @description Signed token to authenticate the WebSocket. Opens only the channels listed in `channels`. */ token: string; /** @description Unix epoch (seconds) when the token expires. */ expires_at: number; /** @description The requested channels the caller may subscribe to. Channels left out are unknown, for another environment, or not accessible. */ channels: string[]; }; SendInvoiceResponse: { /** @description Human-readable confirmation message. */ message: string; /** @description ID of the sent invoice. */ invoiceId: string; invoice: components["schemas"]["InvoiceWithOrg"]; /** @description Echo of the request body. */ received: { /** @description Whether this was sent as a test email. */ is_test_email?: boolean; }; }; ServiceToken: { /** @description Service token ID. */ id: number; /** @description Leading, non-secret prefix of the token value. */ token_prefix: string; /** @description Name of the service the token was issued to. */ service_name: string; /** @description User ID that issued the token, if any. */ created_by: string | null; /** @description When the token was created (ISO-8601). */ created_at: string; /** @description When the token was last used (ISO-8601), or null. */ last_used_at: string | null; /** @description When the token was revoked (ISO-8601), or null. */ revoked_at: string | null; }; ServiceTokenCreatedResponse: { /** @description Response payload. */ data: { service_token: components["schemas"]["ServiceToken"]; /** @description The full secret token value. Returned only at creation time — store it now, it cannot be retrieved later. */ token: string; }; }; ServiceTokenListResponse: { /** @description Response payload. */ data: { /** @description Service tokens, newest first. */ service_tokens: components["schemas"]["ServiceToken"][]; }; }; ServiceTokenResponse: { /** @description Response payload. */ data: { service_token: components["schemas"]["ServiceToken"]; }; }; SessionMedia: { handle: string; name: string; key: string; url: string; mime_type: string; size_bytes: number; source_tool_call_id: string | null; created_at: string; }; SessionTranscript: { rows: components["schemas"]["SessionTranscriptRow"][]; /** @description Media referenced by user and assistant text, keyed by handle. */ media_refs: { [key: string]: components["schemas"]["SessionMedia"]; }; /** @description log_seq of the newest entry the rows were built from. */ last_seq: number | null; }; SessionTranscriptRow: { id: string; /** @enum {string} */ kind: "user"; timestamp: string; seqFrom?: number; seqTo?: number; data: { text: string; createdBy?: string | null; rpcCommandId?: string; }; } | { id: string; /** @enum {string} */ kind: "assistant"; timestamp: string; seqFrom?: number; seqTo?: number; data: { text: string; }; } | { id: string; /** @enum {string} */ kind: "thought"; timestamp: string; seqFrom?: number; seqTo?: number; data: { texts: string[]; }; } | { id: string; /** @enum {string} */ kind: "tools"; timestamp: string; seqFrom?: number; seqTo?: number; data: { label: string; count: number; tools: { name: string; count: number; }[]; durationMs: number; failed: number; running: boolean; }; } | { id: string; /** @enum {string} */ kind: "tool"; timestamp: string; seqFrom?: number; seqTo?: number; data: { toolCallId: string; name: string; argsSummary: string; label: string; durationMs: number | null; changedLines?: { added: number; removed: number; }; commitHash?: string; background?: { jobId: string; end?: { jobId: string; exitCode: number | null; signal: string | null; timedOut: boolean; durationMs: number; }; }; failed: boolean; running: boolean; }; } | { id: string; /** @enum {string} */ kind: "message-session"; timestamp: string; seqFrom?: number; seqTo?: number; data: { toolCallId: string; sessionId: number; created: boolean; message: string | null; failed: boolean; }; } | { id: string; /** @enum {string} */ kind: "subagent"; timestamp: string; seqFrom?: number; seqTo?: number; data: { toolCallId: string; agent: string; /** @enum {string} */ mode: "sync" | "async"; /** @enum {string} */ part: "call" | "async-end"; /** @enum {string} */ state: "running" | "done" | "failed"; error?: string; }; } | { id: string; /** @enum {string} */ kind: "test-report"; timestamp: string; seqFrom?: number; seqTo?: number; data: { toolCallId: string; reportUrl: string; summaryUrl: string; }; } | { id: string; /** @enum {string} */ kind: "commit"; timestamp: string; seqFrom?: number; seqTo?: number; data: { toolCallId: string; sha: string; branch: string | null; }; } | { id: string; /** @enum {string} */ kind: "pr-event"; timestamp: string; seqFrom?: number; seqTo?: number; data: { /** @enum {string} */ event: "opened" | "merged" | "closed"; prNumber: number | null; actor: { userId: string; displayName: string | null; } | null; }; } | { id: string; /** @enum {string} */ kind: "session-closed"; timestamp: string; seqFrom?: number; seqTo?: number; data: { actor: { userId: string; displayName: string | null; } | null; }; } | { id: string; /** @enum {string} */ kind: "notification"; timestamp: string; seqFrom?: number; seqTo?: number; data: { notification: { /** @enum {string} */ kind: "alarm"; instruction: string; } | { /** @enum {string} */ kind: "event_subscription"; delivery: { instruction?: string; event: { id: string; type: string; entity_type: string; entity_id: string; occurred_at: string; payload: { [key: string]: unknown; }; }; }; } | { /** @enum {string} */ kind: "system_message"; delivery: { id: number; message: string; ack_instructions: string; }; }; rpcCommandId?: string; }; } | { id: string; /** @enum {string} */ kind: "compaction"; timestamp: string; seqFrom?: number; seqTo?: number; data: { tokensBefore: number; tokensAfter?: number; }; } | { id: string; /** @enum {string} */ kind: "job"; timestamp: string; seqFrom?: number; seqTo?: number; data: { jobId: string; command: string; exitCode: number | null; signal: string | null; timedOut: boolean; durationMs: number; }; } | { id: string; /** @enum {string} */ kind: "error"; timestamp: string; seqFrom?: number; seqTo?: number; data: { message: string; }; } | { id: string; /** @enum {string} */ kind: "stopped"; timestamp: string; seqFrom?: number; seqTo?: number; data: Record; }; SetProjectRunnerBackendBody: { /** @description An active backend of the project's organisation, or null for Empirical-hosted. */ runner_backend_id: number | null; }; SetupRunnerBackendBody: { /** @description 12-digit AWS account to install the runner in. */ aws_account_id: string; /** @description AWS region with a published template, e.g. `us-east-1`. */ region: string; }; SetupRunnerBackendResponse: { /** @description Response payload. */ data: { runner_backend: components["schemas"]["RunnerBackend"]; /** @description Response payload. */ registration: { /** @description Credential the installation's stack calls home with. Shown once; Empirical keeps only its hash. */ registration_token: string; /** @description ISO-8601 time the link stops working if unused. */ expires_at: string; /** @description Release of the template the link installs. */ stack_version: string; /** @description The template the link installs. */ template_url: string; /** @description AWS console link that opens CloudFormation with the template and Empirical's parameters filled in. */ quick_create_url: string; }; }; }; ShardManifestTests: { /** @description Shard index, or null for a non-sharded run. */ shard_index: number | null; /** @description Scheduled tests on this shard that have run. */ ran_count: number; /** @description Total tests scheduled on this shard. */ scheduled_count: number; /** @description Scheduled tests in order, each tagged ran/pending. */ tests: components["schemas"]["TestRunManifestTest"][]; }; ShardPlanResponse: { /** @description Response payload. */ data: { /** @description Rows inserted. Zero when the run was already planned — the first plan wins and a retried POST is a no-op. */ shards_written: number; /** @description Tests across the posted partition. */ total_tests: number; }; }; SimpleErrorResponse: { /** @description Error message. */ error: string; }; SkipTestRunRequest: { /** @description Full repository name in owner/repo format. */ repo: string; /** @description Full Git commit SHA. */ commit_sha: string; /** @description Environment slug. */ environment?: string; }; SkipTestRunResponse: { data: { /** @description ID of the GitHub check run created as skipped, or null if no GitHub reporter app is installed for the repo. */ check_run_id: number | null; /** @description The status of the test run. */ status: string; }; /** @description Always null for success responses. */ error: unknown; }; SlackAppInstall: { /** @description Slack app install ID. */ id: number; /** @description Organisation ID. */ org_id: number; /** @description Slack app ID. */ slack_app_id: string; /** @description Authorizing Slack user ID. */ authed_user_id: string; /** @description OAuth scopes (CSV). */ scope: string; /** @description OAuth token type. */ token_type: string; /** @description Bot user ID. */ bot_user_id: string; /** @description Slack workspace (team) ID. */ team_id: string; /** @description Slack workspace name. */ team_name: string; /** * Format: uri * @description Slack workspace URL learned from auth.test. */ team_url: string | null; /** @description ISO 8601 creation timestamp. */ created_at: string | null; }; SlackAppInstallListResponse: { /** @description The Slack app installs. */ data: components["schemas"]["SlackAppInstall"][]; /** @description Number of installs. */ count: number; }; SlackAppInstallMutationResponse: { /** @description Whether the write succeeded. */ success: boolean; /** @description The Slack app install. */ data: { /** @description Slack app install ID. */ id: number; /** @description Organisation ID. */ org_id: number; /** @description Slack app ID. */ slack_app_id: string; /** @description Authorizing Slack user ID. */ authed_user_id: string; /** @description OAuth scopes (CSV). */ scope: string; /** @description OAuth token type. */ token_type: string; /** @description Bot user ID. */ bot_user_id: string; /** @description Slack workspace (team) ID. */ team_id: string; /** @description Slack workspace name. */ team_name: string; /** * Format: uri * @description Slack workspace URL learned from auth.test. */ team_url: string | null; /** @description ISO 8601 creation timestamp. */ created_at: string | null; }; }; SlackAppInstallResponse: { /** @description Response payload. */ data: { /** @description Slack app install ID. */ id: number; /** @description Organisation ID. */ org_id: number; /** @description Slack app ID. */ slack_app_id: string; /** @description Authorizing Slack user ID. */ authed_user_id: string; /** @description OAuth scopes (CSV). */ scope: string; /** @description OAuth token type. */ token_type: string; /** @description Bot user ID. */ bot_user_id: string; /** @description Slack workspace (team) ID. */ team_id: string; /** @description Slack workspace name. */ team_name: string; /** * Format: uri * @description Slack workspace URL learned from auth.test. */ team_url: string | null; /** @description ISO 8601 creation timestamp. */ created_at: string | null; }; }; SlackAppInstallUpsertResponse: { /** @description Whether the write succeeded. */ success: boolean; /** @description The Slack app install; null when the install was into Empirical's own workspace, which is not stored per org. */ data: { /** @description Slack app install ID. */ id: number; /** @description Organisation ID. */ org_id: number; /** @description Slack app ID. */ slack_app_id: string; /** @description Authorizing Slack user ID. */ authed_user_id: string; /** @description OAuth scopes (CSV). */ scope: string; /** @description OAuth token type. */ token_type: string; /** @description Bot user ID. */ bot_user_id: string; /** @description Slack workspace (team) ID. */ team_id: string; /** @description Slack workspace name. */ team_name: string; /** * Format: uri * @description Slack workspace URL learned from auth.test. */ team_url: string | null; /** @description ISO 8601 creation timestamp. */ created_at: string | null; } | null; /** @description True when nothing was stored (Empirical's workspace). */ skipped?: boolean; }; SlackAuthTestResponse: { /** @description Always true on success. */ success: boolean; /** @description Raw Slack auth.test result. */ data?: unknown; }; SlackChannelListV2Response: { data: { channels: components["schemas"]["SlackChannelV2"][]; }; }; SlackChannelRefreshV2Response: { data: { channel: components["schemas"]["ValidatedSlackChannelV2"]; /** @description Whether the stored channel name was replaced with Slack's current name. */ renamed: boolean; /** @description Channel name stored before the refresh. */ previous_channel_name: string | null; }; }; SlackChannelV2: { /** @description Canonical Slack channel ID. */ id: number; /** @description Organization scope ID. */ org_id: number; /** @description Slack app installation ID, or null for the shared default installation. */ slack_app_install_id: number | null; /** * @description Credential source used to access the Slack workspace. * @enum {string} */ installation_source: "default" | "org"; /** @description Slack workspace (team) ID. */ team_id: string; /** @description Slack channel ID. */ channel_id: string; /** @description Last known Slack channel name. */ channel_name: string | null; /** @description ISO 8601 archival timestamp. */ archived_at: string | null; /** @description ISO 8601 creation timestamp. */ created_at: string; /** @description ISO 8601 update timestamp. */ updated_at: string; }; SlackChannelValidationListV2Response: { data: { channels: components["schemas"]["ValidatedSlackChannelV2"][]; }; }; SlackFileDownloadError: { /** @description Error message. */ error: string; /** @description Content type returned by Slack, if any. */ content_type?: string | null; /** @description HTTP status returned by Slack, if any. */ upstream_status?: number; }; SlackFileMetadata: { /** @description Slack file ID. */ id: string; /** @description File name. */ name: string; /** @description MIME type, if known. */ mime_type: string | null; /** @description File size in bytes, if known. */ size_bytes: number | null; /** @description Relative path to download the file content. */ download_path: string; }; SlackFileMetadataResponse: { /** @description Response payload. */ data: { file: components["schemas"]["SlackFileMetadata"]; }; }; SlackLinkListResponse: { /** @description Response payload. */ data: components["schemas"]["SlackUserLink"][]; }; SlackMessageEditResult: { /** @enum {boolean} */ ok: true; /** @description Slack channel ID. */ channel: string; /** @description Timestamp id of the message. */ ts: string; }; SlackMessageError: { /** @description Error message. */ error: string; }; SlackMessageResult: { /** @enum {boolean} */ ok: true; /** @description Resolved DM channel, returned for recipient-addressed sends. */ channel?: string; /** @description Root timestamp for future replies; ts is the posted message timestamp. */ thread_ts?: string; /** @description Registered physical Slack root ID. */ slack_thread_id?: number; /** @description Timestamp id of the message that was posted. */ ts: string; }; SlackProxyError: { /** @description Error message. */ error: string; }; SlackReactionError: { /** @description Error message. */ error: string; }; SlackReactionResult: { /** @enum {boolean} */ ok: true; /** @description Emoji name applied or removed. */ reaction: string; /** @enum {string} */ action: "add" | "remove"; }; SlackRunStartThreadReplacedError: { /** @description Error message. */ error: string; /** * @description Machine-readable reason for the rejection. * @enum {string} */ code: "run_start_thread_replaced"; /** @description Test run whose run-start notification was replaced. */ test_run_id: string; /** @description The run's current notification thread in the same channel, or null while the final notification is still being posted. */ replacement: { /** @description Slack channel ID. */ channel: string; /** @description Root timestamp to reply to instead. */ thread_ts: string; /** @description Registered physical Slack root ID. */ slack_thread_id: number; } | null; }; SlackScopeRefreshResponse: { /** @description Whether the refresh succeeded. */ success: boolean; /** @description Granted OAuth scopes (CSV). */ scope: string; }; SlackTeam: { /** @description Slack workspace (team) ID. */ team_id: string; /** @description Slack workspace name. */ team_name: string | null; /** @description Whether this is the shared default Empirical workspace. */ is_default: boolean; /** @description Slack app install row ID, if org-specific. */ install_id: number | null; }; SlackTeamListResponse: { /** @description Response payload. */ data: { teams: components["schemas"]["SlackTeam"][]; }; }; SlackThread: { /** @description Registry thread ID. */ id: number; /** @description Slack workspace (team) ID. */ team_id: string; /** @description Slack channel ID. */ channel_id: string; /** @description Known Slack channel name. */ channel_name: string | null; /** @description Known Slack channel type. */ channel_type: string | null; /** @description Slack user ID for a DM thread, when known. */ recipient_user_id: string | null; /** @description Slack root message timestamp. */ thread_ts: string; /** * Format: uri * @description Direct URL to the Slack root message, using the authenticated viewer's workspace when known and the app installation otherwise. */ permalink: string | null; /** * @description Registry thread kind. * @enum {string} */ kind: "run_notification" | "discussion"; /** * @description Actor category that registered the record. * @enum {string} */ created_by: "system" | "agent" | "user"; /** @description ISO 8601 time of the latest known activity. */ last_activity_at: string; /** @description ISO 8601 deletion time, or null when live. */ deleted_at: string | null; /** @description ISO 8601 creation time. */ created_at: string; /** @description ISO 8601 update time. */ updated_at: string; /** @description Live domain entities associated with this thread. */ entity_links: components["schemas"]["SlackThreadEntityLink"][]; }; SlackThreadEntityLink: { /** @description Registry entity-link ID. */ id: number; /** * @description Domain entity type. * @enum {string} */ entity_type: "test_run" | "failure_group" | "pull_request" | "discussion"; /** @description Linked entity ID. */ entity_id: string; /** @description Whether this is the preferred thread for the entity in this channel. */ is_canonical: boolean; /** * @description Actor category that registered the record. * @enum {string} */ created_by: "system" | "agent" | "user"; /** @description ISO 8601 creation time. */ created_at: string; /** @description ISO 8601 update time. */ updated_at: string; }; SlackThreadEntityLinkResponse: { data: components["schemas"]["SlackThreadEntityLink"]; }; SlackThreadListResponse: { /** @description Registered Slack threads for this page. */ data: { /** @description The page of registered Slack threads. */ threads: components["schemas"]["SlackThread"][]; }; pagination: components["schemas"]["Pagination"]; }; SlackThreadPreviewMessage: { /** @description Slack message timestamp. */ ts: string; /** @description Plain Slack message text. */ text: string; /** @description Author name when Slack includes one. */ author_name: string | null; /** @description Whether an app posted this message. */ is_bot: boolean; /** @description Emoji reactions on this Slack message. */ reactions: { /** @description Slack emoji name. */ name: string; /** @description Number of reactions with this emoji. */ count: number; }[]; }; SlackThreadPreviewResponse: { /** @description Compact Slack thread preview. */ data: { /** @description The root message followed by the first replies. */ messages: components["schemas"]["SlackThreadPreviewMessage"][]; /** @description Total replies reported by Slack. */ reply_count: number; /** @description Replies not included in this compact preview. */ omitted_count: number; }; }; SlackUserLink: { /** @description Link ID. */ id: number; /** @description Whether the link is currently valid. */ is_link_valid: boolean | null; /** @description ISO 8601 timestamp the link was last validated. */ last_validated_at: string | null; /** @description Supabase user ID. */ user_id: string; /** @description Slack workspace whose app installation reaches the user. */ team_id: string; /** @description Slack user's home workspace ID. */ slack_home_team_id: string | null; /** * Format: uri * @description Slack user's home workspace URL. */ slack_home_team_url: string | null; /** @description Slack user ID. */ slack_user_id: string; /** @description Slack username. */ slack_user_name: string | null; /** @description Slack avatar image URL. */ slack_image_url: string | null; /** @description Slack real name. */ slack_user_real_name: string | null; /** @description Slack display name. */ slack_user_display_name: string | null; /** @description Whether the Slack user is a workspace admin. */ slack_is_admin: string | null; /** @description Whether the Slack user is a bot. */ slack_is_bot: string | null; /** @description Slack DM channel ID for the user. */ slack_dm_channel_id: string | null; /** @description ISO 8601 timestamp the DM channel was resolved. */ slack_dm_channel_updated_at: string | null; /** @description Slack app ID the link belongs to (provenance only). */ app_id: string | null; /** @description How the link was created. */ source: string; /** @description ISO 8601 timestamp the link was created. */ created_at: string; /** @description ISO 8601 timestamp the link was last updated. */ updated_at: string; }; Snooze: { /** @description Unique identifier for the snooze. */ id: number; /** @description Array of Playwright test IDs (41-character hashes) that are snoozed. */ test_ids: string[]; /** @description ISO 8601 timestamp for when the snooze expires. Active when in the future. */ snooze_until: string; /** @description Description of why the tests are snoozed. */ description: string | null; /** @description ID of the test run that triggered the snooze creation, if applicable. */ created_from_test_run_id: number | null; /** @description User ID of the creator. Set automatically for dashboard users; `null` for API-created snoozes. */ created_by: string | null; /** @description ISO 8601 timestamp of when the snooze was created. */ created_at: string; /** @description ISO 8601 timestamp of when the snooze was last updated. */ updated_at: string; /** @description Environment ID this snooze is scoped to. `null` if it applies to all environments. */ scoped_to_environment_id: number | null; }; SnoozeListResponse: { /** @description The page of snoozes. */ data: { snoozes: components["schemas"]["Snooze"][]; }; pagination: components["schemas"]["Pagination"]; }; SnoozeResponse: { /** @description Response payload. */ data: { snooze: components["schemas"]["Snooze"]; }; }; SpotInterruptionRequest: { /** @description The stopped ECS task's `startedBy` tag (`emp///`). */ started_by: string; /** * @description AWS region the task-state-change event came from. * @enum {string} */ region: "us-east-1" | "ap-south-1"; /** @description ECS task id of the interrupted task, for the audit trail. */ task_id?: string; /** @description ECS `stoppedReason`, for the audit trail. */ stopped_reason?: string; }; SpotInterruptionResponse: { /** @description Response payload. */ data: { /** * @description Whether the shard was re-dispatched, or the event needed no action. * @enum {string} */ action: "reenqueued" | "skipped"; /** @description Why the event was skipped; absent on re-enqueue. */ reason?: string; }; }; StartRepoTransferBadRequest: components["schemas"]["RepoTransferCodedError"] | components["schemas"]["ErrorResponse"]; StartRepoTransferRequest: { /** @description GitHub org/owner to transfer the repo to. */ target_repo_owner: string; /** @description Repository name at the target owner. */ target_repo_name: string; }; StaticIpsResponse: { /** @description Response payload. */ data: { /** @description AWS region of the proxy fleet. */ region: string; /** @description Human-readable location. */ location: string; /** @description Proxy endpoint to point Playwright's proxy config at. */ endpoint: string; /** @description Egress IPs to allowlist. One per proxy instance. */ ips: string[]; }; }; StopTaskRequest: { /** @description Zero-based shard index, when stopping a sharded run. */ shard_index?: number; /** * @description Job type of the shard to stop. merge_reports and run_setup share shard_index 0. When omitted, the job is resolved from the run's shard rows; an index that carries more than one stoppable job is a 400. `run_setup` is never stoppable and is always rejected. * @enum {string} */ job_type?: "run_test" | "merge_reports" | "run_setup"; }; StopTaskResponse: { /** @description Response payload. */ data: { /** @description Whether the SIGTERM was sent to the task. */ success: boolean; }; }; SubscribeChatSessionResponse: { data: { already_waiting: boolean; subscription_id?: number; }; }; SubscriptionCheckoutResponse: { /** @description Response payload. */ data: { /** @description Dodo hosted checkout to open. It returns to the billing page. */ checkout_url: string; }; }; SubscriptionEndResponse: { /** @description Response payload. */ data: { /** * @description What the subscription became in Dodo: `cancelled` when there was no usage beyond the plan's allowance; `paused` when there was, which Dodo charges on pausing (the subscription is cancelled once that charge succeeds). Either way the plan has ended. * @enum {string} */ status: "cancelled" | "paused"; /** @description Whether Dodo charges a final payment for this cycle's usage beyond the allowance. */ final_charge: boolean; }; }; SubscriptionOfferResponse: { /** @description Response payload. */ data: { /** @description Whether the org can subscribe through Dodo now. */ available: boolean; /** * @description Why not, when `available` is false. * @enum {string|null} */ reason: "not_configured" | "no_org" | "inr" | "has_plan" | "no_plan" | null; /** @description The plan checkout would subscribe to, when available. */ plan: { /** @description Plan name, as shown to customers. */ name: string; /** @description Currency of the prices below, e.g. `usd`. */ currency: string; /** @description Monthly base price in cents of `currency`. */ base_price_cents: number; /** @description Metered allowances and overage rates. */ meters: { /** @description Meter key, e.g. `ai_credits` or `test_minutes`. */ meter: string; /** @description Units included each month. */ included_qty: number | null; /** @description Price per unit above the allowance, in cents of `currency`; may be fractional. */ overage_price_cents: number | null; }[]; } | null; }; }; SubscriptionPortalResponse: { /** @description Response payload. */ data: { /** @description Short-lived Dodo customer portal session: update the card, download invoices. */ portal_url: string; }; }; SubscriptionUsageReconcileResponse: { /** @description Response payload. */ data: { subscription_id: string; cycle_start: string; cycle_end: string; meters: { ai_credits: { /** @description Our usage in the cycle. */ ours: number; /** @description What Dodo's events in the cycle add up to. */ dodo: number; our_events: number; dodo_events: number; }; test_minutes: { /** @description Our usage in the cycle. */ ours: number; /** @description What Dodo's events in the cycle add up to. */ dodo: number; our_events: number; dodo_events: number; }; }; /** @description Event ids of our usage rows that Dodo has no event for. */ missing: string[]; /** @description Dodo event ids in the cycle with no usage row of ours. */ extra: string[]; /** @description Events whose quantity differs from our usage row's (Dodo keeps the first quantity sent). */ changed: { event_id: string; ours: number; dodo: number; }[]; }; }; SystemMessage: { id: number; body: string; created_by: string | null; created_at: string; }; SystemMessageDetailResponse: { data: { system_message: components["schemas"]["SystemMessage"]; recipients: components["schemas"]["SystemMessageRecipient"][]; }; }; SystemMessageListResponse: { data: { system_messages: components["schemas"]["SystemMessageSummary"][]; }; }; SystemMessageRecipient: { project_id: number; chat_session_id: number | null; /** @enum {string} */ delivery_status: "pending" | "delivered" | "failed"; delivery_error: string | null; delivered_at: string | null; /** @enum {string|null} */ ack_status: "accepted" | "declined" | null; ack_note: string | null; acked_at: string | null; acked_by_chat_session_id: number | null; session_is_closed: boolean | null; }; SystemMessageSummary: { id: number; body: string; created_by: string | null; created_at: string; recipients: number; delivered: number; failed: number; acked: number; }; Task: { /** @description Unique identifier for the task. */ id: number; /** @description Project the task belongs to. */ project_id: number; /** @description Task title. */ title: string; /** @description Task description (Markdown). */ description: string; status: components["schemas"]["TaskStatus"]; /** @description Where the task came from, e.g. `linear`, `jira`, `slack` or `dashboard`. */ source: string; /** @description Identifier of the task in its source system. */ source_identifier: string; /** @description User ID of the person the task is owed to. `null` only on tasks created before this was required. */ created_by: string | null; /** @description ISO 8601 timestamp of when the task was created. */ created_at: string; /** @description ISO 8601 timestamp of when the task was last updated. */ updated_at: string; }; TaskChatSession: { /** @description Chat session ID. */ id: number; /** @description Session title, if generated. */ title: string | null; /** @description Supabase user ID of the creator. */ created_by: string | null; /** @description ISO 8601 creation timestamp. */ created_at: string; /** @description ISO 8601 last-update timestamp. */ updated_at: string; /** @description Project ID. */ project_id: number; /** @description Session mode (e.g. `chat`). */ mode: string; /** @description Model used for the session. */ model: string | null; /** @description Tests impacted by the session. */ impacted_tests: unknown[]; /** @description Whether the agent is awaiting user input. */ ask_user_for_input: boolean | null; /** @description Langfuse trace ID for observability. */ langfuse_trace_id: string | null; /** @description Whether the session is closed. */ is_closed: boolean; /** @description Feature flags active for this session. */ feature_flags: string[]; /** @description Outboxed first message awaiting delivery. */ pending_first_message?: unknown; }; TaskChatSessionWithUser: { /** @description Chat session ID. */ id: number; /** @description Session title, if generated. */ title: string | null; /** @description Supabase user ID of the creator. */ created_by: string | null; /** @description ISO 8601 creation timestamp. */ created_at: string; /** @description ISO 8601 last-update timestamp. */ updated_at: string; /** @description Project ID. */ project_id: number; /** @description Session mode (e.g. `chat`). */ mode: string; /** @description Model used for the session. */ model: string | null; /** @description Tests impacted by the session. */ impacted_tests: unknown[]; /** @description Whether the agent is awaiting user input. */ ask_user_for_input: boolean | null; /** @description Langfuse trace ID for observability. */ langfuse_trace_id: string | null; /** @description Whether the session is closed. */ is_closed: boolean; /** @description Feature flags active for this session. */ feature_flags: string[]; /** @description Outboxed first message awaiting delivery. */ pending_first_message?: unknown; /** @description Resolved details for the creating user, if available. */ created_by_user_detail?: { /** @description User ID. */ id: string; /** @description User email address. */ email: string; /** @description User display name. */ name: string; /** @description URL to user avatar image. */ picture: string; } | null; }; TaskChatSessionsResponse: { /** @description Null when no sessions exist. */ data: unknown; /** @description Explanatory message when empty. */ message: string; } | { /** @description Chat sessions for the task. */ data: components["schemas"]["TaskChatSessionWithUser"][]; }; TaskListResponse: { /** @description The page of tasks. */ data: { tasks: components["schemas"]["TaskWithCreator"][]; }; pagination: components["schemas"]["Pagination"]; }; TaskResponse: { /** @description Response payload. */ data: { task: components["schemas"]["TaskWithCreator"]; }; }; TaskSessionResponse: { /** @description Response payload. */ data: { chat_session: components["schemas"]["TaskChatSession"]; }; }; /** * @description Moving a `draft` task to `open` starts an agent session. `closed` and `resolved` are terminal. * @enum {string} */ TaskStatus: "draft" | "open" | "in-review" | "closed" | "resolved"; TaskWithCreator: { /** @description Unique identifier for the task. */ id: number; /** @description Project the task belongs to. */ project_id: number; /** @description Task title. */ title: string; /** @description Task description (Markdown). */ description: string; status: components["schemas"]["TaskStatus"]; /** @description Where the task came from, e.g. `linear`, `jira`, `slack` or `dashboard`. */ source: string; /** @description Identifier of the task in its source system. */ source_identifier: string; /** @description User ID of the person the task is owed to. `null` only on tasks created before this was required. */ created_by: string | null; /** @description ISO 8601 timestamp of when the task was created. */ created_at: string; /** @description ISO 8601 timestamp of when the task was last updated. */ updated_at: string; /** @description Details of the creating user, when known. */ created_by_user_detail?: { /** @description User ID. */ id: string; /** @description User email address. */ email: string; /** @description User display name. */ name: string; /** @description URL to user avatar image. */ picture: string; } | null; }; TelemetryProjectRef: { /** @description Project ID. */ id: number; /** @description Project name. */ name: string | null; /** @description Repository name backing the project. */ repo_name: string | null; }; TelemetryTrackRequest: { /** * @description Event name. Only test-run events are accepted. * @enum {string} */ name: "git.clone_build" | "llm_response_generated" | "overlay.dismissed" | "test_worker.interrupted" | "test_worker.segment.report_download" | "test_worker.segment.report_merge_and_upload" | "test_worker.segment.report_upload" | "test_worker.segment.tests_execute"; /** @description Event properties, forwarded as-is. */ properties: { [key: string]: unknown; }; /** * Format: date-time * @description When the event happened (ISO 8601). Default now. */ timestamp?: string; }; TelemetryTrackResponse: { /** @description Response payload. */ data: { /** @enum {boolean} */ ok: true; }; }; TestCase: { /** @description Playwright test ID (pw_test_id), a 41-character hash that uniquely identifies the test. */ id: string; /** @description Test case name. */ name: string; /** @description File path of the test case. */ file_path: string; /** @description Array of suite names the test belongs to. */ suites: string[]; /** @description Playwright project name. */ playwright_project: string; /** @description Array of tags assigned to the test case. */ tags: string[]; /** @description ISO 8601 timestamp. */ created_at: string; /** @description ISO 8601 timestamp. */ updated_at: string; /** @description Commit SHA where this test case was first seen. Null if not available. */ first_seen_commit_sha: string | null; /** @description Commit SHA where this test case was last seen. Null if not available. */ last_seen_commit_sha: string | null; dependencies: components["schemas"]["TestCaseV2Dependencies"]; }; TestCaseHistoryBatchRequest: { /** @description Test case IDs to fetch history for (non-empty). */ test_case_ids: string[]; /** @description Project ID (ignored; the project comes from auth scope). */ project_id?: number; /** @description Number of days of history (1-90, default 30). Ignored when `start_date` and `end_date` are set. */ days?: number; /** @description Start of a custom date range (ISO 8601). */ start_date?: string; /** @description End of a custom date range (ISO 8601). */ end_date?: string; /** @description Filter by environment ID. */ environment_id?: string; /** @description Maximum history entries returned per test case (1-1000, default 50). */ limit_per_test_case?: number; /** @description When true, also return the most recent passing run per environment for each requested test case. */ include_last_pass_per_env?: boolean; } & { [key: string]: unknown; }; TestCaseHistoryBatchResponse: { /** @description Response payload. */ data: { /** @description Map of `test_case_id` to its history entries (most recent first). */ history_by_test_case_id: { [key: string]: components["schemas"]["TestCaseHistoryEntry"][]; }; /** @description Map of `test_case_id` to its most recent passing run in each environment. Present when requested. */ last_pass_by_test_case_id?: { [key: string]: { environment_id: string; test_run_id: string; executed_at: number; }[]; }; }; /** @description Echoed query parameters and truncation metadata. */ meta: { /** @description Project ID the history was scoped to. */ project_id: string; /** @description Resolved look-back window in days, or null. */ days: number | null; /** @description Resolved custom range start, or null. */ start_date: string | null; /** @description Resolved custom range end, or null. */ end_date: string | null; /** @description Resolved environment filter, or null. */ environment_id: string | null; /** @description Resolved per-test-case history limit. */ limit_per_test_case: number; /** @description Test case IDs whose history hit the limit and may be truncated. */ truncated_test_case_ids: string[]; }; }; TestCaseHistoryEntry: { /** @description ISO 8601 timestamp of the history entry. */ timestamp: string; /** @description Test status for this entry: `pass`, `fail`, `flaky`, or `skip`. */ status: string; /** @description ID of the test run this entry belongs to. */ test_run_id: string; /** @description ID of the environment the test ran in. */ environment_id: string; /** @description ISO 8601 timestamp of when the test executed. */ executed_at: string; /** @description Total duration in milliseconds. */ duration_total: number; /** @description Number of retries for this test execution. */ retries: number; }; TestCaseHistoryUnknownFieldsError: { /** @description Human-readable error message. */ error: string; /** @description Field names that are not allowed. */ unknown_fields: string[]; /** @description Field names that are allowed. */ allowed_fields: string[]; }; /** @description Pagination metadata. */ TestCaseListPagination: { /** @description Current page (1-indexed). */ page: number; /** @description Items per page. */ per_page: number; /** @description Total number of items. */ total: number; /** @description Total number of pages. */ total_pages: number; /** @description Whether more pages exist beyond the current one. */ has_more: boolean; }; TestCaseListResponse: { /** @description Test cases plus the project's sync status. */ data: { /** @description The page of test cases. */ test_cases: components["schemas"]["TestCase"][]; /** @description Details of the project's last test-cases sync error, or null when the last sync succeeded. */ sync_error: { /** @description The error reported by the last test-cases sync. */ message: string; /** @description ISO 8601 timestamp of the sync error, or null. */ occurred_at: string | null; } | null; }; pagination: components["schemas"]["TestCaseListPagination"]; }; TestCasePlaywrightProjectsResponse: { /** @description Distinct Playwright projects across the project's synced test cases. */ playwright_projects: string[]; }; TestCaseRunBeginEvent: { runId: string; test: components["schemas"]["TestCaseRunEndPayloadTest"]; suites: string[]; result: { retry: number; startTime: string; }; projectName: string; shardIndex?: number; }; TestCaseRunBeginEventRequest: { /** * @description Event name, always `test_case_run_begin`. * @enum {string} */ name: "test_case_run_begin"; data: components["schemas"]["TestCaseRunBeginEvent"]; }; TestCaseRunEndAttachment: { name: string; path: string; contentType: string; url: string; }; TestCaseRunEndEventRequest: { /** * @description Event name, e.g. `test_case_run_end`. * @enum {string} */ name?: "test_case_run_end"; data: components["schemas"]["TestCaseRunEndEventV2"]; }; TestCaseRunEndEventV2: { runId: string; test: components["schemas"]["TestCaseRunEndPayloadTest"]; suites: string[]; result: components["schemas"]["TestCaseRunEndPayloadResult"]; projectName: string; attachments: components["schemas"]["TestCaseRunEndAttachment"][]; failingLine?: string; shardIndex?: number; maxFailures?: number; }; TestCaseRunEndPayloadAnnotation: { type: string; description?: string; }; TestCaseRunEndPayloadError: { message?: string; stack?: string; location?: components["schemas"]["TestCaseRunEndPayloadLocation"]; }; TestCaseRunEndPayloadLocation: { file: string; line: number; column: number; }; TestCaseRunEndPayloadResult: { retry: number; status: components["schemas"]["TestCaseRunEndPayloadStatus"]; duration: number; startTime: string; error?: components["schemas"]["TestCaseRunEndPayloadError"]; errors?: components["schemas"]["TestCaseRunEndPayloadError"][]; annotations?: components["schemas"]["TestCaseRunEndPayloadAnnotation"][]; }; /** @enum {string} */ TestCaseRunEndPayloadStatus: "passed" | "failed" | "timedOut" | "skipped" | "interrupted"; TestCaseRunEndPayloadTest: { id: string; title: string; location: components["schemas"]["TestCaseRunEndPayloadLocation"]; expectedStatus: components["schemas"]["TestCaseRunEndPayloadStatus"]; retries: number; }; TestCaseTagsResponse: { /** @description Distinct tags across the project's test cases. */ tags: string[]; }; TestCaseTagsUpdateResponse: { /** @description The updated test case. */ data: { test_case: components["schemas"]["TestCase"]; /** @description Whether the source file was updated with the new tags. */ source_file_updated: boolean; }; /** @description Present alongside a non-null `data` only when the update partially failed (e.g. the source file could not be updated). */ error?: { /** @description Error message describing why the update partially failed. */ message: string; }; }; /** @description Dependency-group metadata for a test case (e.g. Playwright serial groups). Empty object when the test has no dependencies. */ TestCaseV2Dependencies: { /** @description Serial-execution dependency group this test belongs to, if any. */ playwright_serial?: { /** @description ID of the serial dependency group. */ group_id: string; /** @description Full title path of the test within the group. */ title_path: string[]; /** @description File path of the test within the group. */ file_path: string; /** @description Playwright project of the group. */ playwright_project: string; /** @description Position of this test in the serial order. */ dependency_order: number; /** @description Number of tests in the serial group. */ group_size: number; /** @description Test IDs this test depends on running first. */ depends_on: string[]; }; }; TestCasesSyncTriggeredResponse: { /** @description Response payload. */ data: { /** @description Whether the sync job was enqueued. */ triggered: boolean; /** @description Commit SHA the sync was enqueued for. */ commit_sha: string; }; }; TestCountByDayEntry: { /** @description Date in YYYY-MM-DD format. */ date: string; /** @description Number of distinct test cases that ran on this date (skipped tests excluded). */ test_count: number; }; TestCountSummary: { /** @description Test count on the most recent day in the window. */ latest_count: number; /** @description Test count on the first day in the window. */ first_count: number; /** @description Absolute change between `first_count` and `latest_count`. */ change: number; /** @description Percentage change (0-100) between first and latest day. */ change_percent: number; }; TestRunBranchListResponse: { /** @description Response payload. */ data: { /** @description Branch names with recent test runs. */ branches: string[]; }; }; TestRunCase: { /** @description Playwright test ID; the case's URL id. Null for a ledger row that never matched a scheduled entry. */ pw_test_id: string | null; /** @description Shard index (1+) for a sharded run; null for a non-sharded run. */ shard_index: number | null; /** @description ID of the parent test run. */ test_run_id: string; /** * @description Outcome of the case. Provisional while `is_retrying` is true. * @enum {string} */ status: "passed" | "failed" | "flaky" | "skipped"; /** @description True when the case has retries outstanding: `status`, `retries` and `retry_details` reflect only the attempts so far. Only returned with `include_retrying=true`. */ is_retrying: boolean; /** @description Run-time path `[file, ...suites, title]`. */ nesting: string[]; /** @description Playwright project the case ran under. */ test_project: string | null; /** @description Number of retries; null when not recorded. */ retries: number | null; /** @description Total duration in milliseconds. */ total_duration: number | null; /** @description Expected (7-day average) duration in ms. */ expected_duration_ms: number | null; /** @description Raw Playwright retry details; null if absent. */ retry_details: { /** @description Per-attempt retry details. */ retries: components["schemas"]["TestRunCaseRetryDetail"][]; } | null; /** @description Failing source line derived from retry details. */ failing_line: string | null; /** @description ISO 8601 test completion time from the run ledger. */ created_at: string | null; /** @description SHA of the last commit before the run started. */ last_commit_before_run_started_at: string | null; /** @description Snoozes matching this case at read time. */ snooze_info: components["schemas"]["TestRunCaseSnoozeInfo"][]; /** @description Attempts that never ran because an earlier member of this case's Playwright serial group failed on the same attempt. Null when the case is not in a snapshotted group or when nothing was blocked. */ skipped_attempts: components["schemas"]["TestRunCaseSkippedAttempt"][] | null; }; TestRunCaseRetryDetail: { /** @description Zero-based retry attempt index. */ retryIndex: number; /** * @description Outcome of this attempt. * @enum {string} */ status: "passed" | "failed" | "timedOut" | "skipped" | "interrupted"; /** @description Status Playwright expected for the test. */ expectedStatus: string; /** @description Attempt duration in milliseconds. */ duration: number; /** @description ISO 8601 start time of the attempt. */ startTime: string; /** @description Error detail when the attempt failed. */ error?: { /** @description Error message. */ message: string; /** @description Error stack trace. */ stack: string; /** @description Source location of the failure. */ location?: { /** @description Source file. */ file: string; /** @description Line number. */ line: number; /** @description Column number. */ column: number; }; }; /** @description Attachments captured for the attempt. */ attachments?: { /** @description Attachment name. */ name: string; /** @description Attachment storage path. */ path: string; /** @description Attachment MIME type. */ contentType: string; /** @description Attachment URL. */ url: string; }[]; /** @description Source line that failed, if known. */ failingLine?: string; /** @description Playwright annotations for the attempt (static + runtime). Absent on rows recorded before annotations were captured. */ annotations?: { /** @description Annotation type. */ type: string; /** @description Annotation description, if any. */ description?: string; }[]; }; TestRunCaseSkippedAttempt: { /** @description Attempt index this explains. */ retry_index: number; /** @description The serial-group member that blocked this attempt. */ blocked_by: { /** @description Playwright test id of the blocking test. */ pw_test_id: string | null; /** @description Title of the blocking test. */ name: string; /** @description The blocking test's outcome on this attempt. */ status: string; }; }; TestRunCaseSnoozeInfo: { /** @description ID of the matching snooze. */ snooze_id: number; /** @description Snooze description. */ description: string | null; /** @description User ID that created the snooze. */ created_by: string | null; /** @description Avatar URL of the snooze creator. */ created_by_picture: string | null; /** @description ISO 8601 expiry of the snooze. */ snooze_until: string | null; /** @description ISO 8601 creation time of the snooze. */ created_at: string | null; /** * @description Why this snooze matched the case. * @enum {string} */ match_reason: "window" | "originating_run"; /** @description Environment the snooze is scoped to, if any. */ scoped_to_environment_id: number | null; }; TestRunChatSession: { /** @description Chat session ID. */ id: number; /** @description Session title. */ title: string | null; /** @description Creator user ID. */ created_by: string | null; /** @description Creation timestamp (ISO). */ created_at: string; /** @description Last update timestamp (ISO). */ updated_at: string; /** @description Owning project ID. */ project_id: number; /** @description Hive agent ref the session runs (`` or `@`). The legacy values `chat` and `triage` mean the default agent, `main`. */ mode: string; /** * @description Workload class, assigned server-side; null for an ordinary user chat. Read-only — no request body accepts it. * @enum {string|null} */ purpose?: "triage" | "manager" | null; /** @description Requested model. */ model: string | null; /** @description Whether the agent is awaiting user input. */ ask_user_for_input: boolean | null; /** @description Langfuse trace ID. */ langfuse_trace_id: string | null; /** @description Whether the session is closed. */ is_closed: boolean; /** @description For a manager closed by rollover, the manager session that took over. */ superseded_by_session_id: number | null; /** @description The session this one was spawned from: the agent session that delegated it, or the manager it took over from. */ parent_chat_session_id?: number | null; /** * @description How this session came from its parent. * @enum {string|null} */ parent_relationship?: "delegation" | "manager_handoff" | null; /** @description Feature flags enabled for the session. */ feature_flags: string[]; /** @description Resolved Supabase details for the creator. */ created_by_user_detail?: { /** @description Supabase user ID. */ id: string; /** @description User email. */ email: string; /** @description Display name. */ name: string; /** @description Avatar URL. */ picture: string; } | null; /** @description Number of the session's most recently updated PR, if any. */ pr_number: number | null; /** * @description Status of the session's most recently updated PR ('unopened' when it has none). * @enum {string} */ pr_status: "unopened" | "open" | "opened" | "closed" | "merged"; /** @description Name of the owning project. */ project_name: string | null; /** @description Repository name of the owning project. */ project_repo_name: string | null; /** @description Repository owner of the owning project. */ project_repo_owner: string | null; /** @description Tests in this run the session is scoped to; empty when the session is about the whole run (triage). */ linked_pw_test_ids: string[]; }; TestRunDetail: { /** @description Unique identifier. */ id: number; /** * @description Current state of the test run. * @enum {string} */ state: "pending" | "queued" | "started" | "ended" | "error" | "cancelled" | "cancelling"; /** @description Total number of test cases. */ total_count: number; /** @description Number of passed tests. */ success_count: number; /** @description Number of failed tests. */ failed_count: number; /** @description Number of skipped tests. */ skipped_count: number | null; /** @description Number of flaky tests. */ flaky_count: number | null; /** @description Duration in milliseconds. */ duration: number | null; /** @description Git branch being tested. */ test_run_branch: string | null; /** @description Environment identifier. */ environment_slug: string | null; /** @description Environment display name. */ environment_name: string | null; /** @description URL of the deployment tested, i.e. the run's resolved `BUILD_URL` environment variable. */ build_url: string | null; /** @description Git branch of the build. */ build_branch: string | null; /** @description Commit SHA. */ commit: string | null; /** @description ISO 8601 timestamp. */ created_at: string; /** @description Concurrency group and policy the run was created with, or null when no limit applied. */ concurrency: { /** @description Concurrency group the run was scoped to. Runs in the same group are limited to one in progress at a time. */ group: string; /** * @description What this run did when the group already had an active run: `cancel` cancelled it, `wait` queued behind it. * @enum {string} */ on_conflict: "cancel" | "wait"; } | null; /** @description Git commit SHA. */ test_run_head_sha: string | null; /** @description ISO 8601 timestamp when tests started. */ run_started_at: string | null; /** @description ISO 8601 timestamp when tests ended. */ run_ended_at: string | null; /** @description URL to download the Playwright JSON report for this run. */ summary_url: string | null; /** @description Branch-resolution provenance. Null only for historical runs created before provenance was recorded. */ test_code: { requested: { branch: string; /** @enum {string} */ source: "explicit" | "build" | "project_default" | "legacy"; /** @enum {string} */ if_missing: "error" | "use_default" | "create"; }; resolved: { branch: string | null; sha: string | null; /** @enum {string|null} */ fallback_reason: "requested_branch_missing" | null; }; execution: { ref: string | null; sha: string | null; /** @enum {string|null} */ ref_kind: "branch" | "temporary_merge" | null; }; merge_base: { branch: string; sha: string | null; } | null; /** @enum {string} */ resolution_status: "pending" | "resolved" | "branch_missing" | "merge_conflict" | "provider_error"; resolution_error_code: string | null; } | null; /** @description The `trigger` the run was created with, or null when none was sent. */ trigger: { /** * @description Event that produced the run. * @enum {string} */ event: "pull_request"; /** @description Pull request under test. */ pull_request: { /** @description Pull request number in the application repository. */ number?: number; /** @description Head branch. */ head: string; /** @description Base branch. */ base: string; }; } | null; }; TestRunEnvironmentVariable: { /** @description Variable ID (0 for run-level overrides). */ id: number; /** @description Owning project ID. */ project_id: number; /** @description Variable name. */ name: string; /** @description Variable description. */ description: string; /** @description Variable value. */ value: string; /** @description ISO 8601 timestamp the variable was created. */ created_at: string; /** @description ISO 8601 timestamp the variable was last updated. */ updated_at: string; /** @description User ID who last updated the variable. */ updated_by: string | null; /** @description Whether the variable applies to all environments. */ all_environments: boolean; /** @description Environment IDs the variable is scoped to. */ environment_ids: number[]; }; TestRunEnvironmentVariablesResponse: { /** @description Response payload. */ data: { /** @description Resolved environment variables for the run. */ environment_variables: components["schemas"]["TestRunEnvironmentVariable"][]; }; }; TestRunHistoryChartItem: { /** @description Test run ID. */ id: number; /** @description Run state. */ state: string | null; /** @description ISO 8601 creation timestamp. */ created_at: string | null; /** @description Total number of tests. */ total_count: number | null; /** @description Number of passed tests. */ success_count: number | null; /** @description Number of failed tests. */ failed_count: number | null; /** @description Failed tests remaining after snoozes applied. */ failed_count_after_snoozing: number | null; /** @description Number of flaky tests. */ flaky_count: number | null; /** @description Environment ID the run executed against. */ environment_id: number | null; /** @description Environment name. */ environment_name: string | null; /** @description Environment slug. */ environment_slug: string | null; /** @description Error code when the run failed. */ error_code: string | null; /** @description ID of the run this run is a rerun of, if any. */ rerun_source_id: number | null; }; TestRunHistoryChartResponse: { /** @description Response payload. */ data: { /** @description Test runs ordered newest first. */ items: components["schemas"]["TestRunHistoryChartItem"][]; }; }; TestRunItem: { /** @description Unique identifier. */ id: number; /** * @description Current state of the test run. * @enum {string} */ state: "pending" | "queued" | "started" | "ended" | "error" | "cancelled" | "cancelling"; /** @description Total number of test cases. */ total_count: number; /** @description Number of passed tests. */ success_count: number; /** @description Number of failed tests. */ failed_count: number; /** @description Number of skipped tests. */ skipped_count: number | null; /** @description Number of flaky tests. */ flaky_count: number | null; /** @description Duration in milliseconds. */ duration: number | null; /** @description Git branch being tested. */ test_run_branch: string | null; /** @description Environment identifier. */ environment_slug: string | null; /** @description Environment display name. */ environment_name: string | null; /** @description URL of the deployment tested, i.e. the run's resolved `BUILD_URL` environment variable. */ build_url: string | null; /** @description Git branch of the build. */ build_branch: string | null; /** @description Commit SHA. */ commit: string | null; /** @description ISO 8601 timestamp. */ created_at: string; /** @description Concurrency group and policy the run was created with, or null when no limit applied. */ concurrency: { /** @description Concurrency group the run was scoped to. Runs in the same group are limited to one in progress at a time. */ group: string; /** * @description What this run did when the group already had an active run: `cancel` cancelled it, `wait` queued behind it. * @enum {string} */ on_conflict: "cancel" | "wait"; } | null; }; TestRunLinkedChangesResponse: { /** @description Response payload. */ data: { /** @description Null when the run was not triggered by an app PR. */ linked_changes: { /** @description The app repository (owner/name) of the PR. */ app_repo: string; app_pull_request: { number: number | null; head: string; base: string | null; }; /** @description The test repository. */ test_repo: string; /** @description Test branch linked to the app PR by name. */ test_branch: string; default_branch: string; /** @enum {string} */ state: "no_test_branch" | "nothing_to_merge" | "ahead_no_pr" | "pr_open" | "pr_open_not_mergeable" | "error"; /** @enum {string} */ status: "in_progress" | "completed"; /** @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | null; title: string; ahead_by: number; /** @description Open test PR from the test branch, if any. */ test_pull_request: { number: number; url: string; mergeable: boolean | null; } | null; /** @description Merged test PR, when the branch was deleted after merge. */ merged_test_pull_request: { number: number; url: string; } | null; /** @description Latest GitHub check written for the app PR, from any of its runs. */ check: { check_run_url: string | null; head_sha: string; test_run_id: number; state: string | null; last_error: string | null; updated_at: string; } | null; } | null; }; }; TestRunLogEvent: { /** @description Event timestamp in epoch milliseconds. */ timestamp: number; /** @description Log line text. */ message: string; }; TestRunLogsResponse: { /** @description Response payload. */ data: { /** @description Log events for the task. */ events: components["schemas"]["TestRunLogEvent"][]; /** @description Token to fetch the next (forward) page. */ nextForwardToken?: string; /** @description Token to fetch the previous (backward) page. */ nextBackwardToken?: string; }; }; TestRunManifestCountsResponse: { /** @description Response payload. */ data: { /** @description Scheduled test count (interrupted-shard adjusted). */ total_tests: number; /** @description Per-shard scheduled count, or null when the run is unsharded. */ shards: { [key: string]: number; } | null; }; }; TestRunManifestTest: { /** @description Full test line, e.g. `[chromium] › a.spec.ts › title`. */ name: string; /** * @description Whether the scheduled test has run yet. `retrying` means at least one attempt is in but retries are outstanding; its result fields are provisional until it flips to `ran`. `interrupted` means the shard was interrupted before the test finished and a resume shard (`superseded_by_shard`) re-scheduled it; that shard's row holds the result. * @enum {string} */ status: "ran" | "retrying" | "pending" | "interrupted"; /** @description Ledger row ID. */ id?: number; /** @description Shard the row belongs to, or null when unsharded. */ shard_index?: number | null; /** @description Normalized match key for the test. */ match_key?: string; /** @description Playwright `test.id`, if known. */ pw_test_id?: string | null; /** @description Pass/fail verdict for a completed test. */ result_status?: ("passed" | "failed" | "flaky" | "skipped") | null; /** @description Number of retries recorded. */ retries?: number | null; /** @description Total run duration in milliseconds. */ total_duration?: number | null; /** @description Stored Playwright-shaped retry details. */ retry_details?: { /** @description Per-retry attempt details. */ retries: components["schemas"]["RetryDetail"][]; } | null; /** @description Run-time path `[file, ...suites, title]`. */ nesting?: string[] | null; /** @description 7-day average duration (ms) snapshotted at landing. */ expected_duration_ms?: number | null; /** @description Unix ms the latest attempt started. A pending or retrying test with a `started_at` is in flight. */ started_at?: number | null; /** @description Resume shard that re-scheduled this test, when `status` is `interrupted`. */ superseded_by_shard?: number | null; }; TestRunManifestTestsResponse: { /** @description Response payload. */ data: { /** @description Per-shard manifest breakdown. */ tests: components["schemas"]["ShardManifestTests"][]; }; }; TestRunRow: { /** @description Database primary key. */ id: number; /** @description Current run state. */ state: string | null; /** @description Owning project ID. */ project_id: number; /** @description Feature flags applied to the run. */ feature_flags: string[]; /** @description Associated build ID, if any. */ build_id: number | null; /** @description Environment the run executed against. */ environment_id: number | null; /** @description Per-run environment variable overrides. */ environment_variables_overrides: { name: string; value: string; }[] | null; /** @description Arbitrary run metadata. */ metadata: { [key: string]: string; } | null; /** @description GitHub username that triggered the run. */ github_actor: string | null; /** @description User ID that created the run. */ created_by: string | null; /** @description User agent that created the run. */ created_by_user_agent: string | null; /** @description External run identifier. */ run_id: number | null; /** @description ECS task ID executing the run. */ ecs_task_id: string | null; /** @description AWS region of the ECS task. */ ecs_task_region: string | null; /** @description Total number of tests. */ total_count: number | null; /** @description Number of unique tests. */ unique_count: number | null; /** @description Number of passed tests. */ success_count: number | null; /** @description Number of failed tests. */ failed_count: number | null; /** @description Failed tests remaining after snoozes applied. */ failed_count_after_snoozing: number | null; /** @description Number of skipped tests. */ skipped_count: number | null; /** @description Number of flaky tests. */ flaky_count: number | null; /** @description URL of the report summary. */ summary_url: string | null; /** @description Run duration in milliseconds. */ duration: number | null; /** @description ISO 8601 creation timestamp. */ created_at: string | null; /** @description ISO 8601 timestamp when the run ended. */ run_ended_at: string | null; /** @description ISO 8601 timestamp when the run started. */ run_started_at: string | null; /** @description Branch the run executed against. */ test_run_branch: string; /** @description Head commit SHA the run executed against. */ test_run_head_sha: string | null; /** @description Head branch of the merge commit, if merged. */ merge_commit_head_branch: string | null; /** @description Base branch of the merge commit, if merged. */ merge_commit_base_branch: string | null; /** @description Whether the merge commit succeeded. */ merge_commit_successful: boolean | null; /** @description Error code when the run failed. */ error_code: string | null; /** @description Reason the run was cancelled, if any. */ cancellation_reason: string | null; /** @description User ID that cancelled the run, if any. */ cancelled_by_user_id: string | null; /** @description ID of the run that superseded this one, if any. */ superseded_by_test_run_id: number | null; /** @description ID of the run this run is a rerun of, if any. */ rerun_source_id: number | null; /** @description Whether the rerun re-ran only failed tests. */ rerun_only_failed: boolean | null; /** @description Tags applied to the run. */ tags: string[] | null; /** @description Tags whose tests the run skips. */ exclude_tags: string[] | null; /** @description Storage bucket holding the run's artifacts. */ storage_bucket: string | null; }; TestRunShard: { /** @description Shard row ID. */ id: number; /** @description Parent test run ID. */ test_run_id: number; /** * @description Whether the shard runs tests, merges reports, or runs setup once. * @enum {string} */ job_type: "run_test" | "merge_reports" | "run_setup"; /** @description Total number of shards in the run. */ total_shards: number; /** @description This shard's index. */ shard_index: number; /** @description ECS task ID running this shard, if dispatched. */ ecs_task_id: string | null; /** @description AWS region of the ECS task, if dispatched. */ ecs_task_region: string | null; /** @description Shard state (queued, started, ended, error, ...). */ state: string | null; /** @description Error code if the shard failed. */ error_code: string | null; /** @description ISO 8601 timestamp the shard row was created. */ created_at: string; /** @description ISO 8601 timestamp the shard started running. */ started_at: string | null; /** @description ISO 8601 timestamp the shard finished. */ ended_at: string | null; /** @description Shard index this shard resumes from, if a resume. */ resume_from: number | null; }; TestRunShardAssignedTestsResponse: { data: { /** @description Playwright test-case ids this shard is assigned to execute. */ test_case_ids: string[]; /** @description Shard count the plan was built for. */ total_shards: number; }; }; TestRunShardResumeResponse: { /** @description Response payload. */ data: { /** @description Shard index this shard resumes from, if any. */ resume_from: number | null; }; }; TestRunShardState: { /** @description Internal test run ID (primary key). */ testRunId: number; /** @description Zero-based index of the shard. */ shardIndex: number; /** @description Current state of the shard. */ state: string | null; }; TestRunShardsResponse: { /** @description Response payload. */ data: { /** @description Shards for the run, ordered by shard index. */ shards: components["schemas"]["TestRunShard"][]; }; }; TestRunStatusResponse: { /** @description Response payload. */ data: { /** @description Whether the run is in a terminal state. */ isTerminal: boolean; /** * @description Current run state (e.g. queued, started, ended). * @enum {string|null} */ status: "pending" | "queued" | "cancelling" | "cancelled" | "ended" | "started" | "error" | "interrupted" | null; /** @description Arbitrary run metadata key/value pairs. */ metadata: { [key: string]: string; } | null; /** @description ID of the run this run is a rerun of, if any. */ rerun_source_id: number | null; /** @description Whether the rerun re-ran only failed tests. */ rerun_only_failed: boolean | null; /** @description Feature flags active for this run. */ feature_flags: string[]; /** @description Tags applied to the run. */ tags: string[]; /** @description Tags whose tests the run skips. */ exclude_tags: string[]; /** @description Specific test case ids to run. */ test_case_ids: string[]; }; }; TestRunSummaryDetail: { /** @description Diagnosis row ID. */ id: number; /** @description ISO 8601 creation timestamp. */ created_at: string; /** @description Playwright test ID. */ pw_test_id: string | null; /** @description Test run ID. */ test_run_id: string; /** @description Test case status. */ status: string; /** @description Playwright project the test ran under. */ test_project: string | null; /** @description Last commit SHA before the run started. */ last_commit_before_run_started_at: string | null; /** @description Source line that triggered the failure. */ failing_line: string | null; /** @description Run-time test path `[file, ...suites, title]`. */ nesting: string[]; /** @description Per-retry details for the failed test. */ retry_details: { retries: components["schemas"]["RetryDetail"][]; } | null; /** @description Snoozes that apply to this test in this run. */ snooze_info: components["schemas"]["TestRunSummaryDetailSnooze"][]; }; TestRunSummaryDetailResponse: { /** @description Response payload. */ data: components["schemas"]["TestRunSummaryDetail"][]; }; TestRunSummaryDetailSnooze: { /** @description Snooze ID. */ snooze_id: number; /** @description Snooze description. */ description: string | null; /** @description User ID that created the snooze. */ created_by: string | null; /** @description Avatar URL of the snooze creator. */ created_by_picture: string | null; /** @description ISO 8601 timestamp the snooze is active until. */ snooze_until: string | null; /** @description ISO 8601 timestamp the snooze was created. */ created_at: string | null; /** * @description Why the snooze applies: `window` (active window overlapped the run) or `originating_run` (created from this run). * @enum {string} */ match_reason: "window" | "originating_run"; /** @description Environment the snooze is scoped to; null applies to all environments. */ scoped_to_environment_id: number | null; }; TestRunTestCaseDurationsResponse: { data: { /** @description Length of the analytics window the averages cover. */ days: number; /** @description Per-test-case history, keyed by the normalized 41-char Playwright test id. */ durations: { [key: string]: { /** @description Mean total duration over the window, skipped results excluded, in ms. */ avg_duration_total: number; /** @description Mean total duration over the last day, in ms; null without recent results. */ recent_avg_duration_total?: number | null; /** @description Results the average was taken over. */ total_runs: number; }; }; }; }; TestRunTriageSessionResponse: { /** @description Response payload. */ data: { chat_session: components["schemas"]["ChatSession"]; }; }; TestRunsListResponse: { data: { /** @description The project the runs belong to. */ project: { /** @description Project ID. */ id: number; /** @description Project name. */ name: string; /** @description Project slug. */ slug: string; /** @description Repository name for the project. */ repo_name: string; }; /** @description Paginated test runs. */ test_runs: { /** @description The page of test runs. */ items: components["schemas"]["TestRunItem"][]; }; }; pagination: components["schemas"]["Pagination"]; }; TriageStatus: { id: string; project_id: number; test_run_id: number; pw_test_id: string; /** @enum {string} */ status: "working" | "completed"; group_id: string | null; group: components["schemas"]["TriageStatusGroup"]; chat_session_id: number | null; created_at: string; updated_at: string; }; TriageStatusGroup: { id: string; label: string; /** @enum {string} */ type: "app" | "test" | "unknown"; /** @enum {string} */ status: "open" | "resolved"; diagnosis: string | null; recommendation: string | null; } | null; TriageStatusListResponse: { /** @description Response payload. */ data: { triage_statuses: components["schemas"]["TriageStatus"][]; }; }; TriageStatusResponse: { /** @description Response payload. */ data: { triage_status: components["schemas"]["TriageStatus"]; }; }; TriggerMergeResponse: { /** @description Response payload. */ data: { /** @description Database ID of the test run. */ testRunId: number; /** @description Whether the merge-reports job was dispatched. */ mergeTriggered: boolean; /** @description Total number of run_test shards. */ totalShards: number; /** @description Whether any shard reported errors. */ hasErrors: boolean; }; }; TriggerTestRunRequest: { /** @description Slug of a saved environment to run with (e.g., `production`, `staging`). Optional: without it the run uses only the project's variables and the config sent on this request. */ environment?: string; /** @description Build information to associate with the test run. */ build?: { /** @description Git branch name of the build. */ branch?: string; /** @description Git commit SHA of the build. */ commit?: string; /** @description Source repository in owner/name format (e.g., acme/web). */ repo?: string; /** @description Legacy commit URL accepted only to infer build.repo for older callers. */ commit_url?: string; /** @description Legacy build URL forwarded as BUILD_URL for allowlisted projects. */ url?: string; }; /** @description Custom key-value pairs to associate with the test run. Values must be strings or numbers. */ metadata?: { [key: string]: string | number; }; /** @description Environment variables to override for this test run. */ environment_variables_overrides?: { /** @description Name of the environment variable. */ name: string; /** @description Value of the environment variable. */ value: string; }[]; /** @description Tags to filter which tests to run (e.g., `@smoke`, `@critical`). Only tests matching these tags will be executed. */ tags?: string[]; /** @description Tags whose tests are skipped (e.g., `@slow`). Applied after every other selection, so it can only remove tests: with `tags` it runs tests matching `tags` but not `exclude_tags`; alone it runs every test except the excluded ones. */ exclude_tags?: string[]; /** @description Specific test case ids (Playwright per-project `test.id`) to run. Only these tests will be executed. */ test_case_ids?: string[]; /** @description Existing test-repository branch to run. A missing explicit branch creates an errored run; Empirical never creates it. May be supplied alongside `build`, which describes the application code under test. */ branch?: string; /** @description The application pull request under test, for pre-merge runs. The run uses the test-repository branch named `pull_request.head`, merged into the project default branch. If no such branch exists, it uses the default branch. An explicit `branch` takes precedence. */ trigger?: { /** * @description Event that produced the run. * @enum {string} */ event: "pull_request"; /** @description Pull request under test. */ pull_request: { /** @description Pull request number in the application repository. */ number?: number; /** @description Head branch. */ head: string; /** @description Base branch. */ base: string; }; }; /** @description Concurrency group and policy for this run. Runs in the same group (within the project) are limited to one in progress; `on_conflict` says what this run does when the group already has an active run: `cancel` cancels it and starts now, `wait` queues behind it (a newer waiting run replaces an older one). Omit to use the project's legacy concurrency setting; `null` for no limit. */ concurrency?: { /** @description Free-form group key, scoped to the project, e.g. `production`, `staging/acme/web@feat-x`, or a build URL. */ group: string; /** * @description `cancel`: cancel the group's in-progress and waiting runs, then start. `wait`: queue behind the in-progress run; a newer waiting run replaces this one. * @enum {string} */ on_conflict: "cancel" | "wait"; } | null; /** @description Reporters for this run, saved on the run when it is created; at most one entry per `reporter_type`. Omit to use the environment's `reporter_config` (a run without an environment then gets none). A list replaces those defaults: reporters not listed do not fire, and `[]` turns them all off. Without `reporters`, a run started by a person (dashboard, CLI or agent session) also gets `slack_creator_dm`; a list sends the DM only if it names `slack_creator_dm`. Invalid entries (unknown Slack channels, duplicate types) reject the request without creating a run. */ reporters?: ({ /** * @description Posts run status updates to Slack channels. * @enum {string} */ reporter_type: "slack_run_status"; /** @description Slack channel ids (`C…`), as shown in Slack's channel details. Shared (Slack Connect) channels have the same id in every workspace. Each must be a registered, unarchived channel of the project's organization. */ slack_channels?: string[]; /** @description Registered Slack channel ids from `GET /api/v2/slack/channels` (the numeric `id`). Can be combined with `slack_channels`. */ slack_channel_ids?: number[]; } | { /** * @description Posts a GitHub check run on the build commit. Needs `build` with a repository the GitHub Reporter app is installed on. * @enum {string} */ reporter_type: "github_check"; } | { /** * @description Posts (and updates) a comment on the pull request for the build branch. Needs `build` with a repository the GitHub Reporter app is installed on. * @enum {string} */ reporter_type: "github_pr_comment"; } | { /** * @description Tracks the test branch named after the head branch of the app pull request the run was triggered for (`trigger.event` `pull_request`), and keeps the `Empirical linked test changes` check on that pull request up to date: it passes when the test branch has nothing left to merge and fails while it has unmerged commits. The pull request's latest run decides whether it is tracked. Does nothing for runs not triggered by a pull request. Needs `build` with a repository the GitHub Reporter app is installed on. * @enum {string} */ reporter_type: "github_linked_changes"; } | { /** * @description Emails a report when the run ends to every user whose email domain is one of the organization's email domains. * @enum {string} */ reporter_type: "email_run_report"; } | { /** * @description Sends a Slack DM to whoever started the run (from the dashboard, the CLI or an agent session) when it ends, if their Slack account is linked. Runs triggered with a project API key have no one to DM. * @enum {string} */ reporter_type: "slack_creator_dm"; })[]; /** @description Legacy project ID; must match the request's resolved project scope when set. The project scope itself comes from the bound principal or the x-project-id header, never from the body. */ project_id?: number; /** @description Override the number of shards to split the run across. */ total_shards?: number; /** @description ID of the test run this run is a rerun of. */ rerun_source_id?: number; /** @description When rerunning, only re-execute the previously failed tests. */ rerun_only_failed?: boolean; /** @description GitHub username that triggered the run, for attribution. */ github_actor?: string; }; TruncatedProjectApiKey: { /** @description API key ID. */ id: number; /** @description Project the key belongs to. */ project_id: number | null; /** @description Human-readable name for the key. */ name: string; /** @description User ID of the creator, if known. */ created_by: string | null; /** @description ISO 8601 creation timestamp. */ created_at: string | null; /** @description ISO 8601 timestamp the key was last updated. */ updated_at: string | null; /** @description User ID of the last updater, if known. */ updated_by: string | null; /** @description ISO 8601 timestamp the key was last used. */ last_used_at: string | null; /** @description Whether the key is disabled. */ is_disabled: boolean | null; /** @description Whether the key is an internal service key. */ is_internal: boolean | null; /** @description Resolved details for the creating user, if available. */ created_by_user_detail: { /** @description User ID. */ id: string; /** @description User email. */ email: string; /** @description User display name. */ name: string; /** @description User avatar URL. */ picture: string; } | null; /** @description Resolved details for the last updating user, if available. */ updated_by_user_detail: { /** @description User ID. */ id: string; /** @description User email. */ email: string; /** @description User display name. */ name: string; /** @description User avatar URL. */ picture: string; } | null; /** @description Truncated preview of the API key. */ api_key_truncated: string; }; TwoCaptchaProxyRequest: { /** * @description 2Captcha endpoint to call. * @enum {string} */ endpoint: "/createTask" | "/getTaskResult"; /** @description Request payload forwarded to 2Captcha. The configured `clientKey` is injected server-side. */ body?: { [key: string]: unknown; }; }; TwoCaptchaProxyResponse: unknown; UiGetTestRunResponse: { /** @description Response payload. */ data: { /** @description Everything the run detail page renders. */ test_run: { project: components["schemas"]["UiTestRunProject"]; testRun: components["schemas"]["EnrichedTestRun"]; /** @description Test cases referenced by the ledger first page's pw_test_ids, so the run detail page renders without a follow-up lookup. */ test_cases: components["schemas"]["TestCase"][]; /** @description Resolved details for the user that cancelled the run. */ cancelled_by_user: { /** @description Supabase user ID. */ id: string; /** @description User email address. */ email: string; /** @description User display name. */ name: string; /** @description User avatar URL. */ picture: string; } | null; /** @description The agent chat session that triggered this run, if it was triggered from a sandbox (agent) session. Lets the UI render "via agent" and deep-link the session. Null for direct user, scheduler, GitHub Actions, and raw-API triggers. The run's created_by (when set) is the session's owner. */ triggered_via_chat_session: { id: number; title: string | null; } | null; /** @description The customer-hosted runner (Private Runner) the run was dispatched to. Null for runs on Empirical's hosted runners. */ runner_backend: { id: number; name: string; aws_account_id: string; region: string; } | null; /** @description For a pending run held back by its concurrency group (on_conflict=wait), the in-progress run it is waiting on. Null when the run is not pending or nothing blocks it. */ waiting_on_test_run_id: number | null; /** @description First page of ledger-sourced cases, ordered failed → flaky → others so the default 'failed' filter and the failure-first list render correctly on first paint. Shipped inline so the list renders without waiting on a fetch. The client refetches the full set. */ ledger_cases: components["schemas"]["TestRunCase"][]; /** @description Total ledger case count for the run, so the client knows how much the inline first page is truncating. */ ledger_cases_total: number; }; }; }; UiLiveTestRunResponse: { /** @description Response payload. */ data: { test_run: components["schemas"]["LiveTestRun"]; }; }; /** @description Project the run belongs to. The full project row is returned; the documented fields are the ones the dashboard relies on. */ UiTestRunProject: { /** @description Project ID. */ id: number; /** @description Owning organisation ID. */ org_id: number | null; /** @description Project slug. */ slug: string; /** @description Project name. */ name: string; /** @description Repository name backing the project. */ repo_name: string; }; UpcomingInvoiceReminder: { /** @description Invoice ID. */ invoice_id: number; /** @description Human-readable invoice number. */ invoice_number: string; /** @description Billed organisation ID. */ org_id: number; /** @description Billed organisation name. */ org_name: string; /** @description Billing recipients for the reminder. */ billing_emails: string[]; /** @description Invoice amount in minor currency units. */ amount_in_cents: number; /** @description Invoice currency. */ currency: string; /** @description Invoice due date. */ due_date: string | null; /** * @description Reminder email type. * @enum {string} */ reminder_type: "first" | "second"; /** @description Date this reminder would be sent. */ scheduled_send_date: string; /** @description Calendar days since the due date. */ days_past_due: number | null; /** @description First reminder timestamp, if already sent. */ first_reminder_sent_at: string | null; /** @description Second reminder timestamp, if already sent. */ second_reminder_sent_at: string | null; }; UpcomingInvoiceRemindersResponse: { data: { /** @description Upcoming invoice reminder candidates. */ reminders: components["schemas"]["UpcomingInvoiceReminder"][]; }; pagination: components["schemas"]["Pagination"]; }; UpdateApiKeyRequest: { /** * @description Whether to enable or disable the API key. * @enum {string} */ action: "enable" | "disable"; }; UpdateEcsTaskIdRequest: { /** @description ECS task id assigned to the run/shard. */ ecs_task_id: string; /** @description AWS region the ECS task runs in. */ region?: string; /** @description Zero-based shard index, when the run is sharded. */ shard_index?: number; /** @description Total number of shards, when the run is sharded. */ total_shards?: number; /** * @description Which job the task is running. * @enum {string} */ job_type?: "run_test" | "merge_reports" | "run_setup"; }; UpdateEcsTaskResponse: { /** @description Response payload. */ data: { /** @description Whether the ECS task id was recorded. */ updated: boolean; }; }; UpdateEnvironmentRequest: { /** @description Display name. */ name?: string; /** @description URL-friendly identifier. */ slug?: string; /** @description Whether the environment is disabled. */ is_disabled?: boolean; /** @description Playwright project names to include. Items must not start with '!'. */ playwright_projects_match?: string[]; /** @description Playwright project names to exclude. */ playwright_projects_ignore?: string[]; /** @description Cron expression for scheduled triggers, or null. */ scheduled_trigger?: string | null; /** @description Concurrency group and policy scheduled runs are triggered with. Omit to keep the current value; null to fall back to the project's legacy concurrency setting. */ scheduled_concurrency?: { /** @description Free-form group key, scoped to the project. */ group: string; /** * @description `cancel` cancels the group's active run and starts; `wait` queues behind it. * @enum {string} */ on_conflict: "cancel" | "wait"; } | null; /** @description Reporter configuration for the environment. Slack channels (`slack_channels` or `slack_channel_ids`) must be active registered channels of the project's organization (GET /api/v2/slack/channels); they are stored as registered ids. */ reporter_config?: { /** * @description Reporter config schema version. Always `1`. * @enum {number} */ schema_version: 1; /** @description Reporters, at most one per `reporter_type`. Replaces the stored list on write; an empty array disables them. */ reporters: ({ /** * @description Posts run status updates to Slack channels. * @enum {string} */ reporter_type: "slack_run_status"; /** @description Slack channel ids (`C…`), as shown in Slack's channel details. Shared (Slack Connect) channels have the same id in every workspace. Each must be a registered, unarchived channel of the project's organization. */ slack_channels?: string[]; /** @description Registered Slack channel ids from `GET /api/v2/slack/channels` (the numeric `id`). Can be combined with `slack_channels`. */ slack_channel_ids?: number[]; } | { /** * @description Posts a GitHub check run on the build commit. Needs `build` with a repository the GitHub Reporter app is installed on. * @enum {string} */ reporter_type: "github_check"; } | { /** * @description Posts (and updates) a comment on the pull request for the build branch. Needs `build` with a repository the GitHub Reporter app is installed on. * @enum {string} */ reporter_type: "github_pr_comment"; } | { /** * @description Tracks the test branch named after the head branch of the app pull request the run was triggered for (`trigger.event` `pull_request`), and keeps the `Empirical linked test changes` check on that pull request up to date: it passes when the test branch has nothing left to merge and fails while it has unmerged commits. The pull request's latest run decides whether it is tracked. Does nothing for runs not triggered by a pull request. Needs `build` with a repository the GitHub Reporter app is installed on. * @enum {string} */ reporter_type: "github_linked_changes"; } | { /** * @description Emails a report when the run ends to every user whose email domain is one of the organization's email domains. * @enum {string} */ reporter_type: "email_run_report"; })[]; }; }; UpdateFileRequest: { /** * @description Confirms the upload to `upload_url` finished. Fails if the file content is not in storage. * @enum {string} */ status: "uploaded"; }; UpdateJiraProjectMappingsRequest: { /** @description Map of Jira project key to Empirical project ID. */ project_mappings: { [key: string]: number; }; }; UpdateJiraWebhookExpiresAtRequest: { /** * Format: date-time * @description New webhook expiry timestamp, or `null` to clear it. */ webhook_expires_at: string | null; }; UpdateMemoryRequest: { /** @description Memory content (markdown). */ content?: string; /** @description Content format version. */ format_version?: number; /** @description Display name (v2). */ name?: string | null; /** @description Short description (v2). */ description?: string | null; /** @description Why this change was made (max 500 characters). Shown in the session's memory change report. */ reason?: string | null; }; UpdateOrderFormRequest: { org_id?: number; /** @enum {string} */ pricing_model?: "slab" | "fixed"; form_date?: string | null; subscription_start_date?: string | null; term_months?: number | null; end_date?: string | null; status?: string; /** Format: date-time */ signed_at?: string | null; contract_currency?: string; pdf_r2_key?: string | null; lines?: { /** @enum {string} */ kind?: "tier" | "addon"; tier?: string | null; label?: string | null; base_price_cents: number; meters?: { /** @enum {string} */ meter: "test_suite_size" | "ai_credits" | "test_minutes" | "test_run_duration"; included_qty?: number | null; overage_price_cents?: number | null; }[]; }[]; }; UpdatePlanAssignmentRequest: { /** @description Organisation this plan assignment belongs to. */ org_id?: number; /** @description Plan the organisation is on. */ plan_id?: number; /** * Format: date-time * @description When the assignment starts being effective (timestamptz). */ effective_from?: string | null; /** * Format: date-time * @description When the assignment stops being effective, or null for open-ended. */ effective_to?: string | null; /** * @description Origin of the assignment. * @enum {string} */ source?: "order_form" | "derived_from_invoice" | "manual"; }; UpdatePlanRequest: { /** @description Display name, as shown to customers. Renames the linked Dodo product too, so Dodo's checkout, portal and invoices match. */ name?: string; /** * @description `retired` hides the plan from new sales; existing assignments keep it. * @enum {string} */ status?: "active" | "retired"; /** @description `true` creates the plan's Dodo product now if it has none. `false` stops offering it at checkout; a linked Dodo product and existing subscriptions are left as they are. */ dodo_sync?: boolean; }; UpdateProjectResourceRequest: { /** @description New name for the file. */ name?: string; /** @description Description for the file. */ description?: string; /** * @description Set to `"uploaded"` to confirm a pending upload. * @enum {string} */ status?: "uploaded"; }; UpdateShardStateResponse: { /** @description Response payload. */ data: { shard: components["schemas"]["TestRunShardState"]; /** * @description Present and `true` when the worker should merge reports locally instead of dispatching a merge job. * @enum {boolean} */ shouldMergeLocally?: true; /** @description Payload for the local merge job, present only alongside `shouldMergeLocally`. */ mergeJobPayload?: { origin_url: string; git_repo_name: string; git_remote_url: string; git_branch: string; git_commit_sha: string; test_run_id: string; project_name: string; empiricalrun_api_key: string; /** @enum {string} */ region: "us-east-1" | "ap-south-1"; environment_slug?: string; shard_index?: number; total_shards: number; /** @enum {string} */ job_type: "merge_reports"; storage_bucket?: string; resume_run_from_shard?: number; teardown_shard_index?: number; } | null; }; }; UpdateSnoozeRequest: { /** @description ISO 8601 timestamp for when the snooze should expire. */ snooze_until?: string; /** @description Description, or `null` to clear it. */ description?: string | null; /** @description Set to `true` to immediately expire the snooze. */ expire_now?: boolean; /** @description Environment ID to scope the snooze to. Set to `null` to apply to all environments. */ scoped_to_environment_id?: number | null; /** @description Updated array of Playwright test IDs to snooze. */ test_ids?: string[]; }; UpdateTaskRequest: { /** @description New task title. */ title?: string; /** @description New task description (Markdown). */ description?: string; /** * @description New task status. Moving a `draft` task to `open` starts an agent session. * @enum {string} */ status?: "draft" | "open" | "in-review" | "closed" | "resolved"; }; UpdateTestCaseTagsRequest: { /** @description Array of tags to assign to the test case. */ tags: string[]; }; UpdateTestRunStateRequest: { /** @description Run identifier (`run_id`, not the DB primary key). */ testRunId: number; /** @description Deprecated and ignored: the run's own project is used. */ projectRepoName?: string; /** @description Deprecated and ignored: the run's own branch is used. */ testRunBranch?: string; /** @description Commit SHA the run checked out. Set by the worker when the run was dispatched without one. */ testRunHeadSha?: string; /** * @description New run state reported by the run worker. * @enum {string} */ state: "pending" | "queued" | "cancelling" | "cancelled" | "ended" | "started" | "error" | "interrupted"; /** @description Deprecated and ignored: the run's own environment is used. */ environment?: string; /** @description Error code when transitioning to an error state. */ errorCode?: string; }; UpdateTestRunStateResponse: { /** @description Response payload. */ data: { test_run: components["schemas"]["TestRunRow"]; }; }; UpdateWebhookRequest: { /** * Format: uri * @description New HTTPS endpoint for event payloads. */ url?: string; /** @description New set of event names to subscribe to. */ events?: string[]; /** @description Whether the webhook is active. */ is_active?: boolean; }; UpdatedTaskResponse: { /** @description Response payload. */ data: { task: components["schemas"]["Task"]; }; }; UpdatedWebhook: { /** @description Webhook ID. */ id: number; /** @description Project the webhook belongs to. */ project_id: number; /** @description Endpoint that receives event payloads. */ url: string; /** @description Event names this webhook subscribes to. */ events: string[]; /** @description Whether the webhook is active. */ is_active: boolean; /** @description ISO 8601 creation timestamp. */ created_at: string; /** @description ISO 8601 last-update timestamp. */ updated_at: string; /** @description Signing secret, if set. */ secret: string | null; }; UpsertSandboxSnapshotSourcesRequest: { /** @description Snapshot sources to upsert (at least one). */ sources: { /** @description Project the source belongs to, or null if generic. */ project_id: number | null; /** * @description Sandbox provider. * @enum {string} */ provider: "e2b" | "docker" | "vercel"; /** @description Snapshot source identifier (e.g. template ID). */ source_name: string; /** @description Playwright version the snapshot was built with. */ playwright_version: string; /** @description Base template the source was built from. */ base_template: string; /** @description Hash of the package lockfile, if known. */ package_lock_hash?: string | null; /** @description Base branch the snapshot was built from, if known. */ base_branch?: string | null; /** @description Head commit SHA the snapshot was built from. */ head_sha?: string | null; }[]; }; UpsertTriageStatusRequest: { /** @description The run in which this failure was observed. */ test_run_id: number; /** @description Playwright test id of the failing test. */ pw_test_id: string; /** * @description Set "working" when starting a deeper diagnosis, "completed" when done. * @enum {string} */ status: "working" | "completed"; /** @description The failure group this failure resolved to (the group carries the verdict and diagnosis). Omit to keep the stored value; null clears it. */ group_id?: string | null; }; UsageLimit: { /** @description Whether the org's plan supports a usage limit (catalog plans with overage pricing). */ available: boolean; /** @description Most overage allowed per usage period (calendar month, or Dodo billing cycle), in cents of the plan currency. Null means no limit. */ cap_cents: number | null; /** * @description `warning` once the bill (plan + overage) reaches 80% of plan + cap, skipped when that is at or below the plan price (including a $0 limit); `reached` when new work is paused. * @enum {string} */ status: "none" | "ok" | "warning" | "reached"; /** @description When the limit was reached this period (ISO 8601). */ reached_at: string | null; updated_at: string | null; /** @description Who made a change. */ updated_by: { /** @description user | agent | api_key | system */ kind: string; id: string | null; /** @description User name, when a user. */ name: string | null; } | null; }; UsageLimitEvent: { id: number; /** @description spend_cap.set | spend_cap.removed | spend_cap.alert_sent | spend_cap.reached | spend_cap.cleared */ action: string; /** @description Who made a change. */ actor: { /** @description user | agent | api_key | system */ kind: string; id: string | null; /** @description User name, when a user. */ name: string | null; }; before?: unknown; after?: unknown; metadata?: unknown; created_at: string; }; UsageLimitEventsResponse: { /** @description Response payload. */ data: components["schemas"]["UsageLimitEvent"][]; }; UsageLimitResponse: { /** @description Response payload. */ data: { /** @description Whether the org's plan supports a usage limit (catalog plans with overage pricing). */ available: boolean; /** @description Most overage allowed per usage period (calendar month, or Dodo billing cycle), in cents of the plan currency. Null means no limit. */ cap_cents: number | null; /** * @description `warning` once the bill (plan + overage) reaches 80% of plan + cap, skipped when that is at or below the plan price (including a $0 limit); `reached` when new work is paused. * @enum {string} */ status: "none" | "ok" | "warning" | "reached"; /** @description When the limit was reached this period (ISO 8601). */ reached_at: string | null; updated_at: string | null; /** @description Who made a change. */ updated_by: { /** @description user | agent | api_key | system */ kind: string; id: string | null; /** @description User name, when a user. */ name: string | null; } | null; }; }; UserDetailResponse: { /** @description Response payload. */ data: { /** @description Supabase user ID. */ id: string; /** @description User email. */ email: string; /** @description User display name. */ name: string; /** @description User avatar URL. */ picture: string; /** @description Accounts linked to this user. */ connected_accounts: { /** @description Valid linked Slack accounts. */ slack: components["schemas"]["ConnectedSlackAccount"][]; /** @description Valid linked GitHub accounts. */ github: components["schemas"]["ConnectedGithubAccount"][]; }; }; }; UserLinkDeleteResponse: { /** @description Response payload. */ data: { /** @description Always true on successful deletion. */ success: boolean; }; }; UserWithConnectedAccounts: { /** @description Supabase user ID. */ id: string; /** @description User email. */ email: string; /** @description User display name. */ name: string; /** @description User avatar URL. */ picture: string; /** @description Accounts linked to this user. */ connected_accounts: { /** @description Valid linked Slack accounts. */ slack: components["schemas"]["ConnectedSlackAccount"][]; /** @description Valid linked GitHub accounts. */ github: components["schemas"]["ConnectedGithubAccount"][]; }; }; UsersListResponse: { /** @description Response payload. */ data: components["schemas"]["UserWithConnectedAccounts"][]; }; ValidatedSlackChannelV2: { /** @description Canonical Slack channel ID. */ id: number; /** @description Organization scope ID. */ org_id: number; /** @description Slack app installation ID, or null for the shared default installation. */ slack_app_install_id: number | null; /** * @description Credential source used to access the Slack workspace. * @enum {string} */ installation_source: "default" | "org"; /** @description Slack workspace (team) ID. */ team_id: string; /** @description Slack channel ID. */ channel_id: string; /** @description Last known Slack channel name. */ channel_name: string | null; /** @description ISO 8601 archival timestamp. */ archived_at: string | null; /** @description ISO 8601 creation timestamp. */ created_at: string; /** @description ISO 8601 update timestamp. */ updated_at: string; /** @description Live Slack validation result. */ slack_channel_validation: { /** @description Whether the bot can read the channel and its stored name matches Slack. */ ok: boolean; /** @description Slack channel ID. */ channel_id: string; /** @description Whether the bot can read the channel through Slack. */ can_access: boolean; /** @description Whether the bot can read the channel. */ is_member?: boolean; /** @description Current channel name returned by Slack. */ current_channel_name?: string | null; /** @description Whether the stored channel name matches Slack's current name. */ channel_name_matches?: boolean; /** @description Machine-readable validation failure code. */ error_code?: string; /** @description Human-readable validation result. */ message?: string; }; }; VerifyInvoiceRazorpayPaymentRequest: { /** @description Order id returned by razorpay-order. */ razorpay_order_id: string; /** @description Payment id from the checkout success handler. */ razorpay_payment_id: string; /** @description Checkout signature: hex HMAC-SHA256 of `order_id|payment_id`. */ razorpay_signature: string; }; VerifyInvoiceRazorpayPaymentResponse: { /** @description Response payload. */ data: { /** @description Invoice paid status after settling. */ paid_status: string; /** @description Total settled amount in paise after this payment. */ paid_minor: number; }; }; Webhook: { /** @description Webhook ID. */ id: number; /** @description Project the webhook belongs to. */ project_id: number; /** @description Endpoint that receives event payloads. */ url: string; /** @description Event names this webhook subscribes to. */ events: string[]; /** @description Whether the webhook is active. */ is_active: boolean; /** @description ISO 8601 creation timestamp. */ created_at: string; /** @description ISO 8601 last-update timestamp. */ updated_at: string; }; WebhookCreateResponse: { /** @description Response payload. */ data: { webhook: components["schemas"]["CreatedWebhook"]; }; }; WebhookDeleteResponse: { /** @description Response payload. */ data: { /** * @description Always true on success. * @enum {boolean} */ success: true; }; }; WebhookListResponse: { /** @description Response payload. */ data: { webhooks: components["schemas"]["Webhook"][]; }; }; WebhookTestResponse: { /** @description Response payload. */ data: { /** @description Whether the test delivery succeeded. */ success: boolean; /** @description HTTP status returned by the endpoint, if any. */ status_code: number | null; /** @description Delivery error message, if the test failed. */ error: string | null; }; }; WebhookUpdateResponse: { /** @description Response payload. */ data: { webhook: components["schemas"]["UpdatedWebhook"]; }; }; }; responses: never; parameters: never; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export interface operations { listTestRuns: { parameters: { query?: { /** @description Return only the test run with this exact ID. */ id?: number; /** @description Items per page (max 100). Defaults to 20. */ per_page?: number; /** @description Page number (1-indexed). Defaults to 1. */ page?: number; /** @description Filter to runs on this test repo branch. */ branch?: string; /** @description Restrict to runs created in the last N days. */ interval_in_days?: number; /** @description Restrict to runs created at or after this time. */ created_after?: string; /** @description Restrict to runs created before this time. */ created_before?: string; /** @description Filter by run state (e.g. `queued`, `ended`). */ state?: string; /** @description Filter by overall run result. */ result?: "passed" | "failed"; /** @description Filter to one environment. Combined with environment_ids when both are provided. */ environment_id?: number; /** @description Comma-separated environment IDs to filter by. Combined with environment_id when both are provided. */ environment_ids?: string; /** @description Filter to runs created in this concurrency group (exact match on the run's `concurrency.group`). */ concurrency_group?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Paginated list of test runs. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestRunsListResponse"]; }; }; /** @description Invalid request, or the project could not be resolved from the request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createTestRun: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["TriggerTestRunRequest"]; }; }; responses: { /** @description The triggered test run. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreateTestRunResponse"]; }; }; /** @description Invalid request, unknown environment, pierre code-storage repo, or the project could not be resolved. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Billing blocked: an overdue invoice, a failed renewal, no active plan, or the spend limit reached. */ 402: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateTestRunState: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UpdateTestRunStateRequest"]; }; }; responses: { /** @description The updated test run row. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UpdateTestRunStateResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Cannot start a test run that is already in a terminal state. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getTestRun: { parameters: { query?: never; header?: never; path: { /** @description Test run database ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The test run. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GetTestRunResponse"]; }; }; /** @description Invalid test run ID. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listTestRunArtifacts: { parameters: { query?: { /** @description Exact artifact path (relative to the run) to look up via a single HEAD request. Takes precedence over `prefix`/`suffix`. */ key?: string; /** @description Restrict the listing to artifacts whose path starts with this. */ prefix?: string; /** @description Restrict the listing to artifacts whose path ends with this. */ suffix?: string; }; header?: never; path: { /** @description Test run database ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The matching artifacts. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ListArtifactsResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; cancelTestRun: { parameters: { query?: never; header?: never; path: { /** @description Test run database ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CancelTestRunRequest"]; }; }; responses: { /** @description The test run was cancelled. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CancelTestRunResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The test run could not be cancelled (already terminal). */ 412: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CancelTestRunFailureResponse"]; }; }; }; }; rerunTestRun: { parameters: { query?: never; header?: never; path: { /** @description Test run database ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["RerunTestRunRequest"]; }; }; responses: { /** @description The re-triggered test run. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreateTestRunResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Billing blocked: an overdue invoice, a failed renewal, no active plan, or the spend limit reached. */ 402: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Source test run or environment not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; skipTestRun: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["SkipTestRunRequest"]; }; }; responses: { /** @description The skipped check run. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SkipTestRunResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getTestRunV2: { parameters: { query?: never; header?: never; path: { /** @description Test run database ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The test run metadata. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GetTestRunV2Response"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listTestRunChatSessions: { parameters: { query?: never; header?: never; path: { /** @description Test run database ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Sessions linked to the run. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ListTestRunChatSessionsResponse"]; }; }; /** @description Invalid database test run ID. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run not found or inaccessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateTestRunEcsTask: { parameters: { query?: never; header?: never; path: { /** @description External run_id of the test run. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UpdateEcsTaskIdRequest"]; }; }; responses: { /** @description The task id was recorded. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UpdateEcsTaskResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run or shard not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getTestRunEnvironmentVariables: { parameters: { query?: never; header?: never; path: { /** @description External run_id of the test run. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The run's resolved environment variables. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestRunEnvironmentVariablesResponse"]; }; }; /** @description Test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getTestRunLinkedChanges: { parameters: { query?: never; header?: never; path: { /** @description Test run database ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The run's linked test changes. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestRunLinkedChangesResponse"]; }; }; /** @description Invalid database test run ID. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getTestRunLogs: { parameters: { query?: { /** @description Pagination token returned by a previous logs page. */ nextToken?: string; /** @description Maximum number of log events to return. */ limit?: number; /** @description Restrict logs to this shard's ECS task and trim to its execution window. */ shardIndex?: number | null; /** @description Job type of the shard at shardIndex. merge_reports and run_setup share index 0; defaults to merge_reports for index 0 (legacy callers), run_test otherwise. */ jobType?: "run_test" | "merge_reports" | "run_setup"; /** @description Lower bound (epoch ms) for log events. */ startTime?: number | null; /** @description Upper bound (epoch ms) for log events. */ endTime?: number | null; }; header?: never; path: { /** @description Test run database ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The task's log events. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestRunLogsResponse"]; }; }; /** @description ECS task ID not found. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getTestRunManifestTests: { parameters: { query?: never; header?: never; path: { /** @description Test run database ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The run's manifest tests grouped by shard. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestRunManifestTestsResponse"]; }; }; /** @description Invalid database test run ID. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getTestRunManifestCounts: { parameters: { query?: never; header?: never; path: { /** @description External run_id of the test run. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The run's manifest count summary. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestRunManifestCountsResponse"]; }; }; /** @description Test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createTestRunManifest: { parameters: { query?: never; header?: never; path: { /** @description External run_id of the test run. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["PutRunManifestRequest"]; }; }; responses: { /** @description The manifest was stored. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RunManifestResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createTestRunShardPlan: { parameters: { query?: never; header?: never; path: { /** @description External run_id of the test run. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["PostShardPlanRequest"]; }; }; responses: { /** @description The shard plan was stored. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ShardPlanResponse"]; }; }; /** @description The posted plan is not a valid partition. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listTestRunShards: { parameters: { query?: never; header?: never; path: { /** @description Test run database ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The run's shards. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestRunShardsResponse"]; }; }; /** @description Invalid database test run ID. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getTestRunShardAssignedTests: { parameters: { query?: never; header?: never; path: { /** @description External run_id of the test run. */ id: number; /** @description Zero-based shard index within the run. */ shard_index: number | null; }; cookie?: never; }; requestBody?: never; responses: { /** @description The shard's assigned test-case ids. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestRunShardAssignedTestsResponse"]; }; }; /** @description Test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description No shard plan for this run or shard. */ 417: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getTestRunShardResume: { parameters: { query?: never; header?: never; path: { /** @description External run_id of the test run. */ id: number; /** @description Zero-based shard index within the run. */ shard_index: number | null; }; cookie?: never; }; requestBody?: never; responses: { /** @description The shard resume pointer. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestRunShardResumeResponse"]; }; }; /** @description Test run or shard not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getTestRunShardUnrunManifest: { parameters: { query?: never; header?: never; path: { /** @description External run_id of the test run. */ id: number; /** @description Zero-based shard index within the run. */ shard_index: number | null; }; cookie?: never; }; requestBody?: never; responses: { /** @description Gzip-compressed newline-delimited list of unrun test lines. */ 200: { headers: { [name: string]: unknown; }; content: { "application/octet-stream": string; }; }; /** @description Test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Run manifest not found for this shard. */ 417: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getTestRunStatus: { parameters: { query?: never; header?: never; path: { /** @description External run_id of the test run. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The run's status summary. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestRunStatusResponse"]; }; }; /** @description Test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; stopTestRunTask: { parameters: { query?: never; header?: never; path: { /** @description Test run database ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["StopTaskRequest"]; }; }; responses: { /** @description The task was stopped. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StopTaskResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run or shard not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Failed to stop the task. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getTestRunTestCaseDurations: { parameters: { query?: never; header?: never; path: { /** @description External run_id of the test run. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The project's test-case duration history. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestRunTestCaseDurationsResponse"]; }; }; /** @description Test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Analytics is unavailable. */ 503: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getTestRunTriageSession: { parameters: { query?: never; header?: never; path: { /** @description Test run database ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The newest triage session, if one exists. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GetTestRunTriageSessionResponse"]; }; }; /** @description Invalid database test run ID. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run not found or inaccessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createTestRunTriageSession: { parameters: { query?: never; header?: never; path: { /** @description Test run database ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The created triage session. */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestRunTriageSessionResponse"]; }; }; /** @description Invalid database test run ID. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run not found or inaccessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; triggerTestRunMerge: { parameters: { query?: never; header?: never; path: { /** @description Test run database ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The merge job was dispatched. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TriggerMergeResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run or environment not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Not all shards have completed. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Failed to trigger merge reports. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listTestRunBranches: { parameters: { query?: { /** @description Maximum number of branches to return. Default 50. */ limit?: number; /** @description Case-insensitive substring filter on branch name. */ search?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Branches with recent test runs. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestRunBranchListResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getTestRunHistoryChart: { parameters: { query?: { /** @description Look-back window in days (default 30). Ignored when both `start_date` and `end_date` are set. */ days?: number; /** @description Start of a custom date range (ISO 8601). */ start_date?: string; /** @description End of a custom date range (ISO 8601). */ end_date?: string; /** @description Filter to runs scoped to this environment. */ environment_id?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Test runs for the history chart. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestRunHistoryChartResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getTestRunSummaryDetail: { parameters: { query: { /** @description Test run ID (database primary key). */ test_run_id: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Per-test summary details. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestRunSummaryDetailResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listTestCases: { parameters: { query?: { /** @description Comma-separated Playwright test IDs to filter by. Capped at the first 100. */ ids?: string; /** @description Filter to test cases whose file path starts with this value. */ file_path?: string; /** @description Filter to test cases in this Playwright project. */ playwright_project?: string; /** @description Comma-separated tags; returns test cases having any of the given tags. */ tags?: string; /** @description Free-text search across the test case name and file path. */ search?: string; /** @description Filter to test cases first seen at this commit SHA. */ first_seen_commit_sha?: string; /** @description Filter to test cases last seen at this commit SHA. */ last_seen_commit_sha?: string; /** @description When `true` (default), restrict to test cases present at the project's last synced commit. Set `false` to include all test cases. */ is_active?: "true" | "false"; /** @description Page number (1-indexed). Defaults to 1. */ page?: number; /** @description Items per page. Defaults to 100. */ per_page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Paginated test cases and sync status. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestCaseListResponse"]; }; }; /** @description Invalid request or project could not be resolved. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getTestCase: { parameters: { query?: never; header?: never; path: { /** @description Playwright test ID (pw_test_id), the 41-character hash identifying the test case. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The test case. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GetTestCaseResponse"]; }; }; /** @description The test case belongs to a project you cannot access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test case not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateTestCaseTags: { parameters: { query?: never; header?: never; path: { /** @description Playwright test ID (pw_test_id), the 41-character hash identifying the test case. */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UpdateTestCaseTagsRequest"]; }; }; responses: { /** @description The updated test case. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestCaseTagsUpdateResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The test case belongs to a project you cannot access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test case not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listTestCaseTags: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The project's distinct test case tags. */ 200: { headers: { /** @description Caching directive: `public, s-maxage=300, stale-while-revalidate=600`. */ "Cache-Control": string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestCaseTagsResponse"]; }; }; /** @description Project could not be resolved from the request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listTestCasePlaywrightProjects: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The project's distinct Playwright projects. */ 200: { headers: { /** @description Caching directive: `public, s-maxage=300, stale-while-revalidate=600`. */ "Cache-Control": string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestCasePlaywrightProjectsResponse"]; }; }; /** @description Project could not be resolved from the request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createEnvironment: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateEnvironmentRequest"]; }; }; responses: { /** @description The created environment. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EnvironmentResponse"]; }; }; /** @description Invalid request, the slug already exists, or reporter_config names an unknown Slack channel. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project is managed by environments.yaml. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; deleteEnvironment: { parameters: { query?: never; header?: never; path: { /** @description Environment ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Deletion succeeded. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EnvironmentDeleteResponse"]; }; }; /** @description Environment is in an environments.yaml-managed project. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EnvironmentMutationError"]; }; }; /** @description Environment not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EnvironmentMutationError"]; }; }; }; }; updateEnvironment: { parameters: { query?: never; header?: never; path: { /** @description Environment ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UpdateEnvironmentRequest"]; }; }; responses: { /** @description The updated environment row (no `data` envelope). */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Environment"]; }; }; /** @description Invalid request, the slug already exists, or reporter_config names an unknown Slack channel. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EnvironmentMutationError"]; }; }; /** @description Environment is in an environments.yaml-managed project. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EnvironmentMutationError"]; }; }; /** @description Environment not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EnvironmentMutationError"]; }; }; }; }; listEnvironments: { parameters: { query?: { /** @description When set to the string `false`, exclude disabled environments. */ is_disabled?: string; /** @description Filter to the environment with this slug. */ environment_slug?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The project's environments. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ListEnvironmentsResponse"]; }; }; /** @description Invalid request or missing project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; syncEnvironments: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Sync succeeded. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EnvironmentSyncResponse"]; }; }; /** @description Invalid environments.yaml. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listSnoozes: { parameters: { query?: { /** @description Page number (1-indexed). */ page?: number; /** @description Items per page (max 100). */ per_page?: number; /** @description Filter to snoozes scoped to this environment. */ environment_id?: number; /** @description Filter by snooze status. */ status?: "active" | "expired" | "all"; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Paginated list of snoozes. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SnoozeListResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createSnooze: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateSnoozeRequest"]; }; }; responses: { /** @description The created snooze. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SnoozeResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getSnooze: { parameters: { query?: never; header?: never; path: { /** @description Snooze ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The snooze. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SnoozeResponse"]; }; }; /** @description Snooze not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; deleteSnooze: { parameters: { query?: never; header?: never; path: { /** @description Snooze ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The deleted snooze. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SnoozeResponse"]; }; }; /** @description Snooze not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateSnooze: { parameters: { query?: never; header?: never; path: { /** @description Snooze ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UpdateSnoozeRequest"]; }; }; responses: { /** @description The updated snooze. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SnoozeResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Snooze not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; addSnoozeTestCases: { parameters: { query?: never; header?: never; path: { /** @description Snooze ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["AddSnoozeTestCasesRequest"]; }; }; responses: { /** @description The updated snooze. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SnoozeResponse"]; }; }; /** @description Snooze not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listTestCasesAnalyticsV1: { parameters: { query?: { /** @description Number of days to include (1-90). Ignored when both `start_date` and `end_date` are provided. */ days?: number; /** @description Start of a custom date range (ISO 8601). */ start_date?: string; /** @description End of a custom date range (ISO 8601). */ end_date?: string; /** @description Filter to a single environment by ID. */ environment_id?: string; /** @description Free-text search over test name and file path. */ search?: string; /** @description Comma-separated list of tags to filter by. */ tags?: string; /** @description Field to order results by. One of `fail_rate`, `flaky_rate`, `last_run`. Defaults to `fail_rate`. */ order_by?: "fail_rate" | "flaky_rate" | "last_run"; /** @description Sort direction, `asc` or `desc`. Defaults to `desc`. */ order?: "asc" | "desc"; /** @description Maximum number of test cases to return (1-500). */ limit?: number; /** @description Maximum number of history entries to return per test case (1-100). */ limit_history?: number; /** @description Filter to a single test case by ID. */ test_case_id?: string; /** @description When `false`, include inactive test cases. Defaults to active-only. */ is_active?: "true" | "false"; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Test cases with metrics and history. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AnalyticsTestCasesResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Analytics backend error. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AnalyticsErrorResponse"]; }; }; }; }; getTestCountAnalyticsV1: { parameters: { query?: { /** @description Number of days to include (1-90). Ignored when both `start_date` and `end_date` are provided. */ days?: number; /** @description Start of a custom date range (ISO 8601). */ start_date?: string; /** @description End of a custom date range (ISO 8601). */ end_date?: string; /** @description Filter to a single environment by ID. */ environment_id?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Daily distinct test counts and a period summary. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AnalyticsTestCountResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Analytics backend error. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AnalyticsErrorResponse"]; }; }; }; }; listTestRunsAnalyticsV1: { parameters: { query?: { /** @description Number of days to include (1-90). Ignored when both `start_date` and `end_date` are provided. */ days?: number; /** @description Start of a custom date range (ISO 8601). */ start_date?: string; /** @description End of a custom date range (ISO 8601). */ end_date?: string; /** @description Filter to a single environment by ID. */ environment_id?: number; /** @description Filter to test runs on this git branch. */ branch?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Daily test-run stats and a period summary. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AnalyticsTestRunsResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getTestCaseHistoryBatch: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["TestCaseHistoryBatchRequest"]; }; }; responses: { /** @description History grouped by test case. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestCaseHistoryBatchResponse"]; }; }; /** @description Unknown body field(s) supplied. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestCaseHistoryUnknownFieldsError"]; }; }; /** @description Analytics backend error. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AnalyticsErrorResponse"]; }; }; }; }; getTestCaseLastPassPerEnv: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["LastPassPerEnvRequest"]; }; }; responses: { /** @description Last passing run per environment. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LastPassPerEnvResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Analytics backend error. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AnalyticsErrorResponse"]; }; }; }; }; listTestCasesAnalyticsV2: { parameters: { query?: { /** @description Number of days to include (1-90). Ignored when both `start_date` and `end_date` are provided. */ days?: number; /** @description Start of a custom date range (ISO 8601). */ start_date?: string; /** @description End of a custom date range (ISO 8601). */ end_date?: string; /** @description Filter to a single environment by ID. */ environment_id?: string; /** @description Free-text search over test name and file path. */ search?: string; /** @description Comma-separated list of tags to filter by. */ tags?: string; /** @description Field to order results by. One of `fail_rate`, `flaky_rate`, `last_run`. Defaults to `fail_rate`. */ order_by?: "fail_rate" | "flaky_rate" | "last_run"; /** @description Sort direction, `asc` or `desc`. Defaults to `desc`. */ order?: "asc" | "desc"; /** @description Maximum number of test cases to return (1-500). */ limit?: number; /** @description Maximum number of history entries to return per test case (1-100). */ limit_history?: number; /** @description Filter to a single test case by ID. */ test_case_id?: string; /** @description When `false`, include inactive test cases. Defaults to active-only. */ is_active?: "true" | "false"; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Test cases with metrics. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AnalyticsTestCasesV2Response"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Analytics backend error. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AnalyticsErrorResponse"]; }; }; }; }; getTestCountAnalyticsV2: { parameters: { query?: { /** @description Number of days to include (1-90). Ignored when both `start_date` and `end_date` are provided. */ days?: number; /** @description Start of a custom date range (ISO 8601). */ start_date?: string; /** @description End of a custom date range (ISO 8601). */ end_date?: string; /** @description Filter to a single environment by ID. */ environment_id?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Daily distinct test counts and a period summary. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AnalyticsTestCountResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Analytics backend error. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AnalyticsErrorResponse"]; }; }; }; }; listTestRunsAnalyticsV2: { parameters: { query?: { /** @description Number of days to include (1-90). Ignored when both `start_date` and `end_date` are provided. */ days?: number; /** @description Start of a custom date range (ISO 8601). */ start_date?: string; /** @description End of a custom date range (ISO 8601). */ end_date?: string; /** @description Filter to a single environment by ID. */ environment_id?: number; /** @description Filter to test runs on this git branch. */ branch?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Daily test-run stats and a period summary. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AnalyticsTestRunsResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; refreshSlackAppScopes: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description OAuth code from Slack's redirect. */ code: string; /** * Format: uri * @description Redirect URI the authorize request used. */ redirect_uri: string; }; }; }; responses: { /** @description The scopes were refreshed. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackScopeRefreshResponse"]; }; }; /** @description The code was for another workspace. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Slack rejected the OAuth code. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; slackAuthTest: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The Slack auth.test result. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackAuthTestResponse"]; }; }; /** @description The project does not belong to an org. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Error message. */ error: string; }; }; }; /** @description Slack token is not configured. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Error message. */ error: string; }; }; }; }; }; listSlackInstallations: { parameters: { query: { /** @description Organisation ID to list installs for. */ org_id: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The Slack app installs. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackAppInstallListResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; upsertSlackInstallation: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Organisation ID. */ org_id: number; /** @description OAuth code from Slack's redirect. Required for a signed-in user. */ code?: string; /** * Format: uri * @description Redirect URI the authorize request used; Slack requires it to match. Required with `code`. */ redirect_uri?: string; /** @description Slack app ID. System callers only. */ slack_app_id?: string; /** @description Authorizing Slack user ID. System callers only. */ authed_user_id?: string; /** @description OAuth scopes (CSV). System callers only. */ scope?: string; /** @description OAuth token type. System callers only. */ token_type?: string; /** @description OAuth access token. System callers only. */ access_token?: string; /** @description Bot user ID. System callers only. */ bot_user_id?: string; /** @description Slack workspace (team) ID. System callers only. */ team_id?: string; /** @description Slack workspace name. System callers only. */ team_name?: string; }; }; }; responses: { /** @description The created or updated install. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackAppInstallUpsertResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Slack rejected the OAuth code. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Failed to save Slack installation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getSlackInstallation: { parameters: { query?: never; header?: never; path: { /** @description Slack app install ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The Slack app install. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackAppInstallResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Installation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; deleteSlackInstallation: { parameters: { query?: never; header?: never; path: { /** @description Slack app install ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The deleted install. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackAppInstallMutationResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Installation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateSlackInstallation: { parameters: { query?: never; header?: never; path: { /** @description Slack app install ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description OAuth scopes, as a CSV string or array. */ scope?: string | string[]; /** @description Slack app ID. */ slack_app_id?: string; /** @description Authorizing Slack user ID. */ authed_user_id?: string; /** @description OAuth token type. */ token_type?: string; /** @description OAuth access token. */ access_token?: string; /** @description Bot user ID. */ bot_user_id?: string; /** @description Slack workspace name. */ team_name?: string; }; }; }; responses: { /** @description The updated install. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackAppInstallMutationResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Installation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listSlackInstallationsByTeam: { parameters: { query: { /** @description Slack workspace (team) ID. */ team_id: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The Slack app installs. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackAppInstallListResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; slackEventsWebhook: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description The event was accepted, or the url_verification challenge echo. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; slackInteractionsWebhook: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/x-www-form-urlencoded": { /** @description JSON-encoded Slack interaction payload. */ payload: string; }; }; }; responses: { /** @description Slack interaction response, returned verbatim to Slack. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; /** @description Invalid request or unknown interaction type. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"] | { /** @description Error message. */ error: string; }; }; }; }; }; getSlackFileMetadata: { parameters: { query?: never; header?: never; path: { /** @description Slack file ID. */ file_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Slack file metadata. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackFileMetadataResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Sandbox authentication required. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description File, chat session, or Slack thread not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"] | { /** @description Error message. */ error: string; }; }; }; /** @description Slack file error. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Error message. */ error: string; }; }; }; }; }; getSlackFileContent: { parameters: { query?: never; header?: never; path: { /** @description Slack file ID. */ file_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The Slack file content stream. */ 200: { headers: { [name: string]: unknown; }; content: { "application/octet-stream": string; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Sandbox authentication required. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description File, chat session, or Slack thread not found, or not downloadable. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"] | { /** @description Error message. */ error: string; }; }; }; /** @description Slack file download failed. */ 424: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackFileDownloadError"]; }; }; /** @description Slack file error. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Error message. */ error: string; }; }; }; }; }; headSlackFileContent: { parameters: { query?: never; header?: never; path: { /** @description Slack file ID. */ file_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The Slack file content stream. */ 200: { headers: { [name: string]: unknown; }; content: { "application/octet-stream": string; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Sandbox authentication required. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description File, chat session, or Slack thread not found, or not downloadable. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"] | { /** @description Error message. */ error: string; }; }; }; /** @description Slack file download failed. */ 424: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackFileDownloadError"]; }; }; /** @description Slack file error. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Error message. */ error: string; }; }; }; }; }; slackSendMessage: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Markdown message body; not Slack's text field. */ markdown: string; /** @description Agent-defined buttons; each requires exactly one of input or url. Input choices are single-use for the entire message: the first authorized selection removes all input buttons and publicly records who chose what. URL buttons remain available and never wake the agent. Selection requests an operation; the agent must report its outcome separately. Omit when no buttons are needed. */ actions?: ({ /** @description Button text shown to the user. */ label: string; /** @description Text sent to this message's originating agent when selected. Supply enough context to act on it. */ input: string; } | { /** @description Button text shown to the user. */ label: string; /** * Format: uri * @description HTTP(S) destination opened by this repeatable navigation button. Does not send input to the agent or consume the message's choices. */ url: string; })[]; /** @description Slack channel or existing DM channel ID. */ channel: string; /** @description Root timestamp of the thread to reply to. Omit for a top-level post. */ thread_ts?: string; /** @description Required and honored for registered-root replies; optional for new roots. */ idempotency_key?: string; } | { /** @description Markdown message body; not Slack's text field. */ markdown: string; /** @description Agent-defined buttons; each requires exactly one of input or url. Input choices are single-use for the entire message: the first authorized selection removes all input buttons and publicly records who chose what. URL buttons remain available and never wake the agent. Selection requests an operation; the agent must report its outcome separately. Omit when no buttons are needed. */ actions?: ({ /** @description Button text shown to the user. */ label: string; /** @description Text sent to this message's originating agent when selected. Supply enough context to act on it. */ input: string; } | { /** @description Button text shown to the user. */ label: string; /** * Format: uri * @description HTTP(S) destination opened by this repeatable navigation button. Does not send input to the agent or consume the message's choices. */ url: string; })[]; /** @description Recipient Slack user ID. Creates a new DM root; in-thread replies return to the sending session. */ slack_user_id: string; /** @description Required for recipient-addressed sends. Each send creates a new DM root; root creation is not retry-safe if delivery or registration is uncertain. */ idempotency_key: string; } | { /** @description Markdown message body; not Slack's text field. */ markdown: string; /** @description Agent-defined buttons; each requires exactly one of input or url. Input choices are single-use for the entire message: the first authorized selection removes all input buttons and publicly records who chose what. URL buttons remain available and never wake the agent. Selection requests an operation; the agent must report its outcome separately. Omit when no buttons are needed. */ actions?: ({ /** @description Button text shown to the user. */ label: string; /** @description Text sent to this message's originating agent when selected. Supply enough context to act on it. */ input: string; } | { /** @description Button text shown to the user. */ label: string; /** * Format: uri * @description HTTP(S) destination opened by this repeatable navigation button. Does not send input to the agent or consume the message's choices. */ url: string; })[]; /** * Format: uuid * @description Recipient Empirical UUID with one valid linked Slack account. Alternative to slack_user_id. */ user_id: string; idempotency_key: string; }; }; }; responses: { /** @description Message posted. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackMessageResult"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackMessageError"]; }; }; /** @description Sandbox authentication required, or the channel is out of scope. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackMessageError"]; }; }; /** @description Chat session or Slack connection not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackMessageError"]; }; }; /** @description Idempotency conflict. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackMessageError"]; }; }; /** @description The thread was a test run's run-start notification, which was deleted when the run's final notification was posted. Reply in `replacement` instead. */ 410: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackRunStartThreadReplacedError"]; }; }; /** @description Slack upstream error. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackMessageError"]; }; }; }; }; slackDeleteMessage: { parameters: { query?: never; header?: never; path: { /** @description Slack channel or DM channel ID of the message. */ channel: string; /** @description Timestamp id of the message, as returned by POST /api/slack/messages. */ ts: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Message deleted. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackMessageEditResult"]; }; }; /** @description Sandbox authentication required, or the channel is out of scope. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackMessageError"]; }; }; /** @description No message posted by this project's agent at these coordinates. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackMessageError"]; }; }; /** @description Slack upstream error. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackMessageError"]; }; }; }; }; slackUpdateMessage: { parameters: { query?: never; header?: never; path: { /** @description Slack channel or DM channel ID of the message. */ channel: string; /** @description Timestamp id of the message, as returned by POST /api/slack/messages. */ ts: string; }; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Replacement Markdown body; not Slack's text field. */ markdown: string; /** @description Replacement buttons, with the same rules as POST /api/slack/messages. Omit to remove all buttons. */ actions?: ({ /** @description Button text shown to the user. */ label: string; /** @description Text sent to this message's originating agent when selected. Supply enough context to act on it. */ input: string; } | { /** @description Button text shown to the user. */ label: string; /** * Format: uri * @description HTTP(S) destination opened by this repeatable navigation button. Does not send input to the agent or consume the message's choices. */ url: string; })[]; }; }; }; responses: { /** @description Message updated. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackMessageEditResult"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackMessageError"]; }; }; /** @description Sandbox authentication required, or the channel is out of scope. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackMessageError"]; }; }; /** @description No message posted by this project's agent at these coordinates. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackMessageError"]; }; }; /** @description A button on the message was already selected. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackMessageError"]; }; }; /** @description Slack upstream error. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackMessageError"]; }; }; }; }; slackProxy: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** * @description Slack Web API method to call. Read-only methods only. * @enum {string} */ api_method: "conversations.history" | "conversations.replies" | "conversations.info" | "chat.getPermalink" | "files.list" | "files.info" | "users.info"; /** * @description Arguments passed to the Slack method. * @default {} */ args?: { [key: string]: unknown; }; }; }; }; responses: { /** @description The Slack API JSON response, forwarded verbatim. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackProxyError"]; }; }; /** @description Sandbox authentication required, or the resource is out of scope. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackProxyError"]; }; }; /** @description Chat session or Slack connection not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackProxyError"]; }; }; /** @description Slack upstream error. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackProxyError"]; }; }; }; }; slackReaction: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Slack channel id the message lives in. */ channel: string; /** @description Timestamp id of the message to react to, e.g. `1783545993.688449`. */ ts: string; /** @description Emoji name to react with, without colons — e.g. `tada`, `eyes`, `shipit`. Any emoji the workspace has, built-in or custom; a name the workspace does not have is rejected with 400. */ reaction: string; /** * @description Whether to add the reaction or take it back off. Removing is how a status reaction is superseded (e.g. drop `eyes` when adding `white_check_mark`). * @default add * @enum {string} */ action?: "add" | "remove"; }; }; }; responses: { /** @description Reaction applied. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackReactionResult"]; }; }; /** @description Invalid request, or the workspace has no emoji by that name. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackReactionError"]; }; }; /** @description Sandbox authentication required, or the channel is out of scope. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackReactionError"]; }; }; /** @description Chat session or Slack connection not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackReactionError"]; }; }; /** @description The Slack workspace has not granted the reactions:write scope. */ 424: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackReactionError"]; }; }; /** @description Slack upstream error. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackReactionError"]; }; }; }; }; listSlackThreads: { parameters: { query?: { /** @description Page number (1-indexed). */ page?: number; /** @description Items per page (max 100). */ per_page?: number; /** @description Filter by Slack channel ID. */ channel_id?: string; /** @description Filter by registered thread kind. */ kind?: "run_notification" | "discussion"; /** @description Entity type; must be supplied with `entity_id`. */ entity_type?: "test_run" | "failure_group" | "pull_request" | "discussion"; /** @description Entity ID; must be supplied with `entity_type`. */ entity_id?: string; /** @description When true, include registry history for deleted Slack roots. */ include_deleted?: "true" | "false"; /** @description When true, omit run-notification roots with no registered inbound session or sent follow-up message. Discussion roots are always included. */ hide_inactive_run_notifications?: "true" | "false"; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Paginated registered Slack threads. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackThreadListResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createSlackThreadEntityLink: { parameters: { query?: never; header?: never; path: { /** @description Registered Slack thread ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateSlackThreadEntityLinkRequest"]; }; }; responses: { /** @description The live entity link. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackThreadEntityLinkResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Slack thread or entity not found in this project. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; deleteSlackThreadEntityLink: { parameters: { query?: never; header?: never; path: { /** @description Registered Slack thread ID. */ id: number; /** @description Entity link ID from the thread's `entity_links`. */ link_id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The removed entity link. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackThreadEntityLinkResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Entity link not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description System links cannot be removed. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listSlackChannelsV2: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The organization's active Slack channels. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackChannelListV2Response"]; }; }; }; }; refreshSlackChannelV2: { parameters: { query?: never; header?: never; path: { /** @description Canonical Slack channel ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The channel after the refresh, with live validation. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackChannelRefreshV2Response"]; }; }; /** @description Channel not found in the scoped project's organization. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; validateSlackChannelsV2: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The organization's active Slack channels with live validation results. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackChannelValidationListV2Response"]; }; }; }; }; listSlackTeams: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The Slack workspaces available to the project. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackTeamListResponse"]; }; }; }; }; previewSlackThread: { parameters: { query?: never; header?: never; path: { /** @description Registered Slack thread ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Compact Slack thread preview. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackThreadPreviewResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Slack thread not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Slack thread preview unavailable. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getEnvironmentBadge: { parameters: { query?: { /** @description Restrict the badge to the latest run on this branch. Blank/whitespace is treated as unset (latest run across branches). */ branch?: string; /** @description Left-hand label text on the badge. Blank/whitespace falls back to the default (`empirical tests`). */ label?: string; }; header?: never; path: { /** @description Slug of the project that owns the environment. */ project_slug: string; /** @description Slug of the environment to render a badge for. */ environment_slug: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The rendered SVG badge image. */ 200: { headers: { [name: string]: unknown; }; content: { "image/svg+xml": string; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listFailureGroups: { parameters: { query?: { /** @description Page number (1-indexed). */ page?: number; /** @description Items per page (max 100). */ per_page?: number; /** @description Filter by lifecycle status. */ status?: "open" | "resolved"; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Paginated failure groups. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FailureGroupListResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createFailureGroup: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateFailureGroupRequest"]; }; }; responses: { /** @description The failure group. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FailureGroupResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description A group with this label already exists; nothing was written. The existing group is in `data`. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FailureGroupConflictResponse"]; }; }; }; }; getFailureGroup: { parameters: { query?: never; header?: never; path: { /** @description Failure group ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The failure group. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FailureGroupResponse"]; }; }; /** @description Not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; deleteFailureGroup: { parameters: { query?: never; header?: never; path: { /** @description Failure group ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Deleted. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteFailureGroupResponse"]; }; }; /** @description Not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateFailureGroup: { parameters: { query?: never; header?: never; path: { /** @description Failure group ID. */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["PatchFailureGroupRequest"]; }; }; responses: { /** @description The updated failure group. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FailureGroupResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Another group already holds this label; nothing was written. The conflicting group is in `data`. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FailureGroupConflictResponse"]; }; }; }; }; getFailureGroupActivity: { parameters: { query?: never; header?: never; path: { /** @description Failure group ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The activity timeline. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FailureGroupActivityResponse"]; }; }; /** @description Not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listFailureGroupMembers: { parameters: { query?: { state?: "active" | "detached" | "all"; page?: number; per_page?: number; }; header?: never; path: { /** @description Failure group ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The group's members. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FailureGroupMembersResponse"]; }; }; /** @description Group not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; attachFailureGroupMember: { parameters: { query?: never; header?: never; path: { /** @description Failure group ID. */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["AttachFailureGroupMemberRequest"]; }; }; responses: { /** @description The attached member, derived from the membership-event log. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FailureGroupMemberResponse"]; }; }; /** @description Group or test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Membership was detached by a human; not re-attached. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; mergeFailureGroup: { parameters: { query?: never; header?: never; path: { /** @description Failure group ID. */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["MergeFailureGroupRequest"]; }; }; responses: { /** @description The target failure group. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FailureGroupResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listFailureGroupMembersByTestRun: { parameters: { query: { /** @description Return members attached during this run. */ test_run_id: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Members attached during the run. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MembersByTestRunResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listFiles: { parameters: { query?: { /** @description Page number (1-indexed). */ page?: number; /** @description Items per page (max 100). */ per_page?: number; /** @description Only files created by this chat session. */ origin_chat_session_id?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Paginated list of files. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ListFilesResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createFile: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateFileRequest"]; }; }; responses: { /** @description The created file. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreateFileResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getFile: { parameters: { query?: never; header?: never; path: { /** @description File ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The file. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FileResponse"]; }; }; /** @description File not found in this project. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateFile: { parameters: { query?: never; header?: never; path: { /** @description File ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UpdateFileRequest"]; }; }; responses: { /** @description The updated file. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FileResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description File not found in this project. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The file content has not been uploaded yet. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listReporters: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Reporters for the project. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ListReportersResponse"]; }; }; /** @description Missing project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listProjectResources: { parameters: { query?: { /** @description Page number (1-indexed). */ page?: number; /** @description Items per page (max 100). */ per_page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Paginated list of resources. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectResourceListResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createProjectResource: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateProjectResourceRequest"]; }; }; responses: { /** @description The created resource, including an `upload_url`. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreateProjectResourceResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getProjectResource: { parameters: { query?: never; header?: never; path: { /** @description Resource ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The resource. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectResourceResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description File not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; deleteProjectResource: { parameters: { query?: never; header?: never; path: { /** @description Resource ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The resource was deleted. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteProjectResourceResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description File not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateProjectResource: { parameters: { query?: never; header?: never; path: { /** @description Resource ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UpdateProjectResourceRequest"]; }; }; responses: { /** @description The updated resource. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectResourceResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description File not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; downloadResourceContent: { parameters: { query: { /** @description Capability scope: `r` (read) or `w` (write). */ scope: "r" | "w"; /** @description Expiry as a Unix timestamp (seconds). */ exp?: number | null; /** @description HMAC signature for the capability. */ sig: string; }; header?: never; path: { /** @description Resource ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The resource's binary content. */ 200: { headers: { [name: string]: unknown; }; content: { "application/octet-stream": string; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Invalid scope or expired URL. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description File not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; uploadResourceContent: { parameters: { query: { /** @description Capability scope: `r` (read) or `w` (write). */ scope: "r" | "w"; /** @description Expiry as a Unix timestamp (seconds). */ exp?: number | null; /** @description HMAC signature for the capability. */ sig: string; }; header?: never; path: { /** @description Resource ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/octet-stream": string; }; }; responses: { /** @description The upload was stored. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ResourceUploadContentResponse"]; }; }; /** @description Invalid request or missing body. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Invalid scope or expired URL. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description File not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getStaticIps: { parameters: { query: { /** @description Region to look up. One of: ap-south-1. */ region: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Static IPs for the region. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StaticIpsResponse"]; }; }; /** @description Missing or unknown region. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listTasks: { parameters: { query?: { /** @description Page number (1-indexed). */ page?: number; /** @description Items per page. */ per_page?: number; /** @description URL-encoded JSON array of generic filter conditions; malformed input is ignored. */ filters?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Paginated list of tasks. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TaskListResponse"]; }; }; /** @description Invalid request or missing project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or inaccessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createTask: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateTaskRequest"]; }; }; responses: { /** @description The created task. */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreateTaskResponse"]; }; }; /** @description Missing required fields, no person to own the task, or invalid input. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreateTaskError"]; }; }; /** @description Project not found or inaccessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Failed to create task. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getTask: { parameters: { query?: never; header?: never; path: { /** @description Task ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The task. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TaskResponse"]; }; }; /** @description Invalid task ID. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Task not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; deleteTask: { parameters: { query?: never; header?: never; path: { /** @description Task ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The deleted task ID. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeletedTaskResponse"]; }; }; /** @description Invalid task ID. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Task not found or not deleted. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateTask: { parameters: { query?: never; header?: never; path: { /** @description Task ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UpdateTaskRequest"]; }; }; responses: { /** @description The updated task. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UpdatedTaskResponse"]; }; }; /** @description No fields to update or invalid input. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Task not found or not updated. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getOverlayDismissalSummary: { parameters: { query?: { /** @description Page number (1-indexed). Default 1. */ page?: string; /** @description Items per page (1-100). Default 50. */ per_page?: string; /** @description Look-back window in days (1-90, default 7). Ignored when `start_date` and `end_date` are set. */ days?: string; /** @description Start of a custom date range (ISO 8601). */ start_date?: string; /** @description End of a custom date range (ISO 8601). */ end_date?: string; /** @description Filter by environment name. */ environment?: string; /** @description Filter by test run ID. */ test_run_id?: string; /** @description Case-insensitive substring filter on test name. */ test_name?: string; /** @description Filter by success: `true` or `false`. Other values ignored. */ success?: string; /** @description Filter by cache hit: `true` or `false`. Other values ignored. */ cache_hit?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Overlay-dismissal summary for the project. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OverlayDismissalSummaryResponse"]; }; }; /** @description Failed to query telemetry. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getOverlayDismissalEvents: { parameters: { query?: { /** @description Page number (1-indexed). Default 1. */ page?: string; /** @description Items per page (1-100). Default 50. */ per_page?: string; /** @description Look-back window in days (1-90, default 7). Ignored when `start_date` and `end_date` are set. */ days?: string; /** @description Start of a custom date range (ISO 8601). */ start_date?: string; /** @description End of a custom date range (ISO 8601). */ end_date?: string; /** @description Filter by environment name. */ environment?: string; /** @description Filter by test run ID. */ test_run_id?: string; /** @description Case-insensitive substring filter on test name. */ test_name?: string; /** @description Filter by success: `true` or `false`. Other values ignored. */ success?: string; /** @description Filter by cache hit: `true` or `false`. Other values ignored. */ cache_hit?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Paginated overlay-dismissal events for the project. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OverlayDismissalEventsResponse"]; }; }; /** @description Failed to query telemetry. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listTestRunCases: { parameters: { query?: { /** @description Filter to cases with this status. */ status?: "passed" | "failed" | "flaky" | "skipped"; /** @description Page number (1-indexed). Default 1. */ page?: number; /** @description Items per page (capped at 200). Default 50. */ per_page?: number; /** @description Row order. `scheduled` (default) is manifest order — stable for a finished run. `recent` is most-recently-completed first, for the live view of an active run. `duration` is slowest first (total time across attempts). `start_time` is earliest first attempt first; skipped tests last. */ order?: "scheduled" | "recent" | "duration" | "start_time"; /** @description Case-insensitive substring search over the test's full name (project, file, describe blocks, title), Playwright test id and failing line. Combines with `status`, `order` and paging; `pagination.total` counts the matches. Failing lines are searchable only for cases recorded after this parameter was added. */ q?: string; /** @description When `true`, also returns cases that have reported at least one attempt but still have retries outstanding, marked `is_retrying: true`. Their `status` is provisional (from the attempts so far) and can change when the remaining retries land. Defaults to `false`. */ include_retrying?: "true" | "false"; }; header?: never; path: { /** @description Test run database ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Paginated list of test run cases. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ListTestRunCasesResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getTestRunCase: { parameters: { query?: { /** @description When `true`, also returns cases that have reported at least one attempt but still have retries outstanding, marked `is_retrying: true`. Their `status` is provisional (from the attempts so far) and can change when the remaining retries land. Defaults to `false`. */ include_retrying?: "true" | "false"; }; header?: never; path: { /** @description Test run database ID. */ id: number; /** @description Playwright test ID (`pw_test_id`) of the case. */ case_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The test run case. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GetTestRunCaseResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run or test case not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listChatSessionAlarms: { parameters: { query?: never; header?: never; path: { id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Alarms */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { alarms: { id: number; /** @description Compatibility alias for id. */ alarm_id: string; /** @description One-time wake time; null for recurring cron alarms. */ wake_at: string | null; chat_session_id: number; message: string; timing: { /** @enum {string} */ type: "once"; /** * Format: date-time * @description ISO 8601 UTC time at least 5m in the future. */ run_at: string; } | { /** @enum {string} */ type: "cron"; /** @description Five-field UTC cron expression, e.g. "0 *\/4 * * *". Runs must be at least 5m apart. */ cron: string; /** Format: date-time */ ends_at?: string; }; /** @enum {string} */ status: "active" | "completed"; last_run_at: string | null; created_at: string; updated_at: string; }[]; }; }; }; /** @description Session not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createChatSessionAlarm: { parameters: { query?: never; header?: never; path: { id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Why the alarm fires, in at most 200 characters, e.g. "check run 152810 finished". It is set once and cannot be edited. Keep state and rules out of it. */ message: string; timing: { /** @enum {string} */ type: "delay"; /** @description Whole minutes, hours or days (m/h/d), e.g. "15m", "2h", "1d" or "1h30m", between 5m and 72h. Seconds are not supported: use "5m", not "90s" or "300s". */ delay: string; } | { /** @enum {string} */ type: "once"; /** * Format: date-time * @description ISO 8601 UTC time at least 5m in the future. */ run_at: string; } | { /** @enum {string} */ type: "cron"; /** @description Five-field UTC cron expression, e.g. "0 *\/4 * * *". Runs must be at least 5m apart. */ cron: string; /** Format: date-time */ ends_at?: string; }; }; }; }; responses: { /** @description Created alarm */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: number; /** @description Compatibility alias for id. */ alarm_id: string; /** @description One-time wake time; null for recurring cron alarms. */ wake_at: string | null; chat_session_id: number; message: string; timing: { /** @enum {string} */ type: "once"; /** * Format: date-time * @description ISO 8601 UTC time at least 5m in the future. */ run_at: string; } | { /** @enum {string} */ type: "cron"; /** @description Five-field UTC cron expression, e.g. "0 *\/4 * * *". Runs must be at least 5m apart. */ cron: string; /** Format: date-time */ ends_at?: string; }; /** @enum {string} */ status: "active" | "completed"; last_run_at: string | null; created_at: string; updated_at: string; }; }; }; }; /** @description Invalid alarm */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Session not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Session is closed */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; deleteChatSessionAlarm: { parameters: { query?: never; header?: never; path: { id: number; alarm_id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Deleted */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Alarm not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateChatSessionAlarm: { parameters: { query?: never; header?: never; path: { id: number; alarm_id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description New schedule. The message is fixed at creation; delete the alarm and create a new one to change it. */ timing: { /** @enum {string} */ type: "once"; /** * Format: date-time * @description ISO 8601 UTC time at least 5m in the future. */ run_at: string; } | { /** @enum {string} */ type: "cron"; /** @description Five-field UTC cron expression, e.g. "0 *\/4 * * *". Runs must be at least 5m apart. */ cron: string; /** Format: date-time */ ends_at?: string; }; }; }; }; responses: { /** @description Updated alarm */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: number; /** @description Compatibility alias for id. */ alarm_id: string; /** @description One-time wake time; null for recurring cron alarms. */ wake_at: string | null; chat_session_id: number; message: string; timing: { /** @enum {string} */ type: "once"; /** * Format: date-time * @description ISO 8601 UTC time at least 5m in the future. */ run_at: string; } | { /** @enum {string} */ type: "cron"; /** @description Five-field UTC cron expression, e.g. "0 *\/4 * * *". Runs must be at least 5m apart. */ cron: string; /** Format: date-time */ ends_at?: string; }; /** @enum {string} */ status: "active" | "completed"; last_run_at: string | null; created_at: string; updated_at: string; }; }; }; }; /** @description Invalid alarm */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Alarm not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getChatSessionState: { parameters: { query?: { /** @description Page number (1-indexed). Default 1. */ page?: number; /** @description Entries per page (1-100). Default 50. */ per_page?: number; }; header?: never; path: { /** @description Chat session ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description A page of log entries (newest block first), plus user messages and sandbox state. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChatSessionStateResponse"]; }; }; /** @description Chat session not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listChatSessionTriggers: { parameters: { query?: never; header?: never; path: { id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Active triggers */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { triggers: { id: number; /** @enum {string} */ type: "event"; chat_session_id: number; event_type: string; entity_type: string; /** @description Exact entity id, or null when this trigger matches every entity. */ entity_id: string | null; /** @description Optional payload filters. Keys must be allowed for the selected event in the canonical event catalog. A primitive value is an equality match, and enum-like fields only accept the values the event emits. Numeric fields also accept a comparison object such as {"gt": 2} or {"gte": 1, "lte": 5}; operators combine with AND and never match null. */ payload_filter: { [key: string]: (string | number | boolean | { gt?: number; gte?: number; lt?: number; lte?: number; }) | null; }; /** * @description Whether the trigger is consumed after one successful delivery or remains active. Recurring triggers require a wildcard entity match. * @enum {string} */ cardinality: "one_shot" | "recurring"; /** @enum {string} */ status: "active"; created_at: string; }[]; }; }; }; }; /** @description Session not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createChatSessionTrigger: { parameters: { query?: never; header?: never; path: { id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": { /** @enum {string} */ type: "event"; /** @description A subscribable event_type from the canonical Empirical event catalog. */ event_type: string; /** @description Exact canonical entity id to match. Omit on create, or set null on update, to match every entity. */ entity_id?: string; /** @description Optional payload filters. Keys must be allowed for the selected event in the canonical event catalog. A primitive value is an equality match, and enum-like fields only accept the values the event emits. Numeric fields also accept a comparison object such as {"gt": 2} or {"gte": 1, "lte": 5}; operators combine with AND and never match null. */ payload_filter?: { [key: string]: (string | number | boolean | { gt?: number; gte?: number; lt?: number; lte?: number; }) | null; }; /** * @description Whether the trigger is consumed after one successful delivery or remains active. Recurring triggers require a wildcard entity match. * @enum {string} */ cardinality?: "one_shot" | "recurring"; }; }; }; responses: { /** @description Created trigger */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: number; /** @enum {string} */ type: "event"; chat_session_id: number; event_type: string; entity_type: string; /** @description Exact entity id, or null when this trigger matches every entity. */ entity_id: string | null; /** @description Optional payload filters. Keys must be allowed for the selected event in the canonical event catalog. A primitive value is an equality match, and enum-like fields only accept the values the event emits. Numeric fields also accept a comparison object such as {"gt": 2} or {"gte": 1, "lte": 5}; operators combine with AND and never match null. */ payload_filter: { [key: string]: (string | number | boolean | { gt?: number; gte?: number; lt?: number; lte?: number; }) | null; }; /** * @description Whether the trigger is consumed after one successful delivery or remains active. Recurring triggers require a wildcard entity match. * @enum {string} */ cardinality: "one_shot" | "recurring"; /** @enum {string} */ status: "active"; created_at: string; }; }; }; }; /** @description Invalid or unsubscribable event type */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Session not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Session is closed, or the test run already finished */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getChatSessionTrigger: { parameters: { query?: never; header?: never; path: { id: number; trigger_id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Trigger */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: number; /** @enum {string} */ type: "event"; chat_session_id: number; event_type: string; entity_type: string; /** @description Exact entity id, or null when this trigger matches every entity. */ entity_id: string | null; /** @description Optional payload filters. Keys must be allowed for the selected event in the canonical event catalog. A primitive value is an equality match, and enum-like fields only accept the values the event emits. Numeric fields also accept a comparison object such as {"gt": 2} or {"gte": 1, "lte": 5}; operators combine with AND and never match null. */ payload_filter: { [key: string]: (string | number | boolean | { gt?: number; gte?: number; lt?: number; lte?: number; }) | null; }; /** * @description Whether the trigger is consumed after one successful delivery or remains active. Recurring triggers require a wildcard entity match. * @enum {string} */ cardinality: "one_shot" | "recurring"; /** @enum {string} */ status: "active"; created_at: string; }; }; }; }; /** @description Session or trigger not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; deleteChatSessionTrigger: { parameters: { query?: never; header?: never; path: { id: number; trigger_id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Deleted */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Session or trigger not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateChatSessionTrigger: { parameters: { query?: never; header?: never; path: { id: number; trigger_id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description A subscribable event_type from the canonical Empirical event catalog. */ event_type?: string; /** @description Exact canonical entity id to match. Omit on create, or set null on update, to match every entity. */ entity_id?: string | null; /** @description Optional payload filters. Keys must be allowed for the selected event in the canonical event catalog. A primitive value is an equality match, and enum-like fields only accept the values the event emits. Numeric fields also accept a comparison object such as {"gt": 2} or {"gte": 1, "lte": 5}; operators combine with AND and never match null. */ payload_filter?: { [key: string]: (string | number | boolean | { gt?: number; gte?: number; lt?: number; lte?: number; }) | null; }; /** * @description Whether the trigger is consumed after one successful delivery or remains active. Recurring triggers require a wildcard entity match. * @enum {string} */ cardinality?: "one_shot" | "recurring"; }; }; }; responses: { /** @description Updated trigger */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: number; /** @enum {string} */ type: "event"; chat_session_id: number; event_type: string; entity_type: string; /** @description Exact entity id, or null when this trigger matches every entity. */ entity_id: string | null; /** @description Optional payload filters. Keys must be allowed for the selected event in the canonical event catalog. A primitive value is an equality match, and enum-like fields only accept the values the event emits. Numeric fields also accept a comparison object such as {"gt": 2} or {"gte": 1, "lte": 5}; operators combine with AND and never match null. */ payload_filter: { [key: string]: (string | number | boolean | { gt?: number; gte?: number; lt?: number; lte?: number; }) | null; }; /** * @description Whether the trigger is consumed after one successful delivery or remains active. Recurring triggers require a wildcard entity match. * @enum {string} */ cardinality: "one_shot" | "recurring"; /** @enum {string} */ status: "active"; created_at: string; }; }; }; }; /** @description Invalid or unsubscribable event type */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Session or trigger not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The test run already finished */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; checkFailureGroupMatcherOverlap: { parameters: { query?: never; header?: never; path: { /** @description Failure group ID. */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Candidate matcher source for this group: `async ({ testRun, testCase, traceUtils }) => boolean`. */ source: string; }; }; }; responses: { /** @description The other groups' cases the source claims. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Response payload. */ data: { /** @description Cases the source was run against. */ checked_cases: number; /** @description Candidate cases whose run or case could not be loaded. */ skipped_cases: number; /** @description True when candidates were dropped: more than 40 cases, or more than 500 open groups. */ truncated: boolean; /** @description Other groups' members the source returned true for. Empty means no overlap was found among the checked cases. */ claims: { group_id: string; label: string | null; test_run_id: number; pw_test_id: string; }[]; /** @description Cases where the source errored or was not run: no verdict, not a claim. */ errors: { group_id: string; label: string | null; test_run_id: number; pw_test_id: string; /** @description The matcher's error kind (compile, runtime, not_boolean, timeout, out_of_memory, executor), or budget when the check ran out of time before reaching the case. */ error_kind: string; error: string; }[]; }; }; }; }; /** @description Group not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; detachFailureGroupMember: { parameters: { query?: never; header?: never; path: { /** @description Failure group id. */ id: string; /** @description Member test to detach. */ test_case_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Membership detached. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FailureGroupDetachMemberResponse"]; }; }; /** @description Only humans and agents may detach a membership. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Group not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; matchFailureGroups: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Run holding the case to match. */ test_run_id: number; /** @description Case (Playwright test id) to match. Any status: failed or flaky. */ pw_test_id: string; /** @description Dry-run this matcher source instead of the groups' matchers: `async ({ testRun, testCase, traceUtils }) => boolean`. */ source?: string; /** @description Only run these groups' matchers. Default: every open group with a matcher. */ group_ids?: string[]; }; }; }; responses: { /** @description Matcher results for the case. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Response payload. */ data: { test_run_id: number; pw_test_id: string; /** * @description How many matchers returned true: one, several, or none. * @enum {string} */ decision: "single" | "multiple" | "none"; matched_group_ids: string[]; candidate_count: number; /** @description True when the project has more than 500 open groups and only the most recently seen were run. */ truncated: boolean; /** @description Matcher input contract the matchers ran under; store it with a matcher. */ contract_version: number; results: { /** @description The group whose matcher ran; null for a dry-run source. */ group_id: string | null; label: string | null; /** @description The matcher returned true. False on any error. */ matched: boolean; error?: string; /** @description compile, runtime, not_a_function, not_boolean, timeout, out_of_memory, or executor. */ error_kind?: string; duration_ms?: number; /** @description The matcher's console output. */ logs: string[]; /** @description Trace reads that threw, including ones the matcher caught: a false with trace errors means it could not tell, not that it did not match. */ trace_errors: { fn: string; message: string; swallowed?: boolean; }[]; }[]; }; }; }; }; /** @description Test run or case not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; convertPullRequestToDraft: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Repository owner. */ owner: string; /** @description Repository name. */ repo: string; /** @description Pull request number. */ pull_number: number; }; }; }; responses: { /** @description The PR is a draft. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubPrConvertToDraftResponse"]; }; }; /** @description The PR is not open. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubActionError"]; }; }; /** @description Caller cannot access the project. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; markPullRequestReadyForReview: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Repository owner. */ owner: string; /** @description Repository name. */ repo: string; /** @description Pull request number. */ pull_number: number; }; }; }; responses: { /** @description The PR is ready for review. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubPrReadyForReviewResponse"]; }; }; /** @description The PR is not open. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubActionError"]; }; }; /** @description Caller cannot access the project. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; githubProxy: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description HTTP method for the GitHub request. */ method: string; /** @description GitHub API path, e.g. `/repos/o/r`. */ url: string; /** @description Request body for write methods. */ body?: { [key: string]: unknown; }; /** @description GitHub App installation owner. Inferred from `/repos/{owner}/{repo}` URLs when omitted; otherwise defaults to `empirical-run`. */ owner?: string; }; }; }; responses: { /** @description The GitHub API JSON response, forwarded verbatim. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; /** @description A proxy rule rejected the request (including a squash or rebase PR merge), or GitHub returned a client error. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubProxyError"]; }; }; /** @description The URL uses a numeric repository id, the request writes to a protected branch, a project API key attempted a write, or a sandbox proxy rule forbade the request. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubProxyError"]; }; }; /** @description Any other GitHub upstream status is forwarded verbatim with an `{ error }` body. */ 502: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getGsheetMetadata: { parameters: { query: { /** @description ID of the Google spreadsheet to inspect. */ spreadsheet_id: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Spreadsheet metadata and access level. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GsheetMetadataResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Unexpected error. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GsheetPlainError"]; }; }; /** @description Upstream Google Sheets API error. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GsheetPlainError"]; }; }; }; }; proxyGsheetRequest: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description HTTP method to forward to the Google API. */ method: string; /** @description Absolute Google API URL to proxy. Must start with an allowed origin. */ url: string; /** @description Optional JSON body to forward with the request. */ body?: { [key: string]: unknown; }; }; }; }; responses: { /** @description Proxied Google API response. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GsheetProxyResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GsheetProxyBadRequest"]; }; }; /** @description Unexpected error. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GsheetPlainError"]; }; }; /** @description Upstream Google API error. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GsheetPlainError"]; }; }; }; }; listPlaywrightVersions: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Supported Playwright versions and the default version. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PlaywrightVersionsResponse"]; }; }; }; }; compareTraceAgainstPass: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Run holding the failed case. */ test_run_id: number; /** @description Case (Playwright test id) to compare. */ pw_test_id: string; /** @description Failed attempt to compare (retry_details.retries[].retryIndex). Default: the last failed attempt with a trace. */ retry?: number; /** @description Passing attempt to compare against. Default: a passing retry in the same run, else the last pass before this run in the same environment, else in any environment (30-day history). */ baseline?: { test_run_id: number; retry?: number; }; /** @description Include the page as each side left the focus step (base64). Default false. */ screenshots?: boolean; }; }; }; responses: { /** @description The comparison. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Response payload. */ data: { failure: { test_run_id: number; retry: number; file: string; }; baseline: { test_run_id: number; retry: number; file: string; /** @enum {string} */ source: "requested" | "same_run" | "same_environment" | "other_environment"; environment_id: number | null; } | null; /** @description Other recent passes, newest first. */ other_baselines: { test_run_id: number; environment_id: number | null; }[]; /** @description The deepest step where the failed attempt stopped, else where it first diverged; null when the steps match. */ focus: { /** @description Step position, nested steps dotted ("4.2"). */ index: string; /** * @description matched: ran in both. failed: where the failed attempt stopped. extra: only in the failed attempt. missing: only in the passing attempt, before the failure. not-reached: only in the passing attempt, after the failure. * @enum {string} */ kind: "matched" | "failed" | "extra" | "missing" | "not-reached"; title: string; location: string | null; pass_ms: number | null; fail_ms: number | null; error: string | null; /** @description At least 2x and 1s slower than in the passing attempt. */ slower: boolean; } | null; /** @description Aligned top-level steps, plus the nested steps on the path to the focus step. */ rows: { /** @description Step position, nested steps dotted ("4.2"). */ index: string; /** * @description matched: ran in both. failed: where the failed attempt stopped. extra: only in the failed attempt. missing: only in the passing attempt, before the failure. not-reached: only in the passing attempt, after the failure. * @enum {string} */ kind: "matched" | "failed" | "extra" | "missing" | "not-reached"; title: string; location: string | null; pass_ms: number | null; fail_ms: number | null; error: string | null; /** @description At least 2x and 1s slower than in the passing attempt. */ slower: boolean; }[]; screenshots: { pass: { mime_type: string; base64: string; } | null; fail: { mime_type: string; base64: string; } | null; } | null; /** @description Why there is no comparison (e.g. no passing attempt). */ note: string | null; }; }; }; }; /** @description Test run, case, or trace not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Reading a trace failed. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; queryTrace: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Run holding the case. */ test_run_id: number; /** @description Case (Playwright test id) whose trace to read. */ pw_test_id: string; /** @description Attempt to read (retry_details.retries[].retryIndex). Default: the last attempt with a trace. */ retry?: number; /** * @description trace-utils function to call: listSteps, getUniquePageIds, searchNetwork, getConsoleLogs, getWebSocketFrames, getDomSnapshot or extractScreenshots. * @enum {string} */ fn: "listSteps" | "getUniquePageIds" | "searchNetwork" | "getConsoleLogs" | "getWebSocketFrames" | "getDomSnapshot" | "extractScreenshots"; /** @description The function's arguments without `file` (e.g. { urlPattern, status, bodies } for searchNetwork). See the trace-utils skill. */ args?: { [key: string]: unknown; }; }; }; }; responses: { /** @description The function's result. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Response payload. */ data: { /** @description The trace.zip that was read. */ file: string; retry: number; fn: string; /** @description What the trace-utils function returned (screenshots carry base64 image data). */ result?: unknown; }; }; }; }; /** @description Test run, case, or trace not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The trace-utils call failed. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listTriageStatuses: { parameters: { query: { /** @description Return the triage statuses recorded for this test run. */ test_run_id: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The run's triage statuses. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TriageStatusListResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; upsertTriageStatus: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UpsertTriageStatusRequest"]; }; }; responses: { /** @description The triage status. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TriageStatusResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Sandbox authentication required. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run or failure group not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listUsers: { parameters: { query: { /** @description Search term matched against user name or email. */ query: string; /** @description Maximum users to return. Default 10; max 10. */ limit?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Matching users. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UsersListResponse"]; }; }; /** @description Invalid request or ambiguous project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getUser: { parameters: { query?: never; header?: never; path: { /** @description User ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description User details with connected accounts. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UserDetailResponse"]; }; }; /** @description User not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listActivity: { parameters: { query?: { /** @description Cursor from a previous page's `next_cursor`. */ before?: string; /** @description Days with activity per page. */ days?: number; /** @description IANA time zone that days are split in. */ timezone?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description A page of activity. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ActivityResponse"]; }; }; /** @description Invalid cursor or time zone. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createAlarm: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateAlarmRequest"]; }; }; responses: { /** @description The scheduled alarm. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AlarmResponse"]; }; }; /** @description Invalid duration or out of the allowed range. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Caller is not acting on behalf of a chat session. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Chat session not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Chat session is closed. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Scheduling is not available in this environment. */ 503: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listApiKeys: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The project's API keys. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ApiKeyListResponse"]; }; }; /** @description Invalid request or missing project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createApiKey: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateApiKeyRequest"]; }; }; responses: { /** @description The created API key. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ApiKeyCreateResponse"]; }; }; /** @description Invalid request or missing project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Failed to persist the API key. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; deleteApiKey: { parameters: { query?: never; header?: never; path: { /** @description API key ID (positive integer). */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The API key was deleted. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ApiKeySuccessResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description API key not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Failed to delete the API key. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateApiKey: { parameters: { query?: never; header?: never; path: { /** @description API key ID (positive integer). */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UpdateApiKeyRequest"]; }; }; responses: { /** @description The API key was updated. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ApiKeySuccessResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description API key not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Failed to update the API key. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listDashboardBanners: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Active banners. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DashboardBannersResponse"]; }; }; /** @description Missing project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getBillingMonthSummary: { parameters: { query?: { /** @description A UTC calendar month (YYYY-MM), for any org. Defaults to the current period. */ month?: string; /** @description A usage period by key (YYYY-MM-DD, from `/api/billing/periods`): a calendar month, or a billing cycle for an org on a live Dodo subscription. Defaults to the current period. */ period?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The month summary. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["BillingMonthSummaryResponse"]; }; }; /** @description Invalid month or period, or missing project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The project has no org. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listBillingPeriods: { parameters: { query?: { /** @description How many periods. Defaults to 2. */ count?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Usage periods, latest first. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["BillingPeriodsResponse"]; }; }; /** @description Invalid query, or missing project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The project has no org. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; reconcileSubscriptionUsage: { parameters: { query?: { cycle_end?: string; cycle_start?: string; }; header?: never; path: { /** @description Dodo subscription id. */ subscription_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The reconciliation. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SubscriptionUsageReconcileResponse"]; }; }; /** @description Payments are not configured, or an empty cycle. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description No such subscription. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createSubscriptionCheckout: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The checkout. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SubscriptionCheckoutResponse"]; }; }; /** @description Payments not configured, INR org, no plan for sale, or no email for the Dodo customer. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The project has no org. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The org already has a plan or a live subscription. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; endSubscription: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The plan has ended. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SubscriptionEndResponse"]; }; }; /** @description Payments are not configured. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The org has no active subscription. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The subscription is on hold (pay first), is already being ended, or can't be ended in Dodo right now. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getSubscriptionOffer: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The offer. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SubscriptionOfferResponse"]; }; }; }; }; createSubscriptionPortalSession: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The portal session. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SubscriptionPortalResponse"]; }; }; /** @description Payments are not configured. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The org has no Dodo customer. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; setUsageLimit: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Whole dollars, in cents; null removes it. */ cap_cents: number | null; }; }; }; responses: { /** @description The updated usage limit. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UsageLimitResponse"]; }; }; /** @description Invalid body, or the plan doesn't support a limit. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The project has no org. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listUsageLimitEvents: { parameters: { query?: { per_page?: number; /** @description Return events older than this id (pagination cursor). */ before_id?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Usage limit events. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UsageLimitEventsResponse"]; }; }; /** @description Invalid query, or missing project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The project has no org. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listChatSessions: { parameters: { query?: { /** @description Restrict to a single project (ignored for bound principals). */ project_id?: number; /** @description Include closed sessions when `true`. */ show_closed?: boolean | null; /** @description Filter sessions by preset (all, active, merged). */ preset?: "all" | "active" | "merged"; /** @description Page number (1-indexed). Default 1. */ page?: number; /** @description Items per page. Default 10. */ per_page?: number; /** @description Optional Manager sidebar category: executor sessions, or all non-manager/non-executor user-facing sessions. */ category?: "executor" | "user"; /** @description Comma-separated project IDs to include. */ project_ids?: string; /** @description Comma-separated project IDs to exclude. */ exclude_project_ids?: string; /** @description Comma-separated creator user IDs to filter by. */ user_ids?: string; /** @description Only sessions updated within this many days. */ updated_within_days?: number; /** @description URL-encoded JSON array of generic filter conditions. */ filters?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Page of chat sessions. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChatSessionListResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createChatSession: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { message?: string | null; /** @description Hive agent to run, as `` (its `@latest` version) or `@`, e.g. `main@3`. Defaults to `main`. Rejected with a 400 when Hive does not serve that agent or version. The agent version decides the runtime, model, tools and prompt; `model` still overrides its model. List agents with `GET /api/hive/agents`. */ agent?: string | null; /** * @deprecated * @description Deprecated alias of `agent`. The legacy values `chat` and `triage` mean the default agent. */ mode?: string | null; /** @description What the session is about. Each test run must belong to the session's project, otherwise the request fails with a 400. */ links?: { /** @enum {string} */ entity_type: "test_run"; entity_id: number; /** @description Tests in the run this session is scoped to. Omit for the whole run. */ pw_test_ids?: string[] | null; }[] | null; model?: string | null; /** @description Deprecated. Sessions start on the project default branch; a different branch is added to `message` as an instruction to work from it. */ base_branch?: string | null; created_by?: string | null; /** @description When the caller is an agent session, wake it the next time this session waits for input (one-shot). Defaults to true; pass false for a fire-and-forget message. Ignored for other callers. */ subscribe?: boolean | null; }; }; }; responses: { /** @description The created chat session. */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChatSessionCreateResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Billing blocked: an overdue invoice, a failed renewal, no active plan, or the spend limit reached. */ 402: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getChatSession: { parameters: { query?: never; header?: never; path: { /** @description Chat session ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The chat session. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChatSessionDetailResponse"]; }; }; /** @description Chat session not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; patchChatSession: { parameters: { query?: never; header?: never; path: { /** @description Chat session ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": { title?: string; model?: string; impacted_tests?: unknown; }; }; }; responses: { /** @description The updated chat session. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChatSessionPatchResponse"]; }; }; /** @description No fields provided to update. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Chat session not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getChatSessionBranches: { parameters: { query?: never; header?: never; path: { /** @description Chat session ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The session's branches. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChatSessionBranchesResponse"]; }; }; /** @description Chat session not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; closeChatSession: { parameters: { query?: never; header?: never; path: { /** @description Chat session ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The closed chat session. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChatSessionCloseResponse"]; }; }; /** @description Chat session not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getChatSessionCommitDiff: { parameters: { query?: never; header?: never; path: { /** @description Chat session ID. */ id: number; /** @description Commit SHA. */ hash: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The commit diff. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChatSessionCommitDiffResponse"]; }; }; /** @description Chat session, project, or commit diff not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getChatSessionCommitsDiffs: { parameters: { query?: { /** @description Comma-separated commit SHAs to fetch diffs for. */ hashes?: string; }; header?: never; path: { /** @description Chat session ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Diffs keyed by commit SHA. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChatSessionCommitsDiffsResponse"]; }; }; /** @description Missing 'hashes' query parameter. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Chat session or project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getChatSessionCosts: { parameters: { query?: never; header?: never; path: { /** @description Chat session ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Per-session cost and token totals. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChatSessionCostsResponse"]; }; }; /** @description Chat session not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Upstream cost-service response, passed through. */ 502: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getChatSessionCumulativeDiff: { parameters: { query?: { /** @description Head commit SHA to diff against the session's base branch. */ head_sha?: string; }; header?: never; path: { /** @description Chat session ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The cumulative diff. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChatSessionCumulativeDiffResponse"]; }; }; /** @description head_sha is required. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Chat session or project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getChatSessionDiff: { parameters: { query?: { /** @description Return the diff of this specific PR. Exactly one of pr_number or branch is required. */ pr_number?: number; /** @description Return the live comparison for this registered branch. Exactly one of branch or pr_number is required. */ branch?: string; }; header?: never; path: { /** @description Chat session ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The session diff. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChatSessionDiffResponse"]; }; }; /** @description Exactly one of pr_number or branch is required. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Chat session, project, or registered branch not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getChatSessionEntryRange: { parameters: { query: { /** @description First log_seq to return (inclusive). */ from_seq: number; /** @description Last log_seq to return (inclusive). */ to_seq: number; /** @description Maximum entries to return (1-200). Default 100. */ limit?: number; }; header?: never; path: { /** @description Chat session ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Entries in the range, and where the next page starts. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChatSessionEntryRangeResponse"]; }; }; /** @description Chat session not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getChatSessionEntryMedia: { parameters: { query?: never; header?: never; path: { id: number; entry_id: string; media_index: number | null; }; cookie?: never; }; requestBody?: never; responses: { /** @description The inline image bytes. */ 200: { headers: { [name: string]: unknown; }; content: { "application/octet-stream": string; }; }; /** @description Invalid media index. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Chat session, entry, or media not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Stored media type is unsupported. */ 415: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Stored media is not valid base64. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Unable to read session media. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getChatSessionLineage: { parameters: { query?: never; header?: never; path: { /** @description Chat session ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The chat session lineage. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Response payload. */ data: { /** @description The session used to resolve this lineage. */ selected_session_id: number; /** @description Whether older ancestors were omitted. */ has_more_ancestors: boolean; /** @description Whether descendant sessions were omitted. */ has_more_descendants: boolean; /** @description The bounded set of related sessions. */ nodes: { /** @description Chat session ID. */ id: number; /** @description Session title. */ title: string | null; /** * @description The session's role in the lineage graph. * @enum {string} */ kind: "manager" | "executor" | "session"; /** @description Creation timestamp (ISO). */ created_at: string; /** @description Last update timestamp (ISO). */ updated_at: string; /** @description Whether this session is closed. */ is_closed: boolean; }[]; /** @description Typed relationships between returned sessions. */ edges: { /** @description The session that created or preceded the child. */ parent_session_id: number; /** @description The created or successor session. */ child_session_id: number; /** * @description Whether the edge is a manager handoff or delegation. * @enum {string} */ relationship: "delegation" | "manager_handoff"; }[]; }; }; }; }; /** @description Chat session not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; confirmManagerHandoff: { parameters: { query?: never; header?: never; path: { /** @description Chat session ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": { note: string; revision: string | null; }; }; }; responses: { /** @description Manager handoff completed */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Response payload. */ data: { predecessor: components["schemas"]["ChatSession"]; successor: components["schemas"]["ChatSession"]; triggers: { alarms: { id: number; message: string; run_at: string | null; cron: string | null; ends_at: string | null; }[]; event_triggers: { id: number; event_type: string; entity_type: string; entity_id: string | null; payload_filter: { [key: string]: (string | number | boolean | { [key: string]: number; }) | null; }; message?: string; /** @enum {string} */ cardinality: "one_shot" | "recurring"; }[]; }; }; }; }; }; /** @description Chat session not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Manager changed or was already handed off */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; previewManagerHandoff: { parameters: { query?: never; header?: never; path: { /** @description Chat session ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Ephemeral handoff preview */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Response payload. */ data: { note: string; revision: string | null; }; }; }; }; /** @description Chat session not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Session is not an open manager */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; forwardChatSessionMessage: { parameters: { query?: never; header?: never; path: { /** @description Chat session ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": { message: string; /** @enum {string} */ send_action: "steer" | "follow_up"; created_by?: string | null; rpc_command_id?: string; /** @description When the caller is an agent session, wake it the next time this session waits for input (one-shot). Defaults to true; pass false for a fire-and-forget message. Ignored for other callers. */ subscribe?: boolean | null; }; }; }; responses: { /** @description The chat session. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChatSessionForwardMessageResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Billing admission denied. */ 402: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Chat session not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getChatSessionSandboxLogs: { parameters: { query?: never; header?: never; path: { /** @description Chat session ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Plain-text sandbox logs. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": string; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Sandbox logs not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxErrorMessage"]; }; }; }; }; getChatSessionSandboxCommit: { parameters: { query?: { /** @description Also return the commit's unified diff. */ include_diff?: "true" | "false"; }; header?: never; path: { /** @description Chat session ID. */ id: number; /** @description Full or abbreviated commit SHA. */ sha: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The commit. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxCommit"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Sandbox or commit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxErrorMessage"]; }; }; /** @description Sandbox is paused. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxErrorMessage"]; }; }; /** @description Reading the commit failed. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxErrorMessage"]; }; }; }; }; controlChatSessionSandbox: { parameters: { query?: never; header?: never; path: { /** @description Chat session ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": { /** * @description Lifecycle action to apply to the sandbox. `reprovision` builds a fresh sandbox for a session whose previous one failed to start (only acts from an errored/absent sandbox). * @enum {string} */ action: "pause" | "resume" | "reprovision"; }; }; }; responses: { /** @description Action applied. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxActionSuccess"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Sandbox not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxErrorMessage"]; }; }; /** @description Lifecycle control failed. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxErrorMessage"]; }; }; }; }; getChatSessionSandboxHealth: { parameters: { query?: never; header?: never; path: { /** @description Chat session ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Sandbox health. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxHealthResult"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Sandbox not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxErrorMessage"]; }; }; /** @description Sandbox is paused. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxErrorMessage"]; }; }; /** @description Health check failed. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxErrorMessage"]; }; }; }; }; applyChatSessionSandboxLifecycle: { parameters: { query?: never; header?: never; path: { /** @description Chat session ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": { /** @enum {string} */ type: "crashed"; /** @description Crash detail message. */ message: string; } | { /** @enum {string} */ type: "destroyed"; }; }; }; responses: { /** @description Event forwarded. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxLifecycleResult"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The session DO rejected the event. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxLifecycleResult"]; }; }; }; }; getChatSessionSnapshot: { parameters: { query?: never; header?: never; path: { /** @description Chat session ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Sandbox status, agent lifecycle, and user messages. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChatSessionSnapshotResponse"]; }; }; /** @description Chat session not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getChatSessionSubagents: { parameters: { query?: never; header?: never; path: { /** @description Chat session ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Subagents in start order. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChatSessionSubagentsResponse"]; }; }; /** @description Chat session not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getChatSessionSubagentEntries: { parameters: { query?: never; header?: never; path: { /** @description Chat session ID. */ id: number; /** @description Tool call that started the subagent. */ tool_call_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The subagent's entries, empty when no subagent started from that tool call. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChatSessionSubagentEntriesResponse"]; }; }; /** @description Chat session not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; subscribeChatSession: { parameters: { query?: never; header?: never; path: { id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Subscription outcome. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SubscribeChatSessionResponse"]; }; }; /** @description Cannot subscribe a session to itself. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Caller is not acting on behalf of a chat session. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Chat session not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Target session is closed. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getChatSessionTranscript: { parameters: { query?: never; header?: never; path: { /** @description Chat session ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Transcript rows, media referenced by message text, and the newest log_seq. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChatSessionTranscriptResponse"]; }; }; /** @description Chat session not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; registerChatSessionSandboxBranches: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Repository owner the branches were pushed to. */ owner: string; /** @description Repository name the branches were pushed to. */ repo: string; /** @description Branch names that were created/pushed. */ branches: string[]; }; }; }; responses: { /** @description Branches registered. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxBranchesRegistered"]; }; }; /** @description Invalid request, or the caller is not a sandbox principal. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxErrorMessage"]; }; }; /** @description The branch repository does not match the session's project. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxErrorMessage"]; }; }; /** @description Chat session not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxErrorMessage"]; }; }; }; }; getChatSessionSandboxProtectedBranches: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Protected branches. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxProtectedBranches"]; }; }; /** @description The caller is not a sandbox principal. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxErrorMessage"]; }; }; /** @description Chat session not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxErrorMessage"]; }; }; }; }; listChatSessionUsers: { parameters: { query?: { /** @description Restrict to a single project (ignored for bound principals). */ project_id?: number; /** @description Include closed sessions when `true`. */ show_closed?: boolean | null; /** @description Filter sessions by preset (all, active, merged). */ preset?: "all" | "active" | "merged"; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Distinct chat-session creators. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChatSessionUsersResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listCreditGrants: { parameters: { query?: { /** @description Organisation to list grants for. */ org_id?: number | null; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The organisation's credit grants. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditGrantListResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Organisation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createCreditGrant: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateCreditGrantRequest"]; }; }; responses: { /** @description The created credit grant. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditGrantResponse"]; }; }; /** @description Validation failed, the expiry is in the past, or the trial plan is missing or unusable. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Organisation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The organisation is on a plan that isn't a trial, or a trial would overlap another assignment. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listCreditOffers: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description All credit offers. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditOfferListResponse"]; }; }; }; }; createCreditOffer: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateCreditOfferRequest"]; }; }; responses: { /** @description The created credit offer. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditOfferResponse"]; }; }; /** @description Validation failed, the recipient is invalid, the deadline is in the past, or the trial plan is missing or unusable. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The email or domain already has an open offer, or a work domains offer is already open. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; revokeCreditOffer: { parameters: { query?: never; header?: never; path: { /** @description Credit offer ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The revoked credit offer. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditOfferResponse"]; }; }; /** @description Credit offer not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The offer was already claimed or revoked. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; dodoPaymentsWebhook: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Event type, e.g. "subscription.active". */ type: string; /** @description Event payload. */ data: { /** @description Dodo subscription ID. */ subscription_id?: string; }; }; }; }; responses: { /** @description Event acknowledged. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DodoWebhookAckResponse"]; }; }; /** @description Missing or invalid webhook signature. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Dodo API credentials are not configured. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listEnvironmentVariables: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The project's environment variables. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EnvironmentVariableListResponse"]; }; }; /** @description Invalid request or missing project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createEnvironmentVariable: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Variable name. */ name: string; /** @description Optional human-readable description. */ description?: string; /** @description Variable value. */ value: string; /** @description When true (default), applies to every environment. When false, scoped to environment_ids. */ all_environments?: boolean; /** @description Environment IDs this variable is scoped to. */ environment_ids?: number[]; }; }; }; responses: { /** @description The created environment variable. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EnvironmentVariableResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; deleteEnvironmentVariable: { parameters: { query?: never; header?: never; path: { /** @description Environment variable ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Deletion succeeded. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EnvironmentVariableSuccessResponse"]; }; }; /** @description Environment variable not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateEnvironmentVariable: { parameters: { query?: never; header?: never; path: { /** @description Environment variable ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Variable name. */ name: string; /** @description Variable value. */ value: string; /** @description Optional human-readable description. */ description?: string; /** @description When false, the variable is scoped to environment_ids. */ all_environments?: boolean; /** @description Environment IDs this variable is scoped to. */ environment_ids?: number[]; }; }; }; responses: { /** @description The updated environment variable. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EnvironmentVariableResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Environment variable not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; bulkDeleteEnvironmentVariables: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Environment variable IDs to delete. */ ids: number[]; }; }; }; responses: { /** @description Deletion succeeded. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EnvironmentVariableSuccessResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description One or more variables were not found or accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; bulkUpdateEnvironmentVariables: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Scoping updates to apply, one per variable. */ updates: { /** @description Environment variable ID. */ id: number; /** @description Whether the variable applies everywhere. */ all_environments: boolean; /** @description Environment IDs this variable is scoped to. */ environment_ids: number[]; }[]; }; }; }; responses: { /** @description Update succeeded. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EnvironmentVariableSuccessResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description One or more variables were not found or accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; mergeEnvironmentVariables: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Environment variable IDs to merge (at least 2). */ ids: number[]; }; }; }; responses: { /** @description The merged environment variables. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EnvironmentVariablesResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description One or more variables were not found or accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; importLoomFile: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ImportLoomFileRequest"]; }; }; responses: { /** @description The imported video. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ImportLoomFileResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Failed to process the Loom video. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; evaluateFlags: { parameters: { query: { /** @description Comma-separated flag keys to evaluate. */ keys: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Map of resolved flag values. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FlagsResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getGithubRateLimitReport: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Per-installation GitHub rate-limit report. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubRateLimitReportResponse"]; }; }; }; }; receiveAdminGithubEvent: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description Event accepted. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubAdminWebhookAck"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; searchRepositoryBranches: { parameters: { query: { /** @description Repository owner. */ owner: string; /** @description Repository name. */ repo: string; /** @description Branch-name search text. */ query?: string; /** @description Maximum number of matching branches to return. */ limit?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Matching repository branches. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubBranchSearchResponse"]; }; }; /** @description Repository not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description GitHub rejected the branch search. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getCommitDiff: { parameters: { query: { /** @description Repository owner. */ owner: string; /** @description Repository name. */ repo: string; /** @description Repository host; only `github` is supported. */ repo_host?: string; /** @description Commit SHA or ref. */ ref: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The commit diff. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubCommitDiffResponse"]; }; }; /** @description Only GitHub repositories are supported. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Commit diff not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; receiveGithubEvent: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description Event accepted. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubWebhookAck"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getRepoFile: { parameters: { query: { /** @description Repository owner. */ owner: string; /** @description Repository name. */ repo: string; /** @description Repository host; only `github` is supported. */ repo_host?: string; /** @description File path within the repo. */ path: string; /** @description Branch, tag, or commit SHA to read from. */ ref?: string; /** @description Fallback branch when `ref` does not exist. */ baseBranch?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The file contents. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubFileContentsResponse"]; }; }; /** @description Only GitHub repositories are supported. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description File does not exist at the ref. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Path did not resolve to a file. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; putRepoFile: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Repository owner. */ owner: string; /** @description Repository name. */ repo: string; /** @description File path within the repo. */ path: string; /** @description New file contents (required on write). */ content?: string; /** @description Blob SHA of the file being replaced/deleted. */ sha?: string; }; }; }; responses: { /** @description The GitHub mutation response. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubFileMutationResponse"]; }; }; /** @description Missing required field: content. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; deleteRepoFile: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Repository owner. */ owner: string; /** @description Repository name. */ repo: string; /** @description File path within the repo. */ path: string; /** @description New file contents (required on write). */ content?: string; /** @description Blob SHA of the file being replaced/deleted. */ sha?: string; }; }; }; responses: { /** @description The GitHub mutation response. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubFileMutationResponse"]; }; }; /** @description Missing required field: sha. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listMainInstallations: { parameters: { query: { /** @description Project whose org's installs to read. */ project_id: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Main App installations for the org. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GhMainInstallListResponse"]; }; }; /** @description Project does not belong to an org. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; upsertMainInstallation: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Org ID. */ org_id: number; /** @description GitHub App installation ID. */ app_installation_id: string; /** @description GitHub organization login. */ gh_organization?: string; /** @description Repositories accessible to the installation. */ gh_repos?: { id: number; node_id: string; name: string; full_name: string; private: boolean; }[]; }; }; }; responses: { /** @description The upserted main App installation. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GhMainInstallResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Caller cannot access the organisation. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getMainInstallationMetadata: { parameters: { query?: never; header?: never; path: { /** @description GitHub App installation ID. */ app_installation_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Main App installation metadata. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GhMainMetadataResponse"]; }; }; /** @description Installation metadata was not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; closePullRequest: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Repository owner. */ owner: string; /** @description Repository name. */ repo: string; /** @description Pull request number. */ pull_number: number; }; }; }; responses: { /** @description The PR was closed. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubPrCloseResponse"]; }; }; /** @description The PR is not open, or could not be closed. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubActionError"]; }; }; /** @description Caller cannot access the project. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getPullRequestImpactedTests: { parameters: { query: { /** @description Repository owner. */ owner: string; /** @description Repository name. */ repo: string; /** @description Pull request number. */ pull_number: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The pull request's impacted tests. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubPrImpactedTestsResponse"]; }; }; /** @description Project or pull request not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; mergePullRequest: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Repository owner. */ owner: string; /** @description Repository name. */ repo: string; /** @description Pull request number. */ pull_number: number; }; }; }; responses: { /** @description The PR was merged. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubPrMergeResponse"]; }; }; /** @description The PR is not open, is a draft, is not mergeable, or GitHub refused the merge. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubActionError"]; }; }; /** @description Caller cannot access the project. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description GitHub is still computing mergeability. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubActionError"]; }; }; }; }; getPullRequestMergeability: { parameters: { query: { /** @description Repository owner. */ owner: string; /** @description Repository name. */ repo: string; /** @description Pull request number. */ pull_number: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The mergeability status. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubPrMergeabilityResponse"]; }; }; }; }; getPullRequestReview: { parameters: { query: { /** @description Repository owner. */ owner: string; /** @description Repository name. */ repo: string; /** @description Pull request number. */ pull_number: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The pull request review. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubPrReviewResponse"]; }; }; /** @description Project or pull request not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getPullRequestReviewTarget: { parameters: { query: { /** @description Repository owner. */ owner: string; /** @description Repository name. */ repo: string; /** @description Pull request number. */ pull_number: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The pull request's review target. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubPrReviewTargetResponse"]; }; }; /** @description Project, pull request, or owning session not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listReporterDeliveries: { parameters: { query: { /** @description Project whose reporter deliveries to list. */ project_id: number; /** @description Max rows per delivery kind (newest first). */ limit?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Reporter check runs, PR comments and linked test changes checks. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GhReporterDeliveriesResponse"]; }; }; /** @description Project does not belong to an org. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; receiveReporterGithubEvent: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description Event accepted. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GhReporterWebhookAck"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listReporterInstallations: { parameters: { query: { /** @description Project whose org's reporter installs to read. */ project_id: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Reporter App installations for the org. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GhReporterInstallListResponse"]; }; }; /** @description Project does not belong to an org. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createReporterInstallation: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { org_id: number; app_installation_id?: string; permissions: { /** @enum {string} */ metadata: "read"; /** @enum {string} */ checks?: "write" | "read"; /** @enum {string} */ pull_requests?: "write" | "read"; /** @enum {string} */ contents?: "write" | "read"; /** @enum {string} */ issues?: "write" | "read"; /** @enum {string} */ merge_queues?: "write" | "read"; /** @enum {string} */ repository_custom_properties?: "write" | "read"; } & { [key: string]: unknown; }; gh_organization?: string; gh_repos?: { id: number; node_id: string; name: string; full_name: string; private: boolean; }[]; /** @enum {string} */ installation_status: "requested" | "installed"; }; }; }; responses: { /** @description The created reporter installation. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GhReporterInstallResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Caller cannot access the organisation. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getReporterInstallationMetadata: { parameters: { query?: never; header?: never; path: { /** @description GitHub App installation ID. */ app_installation_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Reporter installation metadata. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GhReporterMetadataResponse"]; }; }; /** @description Installation or its metadata was not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; mergeReporterInstallations: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { new_entry_id: number; old_entry_id: number; }; }; }; responses: { /** @description The merged reporter installation. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GhReporterInstallResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listReporterMergeCandidates: { parameters: { query: { /** @description Project whose org's reporter installs to read. */ project_id: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Reporter installations eligible for merging. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GhReporterInstallListResponse"]; }; }; /** @description Project does not belong to an org. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getReporterPullRequest: { parameters: { query: { /** @description Project whose reporter App reads the PR. */ project_id: number; repo_owner: string; repo_name: string; /** @description App PR number. When omitted, the PR is found by head_sha. */ pr_number?: number; /** @description Commit the reporter delivered to. Compared against the PR's current head; also used to find the PR when pr_number is omitted. */ head_sha?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The PR's current state and head. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GhReporterPullRequestResponse"]; }; }; /** @description Neither pr_number nor head_sha given. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project, installation or pull request not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getRepoTree: { parameters: { query: { /** @description Repository owner. */ owner: string; /** @description Repository name. */ repo: string; /** @description Repository host; only `github` is supported. */ repo_host?: string; /** @description Unused; reserved. */ path?: string; /** @description Branch or ref to read the tree from. */ ref?: string; /** @description Fallback branch when `ref` does not exist. */ baseBranch?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The repository tree. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubTreeResponse"]; }; }; /** @description Only GitHub repositories are supported. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Repository or ref not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listHiveAgents: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The available Hive agents. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HiveAgentsResponse"]; }; }; /** @description Hive is not configured or the request failed. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Hive returned an error response. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listHiveModels: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The available Hive models. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HiveModelsResponse"]; }; }; /** @description Hive is not configured or the request failed. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Hive returned an error response. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; proxyInbox: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["PlaywrightUtilsProxyRequest"]; }; }; responses: { /** @description Upstream provider response: its JSON body under `data` plus the upstream `headers`. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PlaywrightUtilsProxyResponse"]; }; }; /** @description Invalid request body. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Provider API key is not configured, or the proxied request failed. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PlaywrightUtilsProxyError"]; }; }; /** @description The upstream provider's status code is forwarded unchanged (any non-2xx is passed through) with the same `{ data, headers }` body. */ 502: { headers: { [name: string]: unknown; }; content?: never; }; }; }; sendFixtureLoginEmail: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["FixtureLoginEmailRequest"]; }; }; responses: { /** @description The email was sent. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FixtureLoginEmailResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; jiraWebhook: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["RequestIngestionWebhook"]; }; }; responses: { /** @description Webhook processed. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["JiraWebhookResponse"]; }; }; /** @description Invalid webhook payload. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description No matching install or project. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; linearWebhook: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["RequestIngestionWebhook"]; }; }; responses: { /** @description Webhook accepted. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LinearWebhookResponse"]; }; }; /** @description Invalid webhook payload. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Invalid signature. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description No matching install or project. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; refreshSandboxToken: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description A freshly minted sandbox access token. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxAuthRefreshResponse"]; }; }; /** @description Missing/malformed refresh token, or unknown session. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxAuthRefreshError"]; }; }; /** @description The session is revoked, expired, or not tied to a chat session. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxAuthRefreshError"]; }; }; }; }; scheduleSnoozeExpiry: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ScheduleSnoozeExpiryRequest"]; }; }; responses: { /** @description The alarm was registered. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ScheduleSnoozeExpiryResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; seedChatSession: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ChatSessionSeedRequest"]; }; }; responses: { /** @description The seeded chat session. */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChatSessionSeedResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Not available in this environment. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listServiceTokens: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The service tokens. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ServiceTokenListResponse"]; }; }; }; }; createServiceToken: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Name of the service the token is issued to (alphanumerics, `_` and `-`). */ service: string; }; }; }; responses: { /** @description The issued service token. */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ServiceTokenCreatedResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Failed to issue service token. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; revokeServiceToken: { parameters: { query?: never; header?: never; path: { /** @description Service token ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The revoked service token. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ServiceTokenResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Service token not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; handleSpotInterruption: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["SpotInterruptionRequest"]; }; }; responses: { /** @description The event was handled. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SpotInterruptionResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; enqueueTestCasesSync: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["EnqueueTestCasesSyncRequest"]; }; }; responses: { /** @description The sync job was enqueued. */ 202: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EnqueueTestCasesSyncResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The jobs queue is not configured. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listInvoices: { parameters: { query?: { /** @description Page number (1-indexed). Default 1. */ page?: string; /** @description Items per page. Default 20. */ per_page?: string; /** @description Filter to invoices for this organisation. */ org_id?: string; /** @description Filter by payment status. */ paid_status?: string; /** @description Filter by issue month (YYYY-MM). */ issue_month?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Paginated list of invoices. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["InvoiceListResponse"]; }; }; }; }; createInvoice: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { number: string; org_id: number; /** Format: date-time */ issue_date?: string | null; /** Format: date-time */ due_date?: string | null; currency: string; amount_in_cents: number; invoice_pdf_url?: string | null; /** Format: uri */ payment_link?: string | null; send_status: string; paid_status: string; /** Format: date-time */ paid_at?: string | null; paid_minor?: number | null; line_items: { item_name: string; sub_item_name: string; sac_hsn: string; quantity: number; unit_price: number; }[]; tax_details: { tax_name: string; tax_percentage: number; }[]; /** Format: date-time */ first_reminder_sent_at?: string | null; /** Format: date-time */ second_reminder_sent_at?: string | null; }; }; }; responses: { /** @description The created invoice. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["InvoiceResponse"]; }; }; /** @description Invalid request or unknown organisation. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"] | components["schemas"]["InvoiceSimpleError"]; }; }; /** @description The organisation is billed by Dodo. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getInvoice: { parameters: { query?: never; header?: never; path: { /** @description Invoice ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The invoice. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["InvoiceResponse"]; }; }; /** @description Invalid invoice id. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Invoice not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateInvoice: { parameters: { query?: never; header?: never; path: { /** @description Invoice ID. */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": { number?: string; org_id?: number; /** Format: date-time */ issue_date?: string | null; /** Format: date-time */ due_date?: string | null; currency?: string; amount_in_cents?: number; invoice_pdf_url?: string | null; /** Format: uri */ payment_link?: string | null; send_status?: string; paid_status?: string; /** Format: date-time */ paid_at?: string | null; paid_minor?: number | null; line_items?: { item_name: string; sub_item_name: string; sac_hsn: string; quantity: number; unit_price: number; }[]; tax_details?: { tax_name: string; tax_percentage: number; }[]; /** Format: date-time */ first_reminder_sent_at?: string | null; /** Format: date-time */ second_reminder_sent_at?: string | null; }; }; }; responses: { /** @description The updated invoice. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["InvoiceResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Invoice not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The target organisation is billed by Dodo. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listInvoiceBillingLines: { parameters: { query?: never; header?: never; path: { /** @description Invoice ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The invoice's billing lines. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["InvoiceBillingLinesResponse"]; }; }; /** @description Invalid invoice id. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Invoice not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; replaceInvoiceBillingLines: { parameters: { query?: never; header?: never; path: { /** @description Invoice ID. */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ReplaceInvoiceBillingLinesRequest"]; }; }; responses: { /** @description The invoice's updated billing lines. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["InvoiceBillingLinesResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Invoice not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; previewInvoiceEmail: { parameters: { query?: { /** @description When `true`, preview the test email (sent to the internal test recipient). Defaults to `false`. */ is_test_email?: "true" | "false"; }; header?: never; path: { /** @description Invoice ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The rendered email. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Response payload. */ data: { /** @description Sender address. */ from: string; /** @description To recipients. */ to: string[]; /** @description CC recipients. */ cc: string[]; /** @description BCC recipients. */ bcc: string[]; /** @description Reply-To addresses. */ reply_to: string[]; /** @description Email subject. */ subject: string; /** @description Rendered email body HTML. */ html: string; /** @description Attached PDF filename, or null when the invoice has no PDF. */ attachment_filename: string | null; }; }; }; }; /** @description Invalid invoice ID or organisation not found. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Invoice not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; generateInvoicePdf: { parameters: { query?: never; header?: never; path: { /** @description Invoice ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The generated invoice PDF. */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string; }; }; /** @description Invalid invoice id, missing org, or invalid invoice data. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Invoice not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Failed to generate the PDF. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["InvoiceGenerateError"]; }; }; }; }; setInvoicePaymentStatus: { parameters: { query?: never; header?: never; path: { /** @description Invoice ID. */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": { /** * @description The reconciled payment status to mirror onto the invoice. * @enum {string} */ status: "paid" | "partially_paid" | "outstanding"; /** * Format: date-time * @description When the invoice was fully paid; null otherwise. */ paid_at?: string | null; /** @description Σ of allocated credit amounts in minor units. */ paid_minor?: number | null; /** @description Origin of the write, e.g. "fin-recon". */ source: string; /** @description Match confidence in [0,1], if available. */ confidence?: number; /** @description Bank credits (from fin) that settle this invoice. */ credit_refs?: components["schemas"]["InvoiceCreditRef"][]; }; }; }; responses: { /** @description The mirrored invoice. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["InvoicePaymentStatusResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Invoice not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getInvoicePdfDownloadUrl: { parameters: { query?: never; header?: never; path: { /** @description Invoice ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The PDF download URL. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["InvoicePdfDownloadUrlResponse"]; }; }; /** @description Invalid invoice id. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Invoice not found or has no PDF. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; downloadInvoicePdf: { parameters: { query?: never; header?: never; path: { /** @description Invoice ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The invoice PDF. */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string; }; }; /** @description Invalid invoice id. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Invoice or its PDF not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; sendInvoice: { parameters: { query?: never; header?: never; path: { /** @description Invoice ID. */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": { is_test_email?: boolean; }; }; }; responses: { /** @description The invoice was sent. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SendInvoiceResponse"]; }; }; /** @description Invalid request, missing PDF, missing org/billing emails, or no due date. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Invoice not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The organisation is billed by Dodo. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listOrgInvoices: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The org's invoices. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OrgInvoiceListResponse"]; }; }; /** @description Invalid request or missing project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; downloadOrgInvoicePdf: { parameters: { query?: never; header?: never; path: { /** @description Invoice ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The invoice PDF. */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string; }; }; /** @description Invalid invoice id. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Invoice or its PDF not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createInvoiceRazorpayOrder: { parameters: { query?: never; header?: never; path: { /** @description Invoice ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The Razorpay order. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["InvoiceRazorpayOrderResponse"]; }; }; /** @description Invalid request, unsupported currency, or Razorpay not configured. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Invoice not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Invoice has no outstanding amount. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; verifyInvoiceRazorpayPayment: { parameters: { query?: never; header?: never; path: { /** @description Invoice ID. */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["VerifyInvoiceRazorpayPaymentRequest"]; }; }; responses: { /** @description The settled payment state. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["VerifyInvoiceRazorpayPaymentResponse"]; }; }; /** @description Invalid request, signature mismatch, order/invoice mismatch, or Razorpay not configured. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Invoice not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Payment not in a settled state. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listUpcomingInvoiceReminders: { parameters: { query?: { /** @description Number of upcoming days to preview. Default 7. */ window_days?: string; /** @description Page number (1-indexed). Default 1. */ page?: string; /** @description Items per page. Default 50. */ per_page?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Paginated upcoming invoice reminders. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UpcomingInvoiceRemindersResponse"]; }; }; }; }; receiveJiraWebhook: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["RequestIngestionProviderPayload"]; }; }; responses: { /** @description Webhook processed. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["JiraWebhookResponse"]; }; }; /** @description Invalid webhook payload. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description No matching install or project. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listJiraInstallations: { parameters: { query: { /** @description Organisation ID to list installations for. */ org_id: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Jira installations for the organisation. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["JiraInstallationListResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Caller cannot access the organisation. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createJiraInstallation: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateJiraInstallationRequest"]; }; }; responses: { /** @description The created or reauthorized installation. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["JiraInstallationResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Atlassian rejected the OAuth code. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Caller cannot access the organisation. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The Jira site belongs to another organisation. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Failed to save the installation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateJiraProjectMappings: { parameters: { query?: never; header?: never; path: { /** @description Jira app installation ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UpdateJiraProjectMappingsRequest"]; }; }; responses: { /** @description The updated installation. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["JiraInstallationRecordResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description No Jira app installed. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; refreshJiraWebhook: { parameters: { query?: never; header?: never; path: { /** @description Jira app installation ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The webhook was refreshed. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["JiraSuccessResponse"]; }; }; /** @description No Jira app installed. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Jira reauthorization is required. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; revokeJiraInstallation: { parameters: { query?: never; header?: never; path: { /** @description Jira app installation ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The installation was revoked. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["JiraSuccessResponse"]; }; }; /** @description No Jira app installed. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; validateJiraInstallation: { parameters: { query?: never; header?: never; path: { /** @description Jira app installation ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Token is valid; webhook status. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["JiraValidationResponse"]; }; }; /** @description Invalid Jira token. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description No Jira app installed. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateJiraWebhookExpiresAt: { parameters: { query?: never; header?: never; path: { /** @description Jira app installation ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UpdateJiraWebhookExpiresAtRequest"]; }; }; responses: { /** @description The updated installation. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["JiraInstallationRecordResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description No Jira app installed. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; receiveLinearWebhook: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["RequestIngestionProviderPayload"]; }; }; responses: { /** @description Webhook accepted. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LinearWebhookResponse"]; }; }; /** @description Invalid webhook payload. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Invalid signature. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description No matching install or project. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listLinearInstallations: { parameters: { query: { /** @description Organization whose installations to list. */ org_id: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Installations for the organization. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LinearInstallListResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createLinearInstallation: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Organization the installation belongs to. */ org_id: number; /** @description OAuth code from Linear's redirect. Required for a signed-in user. */ code?: string; /** * Format: uri * @description Redirect URI the authorize request used; Linear requires it to match. Required with `code`. */ redirect_uri?: string; /** @description Linear app user (actor) id. System callers only. */ linear_app_user_id?: string; /** @description Linear organization id. System callers only. */ linear_organization_id?: string; /** @description OAuth access token. System callers only. */ linear_access_token?: string; /** @description OAuth refresh token. System callers only. */ linear_refresh_token?: string; /** * Format: date-time * @description Expiry of the access token. System callers only. */ linear_access_token_expires_at?: string | null; /** @description Cached Linear organization/team metadata. System callers only; built from Linear for users. */ metadata?: { organization: { name: string; urlKey: string; }; actor: { name: string; email: string; }; teams: { id: string; name: string; key: string; }[]; }; }; }; }; responses: { /** @description The created or reauthorized installation. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LinearInstallCreateResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Linear rejected the OAuth code. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Failed to save the installation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; deleteLinearInstallation: { parameters: { query?: never; header?: never; path: { /** @description Linear app installation ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The installation was deleted. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LinearSuccessResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description No Linear app installed. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateLinearProjectMappings: { parameters: { query?: never; header?: never; path: { /** @description Linear app installation ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Map of Linear team key to Empirical project id. */ project_mappings: { [key: string]: number; }; }; }; }; responses: { /** @description The updated installation. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LinearProjectMappingsResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description No Linear app installed. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; revokeLinearInstallation: { parameters: { query?: never; header?: never; path: { /** @description Linear app installation ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The installation was revoked. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LinearSuccessResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description No Linear app installed. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Failed to revoke the Linear token. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; validateLinearInstallation: { parameters: { query?: never; header?: never; path: { /** @description Linear app installation ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Validation result. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LinearValidateResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Invalid Linear token. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description No Linear app installed. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Error backfilling Linear metadata. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; proxyMailosaur: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["PlaywrightUtilsProxyRequest"]; }; }; responses: { /** @description Upstream provider response: its JSON body under `data` plus the upstream `headers`. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PlaywrightUtilsProxyResponse"]; }; }; /** @description Invalid request body. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Provider API key is not configured, or the proxied request failed. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PlaywrightUtilsProxyError"]; }; }; /** @description The upstream provider's status code is forwarded unchanged (any non-2xx is passed through) with the same `{ data, headers }` body. */ 502: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listMemories: { parameters: { query?: { /** @description Page number (1-indexed). */ page?: number; /** @description Items per page (max 100). */ per_page?: number; /** @description Filter to memories with this exact name. */ name?: string; /** @description Only memories updated after this ISO 8601 instant. Creates, edits and deletes all move `updated_at`; combine with `include_deleted=true` to see deletions too. */ updated_since?: string; /** @description When `true`, soft-deleted memories are included in the listing (marked via `deleted_at`). Defaults to `false`. */ include_deleted?: "true" | "false"; /** @description When `false`, each memory's `content` is returned as an empty string (skipped for a smaller/faster response). Use for name+description index views. Defaults to `true`. */ include_content?: "true" | "false"; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The page of memories. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MemoryListResponse"]; }; }; /** @description Invalid request or missing project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createMemory: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateMemoryRequest"]; }; }; responses: { /** @description The created memory. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MemoryWriteResponse"]; }; }; /** @description Invalid request or missing project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description A memory with this source_path already exists. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Refused by the memory write gate: classified as failure/incident state. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MemoryWriteRejectedResponse"]; }; }; }; }; getMemory: { parameters: { query?: never; header?: never; path: { /** @description Memory ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The memory. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MemoryResponse"]; }; }; /** @description Memory not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; deleteMemory: { parameters: { query?: never; header?: never; path: { /** @description Memory ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["DeleteMemoryRequest"]; }; }; responses: { /** @description Deletion succeeded. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MemoryDeleteResponse"]; }; }; /** @description Memory not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateMemory: { parameters: { query?: never; header?: never; path: { /** @description Memory ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UpdateMemoryRequest"]; }; }; responses: { /** @description The updated memory. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MemoryWriteResponse"]; }; }; /** @description Memory not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Refused by the memory write gate: classified as failure/incident state. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MemoryWriteRejectedResponse"]; }; }; }; }; listMemoryVersions: { parameters: { query?: never; header?: never; path: { /** @description Memory ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The memory's versions. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MemoryVersionListResponse"]; }; }; /** @description Memory not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listMemoryActivity: { parameters: { query?: { /** @description Window for the `daily` series, in days back from now. Per-memory stats always cover full history. Defaults to 90. */ since_days?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Memory activity. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MemoryActivityResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listMemoryChanges: { parameters: { query: { /** @description Chat session whose memory changes to list. */ chat_session_id: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The session's memory changes. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MemoryChangesResponse"]; }; }; /** @description Invalid request or missing project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listMemoryClassifications: { parameters: { query?: { /** @description Limit to memories in this project. Defaults to all projects. */ project_id?: number; /** @description Vocabulary version to read labels for. Defaults to the current vocabulary. */ vocabulary_version?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Memory classifications. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MemoryClassificationsResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getMemoryUsage: { parameters: { query?: { /** @description Window in days back from now. Defaults to 7. */ days?: number; /** @description Rows per list. Defaults to 10. */ limit?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Memory usage. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MemoryUsageResponse"]; }; }; /** @description Invalid request or missing project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listNotifications: { parameters: { query?: { /** @description Maximum read notifications to return. Default 20. */ read_limit?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The user's notifications. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["NotificationListResponse"]; }; }; /** @description Only signed-in users have notifications. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; markNotificationRead: { parameters: { query?: never; header?: never; path: { /** @description Notification ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The notification's read time. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["NotificationReadResponse"]; }; }; /** @description Only signed-in users have notifications. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Notification not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createDummyNotification: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateDummyNotificationBody"]; }; }; responses: { /** @description The created notification. */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DummyNotificationResponse"]; }; }; /** @description Only signed-in users have notifications. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Not available, or nothing to notify about. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; markAllNotificationsRead: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description How many notifications were marked read. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["NotificationsReadAllResponse"]; }; }; /** @description Only signed-in users have notifications. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getOAuthAuthorizeUrl: { parameters: { query: { /** @description OAuth provider. */ provider: "slack" | "linear" | "jira" | "github"; /** @description The dashboard callback the provider returns to. */ redirect_uri: string; /** @description CSRF state, echoed back to the callback. */ state: string; /** @description Slack only: pins the install to a workspace, so re-auth updates it instead of showing a picker. */ team?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The authorize URL. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description The provider's authorize URL. */ url: string; }; }; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The provider's client ID is not configured. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getOAuthClient: { parameters: { query?: never; header?: never; path: { /** @description OAuth client ID. */ client_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The OAuth client. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { client_id: string; /** @description Name the app gave itself. */ name: string; /** * @description dynamic: the app registered itself and is unverified. manual: registered by Empirical. * @enum {string} */ registration_type: "dynamic" | "manual"; /** @description Hosts the app receives access tokens on. */ redirect_hosts: string[]; /** @description Whether any redirect goes to a loopback address, i.e. an app on the user's own computer. */ redirects_to_this_device: boolean; }; }; }; }; /** @description No OAuth client with this ID. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listOrderForms: { parameters: { query?: { /** @description Page number (1-indexed). Default 1. */ page?: string; /** @description Items per page. Default 20. */ per_page?: string; /** @description Filter by organisation ID. */ org_id?: string; /** @description Filter by status. */ status?: string; /** @description Filter by pricing model (`slab` or `fixed`). */ pricing_model?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Paginated list of order forms. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OrderFormListResponse"]; }; }; }; }; createOrderForm: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateOrderFormRequest"]; }; }; responses: { /** @description The created order form. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OrderFormResponse"]; }; }; /** @description Invalid request, or the referenced organisation does not exist. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"] | components["schemas"]["OrderFormOrgNotFoundError"]; }; }; /** @description Failed to load the created order form. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getOrderForm: { parameters: { query?: never; header?: never; path: { /** @description Order form ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The order form. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OrderFormResponse"]; }; }; /** @description Missing or invalid order form ID. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Order form not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateOrderForm: { parameters: { query?: never; header?: never; path: { /** @description Order form ID. */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UpdateOrderFormRequest"]; }; }; responses: { /** @description The updated order form. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OrderFormResponse"]; }; }; /** @description Missing or invalid order form ID, or invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Order form not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; uploadOrderFormPdf: { parameters: { query?: never; header?: never; path: { /** @description Order form ID. */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["OrderFormPdfUploadRequest"]; }; }; responses: { /** @description The order form with the stored PDF key. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OrderFormResponse"]; }; }; /** @description Missing or invalid order form ID, or invalid base64 payload. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Order form not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; downloadOrderFormPdf: { parameters: { query?: never; header?: never; path: { /** @description Order form ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The order form PDF. */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string; }; }; /** @description Missing or invalid order form ID. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Order form or its PDF not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listOrgs: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Organizations the principal can access, with their projects. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OrgListResponse"]; }; }; }; }; createOrg: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["OrgCreateRequest"]; }; }; responses: { /** @description The created organization. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OrgCreateResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateOrg: { parameters: { query?: never; header?: never; path: { /** @description Organization ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["OrgUpdateRequest"]; }; }; responses: { /** @description The updated organization. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OrgUpdateResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Organization not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description An email domain is already claimed by another org. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listOrgInvites: { parameters: { query?: never; header?: never; path: { /** @description Organization ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Invites for the organization. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OrgInviteListResponse"]; }; }; /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createOrgInvite: { parameters: { query?: never; header?: never; path: { /** @description Organization ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateOrgInviteRequest"]; }; }; responses: { /** @description The created invite. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OrgInviteResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Organization not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; revokeOrgInvite: { parameters: { query?: never; header?: never; path: { /** @description Organization ID. */ id: number; /** @description Invite ID. */ invite_id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The revoked invite. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OrgInviteRevokeResponse"]; }; }; /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Pending invite not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listOrgMembers: { parameters: { query?: { /** @description Case-insensitive substring match on email or name. */ search?: string; /** @description Page number (1-indexed). */ page?: number; /** @description Items per page (capped at 100). */ per_page?: number; }; header?: never; path: { /** @description Organization ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Paginated organization members. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OrgMembersResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; removeOrgMember: { parameters: { query?: never; header?: never; path: { /** @description Organization ID. */ id: number; /** @description Supabase user id of the member. */ user_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Removal result. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RemoveMemberResponse"]; }; }; /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listOrgsByEmailDomain: { parameters: { query: { /** @description Email domain to match against org email_domains. */ domain: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Organizations matching the email domain (id and name only). */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OrgsByEmailDomainResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; resolveMembership: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ResolveMembershipRequest"]; }; }; responses: { /** @description The user's memberships and super-admin flag after resolution. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ResolveMembershipResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The user's email is not confirmed. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listPlanAssignments: { parameters: { query?: { /** @description Page number (1-indexed). */ page?: number; /** @description Items per page. */ per_page?: number; /** @description Filter to assignments for this organisation. */ org_id?: number | null; /** @description Filter to assignments for this plan. */ plan_id?: number | null; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Paginated list of plan assignments. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PlanAssignmentListResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createPlanAssignment: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreatePlanAssignmentRequest"]; }; }; responses: { /** @description The created plan assignment. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PlanAssignmentResponse"]; }; }; /** @description Validation failed, or the organisation or plan does not exist. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreatePlanAssignmentBadRequest"]; }; }; /** @description The organisation already has a plan assignment that overlaps this period. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getPlanAssignmentById: { parameters: { query?: never; header?: never; path: { /** @description Plan assignment ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The plan assignment. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PlanAssignmentResponse"]; }; }; /** @description Missing or invalid plan assignment id parameter. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Plan assignment not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updatePlanAssignment: { parameters: { query?: never; header?: never; path: { /** @description Plan assignment ID. */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UpdatePlanAssignmentRequest"]; }; }; responses: { /** @description The updated plan assignment. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PlanAssignmentResponse"]; }; }; /** @description Missing or invalid plan assignment id parameter, or invalid body. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Plan assignment not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The change makes the assignment overlap another one for the organisation. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getOrgPlan: { parameters: { query?: { /** @description Usage month (YYYY-MM, UTC). Returns the plan in effect at the end of that month, or now for the current month. Defaults to now. */ month?: string; /** @description Usage period key (YYYY-MM-DD, from `/api/billing/periods`). Returns the plan in effect at the end of that period, or now for the current period. */ period?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The org's plan status. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OrgPlanResponse"]; }; }; /** @description Invalid month or period, or missing project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listPlans: { parameters: { query?: { /** @description List this organisation's custom plans instead of the shared plans. */ org_id?: number | null; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The plans. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PlanListResponse"]; }; }; }; }; createPlan: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreatePlanRequest"]; }; }; responses: { /** @description The created plan. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PlanResponse"]; }; }; /** @description Validation failed, or `dodo_sync` is set on a plan Dodo can't bill. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description A plan with this key or Dodo product already exists, or Dodo has a product for this key with other terms. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Dodo refused to create the plan's product. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getPlanById: { parameters: { query?: never; header?: never; path: { /** @description Plan ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The plan. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PlanResponse"]; }; }; /** @description Invalid plan id. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Plan not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updatePlan: { parameters: { query?: never; header?: never; path: { /** @description Plan ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UpdatePlanRequest"]; }; }; responses: { /** @description The updated plan. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PlanResponse"]; }; }; /** @description Validation failed, or `dodo_sync` is turned on for a plan Dodo can't bill. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Plan not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Dodo has a product for this key with other terms. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Dodo refused to rename the plan's product or create one. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listProjectAddons: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Add-on state and history. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ListProjectAddonsResponse"]; }; }; /** @description Missing or invalid project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; disableProjectAddon: { parameters: { query?: never; header?: never; path: { /** @description Add-on identifier. One of: static_ip_proxy, repo_ownership. */ addon: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The closed period. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectAddonResponse"]; }; }; /** @description Missing or invalid project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Add-on is not enabled, or is still in use. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; enableProjectAddon: { parameters: { query?: never; header?: never; path: { /** @description Add-on identifier. One of: static_ip_proxy, repo_ownership. */ addon: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["EnableProjectAddonRequest"]; }; }; responses: { /** @description The opened period. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectAddonResponse"]; }; }; /** @description Missing or invalid project scope, or the add-on does not apply to this project. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description effective_from / plan_id require super admin. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Add-on is already enabled. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listProjects: { parameters: { query?: { /** @description Filter by active status: `false` (inactive only) or `all` (no filter, super-admins only). Any other value (or omitted) returns active projects only. */ is_active?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Accessible projects. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectListResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createProject: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Organisation ID that will own the project. */ org_id: number; /** @description Project display name. */ name: string; /** @description Unique project slug. */ slug: string; /** @description Repository name (without slashes). Defaults to `-tests`. */ repo_name?: string; /** * @description Repository host backing the project. A `github` repo is created in the Empirical org. * @default github * @enum {string} */ repo_host?: "github" | "pierre_code_storage"; }; }; }; responses: { /** @description The created project. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreateProjectResponse"]; }; }; /** @description Invalid repository name or slug already taken. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SimpleErrorResponse"]; }; }; /** @description Caller does not belong to the organisation. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SimpleErrorResponse"]; }; }; /** @description Failed to create project. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SimpleErrorResponse"]; }; }; }; }; getProject: { parameters: { query?: never; header?: never; path: { /** @description Project ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The project. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectResponse"]; }; }; /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateProject: { parameters: { query?: never; header?: never; path: { /** @description Project ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": { name?: string; default_branch?: string; protected_branches?: string[]; /** * @deprecated * @description Read-only. Set `concurrency` on the trigger request or `scheduled_concurrency` on the environment instead. * @enum {string} */ test_run_concurrency_limit?: "none" | "project" | "environment" | "branch_environment"; /** * @deprecated * @description Read-only. Set `concurrency` on the trigger request or `scheduled_concurrency` on the environment instead. * @enum {string} */ test_run_concurrency_behavior?: "cancel_previous" | "queue_new"; /** @enum {string} */ test_run_region?: "us-east-1" | "ap-south-1"; test_run_shards?: number | null; profile_icon_url?: string | null; is_active?: boolean; }; }; }; responses: { /** @description The updated project. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PatchProjectResponse"]; }; }; /** @description No valid fields to update. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; renameProjectBranch: { parameters: { query?: never; header?: never; path: { /** @description Project ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Current branch name. */ oldBranch: string; /** @description New branch name. */ newBranch: string; }; }; }; responses: { /** @description Branch renamed. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RenameBranchResponse"]; }; }; /** @description Project has no repository configured. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SimpleErrorResponse"]; }; }; /** @description Project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SimpleErrorResponse"]; }; }; }; }; listProjectBranches: { parameters: { query?: { /** @description Page number (1-indexed). */ page?: number; /** @description Items per page (max 100). */ per_page?: number; /** @description Look-back window in days (max 365). */ days?: number; }; header?: never; path: { /** @description Project ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Branches. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectBranchesResponse"]; }; }; /** @description Project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SimpleErrorResponse"]; }; }; }; }; compareProjectBranches: { parameters: { query: { /** @description Base branch (ref) to compare from. */ base: string; /** @description Head branch (ref) to compare to. */ head: string; }; header?: never; path: { /** @description Project ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Comparison result. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CompareBranchesResponse"]; }; }; /** @description Project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SimpleErrorResponse"]; }; }; }; }; getOrCreateProjectManagerSession: { parameters: { query?: never; header?: never; path: { /** @description Project ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The project's manager session. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectManagerSessionResponse"]; }; }; /** @description Project not found or inaccessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listProjectMergeRequests: { parameters: { query?: { /** @description Page number (1-indexed). */ page?: number; /** @description Items per page (max 100). */ per_page?: number; }; header?: never; path: { /** @description Project ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Merge requests. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MergeRequestsResponse"]; }; }; /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getProjectOrg: { parameters: { query?: never; header?: never; path: { /** @description Project ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The organisation. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectOrgResponse"]; }; }; /** @description Forbidden. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project or organisation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; checkProjectRepoExists: { parameters: { query?: never; header?: never; path: { /** @description Project ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Repo existence. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RepoExistsResponse"]; }; }; /** @description Project is missing repo_owner / repo_name. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SimpleErrorResponse"]; }; }; /** @description Project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SimpleErrorResponse"]; }; }; /** @description GitHub error. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RepoExistsErrorResponse"]; }; }; }; }; checkProjectRepoSettings: { parameters: { query?: { /** @description Check this GitHub owner's repo instead of the project's (e.g. a repo transfer destination). Requires `repo_name`; cannot be `empirical-run`. */ repo_owner?: string; /** @description Repository name to check, with `repo_owner`. */ repo_name?: string; }; header?: never; path: { /** @description Project ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Check results. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RepoSettingsCheckResponse"]; }; }; /** @description Project has no GitHub repository, or invalid target. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description GitHub request failed. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; triggerProjectTestCasesSync: { parameters: { query?: never; header?: never; path: { /** @description Project ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Sync job enqueued. */ 202: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TestCasesSyncTriggeredResponse"]; }; }; /** @description Project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Jobs queue is not configured. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listRepoTransfers: { parameters: { query?: never; header?: never; path: { /** @description Project ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Repo transfers for the project. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RepoTransferListResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RepoTransferError"]; }; }; }; }; startRepoTransfer: { parameters: { query?: never; header?: never; path: { /** @description Project ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["StartRepoTransferRequest"]; }; }; responses: { /** @description The created transfer. */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RepoTransferResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StartRepoTransferBadRequest"]; }; }; /** @description Project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RepoTransferError"]; }; }; /** @description A transfer is already in progress for this project. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RepoTransferConflict"]; }; }; /** @description Server misconfiguration. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RepoTransferError"]; }; }; }; }; getRepoTransfer: { parameters: { query?: never; header?: never; path: { /** @description Project ID. */ id: number; /** @description Repo transfer ID. */ transfer_id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The repo transfer. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RepoTransferResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project or transfer not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RepoTransferError"]; }; }; }; }; checkBranchExists: { parameters: { query: { /** @description Repository owner. */ owner: string; /** @description Repository name. */ repo: string; /** @description Branch name to check. */ branch: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Branch existence. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["BranchExistsResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getProjectByRepoName: { parameters: { query: { /** @description Repository name to look up. */ repo_name: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The project. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectWrappedResponse"]; }; }; /** @description Project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getProjectBySlug: { parameters: { query: { /** @description Project slug to look up. */ slug: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The project. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectResponse"]; }; }; /** @description Project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; checkProjectSlug: { parameters: { query: { /** @description Project slug to check. */ slug: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Slug availability. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CheckSlugResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getProjectClone: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Clone URL for the project. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectCloneResponse"]; }; }; /** @description Repository host is not supported. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getProjectGitToken: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Git credentials. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectGitTokenResponse"]; }; }; /** @description Repository host is not supported. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Not authorised to access the repository. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getProjectKv: { parameters: { query: { /** @description Key to read. */ key: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description KV read result. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectKvGetResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description KV store not configured. */ 503: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; setProjectKv: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Key to write. */ key: string; /** @description JSON value to store. */ value?: unknown; /** @description Time-to-live in seconds (max 2 days). */ ttl: number; }; }; }; responses: { /** @description KV write result. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectKvSetResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Value larger than 2 MB. */ 413: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description KV store not configured. */ 503: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; mergeBranches: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Branch to merge into. */ base_branch: string; /** @description Branch to merge from. */ head_branch?: string; /** @description Deprecated alias for `head_branch`. */ branch_to_merge?: string; }; }; }; responses: { /** @description Merge result. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MergeBranchesResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Merge failed. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getProjectNpmSnapshotUrls: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ProjectNpmSnapshotUrlsBody"]; }; }; responses: { /** @description Presigned snapshot URLs. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectNpmSnapshotUrlsResponse"]; }; }; /** @description The project has no npm snapshot storage. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getProjectStaticIpProxyToken: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Static-IP proxy credentials. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectStaticIpProxyTokenResponse"]; }; }; /** @description Project does not have the static IP proxy add-on. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Token minting is not configured on this environment. */ 503: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; razorpayPaymentsWebhook: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Razorpay event type. */ event: string; /** @description Razorpay event payload. */ payload: { payment?: { entity: { id: string; order_id: string; amount: number; currency: string; status: string; }; }; }; }; }; }; responses: { /** @description Event acknowledged. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RazorpayWebhookAckResponse"]; }; }; /** @description Missing or invalid webhook signature. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Razorpay API credentials are not configured. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createRealtimeToken: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateRealtimeTokenBody"]; }; }; responses: { /** @description The issued token and the channels it opens. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ScopedRealtimeTokenResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description None of the requested channels is accessible. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Realtime service is not configured. */ 503: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RealtimeUnavailableResponse"]; }; }; }; }; listRecentPages: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Recently viewed dashboard destinations. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RecentPagesResponse"]; }; }; /** @description Only signed-in users can access recent pages. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Recent pages storage is unavailable. */ 503: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; recordRecentPage: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["RecordRecentPageRequest"]; }; }; responses: { /** @description The recorded dashboard destination. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RecordRecentPageResponse"]; }; }; /** @description The destination is invalid. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Only signed-in users can record recent pages. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Recent pages storage is unavailable. */ 503: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; claimRunnerBackend: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ClaimRunnerBackendBody"]; }; }; responses: { /** @description The backend after the call. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClaimRunnerBackendResponse"]; }; }; /** @description The stack's resources are not where Empirical expects. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The stack is in a different account or region than the registration. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Unknown registration token. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The registration was claimed by another stack. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The registration link expired. */ 410: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Empirical assumed the role but a check failed. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Empirical cannot assume the role yet; retry. */ 503: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getProjectRunnerBackend: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The project's runner backend, or null. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectRunnerBackendDetailResponse"]; }; }; /** @description Missing or invalid project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or not accessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; removeProjectRunnerBackend: { parameters: { query?: never; header?: never; path: { /** @description A runner backend of the project's organisation. */ id: number | null; }; cookie?: never; }; requestBody?: never; responses: { /** @description The runner was removed. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RemoveRunnerBackendResponse"]; }; }; /** @description Runner backend not found in this organisation. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The runner is active or still used by a project. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; renameProjectRunnerBackend: { parameters: { query?: never; header?: never; path: { /** @description A runner backend of the project's organisation. */ id: number | null; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["RenameRunnerBackendBody"]; }; }; responses: { /** @description The renamed runner. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RunnerBackendResponse"]; }; }; /** @description Runner backend not found in this organisation. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; disconnectProjectRunnerBackend: { parameters: { query?: never; header?: never; path: { /** @description A runner backend of the project's organisation. */ id: number | null; }; cookie?: never; }; requestBody?: never; responses: { /** @description The disabled backend. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DisconnectRunnerBackendResponse"]; }; }; /** @description Runner backend not found in this organisation. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; enableProjectRunnerBackend: { parameters: { query?: never; header?: never; path: { /** @description A runner backend of the project's organisation. */ id: number | null; }; cookie?: never; }; requestBody?: never; responses: { /** @description Every check, and the backend after them. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RunnerBackendVerifyResponse"]; }; }; /** @description Runner backend not found in this organisation. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The backend is not disabled, or its stack was deleted. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createProjectRunnerBackendRegistration: { parameters: { query?: never; header?: never; path: { /** @description A runner backend of the project's organisation. */ id: number | null; }; cookie?: never; }; requestBody?: never; responses: { /** @description The registration link. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RunnerBackendRegistrationResponse"]; }; }; /** @description The backend's region has no published template. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Runner backend not found in this organisation. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The backend is no longer pending. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The published template could not be read. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listProjectOrgRunnerBackends: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The runner backends. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OrgRunnerBackendListResponse"]; }; }; /** @description Missing or invalid project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; setScopedProjectRunnerBackend: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["SetProjectRunnerBackendBody"]; }; }; responses: { /** @description The project's backend. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectRunnerBackendResponse"]; }; }; /** @description The backend is not active. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Runner backend not found in this organisation. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; setupProjectRunnerBackend: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["SetupRunnerBackendBody"]; }; }; responses: { /** @description The backend and its link. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SetupRunnerBackendResponse"]; }; }; /** @description The region has no published template. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description A runner is already connected in that account and region, or a disconnected one's stack still exists. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The published template could not be read. */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; verifyProjectRunnerBackend: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Every check, and the backend after them. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RunnerBackendVerifyResponse"]; }; }; /** @description Missing or invalid project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found, or it runs on Empirical-hosted. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description The runner backend is disabled. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; upsertSandboxSnapshotSources: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UpsertSandboxSnapshotSourcesRequest"]; }; }; responses: { /** @description The upserted sources. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SandboxSnapshotSourcesUpsertResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listSystemMessages: { parameters: { query?: { limit?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Recent system messages, newest first. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SystemMessageListResponse"]; }; }; }; }; createSystemMessage: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateSystemMessageRequest"]; }; }; responses: { /** @description The message and its per-project delivery. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreateSystemMessageResponse"]; }; }; /** @description A listed project does not exist. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Broadcast requested but no project has an open manager session. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getSystemMessage: { parameters: { query?: never; header?: never; path: { id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The message and its per-project status. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SystemMessageDetailResponse"]; }; }; /** @description System message not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; ackSystemMessage: { parameters: { query?: never; header?: never; path: { id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["AckSystemMessageRequest"]; }; }; responses: { /** @description The recorded acknowledgement. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AckSystemMessageResponse"]; }; }; /** @description Caller is not a manager chat session. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description System message was not sent to this project. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listTaskChatSessions: { parameters: { query?: never; header?: never; path: { /** @description Task ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Chat sessions for the task (or an empty-state message). */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TaskChatSessionsResponse"]; }; }; /** @description Invalid task ID. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Task not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createTaskChatSession: { parameters: { query?: never; header?: never; path: { /** @description Task ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Project the chat session belongs to. */ project_id?: (number | string) | null; /** @description First message to send to the agent. */ initial_prompt?: string | null; /** @description Model to use for the chat session. */ model?: string | null; }; }; }; responses: { /** @description The created chat session. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TaskSessionResponse"]; }; }; /** @description Missing acting user or project_id, or invalid input. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project not found or inaccessible. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createTestReportUploadUrls: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateTestReportUploadUrlsRequest"]; }; }; responses: { /** @description Upload URLs, in request order. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreateTestReportUploadUrlsResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; ingestTestCaseRunEndEvent: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["TestCaseRunEndEventRequest"]; }; }; responses: { /** @description Event accepted (acknowledgement). */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["IngestTestCaseRunEndEventResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Run ledger unavailable; retry the event. */ 503: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; ingestTestCaseRunBeginEvent: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["TestCaseRunBeginEventRequest"]; }; }; responses: { /** @description Event accepted (acknowledgement). */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["IngestTestCaseRunEndEventResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateTestRunShardState: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description Parent test run ID (run_id). */ testRunId: number; /** @description Deprecated and ignored: the run's own project is used. */ projectRepoName?: string; /** @description Zero-based index of the shard being updated. */ shardIndex: number; /** @description Total shard count for the run. Required for `run_test` jobs; omitted for `merge_reports`. */ totalShards?: number | null; /** * @description New state for the shard. * @enum {string} */ state: "started" | "ended" | "error" | "interrupted" | "cancelled"; /** @description Error code when the shard failed. */ errorCode?: string; /** @description Resolved head SHA, recorded on first shard start. */ testRunHeadSha?: string; /** @description Deprecated and ignored: the run's own branch is used. */ testRunBranch?: string; /** * @description Job type for the shard. Defaults to `run_test`. * @enum {string} */ jobType?: "run_test" | "merge_reports" | "run_setup"; }; }; }; responses: { /** @description The updated shard, optionally with a local-merge payload. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UpdateShardStateResponse"]; }; }; /** @description Missing required parameters. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run or shard not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; proxyTwoCaptcha: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["TwoCaptchaProxyRequest"]; }; }; responses: { /** @description The 2Captcha response, forwarded unchanged. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TwoCaptchaProxyResponse"]; }; }; /** @description Invalid request body. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description 2Captcha API key is not configured, or the proxied request failed. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PlaywrightUtilsProxyError"]; }; }; /** @description 2Captcha's status code is forwarded unchanged (any non-2xx is passed through) with its JSON body. */ 502: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getUiTestRunDetail: { parameters: { query?: never; header?: never; path: { /** @description Test run database ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The run detail payload. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UiGetTestRunResponse"]; }; }; /** @description Invalid cross-check header. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getUiLiveTestRun: { parameters: { query?: never; header?: never; path: { /** @description Test run database ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The mutable test-run snapshot. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UiLiveTestRunResponse"]; }; }; /** @description Invalid cross-check header. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Test run not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listMyGithubLinks: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description GitHub links for the current user. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubLinkListResponse"]; }; }; /** @description User ID is required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; upsertGithubLink: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": { /** @description OAuth code from GitHub's redirect to the reporter app callback. Required for a signed-in user, whose account is linked to the GitHub user who authorized it. */ code?: string; /** @description User ID to link the GitHub account to. System callers only. */ user_id?: string; /** @description GitHub numeric user ID. System callers only. */ github_user_id?: string; /** @description GitHub login/username. System callers only. */ github_username?: string; /** @description GitHub display name. */ github_display_name?: string | null; /** @description GitHub avatar URL. */ github_avatar_url?: string | null; /** @description GitHub account email. */ github_email?: string | null; }; }; }; responses: { /** @description The upserted GitHub link. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GithubLinkUpsertResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description GitHub rejected the OAuth code. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; deleteMyGithubLink: { parameters: { query: { /** @description ID of the GitHub user link to delete. */ id: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Deletion result. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UserLinkDeleteResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description User ID is required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Link not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getCurrentUser: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The current user. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CurrentUserResponse"]; }; }; }; }; getMyAnnouncementsSeen: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Announcement seen time. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AnnouncementsSeenResponse"]; }; }; /** @description User not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; markMyAnnouncementsSeen: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["MarkAnnouncementsSeenRequest"]; }; }; responses: { /** @description Updated seen time. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AnnouncementsSeenResponse"]; }; }; /** @description User not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createMyMemberships: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Memberships created from pending invites. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MembershipListResponse"]; }; }; /** @description No verified email on the session. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getMyOnboarding: { parameters: { query?: { /** @description Super admins only: the email of the user whose checklist to return. */ view_as?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The caller's onboarding checklist. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OnboardingChecklistResponse"]; }; }; /** @description No verified email on the session. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description `view_as` needs a super admin. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Project or `view_as` user not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; listMySlackLinks: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Slack links for the current user. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SlackLinkListResponse"]; }; }; /** @description User ID is required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; deleteMySlackLink: { parameters: { query: { /** @description ID of the Slack user link to delete. */ id: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Deletion result. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UserLinkDeleteResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description User ID is required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Link not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; trackTelemetryEvent: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["TelemetryTrackRequest"]; }; }; responses: { /** @description Event accepted. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TelemetryTrackResponse"]; }; }; /** @description Invalid event. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; getProjectUsageV2: { parameters: { query?: { /** @description Start of the window, inclusive (ISO 8601, UTC). Must be provided with end_date; both default to the current month-to-date window. */ start_date?: string; /** @description End of the window, exclusive (ISO 8601, UTC). Must be provided with start_date; both default to the current month-to-date window. */ end_date?: string; }; header?: never; path: { /** @description Project ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Usage for the window. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectUsageV2Response"]; }; }; /** @description Project not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; proxyWebhookSite: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["PlaywrightUtilsProxyRequest"]; }; }; responses: { /** @description Upstream provider response: its JSON body under `data` plus the upstream `headers`. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PlaywrightUtilsProxyResponse"]; }; }; /** @description Invalid request body. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Provider API key is not configured, or the proxied request failed. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PlaywrightUtilsProxyError"]; }; }; /** @description The upstream provider's status code is forwarded unchanged (any non-2xx is passed through) with the same `{ data, headers }` body. */ 502: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listWebhooks: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The project's webhooks. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["WebhookListResponse"]; }; }; /** @description Invalid request or missing project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; createWebhook: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateWebhookRequest"]; }; }; responses: { /** @description The created webhook. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["WebhookCreateResponse"]; }; }; /** @description Invalid request or missing project scope. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; deleteWebhook: { parameters: { query?: never; header?: never; path: { /** @description Webhook ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The webhook was deleted. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["WebhookDeleteResponse"]; }; }; /** @description Webhook not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; updateWebhook: { parameters: { query?: never; header?: never; path: { /** @description Webhook ID. */ id: number; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UpdateWebhookRequest"]; }; }; responses: { /** @description The updated webhook. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["WebhookUpdateResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Webhook not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; testWebhook: { parameters: { query?: never; header?: never; path: { /** @description Webhook ID. */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description The test delivery result. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["WebhookTestResponse"]; }; }; /** @description Webhook not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; } //# sourceMappingURL=api-worker-openapi.d.ts.map