@aexhq/sdk 0.50.0 → 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/README.md +55 -22
- package/dist/client/aex.js +15 -5
- package/dist/client/aex.js.map +1 -1
- package/dist/downloads/download.d.ts +2 -9
- package/dist/downloads/download.js +19 -5
- package/dist/downloads/download.js.map +1 -1
- package/dist/generated/errors.js +2 -1
- package/dist/generated/errors.js.map +1 -1
- 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 +394 -414
- package/dist/generated/resources.js +96 -120
- package/dist/generated/resources.js.map +1 -1
- package/dist/generated/routes.d.ts +5 -3
- package/dist/generated/routes.js +247 -443
- package/dist/generated/routes.js.map +1 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.js +3 -0
- 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/transport/transport.js +6 -1
- package/dist/transport/transport.js.map +1 -1
- package/package.json +5 -1
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
* that enters the ledger loses it, so the published client surface is exactly
|
|
7
7
|
* what the platform answers.
|
|
8
8
|
*/
|
|
9
|
+
import type * as Models from "./models.js";
|
|
9
10
|
import type { RouteId } from "./routes.js";
|
|
10
11
|
/** The one client capability every generated resource method needs. */
|
|
11
12
|
export interface ResourceExecutor {
|
|
@@ -15,8 +16,8 @@ export interface ResourceExecutor {
|
|
|
15
16
|
export interface ExecuteOptions {
|
|
16
17
|
/** Query parameters, already rendered as wire strings. */
|
|
17
18
|
readonly query?: Readonly<Record<string, string>>;
|
|
18
|
-
/** The request body
|
|
19
|
-
readonly body?: unknown;
|
|
19
|
+
/** The request body; binary routes require `Uint8Array`, all others use canonical JSON. */
|
|
20
|
+
readonly body?: unknown | Uint8Array;
|
|
20
21
|
/** `Idempotency-Key`, for a route that requires one. */
|
|
21
22
|
readonly idempotencyKey?: string;
|
|
22
23
|
/** `Aex-Operation-Id`, for a route that admits a durable operation. */
|
|
@@ -27,206 +28,280 @@ export declare class ApiKeysClient {
|
|
|
27
28
|
#private;
|
|
28
29
|
constructor(executor: ResourceExecutor);
|
|
29
30
|
/** `POST /api/api-keys` — Mint a workspace API key whose value is returned once. */
|
|
30
|
-
apiKeyCreate
|
|
31
|
-
readonly body:
|
|
31
|
+
apiKeyCreate(params: {
|
|
32
|
+
readonly body: Models.ApiKeyCreateRequest;
|
|
32
33
|
readonly idempotencyKey: string;
|
|
33
|
-
}): Promise<
|
|
34
|
+
}): Promise<Models.NewApiKey>;
|
|
34
35
|
/** `DELETE /api/api-keys/{apiKeyId}` — Revoke a workspace API key. */
|
|
35
|
-
apiKeyRevoke
|
|
36
|
-
readonly apiKeyId:
|
|
37
|
-
}): Promise<
|
|
36
|
+
apiKeyRevoke(params: {
|
|
37
|
+
readonly apiKeyId: Models.Id<"api_key">;
|
|
38
|
+
}): Promise<void>;
|
|
38
39
|
/** `GET /api/api-keys` — List workspace API key metadata. */
|
|
39
|
-
apiKeysList
|
|
40
|
+
apiKeysList(params: {
|
|
40
41
|
readonly query: {
|
|
41
42
|
readonly cursor?: string;
|
|
42
43
|
readonly limit?: string;
|
|
43
44
|
readonly workspaceId: string;
|
|
44
45
|
};
|
|
45
|
-
}): Promise<
|
|
46
|
+
}): Promise<Models.ApiKeyPage>;
|
|
46
47
|
}
|
|
47
48
|
/** The `auth` operations. */
|
|
48
49
|
export declare class AuthClient {
|
|
49
50
|
#private;
|
|
50
51
|
constructor(executor: ResourceExecutor);
|
|
51
52
|
/** `POST /api/auth/sessions` — Exchange a provider authorization code for a browser session. */
|
|
52
|
-
dashboardSessionCreate
|
|
53
|
-
readonly body:
|
|
54
|
-
}): Promise<
|
|
53
|
+
dashboardSessionCreate(params: {
|
|
54
|
+
readonly body: Models.DashboardSessionRequest;
|
|
55
|
+
}): Promise<Models.DashboardSessionCredential>;
|
|
55
56
|
/** `DELETE /api/auth/sessions/current` — Close the browser session the caller presented. */
|
|
56
|
-
dashboardSessionDelete
|
|
57
|
+
dashboardSessionDelete(): Promise<void>;
|
|
57
58
|
/** `POST /api/auth/device/authorizations` — Begin the CLI device-authorization flow. */
|
|
58
|
-
deviceAuthorizationCreate
|
|
59
|
-
readonly body:
|
|
59
|
+
deviceAuthorizationCreate(params: {
|
|
60
|
+
readonly body: Models.DeviceAuthorizationRequest;
|
|
60
61
|
readonly idempotencyKey: string;
|
|
61
|
-
}): Promise<
|
|
62
|
+
}): Promise<Models.DeviceAuthorization>;
|
|
62
63
|
/** `POST /api/auth/device/decisions` — Approve or deny a pending device authorization. */
|
|
63
|
-
deviceDecisionCreate
|
|
64
|
-
readonly body:
|
|
65
|
-
}): Promise<
|
|
64
|
+
deviceDecisionCreate(params: {
|
|
65
|
+
readonly body: Models.DeviceDecisionRequest;
|
|
66
|
+
}): Promise<Models.DeviceDecisionResult>;
|
|
66
67
|
/** `POST /api/auth/device/tokens` — Exchange an approved device code for an account token. */
|
|
67
|
-
deviceTokenCreate
|
|
68
|
-
readonly body:
|
|
69
|
-
}): Promise<
|
|
68
|
+
deviceTokenCreate(params: {
|
|
69
|
+
readonly body: Models.DeviceTokenRequest;
|
|
70
|
+
}): Promise<Models.DeviceToken>;
|
|
70
71
|
}
|
|
71
72
|
/** The `billing` operations. */
|
|
72
73
|
export declare class BillingClient {
|
|
73
74
|
#private;
|
|
74
75
|
constructor(executor: ResourceExecutor);
|
|
75
76
|
/** `GET /api/organizations/{organizationId}/billing/auto-topup-policy` — Read the automatic top-up policy. */
|
|
76
|
-
billingAutoTopupPolicyGet
|
|
77
|
-
readonly organizationId:
|
|
78
|
-
}): Promise<
|
|
77
|
+
billingAutoTopupPolicyGet(params: {
|
|
78
|
+
readonly organizationId: Models.Id<"organization">;
|
|
79
|
+
}): Promise<Models.AutoTopupPolicy>;
|
|
79
80
|
/** `PUT /api/organizations/{organizationId}/billing/auto-topup-policy` — Replace the automatic top-up policy. */
|
|
80
|
-
billingAutoTopupPolicyPut
|
|
81
|
-
readonly organizationId:
|
|
82
|
-
readonly body:
|
|
81
|
+
billingAutoTopupPolicyPut(params: {
|
|
82
|
+
readonly organizationId: Models.Id<"organization">;
|
|
83
|
+
readonly body: Models.AutoTopupPolicyRequest;
|
|
83
84
|
readonly idempotencyKey: string;
|
|
84
|
-
}): Promise<
|
|
85
|
+
}): Promise<Models.AutoTopupPolicy>;
|
|
85
86
|
/** `GET /api/billing/balance` — Read the prepaid balance of an organization. */
|
|
86
|
-
billingBalanceGet
|
|
87
|
+
billingBalanceGet(params?: {
|
|
87
88
|
readonly query?: {
|
|
88
89
|
readonly organizationId?: string;
|
|
89
90
|
};
|
|
90
|
-
}): Promise<
|
|
91
|
+
}): Promise<Models.BillingBalance>;
|
|
91
92
|
/** `POST /api/organizations/{organizationId}/billing/portal-sessions` — Create a hosted billing portal session. */
|
|
92
|
-
billingPortalSessionCreate
|
|
93
|
-
readonly organizationId:
|
|
94
|
-
readonly body:
|
|
93
|
+
billingPortalSessionCreate(params: {
|
|
94
|
+
readonly organizationId: Models.Id<"organization">;
|
|
95
|
+
readonly body: Models.PortalSessionRequest;
|
|
95
96
|
readonly idempotencyKey: string;
|
|
96
|
-
}): Promise<
|
|
97
|
+
}): Promise<Models.HostedSession>;
|
|
97
98
|
/** `POST /api/organizations/{organizationId}/billing/statements/{statementId}/downloads` — Mint a download grant for an issued statement. */
|
|
98
|
-
billingStatementDownloadCreate
|
|
99
|
-
readonly organizationId:
|
|
100
|
-
readonly statementId:
|
|
101
|
-
readonly body:
|
|
99
|
+
billingStatementDownloadCreate(params: {
|
|
100
|
+
readonly organizationId: Models.Id<"organization">;
|
|
101
|
+
readonly statementId: Models.Id<"statement">;
|
|
102
|
+
readonly body: Models.EmptyRequest;
|
|
102
103
|
readonly idempotencyKey: string;
|
|
103
|
-
}): Promise<
|
|
104
|
+
}): Promise<Models.DownloadGrant>;
|
|
104
105
|
/** `GET /api/organizations/{organizationId}/billing/statements/{statementId}` — Read one immutable issued statement. */
|
|
105
|
-
billingStatementGet
|
|
106
|
-
readonly organizationId:
|
|
107
|
-
readonly statementId:
|
|
108
|
-
}): Promise<
|
|
106
|
+
billingStatementGet(params: {
|
|
107
|
+
readonly organizationId: Models.Id<"organization">;
|
|
108
|
+
readonly statementId: Models.Id<"statement">;
|
|
109
|
+
}): Promise<Models.Statement>;
|
|
109
110
|
/** `GET /api/organizations/{organizationId}/billing/statements` — List issued statements, newest first. */
|
|
110
|
-
billingStatementsList
|
|
111
|
-
readonly organizationId:
|
|
111
|
+
billingStatementsList(params: {
|
|
112
|
+
readonly organizationId: Models.Id<"organization">;
|
|
112
113
|
readonly query?: {
|
|
113
114
|
readonly cursor?: string;
|
|
114
115
|
readonly limit?: string;
|
|
115
116
|
};
|
|
116
|
-
}): Promise<
|
|
117
|
+
}): Promise<Models.StatementSummaryPage>;
|
|
117
118
|
/** `POST /api/organizations/{organizationId}/billing/top-up-checkouts` — Create a hosted top-up checkout. */
|
|
118
|
-
billingTopUpCheckoutCreate
|
|
119
|
-
readonly organizationId:
|
|
120
|
-
readonly body:
|
|
119
|
+
billingTopUpCheckoutCreate(params: {
|
|
120
|
+
readonly organizationId: Models.Id<"organization">;
|
|
121
|
+
readonly body: Models.TopUpCheckoutRequest;
|
|
121
122
|
readonly idempotencyKey: string;
|
|
122
|
-
}): Promise<
|
|
123
|
+
}): Promise<Models.HostedSession>;
|
|
123
124
|
}
|
|
124
125
|
/** The `bootstrap` operations. */
|
|
125
126
|
export declare class BootstrapClient {
|
|
126
127
|
#private;
|
|
127
128
|
constructor(executor: ResourceExecutor);
|
|
128
129
|
/** `GET /api/bootstrap` — One bounded read that fills the dashboard shell. */
|
|
129
|
-
dashboardBootstrapGet
|
|
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>;
|
|
130
205
|
}
|
|
131
206
|
/** The `identity` operations. */
|
|
132
207
|
export declare class IdentityClient {
|
|
133
208
|
#private;
|
|
134
209
|
constructor(executor: ResourceExecutor);
|
|
135
210
|
/** `GET /api/account` — Read the account and its operational state. */
|
|
136
|
-
accountGet
|
|
211
|
+
accountGet(params: {
|
|
137
212
|
readonly query: {
|
|
138
213
|
readonly organizationId: string;
|
|
139
214
|
};
|
|
140
|
-
}): Promise<
|
|
215
|
+
}): Promise<Models.AccountOperationalState>;
|
|
141
216
|
}
|
|
142
217
|
/** The `observations` operations. */
|
|
143
218
|
export declare class ObservationsClient {
|
|
144
219
|
#private;
|
|
145
220
|
constructor(executor: ResourceExecutor);
|
|
146
221
|
/** `POST /api/observations/events/query` — Query workspace events observations. */
|
|
147
|
-
observationsEventsQuery
|
|
148
|
-
readonly body:
|
|
149
|
-
}): Promise<
|
|
222
|
+
observationsEventsQuery(params: {
|
|
223
|
+
readonly body: Models.ObservationQuery;
|
|
224
|
+
}): Promise<Models.ObservationPage>;
|
|
150
225
|
/** `POST /api/observations/logs/query` — Query workspace logs observations. */
|
|
151
|
-
observationsLogsQuery
|
|
152
|
-
readonly body:
|
|
153
|
-
}): Promise<
|
|
226
|
+
observationsLogsQuery(params: {
|
|
227
|
+
readonly body: Models.ObservationQuery;
|
|
228
|
+
}): Promise<Models.ObservationPage>;
|
|
154
229
|
/** `POST /api/observations/metrics/aggregate` — Aggregate workspace metric observations. */
|
|
155
|
-
observationsMetricsAggregate
|
|
156
|
-
readonly body:
|
|
157
|
-
}): Promise<
|
|
230
|
+
observationsMetricsAggregate(params: {
|
|
231
|
+
readonly body: Models.MetricAggregationRequest;
|
|
232
|
+
}): Promise<Models.MetricAggregationPage>;
|
|
158
233
|
/** `POST /api/observations/metrics/query` — Query workspace metrics observations. */
|
|
159
|
-
observationsMetricsQuery
|
|
160
|
-
readonly body:
|
|
161
|
-
}): Promise<
|
|
234
|
+
observationsMetricsQuery(params: {
|
|
235
|
+
readonly body: Models.ObservationQuery;
|
|
236
|
+
}): Promise<Models.ObservationPage>;
|
|
162
237
|
/** `POST /api/observations/spans/query` — Query workspace spans observations. */
|
|
163
|
-
observationsSpansQuery
|
|
164
|
-
readonly body:
|
|
165
|
-
}): Promise<
|
|
238
|
+
observationsSpansQuery(params: {
|
|
239
|
+
readonly body: Models.ObservationQuery;
|
|
240
|
+
}): Promise<Models.ObservationPage>;
|
|
166
241
|
/** `POST /api/observations/telemetry/query` — Query workspace telemetry observations. */
|
|
167
|
-
observationsTelemetryQuery
|
|
168
|
-
readonly body:
|
|
169
|
-
}): Promise<
|
|
242
|
+
observationsTelemetryQuery(params: {
|
|
243
|
+
readonly body: Models.ObservationQuery;
|
|
244
|
+
}): Promise<Models.ObservationPage>;
|
|
170
245
|
/** `POST /api/observations/traces/query` — Query workspace traces observations. */
|
|
171
|
-
observationsTracesQuery
|
|
172
|
-
readonly body:
|
|
173
|
-
}): Promise<
|
|
246
|
+
observationsTracesQuery(params: {
|
|
247
|
+
readonly body: Models.ObservationQuery;
|
|
248
|
+
}): Promise<Models.ObservationPage>;
|
|
174
249
|
/** `POST /api/observations/{sessionId}/events/query` — Query session events observations. */
|
|
175
|
-
sessionObservationsEventsQuery
|
|
176
|
-
readonly sessionId:
|
|
177
|
-
readonly body:
|
|
178
|
-
}): Promise<
|
|
250
|
+
sessionObservationsEventsQuery(params: {
|
|
251
|
+
readonly sessionId: Models.Id<"session">;
|
|
252
|
+
readonly body: Models.ObservationQuery;
|
|
253
|
+
}): Promise<Models.ObservationPage>;
|
|
179
254
|
/** `POST /api/observations/{sessionId}/logs/query` — Query session logs observations. */
|
|
180
|
-
sessionObservationsLogsQuery
|
|
181
|
-
readonly sessionId:
|
|
182
|
-
readonly body:
|
|
183
|
-
}): Promise<
|
|
255
|
+
sessionObservationsLogsQuery(params: {
|
|
256
|
+
readonly sessionId: Models.Id<"session">;
|
|
257
|
+
readonly body: Models.ObservationQuery;
|
|
258
|
+
}): Promise<Models.ObservationPage>;
|
|
184
259
|
/** `POST /api/observations/{sessionId}/metrics/aggregate` — Aggregate session metric observations. */
|
|
185
|
-
sessionObservationsMetricsAggregate
|
|
186
|
-
readonly sessionId:
|
|
187
|
-
readonly body:
|
|
188
|
-
}): Promise<
|
|
260
|
+
sessionObservationsMetricsAggregate(params: {
|
|
261
|
+
readonly sessionId: Models.Id<"session">;
|
|
262
|
+
readonly body: Models.MetricAggregationRequest;
|
|
263
|
+
}): Promise<Models.MetricAggregationPage>;
|
|
189
264
|
/** `POST /api/observations/{sessionId}/metrics/query` — Query session metrics observations. */
|
|
190
|
-
sessionObservationsMetricsQuery
|
|
191
|
-
readonly sessionId:
|
|
192
|
-
readonly body:
|
|
193
|
-
}): Promise<
|
|
265
|
+
sessionObservationsMetricsQuery(params: {
|
|
266
|
+
readonly sessionId: Models.Id<"session">;
|
|
267
|
+
readonly body: Models.ObservationQuery;
|
|
268
|
+
}): Promise<Models.ObservationPage>;
|
|
194
269
|
/** `POST /api/observations/{sessionId}/spans/query` — Query session spans observations. */
|
|
195
|
-
sessionObservationsSpansQuery
|
|
196
|
-
readonly sessionId:
|
|
197
|
-
readonly body:
|
|
198
|
-
}): Promise<
|
|
270
|
+
sessionObservationsSpansQuery(params: {
|
|
271
|
+
readonly sessionId: Models.Id<"session">;
|
|
272
|
+
readonly body: Models.ObservationQuery;
|
|
273
|
+
}): Promise<Models.ObservationPage>;
|
|
199
274
|
/** `POST /api/observations/{sessionId}/telemetry/query` — Query session telemetry observations. */
|
|
200
|
-
sessionObservationsTelemetryQuery
|
|
201
|
-
readonly sessionId:
|
|
202
|
-
readonly body:
|
|
203
|
-
}): Promise<
|
|
275
|
+
sessionObservationsTelemetryQuery(params: {
|
|
276
|
+
readonly sessionId: Models.Id<"session">;
|
|
277
|
+
readonly body: Models.ObservationQuery;
|
|
278
|
+
}): Promise<Models.ObservationPage>;
|
|
204
279
|
/** `GET /api/observations/{sessionId}/traces/{traceId}` — Read one assembled trace by its W3C identifier. */
|
|
205
|
-
sessionObservationsTraceGet
|
|
206
|
-
readonly sessionId:
|
|
280
|
+
sessionObservationsTraceGet(params: {
|
|
281
|
+
readonly sessionId: Models.Id<"session">;
|
|
207
282
|
readonly traceId: string;
|
|
208
|
-
}): Promise<
|
|
283
|
+
}): Promise<Models.TraceDetail>;
|
|
209
284
|
/** `POST /api/observations/{sessionId}/traces/query` — Query session traces observations. */
|
|
210
|
-
sessionObservationsTracesQuery
|
|
211
|
-
readonly sessionId:
|
|
212
|
-
readonly body:
|
|
213
|
-
}): Promise<
|
|
285
|
+
sessionObservationsTracesQuery(params: {
|
|
286
|
+
readonly sessionId: Models.Id<"session">;
|
|
287
|
+
readonly body: Models.ObservationQuery;
|
|
288
|
+
}): Promise<Models.ObservationPage>;
|
|
214
289
|
}
|
|
215
290
|
/** The `operations` operations. */
|
|
216
291
|
export declare class OperationsClient {
|
|
217
292
|
#private;
|
|
218
293
|
constructor(executor: ResourceExecutor);
|
|
219
294
|
/** `POST /api/operations/{operationId}/cancellations` — Request cancellation of a central operation. */
|
|
220
|
-
centralOperationCancel
|
|
221
|
-
readonly operationId:
|
|
222
|
-
readonly body:
|
|
223
|
-
}): Promise<
|
|
295
|
+
centralOperationCancel(params: {
|
|
296
|
+
readonly operationId: Models.Id<"operation">;
|
|
297
|
+
readonly body: Models.EmptyRequest;
|
|
298
|
+
}): Promise<Models.Operation>;
|
|
224
299
|
/** `GET /api/operations/{operationId}` — Read one central durable operation. */
|
|
225
|
-
centralOperationGet
|
|
226
|
-
readonly operationId:
|
|
227
|
-
}): Promise<
|
|
300
|
+
centralOperationGet(params: {
|
|
301
|
+
readonly operationId: Models.Id<"operation">;
|
|
302
|
+
}): Promise<Models.Operation>;
|
|
228
303
|
/** `GET /api/operations` — List central durable operations for one organization. */
|
|
229
|
-
centralOperationsList
|
|
304
|
+
centralOperationsList(params: {
|
|
230
305
|
readonly query: {
|
|
231
306
|
readonly cursor?: string;
|
|
232
307
|
readonly kind?: string;
|
|
@@ -234,18 +309,18 @@ export declare class OperationsClient {
|
|
|
234
309
|
readonly organizationId: string;
|
|
235
310
|
readonly status?: string;
|
|
236
311
|
};
|
|
237
|
-
}): Promise<
|
|
312
|
+
}): Promise<Models.OperationPage>;
|
|
238
313
|
/** `POST /api/operations/{operationId}/cancellations` — Request cancellation of a regional operation. */
|
|
239
|
-
regionalOperationCancel
|
|
240
|
-
readonly operationId:
|
|
241
|
-
readonly body:
|
|
242
|
-
}): Promise<
|
|
314
|
+
regionalOperationCancel(params: {
|
|
315
|
+
readonly operationId: Models.Id<"operation">;
|
|
316
|
+
readonly body: Models.EmptyRequest;
|
|
317
|
+
}): Promise<Models.Operation>;
|
|
243
318
|
/** `GET /api/operations/{operationId}` — Read one regional durable operation. */
|
|
244
|
-
regionalOperationGet
|
|
245
|
-
readonly operationId:
|
|
246
|
-
}): Promise<
|
|
319
|
+
regionalOperationGet(params: {
|
|
320
|
+
readonly operationId: Models.Id<"operation">;
|
|
321
|
+
}): Promise<Models.Operation>;
|
|
247
322
|
/** `GET /api/operations` — List regional durable operations. */
|
|
248
|
-
regionalOperationsList
|
|
323
|
+
regionalOperationsList(params?: {
|
|
249
324
|
readonly query?: {
|
|
250
325
|
readonly cursor?: string;
|
|
251
326
|
readonly kind?: string;
|
|
@@ -253,434 +328,339 @@ export declare class OperationsClient {
|
|
|
253
328
|
readonly sessionId?: string;
|
|
254
329
|
readonly status?: string;
|
|
255
330
|
};
|
|
256
|
-
}): Promise<
|
|
331
|
+
}): Promise<Models.OperationPage>;
|
|
257
332
|
}
|
|
258
333
|
/** The `organizations` operations. */
|
|
259
334
|
export declare class OrganizationsClient {
|
|
260
335
|
#private;
|
|
261
336
|
constructor(executor: ResourceExecutor);
|
|
262
337
|
/** `POST /api/invitations/acceptances` — Redeem every pending invitation addressed to the caller's verified email. */
|
|
263
|
-
invitationAccept
|
|
264
|
-
readonly body:
|
|
265
|
-
}): Promise<
|
|
338
|
+
invitationAccept(params: {
|
|
339
|
+
readonly body: Models.EmptyRequest;
|
|
340
|
+
}): Promise<Models.InvitationAcceptResult>;
|
|
266
341
|
/** `POST /api/organizations/{organizationId}/invitations` — Invite a person to the organization. */
|
|
267
|
-
invitationCreate
|
|
268
|
-
readonly organizationId:
|
|
269
|
-
readonly body:
|
|
342
|
+
invitationCreate(params: {
|
|
343
|
+
readonly organizationId: Models.Id<"organization">;
|
|
344
|
+
readonly body: Models.InvitationCreateRequest;
|
|
270
345
|
readonly idempotencyKey: string;
|
|
271
|
-
}): Promise<
|
|
346
|
+
}): Promise<Models.Invitation>;
|
|
272
347
|
/** `GET /api/organizations/{organizationId}/memberships` — List the memberships of an organization. */
|
|
273
|
-
membershipsList
|
|
274
|
-
readonly organizationId:
|
|
348
|
+
membershipsList(params: {
|
|
349
|
+
readonly organizationId: Models.Id<"organization">;
|
|
275
350
|
readonly query?: {
|
|
276
351
|
readonly cursor?: string;
|
|
277
352
|
readonly limit?: string;
|
|
278
353
|
};
|
|
279
|
-
}): Promise<
|
|
354
|
+
}): Promise<Models.MembershipPage>;
|
|
280
355
|
/** `POST /api/organizations` — Create an organization whose creator becomes owner. */
|
|
281
|
-
organizationCreate
|
|
282
|
-
readonly body:
|
|
356
|
+
organizationCreate(params: {
|
|
357
|
+
readonly body: Models.OrganizationCreateRequest;
|
|
283
358
|
readonly idempotencyKey: string;
|
|
284
|
-
}): Promise<
|
|
359
|
+
}): Promise<Models.Organization>;
|
|
285
360
|
/** `GET /api/organizations/{organizationId}` — Read one organization. */
|
|
286
|
-
organizationGet
|
|
287
|
-
readonly organizationId:
|
|
288
|
-
}): Promise<
|
|
361
|
+
organizationGet(params: {
|
|
362
|
+
readonly organizationId: Models.Id<"organization">;
|
|
363
|
+
}): Promise<Models.Organization>;
|
|
289
364
|
/** `GET /api/organizations` — List organizations the caller belongs to. */
|
|
290
|
-
organizationsList
|
|
365
|
+
organizationsList(params?: {
|
|
291
366
|
readonly query?: {
|
|
292
367
|
readonly cursor?: string;
|
|
293
368
|
readonly limit?: string;
|
|
294
369
|
};
|
|
295
|
-
}): Promise<
|
|
370
|
+
}): Promise<Models.OrganizationPage>;
|
|
296
371
|
}
|
|
297
372
|
/** The `otlp` operations. */
|
|
298
373
|
export declare class OtlpClient {
|
|
299
374
|
#private;
|
|
300
375
|
constructor(executor: ResourceExecutor);
|
|
301
376
|
/** `POST /api/otlp/v1/logs` — Admit an OTLP logs batch. */
|
|
302
|
-
otlpLogsIngest
|
|
377
|
+
otlpLogsIngest(params: {
|
|
303
378
|
readonly body: unknown;
|
|
304
379
|
readonly idempotencyKey: string;
|
|
305
|
-
}): Promise<
|
|
380
|
+
}): Promise<Models.TelemetryAdmissionReceipt>;
|
|
306
381
|
/** `POST /api/otlp/v1/metrics` — Admit an OTLP metrics batch. */
|
|
307
|
-
otlpMetricsIngest
|
|
382
|
+
otlpMetricsIngest(params: {
|
|
308
383
|
readonly body: unknown;
|
|
309
384
|
readonly idempotencyKey: string;
|
|
310
|
-
}): Promise<
|
|
385
|
+
}): Promise<Models.TelemetryAdmissionReceipt>;
|
|
311
386
|
/** `POST /api/otlp/v1/traces` — Admit an OTLP traces batch. */
|
|
312
|
-
otlpTracesIngest
|
|
387
|
+
otlpTracesIngest(params: {
|
|
313
388
|
readonly body: unknown;
|
|
314
389
|
readonly idempotencyKey: string;
|
|
315
|
-
}): Promise<
|
|
390
|
+
}): Promise<Models.TelemetryAdmissionReceipt>;
|
|
316
391
|
}
|
|
317
392
|
/** The `provider-credentials` operations. */
|
|
318
393
|
export declare class ProviderCredentialsClient {
|
|
319
394
|
#private;
|
|
320
395
|
constructor(executor: ResourceExecutor);
|
|
321
|
-
/** `GET /api/workspace/provider-credentials/{providerCredentialId}` — Read one provider-credential binding. */
|
|
322
|
-
providerCredentialGet
|
|
323
|
-
readonly providerCredentialId:
|
|
324
|
-
}): Promise<
|
|
325
|
-
/** `POST /api/
|
|
326
|
-
providerCredentialRegister
|
|
327
|
-
readonly body:
|
|
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;
|
|
328
403
|
readonly idempotencyKey: string;
|
|
329
|
-
}): Promise<
|
|
330
|
-
/** `POST /api/workspace/provider-credentials/{providerCredentialId}/revocations` — Revoke a provider-credential binding. */
|
|
331
|
-
providerCredentialRevoke
|
|
332
|
-
readonly providerCredentialId:
|
|
333
|
-
readonly body:
|
|
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;
|
|
334
409
|
readonly idempotencyKey: string;
|
|
335
|
-
}): Promise<
|
|
336
|
-
/** `GET /api/workspace/provider-credentials` — List provider-credential binding metadata. */
|
|
337
|
-
providerCredentialsList
|
|
410
|
+
}): Promise<Models.ProviderCredential>;
|
|
411
|
+
/** `GET /api/workspace/provider-credentials` — List BYOK provider-credential binding metadata. */
|
|
412
|
+
providerCredentialsList(params?: {
|
|
338
413
|
readonly query?: {
|
|
339
414
|
readonly cursor?: string;
|
|
340
415
|
readonly limit?: string;
|
|
341
416
|
readonly provider?: string;
|
|
342
417
|
};
|
|
343
|
-
}): Promise<
|
|
418
|
+
}): Promise<Models.ProviderCredentialPage>;
|
|
344
419
|
}
|
|
345
420
|
/** The `registry` operations. */
|
|
346
421
|
export declare class RegistryClient {
|
|
347
422
|
#private;
|
|
348
423
|
constructor(executor: ResourceExecutor);
|
|
349
|
-
/** `DELETE /api/workspace/files/{name}` — Delete one registered
|
|
350
|
-
registryFilesDelete
|
|
424
|
+
/** `DELETE /api/workspace/files/{name}` — Delete one registered workspace file. */
|
|
425
|
+
registryFilesDelete(params: {
|
|
351
426
|
readonly name: string;
|
|
352
|
-
}): Promise<
|
|
353
|
-
/** `POST /api/workspace/files/{name}/downloads` — Mint a download grant for a registered file. */
|
|
354
|
-
registryFilesDownloadCreate
|
|
427
|
+
}): Promise<void>;
|
|
428
|
+
/** `POST /api/workspace/files/{name}/downloads` — Mint a download grant for a registered workspace file. */
|
|
429
|
+
registryFilesDownloadCreate(params: {
|
|
355
430
|
readonly name: string;
|
|
356
|
-
readonly body:
|
|
431
|
+
readonly body: Models.RegistryDownloadRequest;
|
|
357
432
|
readonly idempotencyKey: string;
|
|
358
|
-
}): Promise<
|
|
359
|
-
/** `GET /api/workspace/files/{name}` — Read one registered
|
|
360
|
-
registryFilesGet
|
|
433
|
+
}): Promise<Models.DownloadGrant>;
|
|
434
|
+
/** `GET /api/workspace/files/{name}` — Read one registered workspace file. */
|
|
435
|
+
registryFilesGet(params: {
|
|
361
436
|
readonly name: string;
|
|
362
|
-
}): Promise<
|
|
363
|
-
/** `GET /api/workspace/files` — List registered files. */
|
|
364
|
-
registryFilesList
|
|
437
|
+
}): Promise<Models.RegisteredFile>;
|
|
438
|
+
/** `GET /api/workspace/files` — List registered workspace files. */
|
|
439
|
+
registryFilesList(params?: {
|
|
365
440
|
readonly query?: {
|
|
366
441
|
readonly cursor?: string;
|
|
367
442
|
readonly limit?: string;
|
|
368
443
|
};
|
|
369
|
-
}): Promise<
|
|
370
|
-
/** `PUT /api/workspace/files/{name}` — Replace one registered
|
|
371
|
-
registryFilesPut
|
|
444
|
+
}): Promise<Models.RegisteredFilePage>;
|
|
445
|
+
/** `PUT /api/workspace/files/{name}` — Replace one registered workspace file. */
|
|
446
|
+
registryFilesPut(params: {
|
|
372
447
|
readonly name: string;
|
|
373
|
-
readonly body:
|
|
448
|
+
readonly body: Models.RegisteredFileValue;
|
|
374
449
|
readonly idempotencyKey: string;
|
|
375
|
-
}): Promise<
|
|
376
|
-
/** `DELETE /api/workspace/instructions/{name}` — Delete one registered entry from instructions. */
|
|
377
|
-
registryInstructionsDelete<T = unknown>(params: {
|
|
378
|
-
readonly name: string;
|
|
379
|
-
}): Promise<T>;
|
|
380
|
-
/** `GET /api/workspace/instructions/{name}` — Read one registered entry from instructions. */
|
|
381
|
-
registryInstructionsGet<T = unknown>(params: {
|
|
382
|
-
readonly name: string;
|
|
383
|
-
}): Promise<T>;
|
|
384
|
-
/** `GET /api/workspace/instructions` — List registered instructions. */
|
|
385
|
-
registryInstructionsList<T = unknown>(params?: {
|
|
386
|
-
readonly query?: {
|
|
387
|
-
readonly cursor?: string;
|
|
388
|
-
readonly limit?: string;
|
|
389
|
-
};
|
|
390
|
-
}): Promise<T>;
|
|
391
|
-
/** `PUT /api/workspace/instructions/{name}` — Replace one registered entry in instructions. */
|
|
392
|
-
registryInstructionsPut<T = unknown>(params: {
|
|
393
|
-
readonly name: string;
|
|
394
|
-
readonly body: unknown;
|
|
395
|
-
readonly idempotencyKey: string;
|
|
396
|
-
}): Promise<T>;
|
|
397
|
-
/** `DELETE /api/workspace/mcp-servers/{name}` — Delete one registered entry from MCP servers. */
|
|
398
|
-
registryMcpServersDelete<T = unknown>(params: {
|
|
399
|
-
readonly name: string;
|
|
400
|
-
}): Promise<T>;
|
|
401
|
-
/** `GET /api/workspace/mcp-servers/{name}` — Read one registered entry from MCP servers. */
|
|
402
|
-
registryMcpServersGet<T = unknown>(params: {
|
|
403
|
-
readonly name: string;
|
|
404
|
-
}): Promise<T>;
|
|
405
|
-
/** `GET /api/workspace/mcp-servers` — List registered MCP servers. */
|
|
406
|
-
registryMcpServersList<T = unknown>(params?: {
|
|
407
|
-
readonly query?: {
|
|
408
|
-
readonly cursor?: string;
|
|
409
|
-
readonly limit?: string;
|
|
410
|
-
};
|
|
411
|
-
}): Promise<T>;
|
|
412
|
-
/** `PUT /api/workspace/mcp-servers/{name}` — Replace one registered entry in MCP servers. */
|
|
413
|
-
registryMcpServersPut<T = unknown>(params: {
|
|
414
|
-
readonly name: string;
|
|
415
|
-
readonly body: unknown;
|
|
416
|
-
readonly idempotencyKey: string;
|
|
417
|
-
}): Promise<T>;
|
|
418
|
-
/** `DELETE /api/workspace/skills/{name}` — Delete one registered entry from skills. */
|
|
419
|
-
registrySkillsDelete<T = unknown>(params: {
|
|
420
|
-
readonly name: string;
|
|
421
|
-
}): Promise<T>;
|
|
422
|
-
/** `GET /api/workspace/skills/{name}` — Read one registered entry from skills. */
|
|
423
|
-
registrySkillsGet<T = unknown>(params: {
|
|
424
|
-
readonly name: string;
|
|
425
|
-
}): Promise<T>;
|
|
426
|
-
/** `GET /api/workspace/skills` — List registered skills. */
|
|
427
|
-
registrySkillsList<T = unknown>(params?: {
|
|
428
|
-
readonly query?: {
|
|
429
|
-
readonly cursor?: string;
|
|
430
|
-
readonly limit?: string;
|
|
431
|
-
};
|
|
432
|
-
}): Promise<T>;
|
|
433
|
-
/** `PUT /api/workspace/skills/{name}` — Replace one registered entry in skills. */
|
|
434
|
-
registrySkillsPut<T = unknown>(params: {
|
|
435
|
-
readonly name: string;
|
|
436
|
-
readonly body: unknown;
|
|
437
|
-
readonly idempotencyKey: string;
|
|
438
|
-
}): Promise<T>;
|
|
439
|
-
/** `DELETE /api/workspace/tools/{name}` — Delete one registered entry from tools. */
|
|
440
|
-
registryToolsDelete<T = unknown>(params: {
|
|
441
|
-
readonly name: string;
|
|
442
|
-
}): Promise<T>;
|
|
443
|
-
/** `GET /api/workspace/tools/{name}` — Read one registered entry from tools. */
|
|
444
|
-
registryToolsGet<T = unknown>(params: {
|
|
445
|
-
readonly name: string;
|
|
446
|
-
}): Promise<T>;
|
|
447
|
-
/** `GET /api/workspace/tools` — List registered tools. */
|
|
448
|
-
registryToolsList<T = unknown>(params?: {
|
|
449
|
-
readonly query?: {
|
|
450
|
-
readonly cursor?: string;
|
|
451
|
-
readonly limit?: string;
|
|
452
|
-
};
|
|
453
|
-
}): Promise<T>;
|
|
454
|
-
/** `PUT /api/workspace/tools/{name}` — Replace one registered entry in tools. */
|
|
455
|
-
registryToolsPut<T = unknown>(params: {
|
|
456
|
-
readonly name: string;
|
|
457
|
-
readonly body: unknown;
|
|
458
|
-
readonly idempotencyKey: string;
|
|
459
|
-
}): Promise<T>;
|
|
460
|
-
}
|
|
461
|
-
/** The `secrets` operations. */
|
|
462
|
-
export declare class SecretsClient {
|
|
463
|
-
#private;
|
|
464
|
-
constructor(executor: ResourceExecutor);
|
|
465
|
-
/** `DELETE /api/secrets/{name}` — Delete a secret, affecting future admission only. */
|
|
466
|
-
secretDelete<T = unknown>(params: {
|
|
467
|
-
readonly name: string;
|
|
468
|
-
}): Promise<T>;
|
|
469
|
-
/** `GET /api/workspace/secrets/{name}` — Read one secret metadata record. */
|
|
470
|
-
secretGet<T = unknown>(params: {
|
|
471
|
-
readonly name: string;
|
|
472
|
-
}): Promise<T>;
|
|
473
|
-
/** `PUT /api/secrets/{name}` — Set a secret value for future admission. */
|
|
474
|
-
secretPut<T = unknown>(params: {
|
|
475
|
-
readonly name: string;
|
|
476
|
-
readonly body: unknown;
|
|
477
|
-
readonly idempotencyKey: string;
|
|
478
|
-
}): Promise<T>;
|
|
479
|
-
/** `POST /api/secrets/{name}/revocations` — Revoke a secret and cancel current custody. */
|
|
480
|
-
secretRevoke<T = unknown>(params: {
|
|
481
|
-
readonly name: string;
|
|
482
|
-
readonly body: unknown;
|
|
483
|
-
readonly idempotencyKey: string;
|
|
484
|
-
}): Promise<T>;
|
|
485
|
-
/** `GET /api/workspace/secrets` — List secret metadata; values are never readable. */
|
|
486
|
-
secretsList<T = unknown>(params?: {
|
|
487
|
-
readonly query?: {
|
|
488
|
-
readonly cursor?: string;
|
|
489
|
-
readonly limit?: string;
|
|
490
|
-
};
|
|
491
|
-
}): Promise<T>;
|
|
450
|
+
}): Promise<Models.RegisteredFile>;
|
|
492
451
|
}
|
|
493
452
|
/** The `sessions` operations. */
|
|
494
453
|
export declare class SessionsClient {
|
|
495
454
|
#private;
|
|
496
455
|
constructor(executor: ResourceExecutor);
|
|
497
|
-
/** `
|
|
498
|
-
|
|
499
|
-
readonly sessionId:
|
|
500
|
-
|
|
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>;
|
|
501
483
|
/** `GET /api/sessions/{sessionId}/messages` — List complete sealed messages in immutable seal-visibility order. */
|
|
502
|
-
sessionMessagesList
|
|
503
|
-
readonly sessionId:
|
|
504
|
-
readonly query?: {
|
|
505
|
-
readonly cursor?: string;
|
|
506
|
-
readonly limit?: string;
|
|
507
|
-
};
|
|
508
|
-
}): Promise<T>;
|
|
509
|
-
/** `POST /api/sessions/{sessionId}/restores` — Admit the durable restore operation, which is legal only inside the recovery window. */
|
|
510
|
-
sessionRestore<T = unknown>(params: {
|
|
511
|
-
readonly sessionId: string;
|
|
512
|
-
readonly body: unknown;
|
|
513
|
-
readonly operationId: string;
|
|
514
|
-
}): Promise<T>;
|
|
515
|
-
/** `GET /api/sessions/{sessionId}/runs/{runId}` — Read one run. */
|
|
516
|
-
sessionRunGet<T = unknown>(params: {
|
|
517
|
-
readonly sessionId: string;
|
|
518
|
-
readonly runId: string;
|
|
519
|
-
}): Promise<T>;
|
|
520
|
-
/** `GET /api/sessions/{sessionId}/runs` — List the runs of a session. */
|
|
521
|
-
sessionRunsList<T = unknown>(params: {
|
|
522
|
-
readonly sessionId: string;
|
|
484
|
+
sessionMessagesList(params: {
|
|
485
|
+
readonly sessionId: Models.Id<"session">;
|
|
523
486
|
readonly query?: {
|
|
524
487
|
readonly cursor?: string;
|
|
525
488
|
readonly limit?: string;
|
|
526
489
|
};
|
|
527
|
-
}): Promise<
|
|
528
|
-
/** `POST /api/sessions/{sessionId}/
|
|
529
|
-
|
|
530
|
-
readonly sessionId:
|
|
531
|
-
readonly body:
|
|
532
|
-
readonly operationId:
|
|
533
|
-
}): Promise<
|
|
534
|
-
/** `POST /api/sessions/{sessionId}/
|
|
535
|
-
|
|
536
|
-
readonly sessionId:
|
|
537
|
-
readonly body:
|
|
538
|
-
readonly operationId:
|
|
539
|
-
}): Promise<
|
|
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>;
|
|
540
509
|
/** `GET /api/sessions` — List sessions in the workspace. */
|
|
541
|
-
sessionsList
|
|
510
|
+
sessionsList(params?: {
|
|
542
511
|
readonly query?: {
|
|
543
512
|
readonly cursor?: string;
|
|
544
513
|
readonly limit?: string;
|
|
545
514
|
readonly status?: string;
|
|
546
515
|
};
|
|
547
|
-
}): Promise<
|
|
516
|
+
}): Promise<Models.SessionListPage>;
|
|
548
517
|
}
|
|
549
518
|
/** The `telemetry-lifecycle` operations. */
|
|
550
519
|
export declare class TelemetryLifecycleClient {
|
|
551
520
|
#private;
|
|
552
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>;
|
|
553
528
|
/** `POST /api/observations/{sessionId}/telemetry/exports/{exportId}/downloads` — Mint a download grant for a ready session telemetry export. */
|
|
554
|
-
sessionTelemetryExportDownloadCreate
|
|
555
|
-
readonly sessionId:
|
|
556
|
-
readonly exportId:
|
|
557
|
-
readonly body:
|
|
529
|
+
sessionTelemetryExportDownloadCreate(params: {
|
|
530
|
+
readonly sessionId: Models.Id<"session">;
|
|
531
|
+
readonly exportId: Models.Id<"export">;
|
|
532
|
+
readonly body: Models.EmptyRequest;
|
|
558
533
|
readonly idempotencyKey: string;
|
|
559
|
-
}): Promise<
|
|
534
|
+
}): Promise<Models.DownloadGrant>;
|
|
560
535
|
/** `GET /api/observations/{sessionId}/telemetry/exports/{exportId}` — Read one session telemetry export record. */
|
|
561
|
-
sessionTelemetryExportGet
|
|
562
|
-
readonly sessionId:
|
|
563
|
-
readonly exportId:
|
|
564
|
-
}): Promise<
|
|
536
|
+
sessionTelemetryExportGet(params: {
|
|
537
|
+
readonly sessionId: Models.Id<"session">;
|
|
538
|
+
readonly exportId: Models.Id<"export">;
|
|
539
|
+
}): Promise<Models.TelemetryExport>;
|
|
565
540
|
/** `POST /api/observations/{sessionId}/telemetry/exports/{exportId}/revocations` — Revoke a session telemetry export and its outstanding grants. */
|
|
566
|
-
sessionTelemetryExportRevoke
|
|
567
|
-
readonly sessionId:
|
|
568
|
-
readonly exportId:
|
|
569
|
-
readonly body:
|
|
541
|
+
sessionTelemetryExportRevoke(params: {
|
|
542
|
+
readonly sessionId: Models.Id<"session">;
|
|
543
|
+
readonly exportId: Models.Id<"export">;
|
|
544
|
+
readonly body: Models.EmptyRequest;
|
|
570
545
|
readonly idempotencyKey: string;
|
|
571
|
-
}): Promise<
|
|
546
|
+
}): Promise<Models.TelemetryExport>;
|
|
572
547
|
/** `GET /api/observations/{sessionId}/telemetry/gaps/{gapId}` — Read one recorded session telemetry gap. */
|
|
573
|
-
sessionTelemetryGapGet
|
|
574
|
-
readonly sessionId:
|
|
575
|
-
readonly gapId:
|
|
576
|
-
}): Promise<
|
|
548
|
+
sessionTelemetryGapGet(params: {
|
|
549
|
+
readonly sessionId: Models.Id<"session">;
|
|
550
|
+
readonly gapId: Models.Id<"telemetry_gap">;
|
|
551
|
+
}): Promise<Models.TelemetryGap>;
|
|
577
552
|
/** `POST /api/observations/{sessionId}/telemetry/gaps/query` — Query recorded session telemetry gaps. */
|
|
578
|
-
sessionTelemetryGapsQuery
|
|
579
|
-
readonly sessionId:
|
|
580
|
-
readonly body:
|
|
581
|
-
}): Promise<
|
|
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>;
|
|
582
562
|
/** `POST /api/observations/telemetry/exports/{exportId}/downloads` — Mint a download grant for a ready telemetry export. */
|
|
583
|
-
telemetryExportDownloadCreate
|
|
584
|
-
readonly exportId:
|
|
585
|
-
readonly body:
|
|
563
|
+
telemetryExportDownloadCreate(params: {
|
|
564
|
+
readonly exportId: Models.Id<"export">;
|
|
565
|
+
readonly body: Models.EmptyRequest;
|
|
586
566
|
readonly idempotencyKey: string;
|
|
587
|
-
}): Promise<
|
|
567
|
+
}): Promise<Models.DownloadGrant>;
|
|
588
568
|
/** `GET /api/observations/telemetry/exports/{exportId}` — Read one telemetry export record. */
|
|
589
|
-
telemetryExportGet
|
|
590
|
-
readonly exportId:
|
|
591
|
-
}): Promise<
|
|
569
|
+
telemetryExportGet(params: {
|
|
570
|
+
readonly exportId: Models.Id<"export">;
|
|
571
|
+
}): Promise<Models.TelemetryExport>;
|
|
592
572
|
/** `POST /api/observations/telemetry/exports/{exportId}/revocations` — Revoke a telemetry export and its outstanding grants. */
|
|
593
|
-
telemetryExportRevoke
|
|
594
|
-
readonly exportId:
|
|
595
|
-
readonly body:
|
|
573
|
+
telemetryExportRevoke(params: {
|
|
574
|
+
readonly exportId: Models.Id<"export">;
|
|
575
|
+
readonly body: Models.EmptyRequest;
|
|
596
576
|
readonly idempotencyKey: string;
|
|
597
|
-
}): Promise<
|
|
577
|
+
}): Promise<Models.TelemetryExport>;
|
|
598
578
|
/** `GET /api/observations/telemetry/gaps/{gapId}` — Read one recorded telemetry gap. */
|
|
599
|
-
telemetryGapGet
|
|
600
|
-
readonly gapId:
|
|
601
|
-
}): Promise<
|
|
579
|
+
telemetryGapGet(params: {
|
|
580
|
+
readonly gapId: Models.Id<"telemetry_gap">;
|
|
581
|
+
}): Promise<Models.TelemetryGap>;
|
|
602
582
|
/** `POST /api/observations/telemetry/gaps/query` — Query recorded workspace telemetry gaps. */
|
|
603
|
-
telemetryGapsQuery
|
|
604
|
-
readonly body:
|
|
605
|
-
}): Promise<
|
|
583
|
+
telemetryGapsQuery(params: {
|
|
584
|
+
readonly body: Models.TelemetryGapQuery;
|
|
585
|
+
}): Promise<Models.TelemetryGapPage>;
|
|
606
586
|
}
|
|
607
587
|
/** The `uploads` operations. */
|
|
608
588
|
export declare class UploadsClient {
|
|
609
589
|
#private;
|
|
610
590
|
constructor(executor: ResourceExecutor);
|
|
611
591
|
/** `DELETE /api/workspace/uploads/{uploadId}` — Abort a staged upload. */
|
|
612
|
-
uploadAbort
|
|
613
|
-
readonly uploadId:
|
|
614
|
-
}): Promise<
|
|
592
|
+
uploadAbort(params: {
|
|
593
|
+
readonly uploadId: Models.Id<"upload">;
|
|
594
|
+
}): Promise<void>;
|
|
615
595
|
/** `POST /api/workspace/uploads/{uploadId}/completion` — Complete a staged upload. */
|
|
616
|
-
uploadComplete
|
|
617
|
-
readonly uploadId:
|
|
618
|
-
readonly body:
|
|
596
|
+
uploadComplete(params: {
|
|
597
|
+
readonly uploadId: Models.Id<"upload">;
|
|
598
|
+
readonly body: Models.UploadCompleteRequest;
|
|
619
599
|
readonly idempotencyKey: string;
|
|
620
|
-
}): Promise<
|
|
600
|
+
}): Promise<Models.Upload>;
|
|
621
601
|
/** `POST /api/workspace/uploads` — Stage a large registered-resource value. */
|
|
622
|
-
uploadCreate
|
|
623
|
-
readonly body:
|
|
602
|
+
uploadCreate(params: {
|
|
603
|
+
readonly body: Models.UploadCreateRequest;
|
|
624
604
|
readonly idempotencyKey: string;
|
|
625
|
-
}): Promise<
|
|
605
|
+
}): Promise<Models.Upload>;
|
|
626
606
|
/** `POST /api/workspace/uploads/{uploadId}/parts` — Mint presigned PUT grants for the named parts. */
|
|
627
|
-
uploadPartsGrant
|
|
628
|
-
readonly uploadId:
|
|
629
|
-
readonly body:
|
|
630
|
-
}): Promise<
|
|
607
|
+
uploadPartsGrant(params: {
|
|
608
|
+
readonly uploadId: Models.Id<"upload">;
|
|
609
|
+
readonly body: Models.UploadPartsRequest;
|
|
610
|
+
}): Promise<Models.UploadPartGrants>;
|
|
631
611
|
}
|
|
632
612
|
/** The `usage` operations. */
|
|
633
613
|
export declare class UsageClient {
|
|
634
614
|
#private;
|
|
635
615
|
constructor(executor: ResourceExecutor);
|
|
636
616
|
/** `POST /api/billing/usage/query` — Query rated usage for this workspace. */
|
|
637
|
-
usageQuery
|
|
617
|
+
usageQuery(params: {
|
|
638
618
|
readonly query?: {
|
|
639
619
|
readonly workspaceId?: string;
|
|
640
620
|
};
|
|
641
|
-
readonly body:
|
|
642
|
-
}): Promise<
|
|
621
|
+
readonly body: Models.UsageQuery;
|
|
622
|
+
}): Promise<Models.UsagePage>;
|
|
643
623
|
}
|
|
644
624
|
/** The `workspace` operations. */
|
|
645
625
|
export declare class WorkspaceClient {
|
|
646
626
|
#private;
|
|
647
627
|
constructor(executor: ResourceExecutor);
|
|
648
628
|
/** `GET /api/workspace` — Read the workspace this credential is pinned to. */
|
|
649
|
-
workspaceCurrentGet
|
|
629
|
+
workspaceCurrentGet(): Promise<Models.Workspace>;
|
|
650
630
|
/** `GET /api/workspace/limits/{limitId}` — Read one effective workspace safety limit. */
|
|
651
|
-
workspaceLimitGet
|
|
652
|
-
readonly limitId:
|
|
653
|
-
}): Promise<
|
|
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>;
|
|
654
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. */
|
|
655
|
-
workspaceLimitsList
|
|
635
|
+
workspaceLimitsList(): Promise<Models.EffectiveWorkspaceLimitPage>;
|
|
656
636
|
}
|
|
657
637
|
/** The `workspaces` operations. */
|
|
658
638
|
export declare class WorkspacesClient {
|
|
659
639
|
#private;
|
|
660
640
|
constructor(executor: ResourceExecutor);
|
|
661
641
|
/** `POST /api/workspaces` — Create a region-pinned workspace. */
|
|
662
|
-
workspaceCreate
|
|
663
|
-
readonly body:
|
|
642
|
+
workspaceCreate(params: {
|
|
643
|
+
readonly body: Models.WorkspaceCreateRequest;
|
|
664
644
|
readonly idempotencyKey: string;
|
|
665
|
-
}): Promise<
|
|
645
|
+
}): Promise<Models.Workspace>;
|
|
666
646
|
/** `POST /api/workspaces/{workspaceId}/deletions` — Admit the global workspace-deletion operation. */
|
|
667
|
-
workspaceDelete
|
|
668
|
-
readonly workspaceId:
|
|
669
|
-
readonly body:
|
|
670
|
-
readonly operationId:
|
|
671
|
-
}): Promise<
|
|
647
|
+
workspaceDelete(params: {
|
|
648
|
+
readonly workspaceId: Models.Id<"workspace">;
|
|
649
|
+
readonly body: Models.WorkspaceDeleteRequest;
|
|
650
|
+
readonly operationId: Models.Id<"operation">;
|
|
651
|
+
}): Promise<Models.Operation>;
|
|
672
652
|
/** `GET /api/workspaces/{workspaceId}` — Read one workspace. */
|
|
673
|
-
workspaceGet
|
|
674
|
-
readonly workspaceId:
|
|
675
|
-
}): Promise<
|
|
653
|
+
workspaceGet(params: {
|
|
654
|
+
readonly workspaceId: Models.Id<"workspace">;
|
|
655
|
+
}): Promise<Models.Workspace>;
|
|
676
656
|
/** `GET /api/workspaces` — List workspaces the caller can reach. */
|
|
677
|
-
workspacesList
|
|
657
|
+
workspacesList(params?: {
|
|
678
658
|
readonly query?: {
|
|
679
659
|
readonly cursor?: string;
|
|
680
660
|
readonly limit?: string;
|
|
681
661
|
readonly organizationId?: string;
|
|
682
662
|
};
|
|
683
|
-
}): Promise<
|
|
663
|
+
}): Promise<Models.WorkspacePage>;
|
|
684
664
|
}
|
|
685
665
|
/**
|
|
686
666
|
* The resource namespaces the client exposes.
|
|
@@ -699,6 +679,8 @@ export declare abstract class GeneratedResources implements ResourceExecutor {
|
|
|
699
679
|
readonly billing: BillingClient;
|
|
700
680
|
/** The `bootstrap` operations. */
|
|
701
681
|
readonly bootstrap: BootstrapClient;
|
|
682
|
+
/** The `files` operations. */
|
|
683
|
+
readonly files: FilesClient;
|
|
702
684
|
/** The `identity` operations. */
|
|
703
685
|
readonly identity: IdentityClient;
|
|
704
686
|
/** The `observations` operations. */
|
|
@@ -713,8 +695,6 @@ export declare abstract class GeneratedResources implements ResourceExecutor {
|
|
|
713
695
|
readonly providerCredentials: ProviderCredentialsClient;
|
|
714
696
|
/** The `registry` operations. */
|
|
715
697
|
readonly registry: RegistryClient;
|
|
716
|
-
/** The `secrets` operations. */
|
|
717
|
-
readonly secrets: SecretsClient;
|
|
718
698
|
/** The `sessions` operations. */
|
|
719
699
|
readonly sessions: SessionsClient;
|
|
720
700
|
/** The `telemetry-lifecycle` operations. */
|