@aexhq/sdk 0.46.5-canary → 0.51.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/NOTICE +38 -0
- package/README.md +54 -29
- package/dist/client/aex.d.ts +33 -0
- package/dist/client/aex.js +108 -0
- package/dist/client/aex.js.map +1 -0
- package/dist/client/credentials.d.ts +25 -0
- package/dist/client/credentials.js +97 -0
- package/dist/client/credentials.js.map +1 -0
- package/dist/client/routing.d.ts +7 -0
- package/dist/client/routing.js +29 -0
- package/dist/client/routing.js.map +1 -0
- package/dist/downloads/download.d.ts +18 -0
- package/dist/downloads/download.js +67 -0
- package/dist/downloads/download.js.map +1 -0
- package/dist/generated/errors.d.ts +12 -0
- package/dist/generated/errors.js +82 -0
- package/dist/generated/errors.js.map +1 -0
- package/dist/generated/models.d.ts +1392 -0
- package/dist/generated/models.js +62 -0
- package/dist/generated/models.js.map +1 -0
- package/dist/generated/resources.d.ts +710 -0
- package/dist/generated/resources.js +582 -0
- package/dist/generated/resources.js.map +1 -0
- package/dist/generated/routes.d.ts +44 -0
- package/dist/generated/routes.js +1905 -0
- package/dist/generated/routes.js.map +1 -0
- package/dist/index.d.ts +21 -50
- package/dist/index.js +14 -62
- package/dist/index.js.map +1 -1
- package/dist/node/session-file-limits.d.ts +4 -0
- package/dist/node/session-file-limits.js +7 -0
- package/dist/node/session-file-limits.js.map +1 -0
- package/dist/node/session-files.d.ts +80 -0
- package/dist/node/session-files.js +254 -0
- package/dist/node/session-files.js.map +1 -0
- package/dist/observations/stream.d.ts +1 -0
- package/dist/observations/stream.js +18 -0
- package/dist/observations/stream.js.map +1 -0
- package/dist/transport/errors.d.ts +60 -0
- package/dist/transport/errors.js +107 -0
- package/dist/transport/errors.js.map +1 -0
- package/dist/transport/pagination.d.ts +8 -0
- package/dist/transport/pagination.js +34 -0
- package/dist/transport/pagination.js.map +1 -0
- package/dist/transport/retry.d.ts +21 -0
- package/dist/transport/retry.js +37 -0
- package/dist/transport/retry.js.map +1 -0
- package/dist/transport/transport.d.ts +25 -0
- package/dist/transport/transport.js +33 -0
- package/dist/transport/transport.js.map +1 -0
- package/package.json +67 -30
- package/dist/_contracts/account-operations.d.ts +0 -101
- package/dist/_contracts/account-operations.js +0 -242
- package/dist/_contracts/account-types.d.ts +0 -461
- package/dist/_contracts/account-types.js +0 -1
- package/dist/_contracts/api-key.d.ts +0 -61
- package/dist/_contracts/api-key.js +0 -101
- package/dist/_contracts/api-routes.d.ts +0 -20
- package/dist/_contracts/api-routes.js +0 -109
- package/dist/_contracts/archive-limits.d.ts +0 -3
- package/dist/_contracts/archive-limits.js +0 -23
- package/dist/_contracts/asset-authoring.d.ts +0 -22
- package/dist/_contracts/asset-authoring.js +0 -106
- package/dist/_contracts/asset-bundle.d.ts +0 -64
- package/dist/_contracts/asset-bundle.js +0 -263
- package/dist/_contracts/asset-upload-helper.d.ts +0 -31
- package/dist/_contracts/asset-upload-helper.js +0 -84
- package/dist/_contracts/billing-admission.d.ts +0 -29
- package/dist/_contracts/billing-admission.js +0 -28
- package/dist/_contracts/bundle-manifest.d.ts +0 -89
- package/dist/_contracts/bundle-manifest.js +0 -158
- package/dist/_contracts/canonical-sha256.d.ts +0 -8
- package/dist/_contracts/canonical-sha256.js +0 -8
- package/dist/_contracts/connection-ticket.d.ts +0 -22
- package/dist/_contracts/connection-ticket.js +0 -54
- package/dist/_contracts/continuation-event.d.ts +0 -31
- package/dist/_contracts/continuation-event.js +0 -6
- package/dist/_contracts/contract-parse-error.d.ts +0 -12
- package/dist/_contracts/contract-parse-error.js +0 -51
- package/dist/_contracts/error-codes.d.ts +0 -26
- package/dist/_contracts/error-codes.js +0 -116
- package/dist/_contracts/error-factory.d.ts +0 -32
- package/dist/_contracts/error-factory.js +0 -174
- package/dist/_contracts/event-envelope.d.ts +0 -471
- package/dist/_contracts/event-envelope.js +0 -501
- package/dist/_contracts/event-stream-client.d.ts +0 -122
- package/dist/_contracts/event-stream-client.js +0 -445
- package/dist/_contracts/event-view.d.ts +0 -44
- package/dist/_contracts/event-view.js +0 -69
- package/dist/_contracts/failure-class.d.ts +0 -29
- package/dist/_contracts/failure-class.js +0 -73
- package/dist/_contracts/http.d.ts +0 -135
- package/dist/_contracts/http.js +0 -434
- package/dist/_contracts/ids.d.ts +0 -66
- package/dist/_contracts/ids.js +0 -119
- package/dist/_contracts/index.d.ts +0 -42
- package/dist/_contracts/index.js +0 -52
- package/dist/_contracts/internal.d.ts +0 -55
- package/dist/_contracts/internal.js +0 -113
- package/dist/_contracts/models.d.ts +0 -30
- package/dist/_contracts/models.js +0 -28
- package/dist/_contracts/operation-core.d.ts +0 -36
- package/dist/_contracts/operation-core.js +0 -70
- package/dist/_contracts/operations.d.ts +0 -218
- package/dist/_contracts/operations.js +0 -1496
- package/dist/_contracts/otlp-projection.d.ts +0 -78
- package/dist/_contracts/otlp-projection.js +0 -171
- package/dist/_contracts/post-hook.d.ts +0 -31
- package/dist/_contracts/post-hook.js +0 -61
- package/dist/_contracts/provider-fault.d.ts +0 -34
- package/dist/_contracts/provider-fault.js +0 -68
- package/dist/_contracts/retry-core.d.ts +0 -29
- package/dist/_contracts/retry-core.js +0 -79
- package/dist/_contracts/runner-event.d.ts +0 -117
- package/dist/_contracts/runner-event.js +0 -172
- package/dist/_contracts/runtime-kind.d.ts +0 -60
- package/dist/_contracts/runtime-kind.js +0 -70
- package/dist/_contracts/runtime-manifest.d.ts +0 -121
- package/dist/_contracts/runtime-manifest.js +0 -83
- package/dist/_contracts/runtime-security-profile.d.ts +0 -26
- package/dist/_contracts/runtime-security-profile.js +0 -73
- package/dist/_contracts/runtime-sizes.d.ts +0 -104
- package/dist/_contracts/runtime-sizes.js +0 -111
- package/dist/_contracts/runtime-types.d.ts +0 -618
- package/dist/_contracts/runtime-types.js +0 -58
- package/dist/_contracts/schemas/asset-bundle.d.ts +0 -70
- package/dist/_contracts/schemas/asset-bundle.js +0 -107
- package/dist/_contracts/schemas/asset-ref.d.ts +0 -61
- package/dist/_contracts/schemas/asset-ref.js +0 -118
- package/dist/_contracts/schemas/bundle-manifest.d.ts +0 -66
- package/dist/_contracts/schemas/bundle-manifest.js +0 -77
- package/dist/_contracts/schemas/index.d.ts +0 -32
- package/dist/_contracts/schemas/index.js +0 -30
- package/dist/_contracts/schemas/mcp-server.d.ts +0 -99
- package/dist/_contracts/schemas/mcp-server.js +0 -209
- package/dist/_contracts/schemas/models.d.ts +0 -29
- package/dist/_contracts/schemas/models.js +0 -51
- package/dist/_contracts/schemas/numeric.d.ts +0 -18
- package/dist/_contracts/schemas/numeric.js +0 -28
- package/dist/_contracts/schemas/post-hook.d.ts +0 -45
- package/dist/_contracts/schemas/post-hook.js +0 -68
- package/dist/_contracts/schemas/response-assets.d.ts +0 -75
- package/dist/_contracts/schemas/response-assets.js +0 -81
- package/dist/_contracts/schemas/response-billing.d.ts +0 -208
- package/dist/_contracts/schemas/response-billing.js +0 -139
- package/dist/_contracts/schemas/response-common.d.ts +0 -132
- package/dist/_contracts/schemas/response-common.js +0 -162
- package/dist/_contracts/schemas/response-identity.d.ts +0 -648
- package/dist/_contracts/schemas/response-identity.js +0 -131
- package/dist/_contracts/schemas/response-mcp-servers.d.ts +0 -51
- package/dist/_contracts/schemas/response-mcp-servers.js +0 -32
- package/dist/_contracts/schemas/response-secrets.d.ts +0 -50
- package/dist/_contracts/schemas/response-secrets.js +0 -32
- package/dist/_contracts/schemas/response-sessions-internal.d.ts +0 -200
- package/dist/_contracts/schemas/response-sessions-internal.js +0 -142
- package/dist/_contracts/schemas/response-sessions.d.ts +0 -1598
- package/dist/_contracts/schemas/response-sessions.js +0 -377
- package/dist/_contracts/schemas/response-webhooks.d.ts +0 -76
- package/dist/_contracts/schemas/response-webhooks.js +0 -42
- package/dist/_contracts/schemas/response-workspace.d.ts +0 -225
- package/dist/_contracts/schemas/response-workspace.js +0 -99
- package/dist/_contracts/schemas/runtime-kind.d.ts +0 -31
- package/dist/_contracts/schemas/runtime-kind.js +0 -29
- package/dist/_contracts/schemas/runtime-security-profile.d.ts +0 -28
- package/dist/_contracts/schemas/runtime-security-profile.js +0 -26
- package/dist/_contracts/schemas/runtime-sizes.d.ts +0 -70
- package/dist/_contracts/schemas/runtime-sizes.js +0 -127
- package/dist/_contracts/schemas/session-limits.d.ts +0 -34
- package/dist/_contracts/schemas/session-limits.js +0 -39
- package/dist/_contracts/schemas/session-machine.d.ts +0 -23
- package/dist/_contracts/schemas/session-machine.js +0 -24
- package/dist/_contracts/schemas/session-request-config.d.ts +0 -58
- package/dist/_contracts/schemas/session-request-config.js +0 -134
- package/dist/_contracts/schemas/session-webhook.d.ts +0 -11
- package/dist/_contracts/schemas/session-webhook.js +0 -38
- package/dist/_contracts/schemas/side-effect-audit.d.ts +0 -98
- package/dist/_contracts/schemas/side-effect-audit.js +0 -102
- package/dist/_contracts/schemas/submission-assets.d.ts +0 -117
- package/dist/_contracts/schemas/submission-assets.js +0 -147
- package/dist/_contracts/schemas/submission-body.d.ts +0 -251
- package/dist/_contracts/schemas/submission-body.js +0 -378
- package/dist/_contracts/schemas/submission-environment.d.ts +0 -79
- package/dist/_contracts/schemas/submission-environment.js +0 -179
- package/dist/_contracts/schemas/submission-request.d.ts +0 -158
- package/dist/_contracts/schemas/submission-request.js +0 -49
- package/dist/_contracts/schemas/submission-secrets.d.ts +0 -47
- package/dist/_contracts/schemas/submission-secrets.js +0 -108
- package/dist/_contracts/schemas/wire.d.ts +0 -118
- package/dist/_contracts/schemas/wire.js +0 -171
- package/dist/_contracts/schemas/workspace-resources.d.ts +0 -50
- package/dist/_contracts/schemas/workspace-resources.js +0 -87
- package/dist/_contracts/sdk-errors.d.ts +0 -212
- package/dist/_contracts/sdk-errors.js +0 -313
- package/dist/_contracts/sdk-secrets.d.ts +0 -67
- package/dist/_contracts/sdk-secrets.js +0 -427
- package/dist/_contracts/session-archive.d.ts +0 -16
- package/dist/_contracts/session-archive.js +0 -92
- package/dist/_contracts/session-artifacts.d.ts +0 -189
- package/dist/_contracts/session-artifacts.js +0 -264
- package/dist/_contracts/session-config.d.ts +0 -373
- package/dist/_contracts/session-config.js +0 -562
- package/dist/_contracts/session-cost-types.d.ts +0 -211
- package/dist/_contracts/session-cost-types.js +0 -69
- package/dist/_contracts/session-cost.d.ts +0 -8
- package/dist/_contracts/session-cost.js +0 -582
- package/dist/_contracts/session-custody.d.ts +0 -165
- package/dist/_contracts/session-custody.js +0 -345
- package/dist/_contracts/session-file-query.d.ts +0 -14
- package/dist/_contracts/session-file-query.js +0 -178
- package/dist/_contracts/session-record.d.ts +0 -112
- package/dist/_contracts/session-record.js +0 -165
- package/dist/_contracts/session-retention.d.ts +0 -201
- package/dist/_contracts/session-retention.js +0 -450
- package/dist/_contracts/side-effect-audit.d.ts +0 -126
- package/dist/_contracts/side-effect-audit.js +0 -520
- package/dist/_contracts/sse.d.ts +0 -74
- package/dist/_contracts/sse.js +0 -227
- package/dist/_contracts/stable.d.ts +0 -45
- package/dist/_contracts/stable.js +0 -62
- package/dist/_contracts/status.d.ts +0 -25
- package/dist/_contracts/status.js +0 -57
- package/dist/_contracts/submission-limits.d.ts +0 -61
- package/dist/_contracts/submission-limits.js +0 -60
- package/dist/_contracts/submission.d.ts +0 -547
- package/dist/_contracts/submission.js +0 -812
- package/dist/_contracts/suggest.d.ts +0 -15
- package/dist/_contracts/suggest.js +0 -53
- package/dist/_contracts/testing/response-bindings.d.ts +0 -45
- package/dist/_contracts/testing/response-bindings.js +0 -256
- package/dist/_contracts/testing/wire-conformance-entry.d.ts +0 -10
- package/dist/_contracts/testing/wire-conformance-entry.js +0 -8
- package/dist/_contracts/testing/wire-conformance.d.ts +0 -169
- package/dist/_contracts/testing/wire-conformance.js +0 -276
- package/dist/_contracts/turn-trace.d.ts +0 -28
- package/dist/_contracts/turn-trace.js +0 -1
- package/dist/_contracts/unknown-field-error.d.ts +0 -13
- package/dist/_contracts/unknown-field-error.js +0 -21
- package/dist/_contracts/value-guards.d.ts +0 -20
- package/dist/_contracts/value-guards.js +0 -34
- package/dist/_contracts/webhook-verify.d.ts +0 -34
- package/dist/_contracts/webhook-verify.js +0 -93
- package/dist/_contracts/wire-observer.d.ts +0 -49
- package/dist/_contracts/wire-observer.js +0 -34
- package/dist/_contracts/workflow-status.d.ts +0 -7
- package/dist/_contracts/workflow-status.js +0 -43
- package/dist/_contracts/workspace-resources.d.ts +0 -98
- package/dist/_contracts/workspace-resources.js +0 -39
- package/dist/archive-limits.d.ts +0 -1
- package/dist/archive-limits.js +0 -2
- package/dist/archive-limits.js.map +0 -1
- package/dist/asset-upload.d.ts +0 -47
- package/dist/asset-upload.js +0 -269
- package/dist/asset-upload.js.map +0 -1
- package/dist/bundle.d.ts +0 -9
- package/dist/bundle.js +0 -20
- package/dist/bundle.js.map +0 -1
- package/dist/canonical-zip.d.ts +0 -68
- package/dist/canonical-zip.js +0 -355
- package/dist/canonical-zip.js.map +0 -1
- package/dist/cli.mjs +0 -12048
- package/dist/cli.mjs.sha256 +0 -1
- package/dist/client-types.d.ts +0 -192
- package/dist/client-types.js +0 -2
- package/dist/client-types.js.map +0 -1
- package/dist/client.d.ts +0 -464
- package/dist/client.js +0 -1207
- package/dist/client.js.map +0 -1
- package/dist/event-projection.d.ts +0 -22
- package/dist/event-projection.js +0 -380
- package/dist/event-projection.js.map +0 -1
- package/dist/fetch-archive.d.ts +0 -16
- package/dist/fetch-archive.js +0 -252
- package/dist/fetch-archive.js.map +0 -1
- package/dist/file.d.ts +0 -96
- package/dist/file.js +0 -272
- package/dist/file.js.map +0 -1
- package/dist/instructions.d.ts +0 -20
- package/dist/instructions.js +0 -40
- package/dist/instructions.js.map +0 -1
- package/dist/legacy-session-provider-fault.d.ts +0 -7
- package/dist/legacy-session-provider-fault.js +0 -38
- package/dist/legacy-session-provider-fault.js.map +0 -1
- package/dist/mcp-server.d.ts +0 -84
- package/dist/mcp-server.js +0 -117
- package/dist/mcp-server.js.map +0 -1
- package/dist/node-fs.d.ts +0 -29
- package/dist/node-fs.js +0 -19
- package/dist/node-fs.js.map +0 -1
- package/dist/node-walk.d.ts +0 -69
- package/dist/node-walk.js +0 -151
- package/dist/node-walk.js.map +0 -1
- package/dist/path-basename.d.ts +0 -5
- package/dist/path-basename.js +0 -9
- package/dist/path-basename.js.map +0 -1
- package/dist/retry.d.ts +0 -70
- package/dist/retry.js +0 -155
- package/dist/retry.js.map +0 -1
- package/dist/secret.d.ts +0 -65
- package/dist/secret.js +0 -110
- package/dist/secret.js.map +0 -1
- package/dist/session-validate.d.ts +0 -100
- package/dist/session-validate.js +0 -303
- package/dist/session-validate.js.map +0 -1
- package/dist/skill.d.ts +0 -99
- package/dist/skill.js +0 -169
- package/dist/skill.js.map +0 -1
- package/dist/submission-wire.d.ts +0 -13
- package/dist/submission-wire.js +0 -69
- package/dist/submission-wire.js.map +0 -1
- package/dist/tool.d.ts +0 -41
- package/dist/tool.js +0 -76
- package/dist/tool.js.map +0 -1
- package/dist/version.d.ts +0 -9
- package/dist/version.js +0 -10
- package/dist/version.js.map +0 -1
- package/docs/authentication.md +0 -125
- package/docs/billing.md +0 -164
- package/docs/cleanup.md +0 -27
- package/docs/concepts/agent-tools.md +0 -47
- package/docs/concepts/composition.md +0 -60
- package/docs/concepts/providers-and-runtimes.md +0 -121
- package/docs/concepts/sessions.md +0 -51
- package/docs/concepts/subagents.md +0 -35
- package/docs/credentials.md +0 -116
- package/docs/defaults.md +0 -51
- package/docs/errors.md +0 -258
- package/docs/events.md +0 -143
- package/docs/files.md +0 -130
- package/docs/limits-and-quotas.md +0 -114
- package/docs/limits.md +0 -51
- package/docs/mcp.md +0 -47
- package/docs/networking.md +0 -114
- package/docs/provider-runtime-capabilities.md +0 -32
- package/docs/public-surface.json +0 -73
- package/docs/quickstart.md +0 -135
- package/docs/release.md +0 -44
- package/docs/retries.md +0 -108
- package/docs/secrets.md +0 -141
- package/docs/session-config.md +0 -51
- package/docs/session-record.md +0 -58
- package/docs/skills.md +0 -65
- package/docs/telemetry.md +0 -66
- package/docs/testing.md +0 -35
- package/docs/vision-skills.md +0 -94
- package/docs/webhooks.md +0 -143
|
@@ -0,0 +1,710 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The typed resource surface, one method per served operation.
|
|
3
|
+
*
|
|
4
|
+
* Nothing here is hand-maintained. A route that leaves the deferral ledger
|
|
5
|
+
* gains its method in the same regeneration that publishes it, and a route
|
|
6
|
+
* that enters the ledger loses it, so the published client surface is exactly
|
|
7
|
+
* what the platform answers.
|
|
8
|
+
*/
|
|
9
|
+
import type * as Models from "./models.js";
|
|
10
|
+
import type { RouteId } from "./routes.js";
|
|
11
|
+
/** The one client capability every generated resource method needs. */
|
|
12
|
+
export interface ResourceExecutor {
|
|
13
|
+
execute<T>(routeId: RouteId, bindings?: Readonly<Record<string, string>>, options?: ExecuteOptions): Promise<T>;
|
|
14
|
+
}
|
|
15
|
+
/** Everything beyond the path a single call can carry. */
|
|
16
|
+
export interface ExecuteOptions {
|
|
17
|
+
/** Query parameters, already rendered as wire strings. */
|
|
18
|
+
readonly query?: Readonly<Record<string, string>>;
|
|
19
|
+
/** The request body; binary routes require `Uint8Array`, all others use canonical JSON. */
|
|
20
|
+
readonly body?: unknown | Uint8Array;
|
|
21
|
+
/** `Idempotency-Key`, for a route that requires one. */
|
|
22
|
+
readonly idempotencyKey?: string;
|
|
23
|
+
/** `Aex-Operation-Id`, for a route that admits a durable operation. */
|
|
24
|
+
readonly operationId?: string;
|
|
25
|
+
}
|
|
26
|
+
/** The `api-keys` operations. */
|
|
27
|
+
export declare class ApiKeysClient {
|
|
28
|
+
#private;
|
|
29
|
+
constructor(executor: ResourceExecutor);
|
|
30
|
+
/** `POST /api/api-keys` — Mint a workspace API key whose value is returned once. */
|
|
31
|
+
apiKeyCreate(params: {
|
|
32
|
+
readonly body: Models.ApiKeyCreateRequest;
|
|
33
|
+
readonly idempotencyKey: string;
|
|
34
|
+
}): Promise<Models.NewApiKey>;
|
|
35
|
+
/** `DELETE /api/api-keys/{apiKeyId}` — Revoke a workspace API key. */
|
|
36
|
+
apiKeyRevoke(params: {
|
|
37
|
+
readonly apiKeyId: Models.Id<"api_key">;
|
|
38
|
+
}): Promise<void>;
|
|
39
|
+
/** `GET /api/api-keys` — List workspace API key metadata. */
|
|
40
|
+
apiKeysList(params: {
|
|
41
|
+
readonly query: {
|
|
42
|
+
readonly cursor?: string;
|
|
43
|
+
readonly limit?: string;
|
|
44
|
+
readonly workspaceId: string;
|
|
45
|
+
};
|
|
46
|
+
}): Promise<Models.ApiKeyPage>;
|
|
47
|
+
}
|
|
48
|
+
/** The `auth` operations. */
|
|
49
|
+
export declare class AuthClient {
|
|
50
|
+
#private;
|
|
51
|
+
constructor(executor: ResourceExecutor);
|
|
52
|
+
/** `POST /api/auth/sessions` — Exchange a provider authorization code for a browser session. */
|
|
53
|
+
dashboardSessionCreate(params: {
|
|
54
|
+
readonly body: Models.DashboardSessionRequest;
|
|
55
|
+
}): Promise<Models.DashboardSessionCredential>;
|
|
56
|
+
/** `DELETE /api/auth/sessions/current` — Close the browser session the caller presented. */
|
|
57
|
+
dashboardSessionDelete(): Promise<void>;
|
|
58
|
+
/** `POST /api/auth/device/authorizations` — Begin the CLI device-authorization flow. */
|
|
59
|
+
deviceAuthorizationCreate(params: {
|
|
60
|
+
readonly body: Models.DeviceAuthorizationRequest;
|
|
61
|
+
readonly idempotencyKey: string;
|
|
62
|
+
}): Promise<Models.DeviceAuthorization>;
|
|
63
|
+
/** `POST /api/auth/device/decisions` — Approve or deny a pending device authorization. */
|
|
64
|
+
deviceDecisionCreate(params: {
|
|
65
|
+
readonly body: Models.DeviceDecisionRequest;
|
|
66
|
+
}): Promise<Models.DeviceDecisionResult>;
|
|
67
|
+
/** `POST /api/auth/device/tokens` — Exchange an approved device code for an account token. */
|
|
68
|
+
deviceTokenCreate(params: {
|
|
69
|
+
readonly body: Models.DeviceTokenRequest;
|
|
70
|
+
}): Promise<Models.DeviceToken>;
|
|
71
|
+
}
|
|
72
|
+
/** The `billing` operations. */
|
|
73
|
+
export declare class BillingClient {
|
|
74
|
+
#private;
|
|
75
|
+
constructor(executor: ResourceExecutor);
|
|
76
|
+
/** `GET /api/organizations/{organizationId}/billing/auto-topup-policy` — Read the automatic top-up policy. */
|
|
77
|
+
billingAutoTopupPolicyGet(params: {
|
|
78
|
+
readonly organizationId: Models.Id<"organization">;
|
|
79
|
+
}): Promise<Models.AutoTopupPolicy>;
|
|
80
|
+
/** `PUT /api/organizations/{organizationId}/billing/auto-topup-policy` — Replace the automatic top-up policy. */
|
|
81
|
+
billingAutoTopupPolicyPut(params: {
|
|
82
|
+
readonly organizationId: Models.Id<"organization">;
|
|
83
|
+
readonly body: Models.AutoTopupPolicyRequest;
|
|
84
|
+
readonly idempotencyKey: string;
|
|
85
|
+
}): Promise<Models.AutoTopupPolicy>;
|
|
86
|
+
/** `GET /api/billing/balance` — Read the prepaid balance of an organization. */
|
|
87
|
+
billingBalanceGet(params?: {
|
|
88
|
+
readonly query?: {
|
|
89
|
+
readonly organizationId?: string;
|
|
90
|
+
};
|
|
91
|
+
}): Promise<Models.BillingBalance>;
|
|
92
|
+
/** `POST /api/organizations/{organizationId}/billing/portal-sessions` — Create a hosted billing portal session. */
|
|
93
|
+
billingPortalSessionCreate(params: {
|
|
94
|
+
readonly organizationId: Models.Id<"organization">;
|
|
95
|
+
readonly body: Models.PortalSessionRequest;
|
|
96
|
+
readonly idempotencyKey: string;
|
|
97
|
+
}): Promise<Models.HostedSession>;
|
|
98
|
+
/** `POST /api/organizations/{organizationId}/billing/statements/{statementId}/downloads` — Mint a download grant for an issued statement. */
|
|
99
|
+
billingStatementDownloadCreate(params: {
|
|
100
|
+
readonly organizationId: Models.Id<"organization">;
|
|
101
|
+
readonly statementId: Models.Id<"statement">;
|
|
102
|
+
readonly body: Models.EmptyRequest;
|
|
103
|
+
readonly idempotencyKey: string;
|
|
104
|
+
}): Promise<Models.DownloadGrant>;
|
|
105
|
+
/** `GET /api/organizations/{organizationId}/billing/statements/{statementId}` — Read one immutable issued statement. */
|
|
106
|
+
billingStatementGet(params: {
|
|
107
|
+
readonly organizationId: Models.Id<"organization">;
|
|
108
|
+
readonly statementId: Models.Id<"statement">;
|
|
109
|
+
}): Promise<Models.Statement>;
|
|
110
|
+
/** `GET /api/organizations/{organizationId}/billing/statements` — List issued statements, newest first. */
|
|
111
|
+
billingStatementsList(params: {
|
|
112
|
+
readonly organizationId: Models.Id<"organization">;
|
|
113
|
+
readonly query?: {
|
|
114
|
+
readonly cursor?: string;
|
|
115
|
+
readonly limit?: string;
|
|
116
|
+
};
|
|
117
|
+
}): Promise<Models.StatementSummaryPage>;
|
|
118
|
+
/** `POST /api/organizations/{organizationId}/billing/top-up-checkouts` — Create a hosted top-up checkout. */
|
|
119
|
+
billingTopUpCheckoutCreate(params: {
|
|
120
|
+
readonly organizationId: Models.Id<"organization">;
|
|
121
|
+
readonly body: Models.TopUpCheckoutRequest;
|
|
122
|
+
readonly idempotencyKey: string;
|
|
123
|
+
}): Promise<Models.HostedSession>;
|
|
124
|
+
}
|
|
125
|
+
/** The `bootstrap` operations. */
|
|
126
|
+
export declare class BootstrapClient {
|
|
127
|
+
#private;
|
|
128
|
+
constructor(executor: ResourceExecutor);
|
|
129
|
+
/** `GET /api/bootstrap` — One bounded read that fills the dashboard shell. */
|
|
130
|
+
dashboardBootstrapGet(): Promise<Models.DashboardBootstrap>;
|
|
131
|
+
}
|
|
132
|
+
/** The `files` operations. */
|
|
133
|
+
export declare class FilesClient {
|
|
134
|
+
#private;
|
|
135
|
+
constructor(executor: ResourceExecutor);
|
|
136
|
+
/** `POST /api/sessions/{sessionId}/files/live/downloads/{fileDownloadId}/completion` — Re-stat, re-hash, and close an exact live-file download after SDK verification. */
|
|
137
|
+
sessionFilesLiveDownloadComplete(params: {
|
|
138
|
+
readonly sessionId: Models.Id<"session">;
|
|
139
|
+
readonly fileDownloadId: Models.Id<"file_download">;
|
|
140
|
+
readonly body: Models.LiveFileDownloadCompleteRequest;
|
|
141
|
+
readonly idempotencyKey: string;
|
|
142
|
+
}): Promise<Models.LiveFileDownload>;
|
|
143
|
+
/** `POST /api/sessions/{sessionId}/files/live/downloads` — Open one exact-version live file directly from the retained generation, auto-resuming it. */
|
|
144
|
+
sessionFilesLiveDownloadCreate(params: {
|
|
145
|
+
readonly sessionId: Models.Id<"session">;
|
|
146
|
+
readonly body: Models.LiveFileDownloadRequest;
|
|
147
|
+
readonly idempotencyKey: string;
|
|
148
|
+
}): Promise<Models.LiveFileDownload>;
|
|
149
|
+
/** `DELETE /api/sessions/{sessionId}/files/live/downloads/{fileDownloadId}` — Close an abandoned live-file descriptor, auto-resuming the same generation. */
|
|
150
|
+
sessionFilesLiveDownloadDelete(params: {
|
|
151
|
+
readonly sessionId: Models.Id<"session">;
|
|
152
|
+
readonly fileDownloadId: Models.Id<"file_download">;
|
|
153
|
+
}): Promise<void>;
|
|
154
|
+
/** `GET /api/sessions/{sessionId}/files/live/downloads/{fileDownloadId}/parts/{partNumber}` — Read one raw exact-version range directly from the retained generation. */
|
|
155
|
+
sessionFilesLiveDownloadPartGet(params: {
|
|
156
|
+
readonly sessionId: Models.Id<"session">;
|
|
157
|
+
readonly fileDownloadId: Models.Id<"file_download">;
|
|
158
|
+
readonly partNumber: number;
|
|
159
|
+
readonly query: {
|
|
160
|
+
readonly version: string;
|
|
161
|
+
};
|
|
162
|
+
}): Promise<Uint8Array>;
|
|
163
|
+
/** `POST /api/sessions/{sessionId}/files/live/list` — List the exact live generation, auto-resuming that same generation when suspended. */
|
|
164
|
+
sessionFilesLiveList(params: {
|
|
165
|
+
readonly sessionId: Models.Id<"session">;
|
|
166
|
+
readonly body: Models.LiveFileListRequest;
|
|
167
|
+
}): Promise<Models.LiveFileEntryPage>;
|
|
168
|
+
/** `POST /api/sessions/{sessionId}/files/live/stat` — Stat one live path without following a symlink, auto-resuming the same generation. */
|
|
169
|
+
sessionFilesLiveStat(params: {
|
|
170
|
+
readonly sessionId: Models.Id<"session">;
|
|
171
|
+
readonly body: Models.LiveFileStatRequest;
|
|
172
|
+
}): Promise<Models.LiveFileEntry>;
|
|
173
|
+
/** `POST /api/sessions/{sessionId}/files/live/uploads/{fileUploadId}/completion` — Verify every part and atomically publish one live file in the same generation. */
|
|
174
|
+
sessionFilesLiveUploadComplete(params: {
|
|
175
|
+
readonly sessionId: Models.Id<"session">;
|
|
176
|
+
readonly fileUploadId: Models.Id<"file_upload">;
|
|
177
|
+
readonly idempotencyKey: string;
|
|
178
|
+
}): Promise<Models.LiveFileUpload>;
|
|
179
|
+
/** `POST /api/sessions/{sessionId}/files/live/uploads` — Create a resumable upload in the exact live generation, auto-resuming it when suspended. */
|
|
180
|
+
sessionFilesLiveUploadCreate(params: {
|
|
181
|
+
readonly sessionId: Models.Id<"session">;
|
|
182
|
+
readonly body: Models.LiveFileUploadCreateRequest;
|
|
183
|
+
readonly idempotencyKey: string;
|
|
184
|
+
}): Promise<Models.LiveFileUpload>;
|
|
185
|
+
/** `DELETE /api/sessions/{sessionId}/files/live/uploads/{fileUploadId}` — Abort a partial upload, auto-resuming the same generation to remove its temporary bytes. */
|
|
186
|
+
sessionFilesLiveUploadDelete(params: {
|
|
187
|
+
readonly sessionId: Models.Id<"session">;
|
|
188
|
+
readonly fileUploadId: Models.Id<"file_upload">;
|
|
189
|
+
}): Promise<void>;
|
|
190
|
+
/** `GET /api/sessions/{sessionId}/files/live/uploads/{fileUploadId}` — Read resumable live-upload state, auto-resuming the same generation. */
|
|
191
|
+
sessionFilesLiveUploadGet(params: {
|
|
192
|
+
readonly sessionId: Models.Id<"session">;
|
|
193
|
+
readonly fileUploadId: Models.Id<"file_upload">;
|
|
194
|
+
}): Promise<Models.LiveFileUpload>;
|
|
195
|
+
/** `PUT /api/sessions/{sessionId}/files/live/uploads/{fileUploadId}/parts/{partNumber}` — Put one exact logical part directly into the retained generation. */
|
|
196
|
+
sessionFilesLiveUploadPartPut(params: {
|
|
197
|
+
readonly sessionId: Models.Id<"session">;
|
|
198
|
+
readonly fileUploadId: Models.Id<"file_upload">;
|
|
199
|
+
readonly partNumber: number;
|
|
200
|
+
readonly query: {
|
|
201
|
+
readonly sha256: string;
|
|
202
|
+
};
|
|
203
|
+
readonly body: Uint8Array;
|
|
204
|
+
}): Promise<Models.LiveFileUpload>;
|
|
205
|
+
}
|
|
206
|
+
/** The `identity` operations. */
|
|
207
|
+
export declare class IdentityClient {
|
|
208
|
+
#private;
|
|
209
|
+
constructor(executor: ResourceExecutor);
|
|
210
|
+
/** `GET /api/account` — Read the account and its operational state. */
|
|
211
|
+
accountGet(params: {
|
|
212
|
+
readonly query: {
|
|
213
|
+
readonly organizationId: string;
|
|
214
|
+
};
|
|
215
|
+
}): Promise<Models.AccountOperationalState>;
|
|
216
|
+
}
|
|
217
|
+
/** The `observations` operations. */
|
|
218
|
+
export declare class ObservationsClient {
|
|
219
|
+
#private;
|
|
220
|
+
constructor(executor: ResourceExecutor);
|
|
221
|
+
/** `POST /api/observations/events/query` — Query workspace events observations. */
|
|
222
|
+
observationsEventsQuery(params: {
|
|
223
|
+
readonly body: Models.ObservationQuery;
|
|
224
|
+
}): Promise<Models.ObservationPage>;
|
|
225
|
+
/** `POST /api/observations/logs/query` — Query workspace logs observations. */
|
|
226
|
+
observationsLogsQuery(params: {
|
|
227
|
+
readonly body: Models.ObservationQuery;
|
|
228
|
+
}): Promise<Models.ObservationPage>;
|
|
229
|
+
/** `POST /api/observations/metrics/aggregate` — Aggregate workspace metric observations. */
|
|
230
|
+
observationsMetricsAggregate(params: {
|
|
231
|
+
readonly body: Models.MetricAggregationRequest;
|
|
232
|
+
}): Promise<Models.MetricAggregationPage>;
|
|
233
|
+
/** `POST /api/observations/metrics/query` — Query workspace metrics observations. */
|
|
234
|
+
observationsMetricsQuery(params: {
|
|
235
|
+
readonly body: Models.ObservationQuery;
|
|
236
|
+
}): Promise<Models.ObservationPage>;
|
|
237
|
+
/** `POST /api/observations/spans/query` — Query workspace spans observations. */
|
|
238
|
+
observationsSpansQuery(params: {
|
|
239
|
+
readonly body: Models.ObservationQuery;
|
|
240
|
+
}): Promise<Models.ObservationPage>;
|
|
241
|
+
/** `POST /api/observations/telemetry/query` — Query workspace telemetry observations. */
|
|
242
|
+
observationsTelemetryQuery(params: {
|
|
243
|
+
readonly body: Models.ObservationQuery;
|
|
244
|
+
}): Promise<Models.ObservationPage>;
|
|
245
|
+
/** `POST /api/observations/traces/query` — Query workspace traces observations. */
|
|
246
|
+
observationsTracesQuery(params: {
|
|
247
|
+
readonly body: Models.ObservationQuery;
|
|
248
|
+
}): Promise<Models.ObservationPage>;
|
|
249
|
+
/** `POST /api/observations/{sessionId}/events/query` — Query session events observations. */
|
|
250
|
+
sessionObservationsEventsQuery(params: {
|
|
251
|
+
readonly sessionId: Models.Id<"session">;
|
|
252
|
+
readonly body: Models.ObservationQuery;
|
|
253
|
+
}): Promise<Models.ObservationPage>;
|
|
254
|
+
/** `POST /api/observations/{sessionId}/logs/query` — Query session logs observations. */
|
|
255
|
+
sessionObservationsLogsQuery(params: {
|
|
256
|
+
readonly sessionId: Models.Id<"session">;
|
|
257
|
+
readonly body: Models.ObservationQuery;
|
|
258
|
+
}): Promise<Models.ObservationPage>;
|
|
259
|
+
/** `POST /api/observations/{sessionId}/metrics/aggregate` — Aggregate session metric observations. */
|
|
260
|
+
sessionObservationsMetricsAggregate(params: {
|
|
261
|
+
readonly sessionId: Models.Id<"session">;
|
|
262
|
+
readonly body: Models.MetricAggregationRequest;
|
|
263
|
+
}): Promise<Models.MetricAggregationPage>;
|
|
264
|
+
/** `POST /api/observations/{sessionId}/metrics/query` — Query session metrics observations. */
|
|
265
|
+
sessionObservationsMetricsQuery(params: {
|
|
266
|
+
readonly sessionId: Models.Id<"session">;
|
|
267
|
+
readonly body: Models.ObservationQuery;
|
|
268
|
+
}): Promise<Models.ObservationPage>;
|
|
269
|
+
/** `POST /api/observations/{sessionId}/spans/query` — Query session spans observations. */
|
|
270
|
+
sessionObservationsSpansQuery(params: {
|
|
271
|
+
readonly sessionId: Models.Id<"session">;
|
|
272
|
+
readonly body: Models.ObservationQuery;
|
|
273
|
+
}): Promise<Models.ObservationPage>;
|
|
274
|
+
/** `POST /api/observations/{sessionId}/telemetry/query` — Query session telemetry observations. */
|
|
275
|
+
sessionObservationsTelemetryQuery(params: {
|
|
276
|
+
readonly sessionId: Models.Id<"session">;
|
|
277
|
+
readonly body: Models.ObservationQuery;
|
|
278
|
+
}): Promise<Models.ObservationPage>;
|
|
279
|
+
/** `GET /api/observations/{sessionId}/traces/{traceId}` — Read one assembled trace by its W3C identifier. */
|
|
280
|
+
sessionObservationsTraceGet(params: {
|
|
281
|
+
readonly sessionId: Models.Id<"session">;
|
|
282
|
+
readonly traceId: string;
|
|
283
|
+
}): Promise<Models.TraceDetail>;
|
|
284
|
+
/** `POST /api/observations/{sessionId}/traces/query` — Query session traces observations. */
|
|
285
|
+
sessionObservationsTracesQuery(params: {
|
|
286
|
+
readonly sessionId: Models.Id<"session">;
|
|
287
|
+
readonly body: Models.ObservationQuery;
|
|
288
|
+
}): Promise<Models.ObservationPage>;
|
|
289
|
+
}
|
|
290
|
+
/** The `operations` operations. */
|
|
291
|
+
export declare class OperationsClient {
|
|
292
|
+
#private;
|
|
293
|
+
constructor(executor: ResourceExecutor);
|
|
294
|
+
/** `POST /api/operations/{operationId}/cancellations` — Request cancellation of a central operation. */
|
|
295
|
+
centralOperationCancel(params: {
|
|
296
|
+
readonly operationId: Models.Id<"operation">;
|
|
297
|
+
readonly body: Models.EmptyRequest;
|
|
298
|
+
}): Promise<Models.Operation>;
|
|
299
|
+
/** `GET /api/operations/{operationId}` — Read one central durable operation. */
|
|
300
|
+
centralOperationGet(params: {
|
|
301
|
+
readonly operationId: Models.Id<"operation">;
|
|
302
|
+
}): Promise<Models.Operation>;
|
|
303
|
+
/** `GET /api/operations` — List central durable operations for one organization. */
|
|
304
|
+
centralOperationsList(params: {
|
|
305
|
+
readonly query: {
|
|
306
|
+
readonly cursor?: string;
|
|
307
|
+
readonly kind?: string;
|
|
308
|
+
readonly limit?: string;
|
|
309
|
+
readonly organizationId: string;
|
|
310
|
+
readonly status?: string;
|
|
311
|
+
};
|
|
312
|
+
}): Promise<Models.OperationPage>;
|
|
313
|
+
/** `POST /api/operations/{operationId}/cancellations` — Request cancellation of a regional operation. */
|
|
314
|
+
regionalOperationCancel(params: {
|
|
315
|
+
readonly operationId: Models.Id<"operation">;
|
|
316
|
+
readonly body: Models.EmptyRequest;
|
|
317
|
+
}): Promise<Models.Operation>;
|
|
318
|
+
/** `GET /api/operations/{operationId}` — Read one regional durable operation. */
|
|
319
|
+
regionalOperationGet(params: {
|
|
320
|
+
readonly operationId: Models.Id<"operation">;
|
|
321
|
+
}): Promise<Models.Operation>;
|
|
322
|
+
/** `GET /api/operations` — List regional durable operations. */
|
|
323
|
+
regionalOperationsList(params?: {
|
|
324
|
+
readonly query?: {
|
|
325
|
+
readonly cursor?: string;
|
|
326
|
+
readonly kind?: string;
|
|
327
|
+
readonly limit?: string;
|
|
328
|
+
readonly sessionId?: string;
|
|
329
|
+
readonly status?: string;
|
|
330
|
+
};
|
|
331
|
+
}): Promise<Models.OperationPage>;
|
|
332
|
+
}
|
|
333
|
+
/** The `organizations` operations. */
|
|
334
|
+
export declare class OrganizationsClient {
|
|
335
|
+
#private;
|
|
336
|
+
constructor(executor: ResourceExecutor);
|
|
337
|
+
/** `POST /api/invitations/acceptances` — Redeem every pending invitation addressed to the caller's verified email. */
|
|
338
|
+
invitationAccept(params: {
|
|
339
|
+
readonly body: Models.EmptyRequest;
|
|
340
|
+
}): Promise<Models.InvitationAcceptResult>;
|
|
341
|
+
/** `POST /api/organizations/{organizationId}/invitations` — Invite a person to the organization. */
|
|
342
|
+
invitationCreate(params: {
|
|
343
|
+
readonly organizationId: Models.Id<"organization">;
|
|
344
|
+
readonly body: Models.InvitationCreateRequest;
|
|
345
|
+
readonly idempotencyKey: string;
|
|
346
|
+
}): Promise<Models.Invitation>;
|
|
347
|
+
/** `GET /api/organizations/{organizationId}/memberships` — List the memberships of an organization. */
|
|
348
|
+
membershipsList(params: {
|
|
349
|
+
readonly organizationId: Models.Id<"organization">;
|
|
350
|
+
readonly query?: {
|
|
351
|
+
readonly cursor?: string;
|
|
352
|
+
readonly limit?: string;
|
|
353
|
+
};
|
|
354
|
+
}): Promise<Models.MembershipPage>;
|
|
355
|
+
/** `POST /api/organizations` — Create an organization whose creator becomes owner. */
|
|
356
|
+
organizationCreate(params: {
|
|
357
|
+
readonly body: Models.OrganizationCreateRequest;
|
|
358
|
+
readonly idempotencyKey: string;
|
|
359
|
+
}): Promise<Models.Organization>;
|
|
360
|
+
/** `GET /api/organizations/{organizationId}` — Read one organization. */
|
|
361
|
+
organizationGet(params: {
|
|
362
|
+
readonly organizationId: Models.Id<"organization">;
|
|
363
|
+
}): Promise<Models.Organization>;
|
|
364
|
+
/** `GET /api/organizations` — List organizations the caller belongs to. */
|
|
365
|
+
organizationsList(params?: {
|
|
366
|
+
readonly query?: {
|
|
367
|
+
readonly cursor?: string;
|
|
368
|
+
readonly limit?: string;
|
|
369
|
+
};
|
|
370
|
+
}): Promise<Models.OrganizationPage>;
|
|
371
|
+
}
|
|
372
|
+
/** The `otlp` operations. */
|
|
373
|
+
export declare class OtlpClient {
|
|
374
|
+
#private;
|
|
375
|
+
constructor(executor: ResourceExecutor);
|
|
376
|
+
/** `POST /api/otlp/v1/logs` — Admit an OTLP logs batch. */
|
|
377
|
+
otlpLogsIngest(params: {
|
|
378
|
+
readonly body: unknown;
|
|
379
|
+
readonly idempotencyKey: string;
|
|
380
|
+
}): Promise<Models.TelemetryAdmissionReceipt>;
|
|
381
|
+
/** `POST /api/otlp/v1/metrics` — Admit an OTLP metrics batch. */
|
|
382
|
+
otlpMetricsIngest(params: {
|
|
383
|
+
readonly body: unknown;
|
|
384
|
+
readonly idempotencyKey: string;
|
|
385
|
+
}): Promise<Models.TelemetryAdmissionReceipt>;
|
|
386
|
+
/** `POST /api/otlp/v1/traces` — Admit an OTLP traces batch. */
|
|
387
|
+
otlpTracesIngest(params: {
|
|
388
|
+
readonly body: unknown;
|
|
389
|
+
readonly idempotencyKey: string;
|
|
390
|
+
}): Promise<Models.TelemetryAdmissionReceipt>;
|
|
391
|
+
}
|
|
392
|
+
/** The `provider-credentials` operations. */
|
|
393
|
+
export declare class ProviderCredentialsClient {
|
|
394
|
+
#private;
|
|
395
|
+
constructor(executor: ResourceExecutor);
|
|
396
|
+
/** `GET /api/workspace/provider-credentials/{providerCredentialId}` — Read one BYOK provider-credential binding. */
|
|
397
|
+
providerCredentialGet(params: {
|
|
398
|
+
readonly providerCredentialId: Models.Id<"provider_credential">;
|
|
399
|
+
}): Promise<Models.ProviderCredential>;
|
|
400
|
+
/** `POST /api/workspace/provider-credentials` — Register a dedicated BYOK provider credential; carries plaintext once. */
|
|
401
|
+
providerCredentialRegister(params: {
|
|
402
|
+
readonly body: Models.ProviderCredentialRegisterRequest;
|
|
403
|
+
readonly idempotencyKey: string;
|
|
404
|
+
}): Promise<Models.ProviderCredential>;
|
|
405
|
+
/** `POST /api/workspace/provider-credentials/{providerCredentialId}/revocations` — Revoke a BYOK provider-credential binding. */
|
|
406
|
+
providerCredentialRevoke(params: {
|
|
407
|
+
readonly providerCredentialId: Models.Id<"provider_credential">;
|
|
408
|
+
readonly body: Models.EmptyRequest;
|
|
409
|
+
readonly idempotencyKey: string;
|
|
410
|
+
}): Promise<Models.ProviderCredential>;
|
|
411
|
+
/** `GET /api/workspace/provider-credentials` — List BYOK provider-credential binding metadata. */
|
|
412
|
+
providerCredentialsList(params?: {
|
|
413
|
+
readonly query?: {
|
|
414
|
+
readonly cursor?: string;
|
|
415
|
+
readonly limit?: string;
|
|
416
|
+
readonly provider?: string;
|
|
417
|
+
};
|
|
418
|
+
}): Promise<Models.ProviderCredentialPage>;
|
|
419
|
+
}
|
|
420
|
+
/** The `registry` operations. */
|
|
421
|
+
export declare class RegistryClient {
|
|
422
|
+
#private;
|
|
423
|
+
constructor(executor: ResourceExecutor);
|
|
424
|
+
/** `DELETE /api/workspace/files/{name}` — Delete one registered workspace file. */
|
|
425
|
+
registryFilesDelete(params: {
|
|
426
|
+
readonly name: string;
|
|
427
|
+
}): Promise<void>;
|
|
428
|
+
/** `POST /api/workspace/files/{name}/downloads` — Mint a download grant for a registered workspace file. */
|
|
429
|
+
registryFilesDownloadCreate(params: {
|
|
430
|
+
readonly name: string;
|
|
431
|
+
readonly body: Models.RegistryDownloadRequest;
|
|
432
|
+
readonly idempotencyKey: string;
|
|
433
|
+
}): Promise<Models.DownloadGrant>;
|
|
434
|
+
/** `GET /api/workspace/files/{name}` — Read one registered workspace file. */
|
|
435
|
+
registryFilesGet(params: {
|
|
436
|
+
readonly name: string;
|
|
437
|
+
}): Promise<Models.RegisteredFile>;
|
|
438
|
+
/** `GET /api/workspace/files` — List registered workspace files. */
|
|
439
|
+
registryFilesList(params?: {
|
|
440
|
+
readonly query?: {
|
|
441
|
+
readonly cursor?: string;
|
|
442
|
+
readonly limit?: string;
|
|
443
|
+
};
|
|
444
|
+
}): Promise<Models.RegisteredFilePage>;
|
|
445
|
+
/** `PUT /api/workspace/files/{name}` — Replace one registered workspace file. */
|
|
446
|
+
registryFilesPut(params: {
|
|
447
|
+
readonly name: string;
|
|
448
|
+
readonly body: Models.RegisteredFileValue;
|
|
449
|
+
readonly idempotencyKey: string;
|
|
450
|
+
}): Promise<Models.RegisteredFile>;
|
|
451
|
+
}
|
|
452
|
+
/** The `sessions` operations. */
|
|
453
|
+
export declare class SessionsClient {
|
|
454
|
+
#private;
|
|
455
|
+
constructor(executor: ResourceExecutor);
|
|
456
|
+
/** `POST /api/sessions/{sessionId}/cancellations` — Cancel current work and return the session to idle. */
|
|
457
|
+
sessionCancel(params: {
|
|
458
|
+
readonly sessionId: Models.Id<"session">;
|
|
459
|
+
readonly body: Models.EmptyRequest;
|
|
460
|
+
readonly operationId: Models.Id<"operation">;
|
|
461
|
+
}): Promise<Models.Operation>;
|
|
462
|
+
/** `POST /api/sessions` — Create an eight-hour multi-turn session. */
|
|
463
|
+
sessionCreate(params: {
|
|
464
|
+
readonly body: Models.SessionCreateRequest;
|
|
465
|
+
readonly idempotencyKey: string;
|
|
466
|
+
}): Promise<Models.Session>;
|
|
467
|
+
/** `POST /api/sessions/{sessionId}/deletions` — Irreversibly delete the session and session-scoped user content, observations, telemetry, and export objects. Independent registered workspace files remain. */
|
|
468
|
+
sessionDelete(params: {
|
|
469
|
+
readonly sessionId: Models.Id<"session">;
|
|
470
|
+
readonly body: Models.EmptyRequest;
|
|
471
|
+
readonly operationId: Models.Id<"operation">;
|
|
472
|
+
}): Promise<Models.Operation>;
|
|
473
|
+
/** `GET /api/sessions/{sessionId}` — Read session metadata, including automatic lifecycle state, or its minimal deletion tombstone. */
|
|
474
|
+
sessionGet(params: {
|
|
475
|
+
readonly sessionId: Models.Id<"session">;
|
|
476
|
+
}): Promise<Models.Session>;
|
|
477
|
+
/** `POST /api/sessions/{sessionId}/messages` — Send text and start the session's next work, automatically resuming the same suspended generation. */
|
|
478
|
+
sessionMessageSend(params: {
|
|
479
|
+
readonly sessionId: Models.Id<"session">;
|
|
480
|
+
readonly body: Models.MessageSendRequest;
|
|
481
|
+
readonly idempotencyKey: string;
|
|
482
|
+
}): Promise<Models.MessageSendResult>;
|
|
483
|
+
/** `GET /api/sessions/{sessionId}/messages` — List complete sealed messages in immutable seal-visibility order. */
|
|
484
|
+
sessionMessagesList(params: {
|
|
485
|
+
readonly sessionId: Models.Id<"session">;
|
|
486
|
+
readonly query?: {
|
|
487
|
+
readonly cursor?: string;
|
|
488
|
+
readonly limit?: string;
|
|
489
|
+
};
|
|
490
|
+
}): Promise<Models.MessagePage>;
|
|
491
|
+
/** `POST /api/sessions/{sessionId}/resumptions` — Resume the same retained generation to idle. */
|
|
492
|
+
sessionResume(params: {
|
|
493
|
+
readonly sessionId: Models.Id<"session">;
|
|
494
|
+
readonly body: Models.EmptyRequest;
|
|
495
|
+
readonly operationId: Models.Id<"operation">;
|
|
496
|
+
}): Promise<Models.Operation>;
|
|
497
|
+
/** `POST /api/sessions/{sessionId}/suspensions` — Suspend an idle session while retaining its exact generation; cancel active work first. */
|
|
498
|
+
sessionSuspend(params: {
|
|
499
|
+
readonly sessionId: Models.Id<"session">;
|
|
500
|
+
readonly body: Models.EmptyRequest;
|
|
501
|
+
readonly operationId: Models.Id<"operation">;
|
|
502
|
+
}): Promise<Models.Operation>;
|
|
503
|
+
/** `POST /api/sessions/{sessionId}/terminations` — Permanently destroy compute and live files while retaining metadata and sealed messages. */
|
|
504
|
+
sessionTerminate(params: {
|
|
505
|
+
readonly sessionId: Models.Id<"session">;
|
|
506
|
+
readonly body: Models.EmptyRequest;
|
|
507
|
+
readonly operationId: Models.Id<"operation">;
|
|
508
|
+
}): Promise<Models.Operation>;
|
|
509
|
+
/** `GET /api/sessions` — List sessions in the workspace. */
|
|
510
|
+
sessionsList(params?: {
|
|
511
|
+
readonly query?: {
|
|
512
|
+
readonly cursor?: string;
|
|
513
|
+
readonly limit?: string;
|
|
514
|
+
readonly status?: string;
|
|
515
|
+
};
|
|
516
|
+
}): Promise<Models.SessionListPage>;
|
|
517
|
+
}
|
|
518
|
+
/** The `telemetry-lifecycle` operations. */
|
|
519
|
+
export declare class TelemetryLifecycleClient {
|
|
520
|
+
#private;
|
|
521
|
+
constructor(executor: ResourceExecutor);
|
|
522
|
+
/** `POST /api/observations/{sessionId}/telemetry/exports` — Admit the durable session telemetry-export operation. */
|
|
523
|
+
sessionTelemetryExportCreate(params: {
|
|
524
|
+
readonly sessionId: Models.Id<"session">;
|
|
525
|
+
readonly body: Models.TelemetryExportRequest;
|
|
526
|
+
readonly operationId: Models.Id<"operation">;
|
|
527
|
+
}): Promise<Models.Operation>;
|
|
528
|
+
/** `POST /api/observations/{sessionId}/telemetry/exports/{exportId}/downloads` — Mint a download grant for a ready session telemetry export. */
|
|
529
|
+
sessionTelemetryExportDownloadCreate(params: {
|
|
530
|
+
readonly sessionId: Models.Id<"session">;
|
|
531
|
+
readonly exportId: Models.Id<"export">;
|
|
532
|
+
readonly body: Models.EmptyRequest;
|
|
533
|
+
readonly idempotencyKey: string;
|
|
534
|
+
}): Promise<Models.DownloadGrant>;
|
|
535
|
+
/** `GET /api/observations/{sessionId}/telemetry/exports/{exportId}` — Read one session telemetry export record. */
|
|
536
|
+
sessionTelemetryExportGet(params: {
|
|
537
|
+
readonly sessionId: Models.Id<"session">;
|
|
538
|
+
readonly exportId: Models.Id<"export">;
|
|
539
|
+
}): Promise<Models.TelemetryExport>;
|
|
540
|
+
/** `POST /api/observations/{sessionId}/telemetry/exports/{exportId}/revocations` — Revoke a session telemetry export and its outstanding grants. */
|
|
541
|
+
sessionTelemetryExportRevoke(params: {
|
|
542
|
+
readonly sessionId: Models.Id<"session">;
|
|
543
|
+
readonly exportId: Models.Id<"export">;
|
|
544
|
+
readonly body: Models.EmptyRequest;
|
|
545
|
+
readonly idempotencyKey: string;
|
|
546
|
+
}): Promise<Models.TelemetryExport>;
|
|
547
|
+
/** `GET /api/observations/{sessionId}/telemetry/gaps/{gapId}` — Read one recorded session telemetry gap. */
|
|
548
|
+
sessionTelemetryGapGet(params: {
|
|
549
|
+
readonly sessionId: Models.Id<"session">;
|
|
550
|
+
readonly gapId: Models.Id<"telemetry_gap">;
|
|
551
|
+
}): Promise<Models.TelemetryGap>;
|
|
552
|
+
/** `POST /api/observations/{sessionId}/telemetry/gaps/query` — Query recorded session telemetry gaps. */
|
|
553
|
+
sessionTelemetryGapsQuery(params: {
|
|
554
|
+
readonly sessionId: Models.Id<"session">;
|
|
555
|
+
readonly body: Models.TelemetryGapQuery;
|
|
556
|
+
}): Promise<Models.TelemetryGapPage>;
|
|
557
|
+
/** `POST /api/observations/telemetry/exports` — Admit the durable workspace telemetry-export operation. */
|
|
558
|
+
telemetryExportCreate(params: {
|
|
559
|
+
readonly body: Models.TelemetryExportRequest;
|
|
560
|
+
readonly operationId: Models.Id<"operation">;
|
|
561
|
+
}): Promise<Models.Operation>;
|
|
562
|
+
/** `POST /api/observations/telemetry/exports/{exportId}/downloads` — Mint a download grant for a ready telemetry export. */
|
|
563
|
+
telemetryExportDownloadCreate(params: {
|
|
564
|
+
readonly exportId: Models.Id<"export">;
|
|
565
|
+
readonly body: Models.EmptyRequest;
|
|
566
|
+
readonly idempotencyKey: string;
|
|
567
|
+
}): Promise<Models.DownloadGrant>;
|
|
568
|
+
/** `GET /api/observations/telemetry/exports/{exportId}` — Read one telemetry export record. */
|
|
569
|
+
telemetryExportGet(params: {
|
|
570
|
+
readonly exportId: Models.Id<"export">;
|
|
571
|
+
}): Promise<Models.TelemetryExport>;
|
|
572
|
+
/** `POST /api/observations/telemetry/exports/{exportId}/revocations` — Revoke a telemetry export and its outstanding grants. */
|
|
573
|
+
telemetryExportRevoke(params: {
|
|
574
|
+
readonly exportId: Models.Id<"export">;
|
|
575
|
+
readonly body: Models.EmptyRequest;
|
|
576
|
+
readonly idempotencyKey: string;
|
|
577
|
+
}): Promise<Models.TelemetryExport>;
|
|
578
|
+
/** `GET /api/observations/telemetry/gaps/{gapId}` — Read one recorded telemetry gap. */
|
|
579
|
+
telemetryGapGet(params: {
|
|
580
|
+
readonly gapId: Models.Id<"telemetry_gap">;
|
|
581
|
+
}): Promise<Models.TelemetryGap>;
|
|
582
|
+
/** `POST /api/observations/telemetry/gaps/query` — Query recorded workspace telemetry gaps. */
|
|
583
|
+
telemetryGapsQuery(params: {
|
|
584
|
+
readonly body: Models.TelemetryGapQuery;
|
|
585
|
+
}): Promise<Models.TelemetryGapPage>;
|
|
586
|
+
}
|
|
587
|
+
/** The `uploads` operations. */
|
|
588
|
+
export declare class UploadsClient {
|
|
589
|
+
#private;
|
|
590
|
+
constructor(executor: ResourceExecutor);
|
|
591
|
+
/** `DELETE /api/workspace/uploads/{uploadId}` — Abort a staged upload. */
|
|
592
|
+
uploadAbort(params: {
|
|
593
|
+
readonly uploadId: Models.Id<"upload">;
|
|
594
|
+
}): Promise<void>;
|
|
595
|
+
/** `POST /api/workspace/uploads/{uploadId}/completion` — Complete a staged upload. */
|
|
596
|
+
uploadComplete(params: {
|
|
597
|
+
readonly uploadId: Models.Id<"upload">;
|
|
598
|
+
readonly body: Models.UploadCompleteRequest;
|
|
599
|
+
readonly idempotencyKey: string;
|
|
600
|
+
}): Promise<Models.Upload>;
|
|
601
|
+
/** `POST /api/workspace/uploads` — Stage a large registered-resource value. */
|
|
602
|
+
uploadCreate(params: {
|
|
603
|
+
readonly body: Models.UploadCreateRequest;
|
|
604
|
+
readonly idempotencyKey: string;
|
|
605
|
+
}): Promise<Models.Upload>;
|
|
606
|
+
/** `POST /api/workspace/uploads/{uploadId}/parts` — Mint presigned PUT grants for the named parts. */
|
|
607
|
+
uploadPartsGrant(params: {
|
|
608
|
+
readonly uploadId: Models.Id<"upload">;
|
|
609
|
+
readonly body: Models.UploadPartsRequest;
|
|
610
|
+
}): Promise<Models.UploadPartGrants>;
|
|
611
|
+
}
|
|
612
|
+
/** The `usage` operations. */
|
|
613
|
+
export declare class UsageClient {
|
|
614
|
+
#private;
|
|
615
|
+
constructor(executor: ResourceExecutor);
|
|
616
|
+
/** `POST /api/billing/usage/query` — Query rated usage for this workspace. */
|
|
617
|
+
usageQuery(params: {
|
|
618
|
+
readonly query?: {
|
|
619
|
+
readonly workspaceId?: string;
|
|
620
|
+
};
|
|
621
|
+
readonly body: Models.UsageQuery;
|
|
622
|
+
}): Promise<Models.UsagePage>;
|
|
623
|
+
}
|
|
624
|
+
/** The `workspace` operations. */
|
|
625
|
+
export declare class WorkspaceClient {
|
|
626
|
+
#private;
|
|
627
|
+
constructor(executor: ResourceExecutor);
|
|
628
|
+
/** `GET /api/workspace` — Read the workspace this credential is pinned to. */
|
|
629
|
+
workspaceCurrentGet(): Promise<Models.Workspace>;
|
|
630
|
+
/** `GET /api/workspace/limits/{limitId}` — Read one effective workspace safety limit. */
|
|
631
|
+
workspaceLimitGet(params: {
|
|
632
|
+
readonly limitId: "context.tool_result_bytes" | "session.materialized_agents" | "session.initial_files_bytes" | "session.initial_files_count" | "session.agent_execution" | "session.run_budget" | "api.json_body" | "telemetry.batch" | "telemetry.ingest_rate" | "telemetry.metric_series" | "query.filter" | "query.page" | "stream.frame" | "metric.aggregate" | "registry.entries" | "registry.value_bytes" | "telemetry.export";
|
|
633
|
+
}): Promise<Models.EffectiveWorkspaceLimit>;
|
|
634
|
+
/** `GET /api/workspace/limits` — List the effective workspace safety limits. The registry is closed and complete, so the whole set is one page and no continuation is ever minted. */
|
|
635
|
+
workspaceLimitsList(): Promise<Models.EffectiveWorkspaceLimitPage>;
|
|
636
|
+
}
|
|
637
|
+
/** The `workspaces` operations. */
|
|
638
|
+
export declare class WorkspacesClient {
|
|
639
|
+
#private;
|
|
640
|
+
constructor(executor: ResourceExecutor);
|
|
641
|
+
/** `POST /api/workspaces` — Create a region-pinned workspace. */
|
|
642
|
+
workspaceCreate(params: {
|
|
643
|
+
readonly body: Models.WorkspaceCreateRequest;
|
|
644
|
+
readonly idempotencyKey: string;
|
|
645
|
+
}): Promise<Models.Workspace>;
|
|
646
|
+
/** `POST /api/workspaces/{workspaceId}/deletions` — Admit the global workspace-deletion operation. */
|
|
647
|
+
workspaceDelete(params: {
|
|
648
|
+
readonly workspaceId: Models.Id<"workspace">;
|
|
649
|
+
readonly body: Models.WorkspaceDeleteRequest;
|
|
650
|
+
readonly operationId: Models.Id<"operation">;
|
|
651
|
+
}): Promise<Models.Operation>;
|
|
652
|
+
/** `GET /api/workspaces/{workspaceId}` — Read one workspace. */
|
|
653
|
+
workspaceGet(params: {
|
|
654
|
+
readonly workspaceId: Models.Id<"workspace">;
|
|
655
|
+
}): Promise<Models.Workspace>;
|
|
656
|
+
/** `GET /api/workspaces` — List workspaces the caller can reach. */
|
|
657
|
+
workspacesList(params?: {
|
|
658
|
+
readonly query?: {
|
|
659
|
+
readonly cursor?: string;
|
|
660
|
+
readonly limit?: string;
|
|
661
|
+
readonly organizationId?: string;
|
|
662
|
+
};
|
|
663
|
+
}): Promise<Models.WorkspacePage>;
|
|
664
|
+
}
|
|
665
|
+
/**
|
|
666
|
+
* The resource namespaces the client exposes.
|
|
667
|
+
*
|
|
668
|
+
* The client extends this rather than listing the namespaces itself, so a
|
|
669
|
+
* fragment whose last served operation lands or leaves cannot be forgotten
|
|
670
|
+
* in the hand-written half.
|
|
671
|
+
*/
|
|
672
|
+
export declare abstract class GeneratedResources implements ResourceExecutor {
|
|
673
|
+
abstract execute<T>(routeId: RouteId, bindings?: Readonly<Record<string, string>>, options?: ExecuteOptions): Promise<T>;
|
|
674
|
+
/** The `api-keys` operations. */
|
|
675
|
+
readonly apiKeys: ApiKeysClient;
|
|
676
|
+
/** The `auth` operations. */
|
|
677
|
+
readonly auth: AuthClient;
|
|
678
|
+
/** The `billing` operations. */
|
|
679
|
+
readonly billing: BillingClient;
|
|
680
|
+
/** The `bootstrap` operations. */
|
|
681
|
+
readonly bootstrap: BootstrapClient;
|
|
682
|
+
/** The `files` operations. */
|
|
683
|
+
readonly files: FilesClient;
|
|
684
|
+
/** The `identity` operations. */
|
|
685
|
+
readonly identity: IdentityClient;
|
|
686
|
+
/** The `observations` operations. */
|
|
687
|
+
readonly observations: ObservationsClient;
|
|
688
|
+
/** The `operations` operations. */
|
|
689
|
+
readonly operations: OperationsClient;
|
|
690
|
+
/** The `organizations` operations. */
|
|
691
|
+
readonly organizations: OrganizationsClient;
|
|
692
|
+
/** The `otlp` operations. */
|
|
693
|
+
readonly otlp: OtlpClient;
|
|
694
|
+
/** The `provider-credentials` operations. */
|
|
695
|
+
readonly providerCredentials: ProviderCredentialsClient;
|
|
696
|
+
/** The `registry` operations. */
|
|
697
|
+
readonly registry: RegistryClient;
|
|
698
|
+
/** The `sessions` operations. */
|
|
699
|
+
readonly sessions: SessionsClient;
|
|
700
|
+
/** The `telemetry-lifecycle` operations. */
|
|
701
|
+
readonly telemetryLifecycle: TelemetryLifecycleClient;
|
|
702
|
+
/** The `uploads` operations. */
|
|
703
|
+
readonly uploads: UploadsClient;
|
|
704
|
+
/** The `usage` operations. */
|
|
705
|
+
readonly usage: UsageClient;
|
|
706
|
+
/** The `workspace` operations. */
|
|
707
|
+
readonly workspace: WorkspaceClient;
|
|
708
|
+
/** The `workspaces` operations. */
|
|
709
|
+
readonly workspaces: WorkspacesClient;
|
|
710
|
+
}
|