@lightspeed-ai/sdk 0.4.0 → 0.5.1
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/dist/generated/methods.d.ts +198 -127
- package/dist/generated/methods.d.ts.map +1 -1
- package/dist/generated/methods.js +130 -85
- package/dist/generated/methods.js.map +1 -1
- package/dist/generated/types.d.ts +641 -217
- package/dist/generated/types.d.ts.map +1 -1
- package/dist/generated/workflow-manifest.d.ts +127 -1
- package/dist/generated/workflow-manifest.d.ts.map +1 -1
- package/dist/generated/workflow-manifest.js +139 -1
- package/dist/generated/workflow-manifest.js.map +1 -1
- package/dist/generated/workflow-types.d.ts +322 -23
- package/dist/generated/workflow-types.d.ts.map +1 -1
- package/dist/workflow.d.ts +104 -0
- package/dist/workflow.d.ts.map +1 -1
- package/package.json +1 -1
- package/release.json +2 -2
- package/schema/api.schema.json +1172 -518
- package/schema/workflow.json +139 -1
- package/schema/workflow.schema.json +594 -1
- package/src/generated/methods.ts +199 -127
- package/src/generated/types.ts +658 -231
- package/src/generated/workflow-manifest.ts +139 -1
- package/src/generated/workflow-types.ts +346 -26
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type * as Api from "./types.js";
|
|
2
|
-
export declare const METHODS: readonly ["vfs/workspaces/files/read", "initialize", "session/start", "session/managed/start", "session/read", "session/list", "session/config/put", "session/rename", "session/metadata/put", "session/retention/put", "session/close", "session/delete", "session/share", "session/events/read", "session/context/append", "session/context/remove", "session/context/replace", "session/context/compact", "session/runs/start", "session/runs/list", "session/runs/read", "session/runs/cancel", "session/runs/approvals/decide", "session/runs/steer", "session/skills/list", "session/profiles/apply", "session/environments/activate", "session/environments/deactivate", "environments/credentials/bind", "environments/credentials/list", "environments/credentials/unbind", "environments/create", "environments/read", "environments/list", "environments/close", "environments/external/create", "environments/ingress/put", "environments/power/put", "environments/
|
|
2
|
+
export declare const METHODS: readonly ["vfs/workspaces/files/read", "initialize", "session/start", "session/managed/start", "session/read", "session/list", "session/config/put", "session/rename", "session/metadata/put", "session/retention/put", "session/close", "session/delete", "session/share", "session/events/read", "session/context/append", "session/context/remove", "session/context/replace", "session/context/compact", "session/runs/start", "session/runs/list", "session/runs/read", "session/runs/cancel", "session/runs/approvals/decide", "session/runs/steer", "session/skills/list", "session/profiles/apply", "session/environments/activate", "session/environments/deactivate", "environments/credentials/bind", "environments/credentials/list", "environments/credentials/unbind", "environments/create", "environments/read", "environments/update", "environments/list", "environments/close", "environments/external/create", "environments/ingress/put", "environments/power/put", "environments/provider-bindings/list", "environments/provider-bindings/read", "environments/templates/list", "environments/templates/read", "environments/jobs/create", "environments/jobs/read", "environments/jobs/cancel", "environments/registration-keys/create", "environments/registration-keys/read", "environments/registration-keys/list", "environments/registration-keys/update", "environments/registration-keys/rotate", "environments/registration-keys/revoke", "transcriptions/start", "transcriptions/read", "transcriptions/cancel", "models/defaults/read", "models/defaults/put", "models/list", "profiles/create", "profiles/read", "profiles/list", "profiles/put", "profiles/delete", "blobs/put", "blobs/read", "blobs/has", "vfs/snapshots/commit", "vfs/snapshots/read", "vfs/workspaces/create", "vfs/workspaces/read", "vfs/workspaces/list", "vfs/workspaces/update", "vfs/workspaces/delete", "mcp/servers/put", "mcp/servers/auth/discover", "mcp/servers/tools/discover", "mcp/servers/read", "mcp/servers/list", "mcp/servers/delete", "auth/grants/import", "auth/grants/lease", "auth/grants/read", "auth/grants/list", "auth/grants/revoke", "auth/clients/create", "auth/clients/read", "auth/clients/list", "auth/clients/delete", "auth/flows/start", "auth/flows/read", "auth/providers/create", "auth/providers/read", "auth/providers/list", "auth/providers/delete", "auth/github/installations/list", "auth/github/installations/grant", "bots/create", "bots/put", "bots/read", "bots/list", "bots/close", "bots/delete", "bots/state/read", "bots/sessions/rotate", "bots/triggers/put", "bots/triggers/read", "bots/triggers/list", "bots/triggers/delete", "bots/events/admit", "bots/events/replay", "bots/events/list", "bots/events/read", "bots/filters/test", "channels/accounts/create", "channels/accounts/put", "channels/accounts/read", "channels/accounts/list", "channels/accounts/delete", "channels/inbound/admit", "channels/pairings/list", "channels/pairings/delete", "channels/conversations/read", "deployment/sessions/deleted/list", "deployment/sessions/purge", "deployment/environment-provider-bindings/list", "deployment/universes/create", "deployment/universes/list", "deployment/universes/read", "deployment/universes/slug/put", "deployment/universes/delete", "deployment/api-keys/create", "deployment/api-keys/list", "deployment/api-keys/rotate", "deployment/api-keys/revoke", "deployment/environment-providers/put", "deployment/environment-providers/list", "deployment/environment-providers/read", "deployment/environment-providers/delete", "deployment/environment-providers/bindings/put", "deployment/environment-providers/bindings/delete", "deployment/channels/accounts/list"];
|
|
3
3
|
export declare const METHOD_INFO: {
|
|
4
4
|
readonly "vfs/workspaces/files/read": {
|
|
5
5
|
readonly scope: "universe";
|
|
@@ -57,7 +57,7 @@ export declare const METHOD_INFO: {
|
|
|
57
57
|
readonly "session/config/put": {
|
|
58
58
|
readonly scope: "universe";
|
|
59
59
|
readonly access: {
|
|
60
|
-
readonly action: "
|
|
60
|
+
readonly action: "configure_session";
|
|
61
61
|
readonly kind: "universe";
|
|
62
62
|
};
|
|
63
63
|
readonly summary: "Replace session configuration";
|
|
@@ -75,7 +75,7 @@ export declare const METHOD_INFO: {
|
|
|
75
75
|
readonly "session/metadata/put": {
|
|
76
76
|
readonly scope: "universe";
|
|
77
77
|
readonly access: {
|
|
78
|
-
readonly action: "
|
|
78
|
+
readonly action: "configure_session";
|
|
79
79
|
readonly kind: "universe";
|
|
80
80
|
};
|
|
81
81
|
readonly summary: "Replace session metadata";
|
|
@@ -84,16 +84,16 @@ export declare const METHOD_INFO: {
|
|
|
84
84
|
readonly "session/retention/put": {
|
|
85
85
|
readonly scope: "universe";
|
|
86
86
|
readonly access: {
|
|
87
|
-
readonly action: "
|
|
87
|
+
readonly action: "set_session_retention";
|
|
88
88
|
readonly kind: "universe";
|
|
89
89
|
};
|
|
90
90
|
readonly summary: "Replace session retention";
|
|
91
|
-
readonly description: "Sets the positive close-relative automatic-deletion duration on a retention root, or clears it with null. Forks and delegated children inherit the root policy and cannot override it.";
|
|
91
|
+
readonly description: "Sets the positive close-relative automatic soft-deletion duration on a retention root, or clears it with null. Forks and delegated children inherit the root policy and cannot override it. Retention does not permanently delete stored history.";
|
|
92
92
|
};
|
|
93
93
|
readonly "session/close": {
|
|
94
94
|
readonly scope: "universe";
|
|
95
95
|
readonly access: {
|
|
96
|
-
readonly action: "
|
|
96
|
+
readonly action: "close_session";
|
|
97
97
|
readonly kind: "universe";
|
|
98
98
|
};
|
|
99
99
|
readonly summary: "Close a session";
|
|
@@ -106,7 +106,7 @@ export declare const METHOD_INFO: {
|
|
|
106
106
|
readonly kind: "universe";
|
|
107
107
|
};
|
|
108
108
|
readonly summary: "Delete closed sessions";
|
|
109
|
-
readonly description: "Permanently
|
|
109
|
+
readonly description: "Permanently deletes a closed retention-tree leaf, or its closed history-fork and delegated-child subtree when cascade is true. Set softDelete to true to hide sessions while retaining records and history until a deployment administrator purges them. Prior soft deletion is not required for permanent deletion. Config-only clones are never included.";
|
|
110
110
|
};
|
|
111
111
|
readonly "session/share": {
|
|
112
112
|
readonly scope: "universe";
|
|
@@ -228,7 +228,7 @@ export declare const METHOD_INFO: {
|
|
|
228
228
|
readonly "session/profiles/apply": {
|
|
229
229
|
readonly scope: "universe";
|
|
230
230
|
readonly access: {
|
|
231
|
-
readonly action: "
|
|
231
|
+
readonly action: "configure_session";
|
|
232
232
|
readonly kind: "universe";
|
|
233
233
|
};
|
|
234
234
|
readonly summary: "Apply a profile to a session";
|
|
@@ -237,7 +237,7 @@ export declare const METHOD_INFO: {
|
|
|
237
237
|
readonly "session/environments/activate": {
|
|
238
238
|
readonly scope: "universe";
|
|
239
239
|
readonly access: {
|
|
240
|
-
readonly action: "
|
|
240
|
+
readonly action: "configure_session";
|
|
241
241
|
readonly kind: "universe";
|
|
242
242
|
};
|
|
243
243
|
readonly summary: "Activate a session environment";
|
|
@@ -246,7 +246,7 @@ export declare const METHOD_INFO: {
|
|
|
246
246
|
readonly "session/environments/deactivate": {
|
|
247
247
|
readonly scope: "universe";
|
|
248
248
|
readonly access: {
|
|
249
|
-
readonly action: "
|
|
249
|
+
readonly action: "configure_session";
|
|
250
250
|
readonly kind: "universe";
|
|
251
251
|
};
|
|
252
252
|
readonly summary: "Deactivate the session environment";
|
|
@@ -286,7 +286,7 @@ export declare const METHOD_INFO: {
|
|
|
286
286
|
readonly kind: "universe";
|
|
287
287
|
};
|
|
288
288
|
readonly summary: "Create an environment";
|
|
289
|
-
readonly description: "
|
|
289
|
+
readonly description: "Creates a provisioned environment, attributed to the caller, from a template of a provider enabled for the universe. Idempotent per requestId: same inputs, same environment; others conflict. Provisioning until the target's first envd handshake, then open; idle overrides the template default.";
|
|
290
290
|
};
|
|
291
291
|
readonly "environments/read": {
|
|
292
292
|
readonly scope: "universe";
|
|
@@ -295,7 +295,16 @@ export declare const METHOD_INFO: {
|
|
|
295
295
|
readonly kind: "universe";
|
|
296
296
|
};
|
|
297
297
|
readonly summary: "Read an environment";
|
|
298
|
-
readonly description: "Returns
|
|
298
|
+
readonly description: "Returns one environment: its source, lifecycle state, derived display status, state message, close reason, daemon build, and the latest provider observation.";
|
|
299
|
+
};
|
|
300
|
+
readonly "environments/update": {
|
|
301
|
+
readonly scope: "universe";
|
|
302
|
+
readonly access: {
|
|
303
|
+
readonly action: "configure_resource";
|
|
304
|
+
readonly kind: "universe";
|
|
305
|
+
};
|
|
306
|
+
readonly summary: "Update an environment";
|
|
307
|
+
readonly description: "Replaces the display name and caller metadata of an environment of any kind. Refused for a closed environment.";
|
|
299
308
|
};
|
|
300
309
|
readonly "environments/list": {
|
|
301
310
|
readonly scope: "universe";
|
|
@@ -304,7 +313,7 @@ export declare const METHOD_INFO: {
|
|
|
304
313
|
readonly kind: "universe";
|
|
305
314
|
};
|
|
306
315
|
readonly summary: "List environments";
|
|
307
|
-
readonly description: "Lists the universe environments, optionally filtered by provider,
|
|
316
|
+
readonly description: "Lists the universe environments in id order, one page at a time, optionally filtered by provider, registration key, state, or metadata. Closed environments are omitted unless includeClosed is set or state is closed. Continue from nextAfter.";
|
|
308
317
|
};
|
|
309
318
|
readonly "environments/close": {
|
|
310
319
|
readonly scope: "universe";
|
|
@@ -313,7 +322,7 @@ export declare const METHOD_INFO: {
|
|
|
313
322
|
readonly kind: "universe";
|
|
314
323
|
};
|
|
315
324
|
readonly summary: "Close an environment";
|
|
316
|
-
readonly description: "
|
|
325
|
+
readonly description: "Closes an environment; idempotent. A provisioned environment moves to closing while Lightspeed asks its provider to remove the target, retrying until it is gone, then closed. External and registered environments close at once, and a connected registered daemon is told its environment closed.";
|
|
317
326
|
};
|
|
318
327
|
readonly "environments/external/create": {
|
|
319
328
|
readonly scope: "universe";
|
|
@@ -322,7 +331,7 @@ export declare const METHOD_INFO: {
|
|
|
322
331
|
readonly kind: "universe";
|
|
323
332
|
};
|
|
324
333
|
readonly summary: "Register an external environment";
|
|
325
|
-
readonly description: "Creates an environment backed by a Lightspeed-reachable envd
|
|
334
|
+
readonly description: "Creates an open environment backed by a Lightspeed-reachable envd endpoint, attributed to the caller. Idempotent per requestId. Reachability is checked on use.";
|
|
326
335
|
};
|
|
327
336
|
readonly "environments/ingress/put": {
|
|
328
337
|
readonly scope: "universe";
|
|
@@ -331,7 +340,7 @@ export declare const METHOD_INFO: {
|
|
|
331
340
|
readonly kind: "universe";
|
|
332
341
|
};
|
|
333
342
|
readonly summary: "Configure environment public ingress";
|
|
334
|
-
readonly description: "Synchronously
|
|
343
|
+
readonly description: "Synchronously ensures or removes public ingress of an open provisioned environment through its provider; source.publicEndpoint carries the reported endpoint. Rejected when the provider offers no ingress; an internal error, safe to retry, when the provider is unreachable or times out. The provider owns hostname, guest port, routing, TLS, and health.";
|
|
335
344
|
};
|
|
336
345
|
readonly "environments/power/put": {
|
|
337
346
|
readonly scope: "universe";
|
|
@@ -339,17 +348,8 @@ export declare const METHOD_INFO: {
|
|
|
339
348
|
readonly action: "configure_resource";
|
|
340
349
|
readonly kind: "universe";
|
|
341
350
|
};
|
|
342
|
-
readonly summary: "Set environment power
|
|
343
|
-
readonly description: "
|
|
344
|
-
};
|
|
345
|
-
readonly "environments/idle-policy/put": {
|
|
346
|
-
readonly scope: "universe";
|
|
347
|
-
readonly access: {
|
|
348
|
-
readonly action: "configure_resource";
|
|
349
|
-
readonly kind: "universe";
|
|
350
|
-
};
|
|
351
|
-
readonly summary: "Set environment idle policy";
|
|
352
|
-
readonly description: "Replaces or clears the staged idle policy of a provisioned environment. The power reaper measures the daemon's idle duration against the pause/suspend/stop/close thresholds and escalates through the stages the provider supports.";
|
|
351
|
+
readonly summary: "Set environment power";
|
|
352
|
+
readonly description: "Synchronously moves an open provisioned environment's target to running, paused, suspended, or stopped via its provider and records the observation; the provider may also change power on idle. Rejected without provider power control or when the template lacks the state; an internal error, safe to retry, when the provider is unreachable or times out.";
|
|
353
353
|
};
|
|
354
354
|
readonly "environments/provider-bindings/list": {
|
|
355
355
|
readonly scope: "universe";
|
|
@@ -358,7 +358,7 @@ export declare const METHOD_INFO: {
|
|
|
358
358
|
readonly kind: "universe";
|
|
359
359
|
};
|
|
360
360
|
readonly summary: "List environment provider bindings";
|
|
361
|
-
readonly description: "Lists this universe's
|
|
361
|
+
readonly description: "Lists this universe's bindings to deployment providers and whether each is enabled.";
|
|
362
362
|
};
|
|
363
363
|
readonly "environments/provider-bindings/read": {
|
|
364
364
|
readonly scope: "universe";
|
|
@@ -367,7 +367,7 @@ export declare const METHOD_INFO: {
|
|
|
367
367
|
readonly kind: "universe";
|
|
368
368
|
};
|
|
369
369
|
readonly summary: "Read an environment provider binding";
|
|
370
|
-
readonly description: "Returns
|
|
370
|
+
readonly description: "Returns this universe's binding to one provider. Templates and physical resource, network, and ingress policy remain provider-owned.";
|
|
371
371
|
};
|
|
372
372
|
readonly "environments/templates/list": {
|
|
373
373
|
readonly scope: "universe";
|
|
@@ -376,7 +376,7 @@ export declare const METHOD_INFO: {
|
|
|
376
376
|
readonly kind: "universe";
|
|
377
377
|
};
|
|
378
378
|
readonly summary: "List environment templates";
|
|
379
|
-
readonly description: "Reads
|
|
379
|
+
readonly description: "Reads templates live from the controllers of the universe's enabled provider bindings, or of one provider: compute, power states, public ingress, and default idle policy.";
|
|
380
380
|
};
|
|
381
381
|
readonly "environments/templates/read": {
|
|
382
382
|
readonly scope: "universe";
|
|
@@ -385,7 +385,7 @@ export declare const METHOD_INFO: {
|
|
|
385
385
|
readonly kind: "universe";
|
|
386
386
|
};
|
|
387
387
|
readonly summary: "Read an environment template";
|
|
388
|
-
readonly description: "Returns one
|
|
388
|
+
readonly description: "Returns one template, read live from a bound provider's controller.";
|
|
389
389
|
};
|
|
390
390
|
readonly "environments/jobs/create": {
|
|
391
391
|
readonly scope: "universe";
|
|
@@ -394,7 +394,7 @@ export declare const METHOD_INFO: {
|
|
|
394
394
|
readonly kind: "universe";
|
|
395
395
|
};
|
|
396
396
|
readonly summary: "Create environment jobs";
|
|
397
|
-
readonly description: "Starts a dependency-aware job group on one environment instance, injecting
|
|
397
|
+
readonly description: "Starts a dependency-aware job group on one environment instance, injecting its configured credentials at provider start. requestId is the retry identity; jobs are owned by the instance, not a session. A powered-down environment wakes on its data route; the call fails with environment_not_ready while it wakes or reconnects; retry with backoff.";
|
|
398
398
|
};
|
|
399
399
|
readonly "environments/jobs/read": {
|
|
400
400
|
readonly scope: "universe";
|
|
@@ -403,7 +403,7 @@ export declare const METHOD_INFO: {
|
|
|
403
403
|
readonly kind: "universe";
|
|
404
404
|
};
|
|
405
405
|
readonly summary: "Read environment jobs";
|
|
406
|
-
readonly description: "Reads selected job handles with bounded output
|
|
406
|
+
readonly description: "Reads selected job handles with bounded output from a byte offset or the output tail; continue from each entry's outputNext and poll on the returned status.";
|
|
407
407
|
};
|
|
408
408
|
readonly "environments/jobs/cancel": {
|
|
409
409
|
readonly scope: "universe";
|
|
@@ -421,7 +421,7 @@ export declare const METHOD_INFO: {
|
|
|
421
421
|
readonly kind: "universe";
|
|
422
422
|
};
|
|
423
423
|
readonly summary: "Mint an environment registration key";
|
|
424
|
-
readonly description: "Creates a reusable universe-scoped key that lets outbound envd daemons register as environments. The plaintext secret is returned exactly once; only its hash is stored. Identity mode, active limit, disconnect grace, and expiry are the key's policy. Treat the secret like a cluster-join credential.";
|
|
424
|
+
readonly description: "Creates a reusable universe-scoped key that lets outbound envd daemons register as environments. The plaintext secret is returned exactly once; only its hash is stored. Identity mode (immutable), active limit, disconnect grace, offline close-after, and expiry are the key's policy. Treat the secret like a cluster-join credential.";
|
|
425
425
|
};
|
|
426
426
|
readonly "environments/registration-keys/read": {
|
|
427
427
|
readonly scope: "universe";
|
|
@@ -441,6 +441,24 @@ export declare const METHOD_INFO: {
|
|
|
441
441
|
readonly summary: "List environment registration keys";
|
|
442
442
|
readonly description: "Lists this universe's registration keys with policy, status, and derived counts. Each key is the group of the environments it admitted.";
|
|
443
443
|
};
|
|
444
|
+
readonly "environments/registration-keys/update": {
|
|
445
|
+
readonly scope: "universe";
|
|
446
|
+
readonly access: {
|
|
447
|
+
readonly action: "configure_resource";
|
|
448
|
+
readonly kind: "universe";
|
|
449
|
+
};
|
|
450
|
+
readonly summary: "Update an environment registration key";
|
|
451
|
+
readonly description: "Replaces a key's editable policy: display name, active limit, disconnect grace, offline close-after, and expiry; an omitted field is unset. The identity mode is immutable. The active limit and expiry apply to later admissions; a changed disconnect grace or offline close-after applies at the next sweep to environments whose daemon is away.";
|
|
452
|
+
};
|
|
453
|
+
readonly "environments/registration-keys/rotate": {
|
|
454
|
+
readonly scope: "universe";
|
|
455
|
+
readonly access: {
|
|
456
|
+
readonly action: "configure_resource";
|
|
457
|
+
readonly kind: "universe";
|
|
458
|
+
};
|
|
459
|
+
readonly summary: "Rotate an environment registration key";
|
|
460
|
+
readonly description: "Replaces the key's secret and display prefix and retires the old secret at once. The key keeps its id, group, policy, and the environments it admitted; daemons already registered are unaffected because they never present the key again. Returns the new secret once. Refused for a revoked key.";
|
|
461
|
+
};
|
|
444
462
|
readonly "environments/registration-keys/revoke": {
|
|
445
463
|
readonly scope: "universe";
|
|
446
464
|
readonly access: {
|
|
@@ -897,7 +915,7 @@ export declare const METHOD_INFO: {
|
|
|
897
915
|
readonly kind: "universe";
|
|
898
916
|
};
|
|
899
917
|
readonly summary: "Delete a bot";
|
|
900
|
-
readonly description: "Closes the bot if needed, waits for its controller to complete,
|
|
918
|
+
readonly description: "Closes the bot if needed, waits for its controller to complete, retains its session history, and removes the record so the bot id is free again.";
|
|
901
919
|
};
|
|
902
920
|
readonly "bots/state/read": {
|
|
903
921
|
readonly scope: "universe";
|
|
@@ -1078,6 +1096,22 @@ export declare const METHOD_INFO: {
|
|
|
1078
1096
|
readonly summary: "Read a conversation snapshot";
|
|
1079
1097
|
readonly description: "Queries the conversation workflow's live state for one chat, for debugging; absent when no workflow exists yet.";
|
|
1080
1098
|
};
|
|
1099
|
+
readonly "deployment/sessions/deleted/list": {
|
|
1100
|
+
readonly scope: "deployment";
|
|
1101
|
+
readonly access: {
|
|
1102
|
+
readonly kind: "deployment";
|
|
1103
|
+
};
|
|
1104
|
+
readonly summary: "List deleted sessions";
|
|
1105
|
+
readonly description: "Administrative metadata for soft-deleted sessions, ordered by session ID. Unavailable through universe-scoped methods.";
|
|
1106
|
+
};
|
|
1107
|
+
readonly "deployment/sessions/purge": {
|
|
1108
|
+
readonly scope: "deployment";
|
|
1109
|
+
readonly access: {
|
|
1110
|
+
readonly kind: "deployment";
|
|
1111
|
+
};
|
|
1112
|
+
readonly summary: "Permanently delete a session";
|
|
1113
|
+
readonly description: "Removes a soft-deleted session and its soft-deleted history subtree. Rejects any selected session that has not been soft-deleted. Releases event, checkpoint and blob references; unreferenced blobs follow normal garbage collection. Does not delete external workspaces, environments, backups or Temporal history.";
|
|
1114
|
+
};
|
|
1081
1115
|
readonly "deployment/environment-provider-bindings/list": {
|
|
1082
1116
|
readonly scope: "deployment";
|
|
1083
1117
|
readonly access: {
|
|
@@ -1164,7 +1198,7 @@ export declare const METHOD_INFO: {
|
|
|
1164
1198
|
readonly kind: "deployment";
|
|
1165
1199
|
};
|
|
1166
1200
|
readonly summary: "Put an environment provider";
|
|
1167
|
-
readonly description: "Registers or replaces
|
|
1201
|
+
readonly description: "Registers or replaces a deployment provider: controller endpoint, optional data route base, and optional bearer credential for controller and data routes (write-only: kept when omitted, removed by clearCredential, never returned). The controller is probed: a definitive refusal is invalid_request, unreachable is accepted. The provider never calls Lightspeed.";
|
|
1168
1202
|
};
|
|
1169
1203
|
readonly "deployment/environment-providers/list": {
|
|
1170
1204
|
readonly scope: "deployment";
|
|
@@ -1172,7 +1206,7 @@ export declare const METHOD_INFO: {
|
|
|
1172
1206
|
readonly kind: "deployment";
|
|
1173
1207
|
};
|
|
1174
1208
|
readonly summary: "List environment providers";
|
|
1175
|
-
readonly description: "Returns every deployment-registered
|
|
1209
|
+
readonly description: "Returns every deployment-registered provider with its controller endpoint, data route base, and whether a credential is stored.";
|
|
1176
1210
|
};
|
|
1177
1211
|
readonly "deployment/environment-providers/read": {
|
|
1178
1212
|
readonly scope: "deployment";
|
|
@@ -1180,7 +1214,7 @@ export declare const METHOD_INFO: {
|
|
|
1180
1214
|
readonly kind: "deployment";
|
|
1181
1215
|
};
|
|
1182
1216
|
readonly summary: "Read an environment provider";
|
|
1183
|
-
readonly description: "Returns one deployment-registered
|
|
1217
|
+
readonly description: "Returns one deployment-registered provider with its controller endpoint, data route base, and whether a credential is stored.";
|
|
1184
1218
|
};
|
|
1185
1219
|
readonly "deployment/environment-providers/delete": {
|
|
1186
1220
|
readonly scope: "deployment";
|
|
@@ -1188,7 +1222,7 @@ export declare const METHOD_INFO: {
|
|
|
1188
1222
|
readonly kind: "deployment";
|
|
1189
1223
|
};
|
|
1190
1224
|
readonly summary: "Delete an environment provider";
|
|
1191
|
-
readonly description: "Deletes a deployment provider only when no universe binding references it.";
|
|
1225
|
+
readonly description: "Deletes a deployment provider only when no universe binding and no non-closed environment references it.";
|
|
1192
1226
|
};
|
|
1193
1227
|
readonly "deployment/environment-providers/bindings/put": {
|
|
1194
1228
|
readonly scope: "deployment";
|
|
@@ -1196,7 +1230,7 @@ export declare const METHOD_INFO: {
|
|
|
1196
1230
|
readonly kind: "deployment";
|
|
1197
1231
|
};
|
|
1198
1232
|
readonly summary: "Put an environment provider binding";
|
|
1199
|
-
readonly description: "Creates or replaces one universe's
|
|
1233
|
+
readonly description: "Creates or replaces one universe's binding to a deployment provider. Only an enabled binding admits creates, template listing, and data routes for the universe.";
|
|
1200
1234
|
};
|
|
1201
1235
|
readonly "deployment/environment-providers/bindings/delete": {
|
|
1202
1236
|
readonly scope: "deployment";
|
|
@@ -1204,15 +1238,7 @@ export declare const METHOD_INFO: {
|
|
|
1204
1238
|
readonly kind: "deployment";
|
|
1205
1239
|
};
|
|
1206
1240
|
readonly summary: "Delete an environment provider binding";
|
|
1207
|
-
readonly description: "Deletes a universe provider
|
|
1208
|
-
};
|
|
1209
|
-
readonly "deployment/environments/adopt": {
|
|
1210
|
-
readonly scope: "deployment";
|
|
1211
|
-
readonly access: {
|
|
1212
|
-
readonly kind: "deployment";
|
|
1213
|
-
};
|
|
1214
|
-
readonly summary: "Adopt a provider environment";
|
|
1215
|
-
readonly description: "Creates a universe environment by transferring an existing provider target into Lightspeed's managed lifecycle. The caller must explicitly accept ownership transfer.";
|
|
1241
|
+
readonly description: "Deletes a universe's binding to a provider only when the universe has no non-closed environment of that provider.";
|
|
1216
1242
|
};
|
|
1217
1243
|
readonly "deployment/channels/accounts/list": {
|
|
1218
1244
|
readonly scope: "deployment";
|
|
@@ -1311,7 +1337,7 @@ export interface MethodMap {
|
|
|
1311
1337
|
/**
|
|
1312
1338
|
* Replace session retention
|
|
1313
1339
|
*
|
|
1314
|
-
* Sets the positive close-relative automatic-deletion duration on a retention root, or clears it with null. Forks and delegated children inherit the root policy and cannot override it.
|
|
1340
|
+
* Sets the positive close-relative automatic soft-deletion duration on a retention root, or clears it with null. Forks and delegated children inherit the root policy and cannot override it. Retention does not permanently delete stored history.
|
|
1315
1341
|
*/
|
|
1316
1342
|
"session/retention/put": {
|
|
1317
1343
|
params: Api.SessionRetentionPutParams;
|
|
@@ -1329,7 +1355,7 @@ export interface MethodMap {
|
|
|
1329
1355
|
/**
|
|
1330
1356
|
* Delete closed sessions
|
|
1331
1357
|
*
|
|
1332
|
-
* Permanently
|
|
1358
|
+
* Permanently deletes a closed retention-tree leaf, or its closed history-fork and delegated-child subtree when cascade is true. Set softDelete to true to hide sessions while retaining records and history until a deployment administrator purges them. Prior soft deletion is not required for permanent deletion. Config-only clones are never included.
|
|
1333
1359
|
*/
|
|
1334
1360
|
"session/delete": {
|
|
1335
1361
|
params: Api.SessionDeleteParams;
|
|
@@ -1509,7 +1535,7 @@ export interface MethodMap {
|
|
|
1509
1535
|
/**
|
|
1510
1536
|
* Create an environment
|
|
1511
1537
|
*
|
|
1512
|
-
*
|
|
1538
|
+
* Creates a provisioned environment, attributed to the caller, from a template of a provider enabled for the universe. Idempotent per requestId: same inputs, same environment; others conflict. Provisioning until the target's first envd handshake, then open; idle overrides the template default.
|
|
1513
1539
|
*/
|
|
1514
1540
|
"environments/create": {
|
|
1515
1541
|
params: Api.EnvironmentCreateParams;
|
|
@@ -1518,16 +1544,25 @@ export interface MethodMap {
|
|
|
1518
1544
|
/**
|
|
1519
1545
|
* Read an environment
|
|
1520
1546
|
*
|
|
1521
|
-
* Returns
|
|
1547
|
+
* Returns one environment: its source, lifecycle state, derived display status, state message, close reason, daemon build, and the latest provider observation.
|
|
1522
1548
|
*/
|
|
1523
1549
|
"environments/read": {
|
|
1524
1550
|
params: Api.EnvironmentReadParams;
|
|
1525
1551
|
result: Api.AgentApiOutcomeOfEnvironmentReadResponse;
|
|
1526
1552
|
};
|
|
1553
|
+
/**
|
|
1554
|
+
* Update an environment
|
|
1555
|
+
*
|
|
1556
|
+
* Replaces the display name and caller metadata of an environment of any kind. Refused for a closed environment.
|
|
1557
|
+
*/
|
|
1558
|
+
"environments/update": {
|
|
1559
|
+
params: Api.EnvironmentUpdateParams;
|
|
1560
|
+
result: Api.AgentApiOutcomeOfEnvironmentUpdateResponse;
|
|
1561
|
+
};
|
|
1527
1562
|
/**
|
|
1528
1563
|
* List environments
|
|
1529
1564
|
*
|
|
1530
|
-
* Lists the universe environments, optionally filtered by provider,
|
|
1565
|
+
* Lists the universe environments in id order, one page at a time, optionally filtered by provider, registration key, state, or metadata. Closed environments are omitted unless includeClosed is set or state is closed. Continue from nextAfter.
|
|
1531
1566
|
*/
|
|
1532
1567
|
"environments/list": {
|
|
1533
1568
|
params: Api.EnvironmentListParams;
|
|
@@ -1536,7 +1571,7 @@ export interface MethodMap {
|
|
|
1536
1571
|
/**
|
|
1537
1572
|
* Close an environment
|
|
1538
1573
|
*
|
|
1539
|
-
*
|
|
1574
|
+
* Closes an environment; idempotent. A provisioned environment moves to closing while Lightspeed asks its provider to remove the target, retrying until it is gone, then closed. External and registered environments close at once, and a connected registered daemon is told its environment closed.
|
|
1540
1575
|
*/
|
|
1541
1576
|
"environments/close": {
|
|
1542
1577
|
params: Api.EnvironmentCloseParams;
|
|
@@ -1545,7 +1580,7 @@ export interface MethodMap {
|
|
|
1545
1580
|
/**
|
|
1546
1581
|
* Register an external environment
|
|
1547
1582
|
*
|
|
1548
|
-
* Creates an environment backed by a Lightspeed-reachable envd
|
|
1583
|
+
* Creates an open environment backed by a Lightspeed-reachable envd endpoint, attributed to the caller. Idempotent per requestId. Reachability is checked on use.
|
|
1549
1584
|
*/
|
|
1550
1585
|
"environments/external/create": {
|
|
1551
1586
|
params: Api.EnvironmentExternalCreateParams;
|
|
@@ -1554,34 +1589,25 @@ export interface MethodMap {
|
|
|
1554
1589
|
/**
|
|
1555
1590
|
* Configure environment public ingress
|
|
1556
1591
|
*
|
|
1557
|
-
* Synchronously
|
|
1592
|
+
* Synchronously ensures or removes public ingress of an open provisioned environment through its provider; source.publicEndpoint carries the reported endpoint. Rejected when the provider offers no ingress; an internal error, safe to retry, when the provider is unreachable or times out. The provider owns hostname, guest port, routing, TLS, and health.
|
|
1558
1593
|
*/
|
|
1559
1594
|
"environments/ingress/put": {
|
|
1560
1595
|
params: Api.EnvironmentIngressPutParams;
|
|
1561
1596
|
result: Api.AgentApiOutcomeOfEnvironmentIngressPutResponse;
|
|
1562
1597
|
};
|
|
1563
1598
|
/**
|
|
1564
|
-
* Set environment power
|
|
1599
|
+
* Set environment power
|
|
1565
1600
|
*
|
|
1566
|
-
*
|
|
1601
|
+
* Synchronously moves an open provisioned environment's target to running, paused, suspended, or stopped via its provider and records the observation; the provider may also change power on idle. Rejected without provider power control or when the template lacks the state; an internal error, safe to retry, when the provider is unreachable or times out.
|
|
1567
1602
|
*/
|
|
1568
1603
|
"environments/power/put": {
|
|
1569
1604
|
params: Api.EnvironmentPowerPutParams;
|
|
1570
1605
|
result: Api.AgentApiOutcomeOfEnvironmentPowerPutResponse;
|
|
1571
1606
|
};
|
|
1572
|
-
/**
|
|
1573
|
-
* Set environment idle policy
|
|
1574
|
-
*
|
|
1575
|
-
* Replaces or clears the staged idle policy of a provisioned environment. The power reaper measures the daemon's idle duration against the pause/suspend/stop/close thresholds and escalates through the stages the provider supports.
|
|
1576
|
-
*/
|
|
1577
|
-
"environments/idle-policy/put": {
|
|
1578
|
-
params: Api.EnvironmentIdlePolicyPutParams;
|
|
1579
|
-
result: Api.AgentApiOutcomeOfEnvironmentIdlePolicyPutResponse;
|
|
1580
|
-
};
|
|
1581
1607
|
/**
|
|
1582
1608
|
* List environment provider bindings
|
|
1583
1609
|
*
|
|
1584
|
-
* Lists this universe's
|
|
1610
|
+
* Lists this universe's bindings to deployment providers and whether each is enabled.
|
|
1585
1611
|
*/
|
|
1586
1612
|
"environments/provider-bindings/list": {
|
|
1587
1613
|
params: Api.EnvironmentProviderBindingListParams;
|
|
@@ -1590,7 +1616,7 @@ export interface MethodMap {
|
|
|
1590
1616
|
/**
|
|
1591
1617
|
* Read an environment provider binding
|
|
1592
1618
|
*
|
|
1593
|
-
* Returns
|
|
1619
|
+
* Returns this universe's binding to one provider. Templates and physical resource, network, and ingress policy remain provider-owned.
|
|
1594
1620
|
*/
|
|
1595
1621
|
"environments/provider-bindings/read": {
|
|
1596
1622
|
params: Api.EnvironmentProviderBindingReadParams;
|
|
@@ -1599,7 +1625,7 @@ export interface MethodMap {
|
|
|
1599
1625
|
/**
|
|
1600
1626
|
* List environment templates
|
|
1601
1627
|
*
|
|
1602
|
-
* Reads
|
|
1628
|
+
* Reads templates live from the controllers of the universe's enabled provider bindings, or of one provider: compute, power states, public ingress, and default idle policy.
|
|
1603
1629
|
*/
|
|
1604
1630
|
"environments/templates/list": {
|
|
1605
1631
|
params: Api.EnvironmentTemplateListParams;
|
|
@@ -1608,7 +1634,7 @@ export interface MethodMap {
|
|
|
1608
1634
|
/**
|
|
1609
1635
|
* Read an environment template
|
|
1610
1636
|
*
|
|
1611
|
-
* Returns one
|
|
1637
|
+
* Returns one template, read live from a bound provider's controller.
|
|
1612
1638
|
*/
|
|
1613
1639
|
"environments/templates/read": {
|
|
1614
1640
|
params: Api.EnvironmentTemplateReadParams;
|
|
@@ -1617,7 +1643,7 @@ export interface MethodMap {
|
|
|
1617
1643
|
/**
|
|
1618
1644
|
* Create environment jobs
|
|
1619
1645
|
*
|
|
1620
|
-
* Starts a dependency-aware job group on one environment instance, injecting
|
|
1646
|
+
* Starts a dependency-aware job group on one environment instance, injecting its configured credentials at provider start. requestId is the retry identity; jobs are owned by the instance, not a session. A powered-down environment wakes on its data route; the call fails with environment_not_ready while it wakes or reconnects; retry with backoff.
|
|
1621
1647
|
*/
|
|
1622
1648
|
"environments/jobs/create": {
|
|
1623
1649
|
params: Api.EnvironmentJobCreateParams;
|
|
@@ -1626,7 +1652,7 @@ export interface MethodMap {
|
|
|
1626
1652
|
/**
|
|
1627
1653
|
* Read environment jobs
|
|
1628
1654
|
*
|
|
1629
|
-
* Reads selected job handles with bounded output
|
|
1655
|
+
* Reads selected job handles with bounded output from a byte offset or the output tail; continue from each entry's outputNext and poll on the returned status.
|
|
1630
1656
|
*/
|
|
1631
1657
|
"environments/jobs/read": {
|
|
1632
1658
|
params: Api.EnvironmentJobReadParams;
|
|
@@ -1644,7 +1670,7 @@ export interface MethodMap {
|
|
|
1644
1670
|
/**
|
|
1645
1671
|
* Mint an environment registration key
|
|
1646
1672
|
*
|
|
1647
|
-
* Creates a reusable universe-scoped key that lets outbound envd daemons register as environments. The plaintext secret is returned exactly once; only its hash is stored. Identity mode, active limit, disconnect grace, and expiry are the key's policy. Treat the secret like a cluster-join credential.
|
|
1673
|
+
* Creates a reusable universe-scoped key that lets outbound envd daemons register as environments. The plaintext secret is returned exactly once; only its hash is stored. Identity mode (immutable), active limit, disconnect grace, offline close-after, and expiry are the key's policy. Treat the secret like a cluster-join credential.
|
|
1648
1674
|
*/
|
|
1649
1675
|
"environments/registration-keys/create": {
|
|
1650
1676
|
params: Api.EnvironmentRegistrationKeyCreateParams;
|
|
@@ -1668,6 +1694,24 @@ export interface MethodMap {
|
|
|
1668
1694
|
params: Api.EnvironmentRegistrationKeyListParams;
|
|
1669
1695
|
result: Api.AgentApiOutcomeOfEnvironmentRegistrationKeyListResponse;
|
|
1670
1696
|
};
|
|
1697
|
+
/**
|
|
1698
|
+
* Update an environment registration key
|
|
1699
|
+
*
|
|
1700
|
+
* Replaces a key's editable policy: display name, active limit, disconnect grace, offline close-after, and expiry; an omitted field is unset. The identity mode is immutable. The active limit and expiry apply to later admissions; a changed disconnect grace or offline close-after applies at the next sweep to environments whose daemon is away.
|
|
1701
|
+
*/
|
|
1702
|
+
"environments/registration-keys/update": {
|
|
1703
|
+
params: Api.EnvironmentRegistrationKeyUpdateParams;
|
|
1704
|
+
result: Api.AgentApiOutcomeOfEnvironmentRegistrationKeyUpdateResponse;
|
|
1705
|
+
};
|
|
1706
|
+
/**
|
|
1707
|
+
* Rotate an environment registration key
|
|
1708
|
+
*
|
|
1709
|
+
* Replaces the key's secret and display prefix and retires the old secret at once. The key keeps its id, group, policy, and the environments it admitted; daemons already registered are unaffected because they never present the key again. Returns the new secret once. Refused for a revoked key.
|
|
1710
|
+
*/
|
|
1711
|
+
"environments/registration-keys/rotate": {
|
|
1712
|
+
params: Api.EnvironmentRegistrationKeyRotateParams;
|
|
1713
|
+
result: Api.AgentApiOutcomeOfEnvironmentRegistrationKeyRotateResponse;
|
|
1714
|
+
};
|
|
1671
1715
|
/**
|
|
1672
1716
|
* Revoke an environment registration key
|
|
1673
1717
|
*
|
|
@@ -2121,7 +2165,7 @@ export interface MethodMap {
|
|
|
2121
2165
|
/**
|
|
2122
2166
|
* Delete a bot
|
|
2123
2167
|
*
|
|
2124
|
-
* Closes the bot if needed, waits for its controller to complete,
|
|
2168
|
+
* Closes the bot if needed, waits for its controller to complete, retains its session history, and removes the record so the bot id is free again.
|
|
2125
2169
|
*/
|
|
2126
2170
|
"bots/delete": {
|
|
2127
2171
|
params: Api.BotDeleteParams;
|
|
@@ -2307,6 +2351,24 @@ export interface MethodMap {
|
|
|
2307
2351
|
params: Api.ChannelConversationReadParams;
|
|
2308
2352
|
result: Api.AgentApiOutcomeOfChannelConversationReadResponse;
|
|
2309
2353
|
};
|
|
2354
|
+
/**
|
|
2355
|
+
* List deleted sessions
|
|
2356
|
+
*
|
|
2357
|
+
* Administrative metadata for soft-deleted sessions, ordered by session ID. Unavailable through universe-scoped methods.
|
|
2358
|
+
*/
|
|
2359
|
+
"deployment/sessions/deleted/list": {
|
|
2360
|
+
params: Api.DeploymentDeletedSessionsListParams;
|
|
2361
|
+
result: Api.AgentApiOutcomeOfDeploymentDeletedSessionsListResponse;
|
|
2362
|
+
};
|
|
2363
|
+
/**
|
|
2364
|
+
* Permanently delete a session
|
|
2365
|
+
*
|
|
2366
|
+
* Removes a soft-deleted session and its soft-deleted history subtree. Rejects any selected session that has not been soft-deleted. Releases event, checkpoint and blob references; unreferenced blobs follow normal garbage collection. Does not delete external workspaces, environments, backups or Temporal history.
|
|
2367
|
+
*/
|
|
2368
|
+
"deployment/sessions/purge": {
|
|
2369
|
+
params: Api.DeploymentSessionPurgeParams;
|
|
2370
|
+
result: Api.AgentApiOutcomeOfDeploymentSessionPurgeResponse;
|
|
2371
|
+
};
|
|
2310
2372
|
/**
|
|
2311
2373
|
* List a universe's deployment provider bindings
|
|
2312
2374
|
*
|
|
@@ -2400,7 +2462,7 @@ export interface MethodMap {
|
|
|
2400
2462
|
/**
|
|
2401
2463
|
* Put an environment provider
|
|
2402
2464
|
*
|
|
2403
|
-
* Registers or replaces
|
|
2465
|
+
* Registers or replaces a deployment provider: controller endpoint, optional data route base, and optional bearer credential for controller and data routes (write-only: kept when omitted, removed by clearCredential, never returned). The controller is probed: a definitive refusal is invalid_request, unreachable is accepted. The provider never calls Lightspeed.
|
|
2404
2466
|
*/
|
|
2405
2467
|
"deployment/environment-providers/put": {
|
|
2406
2468
|
params: Api.DeploymentEnvironmentProviderPutParams;
|
|
@@ -2409,7 +2471,7 @@ export interface MethodMap {
|
|
|
2409
2471
|
/**
|
|
2410
2472
|
* List environment providers
|
|
2411
2473
|
*
|
|
2412
|
-
* Returns every deployment-registered
|
|
2474
|
+
* Returns every deployment-registered provider with its controller endpoint, data route base, and whether a credential is stored.
|
|
2413
2475
|
*/
|
|
2414
2476
|
"deployment/environment-providers/list": {
|
|
2415
2477
|
params: Api.DeploymentEnvironmentProviderListParams;
|
|
@@ -2418,7 +2480,7 @@ export interface MethodMap {
|
|
|
2418
2480
|
/**
|
|
2419
2481
|
* Read an environment provider
|
|
2420
2482
|
*
|
|
2421
|
-
* Returns one deployment-registered
|
|
2483
|
+
* Returns one deployment-registered provider with its controller endpoint, data route base, and whether a credential is stored.
|
|
2422
2484
|
*/
|
|
2423
2485
|
"deployment/environment-providers/read": {
|
|
2424
2486
|
params: Api.DeploymentEnvironmentProviderReadParams;
|
|
@@ -2427,7 +2489,7 @@ export interface MethodMap {
|
|
|
2427
2489
|
/**
|
|
2428
2490
|
* Delete an environment provider
|
|
2429
2491
|
*
|
|
2430
|
-
* Deletes a deployment provider only when no universe binding references it.
|
|
2492
|
+
* Deletes a deployment provider only when no universe binding and no non-closed environment references it.
|
|
2431
2493
|
*/
|
|
2432
2494
|
"deployment/environment-providers/delete": {
|
|
2433
2495
|
params: Api.DeploymentEnvironmentProviderDeleteParams;
|
|
@@ -2436,7 +2498,7 @@ export interface MethodMap {
|
|
|
2436
2498
|
/**
|
|
2437
2499
|
* Put an environment provider binding
|
|
2438
2500
|
*
|
|
2439
|
-
* Creates or replaces one universe's
|
|
2501
|
+
* Creates or replaces one universe's binding to a deployment provider. Only an enabled binding admits creates, template listing, and data routes for the universe.
|
|
2440
2502
|
*/
|
|
2441
2503
|
"deployment/environment-providers/bindings/put": {
|
|
2442
2504
|
params: Api.DeploymentProviderBindingPutParams;
|
|
@@ -2445,21 +2507,12 @@ export interface MethodMap {
|
|
|
2445
2507
|
/**
|
|
2446
2508
|
* Delete an environment provider binding
|
|
2447
2509
|
*
|
|
2448
|
-
* Deletes a universe provider
|
|
2510
|
+
* Deletes a universe's binding to a provider only when the universe has no non-closed environment of that provider.
|
|
2449
2511
|
*/
|
|
2450
2512
|
"deployment/environment-providers/bindings/delete": {
|
|
2451
2513
|
params: Api.DeploymentProviderBindingDeleteParams;
|
|
2452
2514
|
result: Api.AgentApiOutcomeOfDeploymentProviderBindingDeleteResponse;
|
|
2453
2515
|
};
|
|
2454
|
-
/**
|
|
2455
|
-
* Adopt a provider environment
|
|
2456
|
-
*
|
|
2457
|
-
* Creates a universe environment by transferring an existing provider target into Lightspeed's managed lifecycle. The caller must explicitly accept ownership transfer.
|
|
2458
|
-
*/
|
|
2459
|
-
"deployment/environments/adopt": {
|
|
2460
|
-
params: Api.DeploymentEnvironmentAdoptParams;
|
|
2461
|
-
result: Api.AgentApiOutcomeOfDeploymentEnvironmentAdoptResponse;
|
|
2462
|
-
};
|
|
2463
2516
|
/**
|
|
2464
2517
|
* List channel accounts across universes
|
|
2465
2518
|
*
|
|
@@ -2533,7 +2586,7 @@ export declare const rpc: {
|
|
|
2533
2586
|
/**
|
|
2534
2587
|
* Replace session retention
|
|
2535
2588
|
*
|
|
2536
|
-
* Sets the positive close-relative automatic-deletion duration on a retention root, or clears it with null. Forks and delegated children inherit the root policy and cannot override it.
|
|
2589
|
+
* Sets the positive close-relative automatic soft-deletion duration on a retention root, or clears it with null. Forks and delegated children inherit the root policy and cannot override it. Retention does not permanently delete stored history.
|
|
2537
2590
|
*/
|
|
2538
2591
|
readonly sessionRetentionPut: (client: RpcCaller, params: Api.SessionRetentionPutParams) => Promise<Api.AgentApiOutcomeOfSessionRetentionPutResponse>;
|
|
2539
2592
|
/**
|
|
@@ -2545,7 +2598,7 @@ export declare const rpc: {
|
|
|
2545
2598
|
/**
|
|
2546
2599
|
* Delete closed sessions
|
|
2547
2600
|
*
|
|
2548
|
-
* Permanently
|
|
2601
|
+
* Permanently deletes a closed retention-tree leaf, or its closed history-fork and delegated-child subtree when cascade is true. Set softDelete to true to hide sessions while retaining records and history until a deployment administrator purges them. Prior soft deletion is not required for permanent deletion. Config-only clones are never included.
|
|
2549
2602
|
*/
|
|
2550
2603
|
readonly sessionDelete: (client: RpcCaller, params: Api.SessionDeleteParams) => Promise<Api.AgentApiOutcomeOfSessionDeleteResponse>;
|
|
2551
2604
|
/**
|
|
@@ -2665,85 +2718,85 @@ export declare const rpc: {
|
|
|
2665
2718
|
/**
|
|
2666
2719
|
* Create an environment
|
|
2667
2720
|
*
|
|
2668
|
-
*
|
|
2721
|
+
* Creates a provisioned environment, attributed to the caller, from a template of a provider enabled for the universe. Idempotent per requestId: same inputs, same environment; others conflict. Provisioning until the target's first envd handshake, then open; idle overrides the template default.
|
|
2669
2722
|
*/
|
|
2670
2723
|
readonly environmentsCreate: (client: RpcCaller, params: Api.EnvironmentCreateParams) => Promise<Api.AgentApiOutcomeOfEnvironmentCreateResponse>;
|
|
2671
2724
|
/**
|
|
2672
2725
|
* Read an environment
|
|
2673
2726
|
*
|
|
2674
|
-
* Returns
|
|
2727
|
+
* Returns one environment: its source, lifecycle state, derived display status, state message, close reason, daemon build, and the latest provider observation.
|
|
2675
2728
|
*/
|
|
2676
2729
|
readonly environmentsRead: (client: RpcCaller, params: Api.EnvironmentReadParams) => Promise<Api.AgentApiOutcomeOfEnvironmentReadResponse>;
|
|
2730
|
+
/**
|
|
2731
|
+
* Update an environment
|
|
2732
|
+
*
|
|
2733
|
+
* Replaces the display name and caller metadata of an environment of any kind. Refused for a closed environment.
|
|
2734
|
+
*/
|
|
2735
|
+
readonly environmentsUpdate: (client: RpcCaller, params: Api.EnvironmentUpdateParams) => Promise<Api.AgentApiOutcomeOfEnvironmentUpdateResponse>;
|
|
2677
2736
|
/**
|
|
2678
2737
|
* List environments
|
|
2679
2738
|
*
|
|
2680
|
-
* Lists the universe environments, optionally filtered by provider,
|
|
2739
|
+
* Lists the universe environments in id order, one page at a time, optionally filtered by provider, registration key, state, or metadata. Closed environments are omitted unless includeClosed is set or state is closed. Continue from nextAfter.
|
|
2681
2740
|
*/
|
|
2682
2741
|
readonly environmentsList: (client: RpcCaller, params: Api.EnvironmentListParams) => Promise<Api.AgentApiOutcomeOfEnvironmentListResponse>;
|
|
2683
2742
|
/**
|
|
2684
2743
|
* Close an environment
|
|
2685
2744
|
*
|
|
2686
|
-
*
|
|
2745
|
+
* Closes an environment; idempotent. A provisioned environment moves to closing while Lightspeed asks its provider to remove the target, retrying until it is gone, then closed. External and registered environments close at once, and a connected registered daemon is told its environment closed.
|
|
2687
2746
|
*/
|
|
2688
2747
|
readonly environmentsClose: (client: RpcCaller, params: Api.EnvironmentCloseParams) => Promise<Api.AgentApiOutcomeOfEnvironmentCloseResponse>;
|
|
2689
2748
|
/**
|
|
2690
2749
|
* Register an external environment
|
|
2691
2750
|
*
|
|
2692
|
-
* Creates an environment backed by a Lightspeed-reachable envd
|
|
2751
|
+
* Creates an open environment backed by a Lightspeed-reachable envd endpoint, attributed to the caller. Idempotent per requestId. Reachability is checked on use.
|
|
2693
2752
|
*/
|
|
2694
2753
|
readonly environmentsExternalCreate: (client: RpcCaller, params: Api.EnvironmentExternalCreateParams) => Promise<Api.AgentApiOutcomeOfEnvironmentExternalCreateResponse>;
|
|
2695
2754
|
/**
|
|
2696
2755
|
* Configure environment public ingress
|
|
2697
2756
|
*
|
|
2698
|
-
* Synchronously
|
|
2757
|
+
* Synchronously ensures or removes public ingress of an open provisioned environment through its provider; source.publicEndpoint carries the reported endpoint. Rejected when the provider offers no ingress; an internal error, safe to retry, when the provider is unreachable or times out. The provider owns hostname, guest port, routing, TLS, and health.
|
|
2699
2758
|
*/
|
|
2700
2759
|
readonly environmentsIngressPut: (client: RpcCaller, params: Api.EnvironmentIngressPutParams) => Promise<Api.AgentApiOutcomeOfEnvironmentIngressPutResponse>;
|
|
2701
2760
|
/**
|
|
2702
|
-
* Set environment power
|
|
2761
|
+
* Set environment power
|
|
2703
2762
|
*
|
|
2704
|
-
*
|
|
2763
|
+
* Synchronously moves an open provisioned environment's target to running, paused, suspended, or stopped via its provider and records the observation; the provider may also change power on idle. Rejected without provider power control or when the template lacks the state; an internal error, safe to retry, when the provider is unreachable or times out.
|
|
2705
2764
|
*/
|
|
2706
2765
|
readonly environmentsPowerPut: (client: RpcCaller, params: Api.EnvironmentPowerPutParams) => Promise<Api.AgentApiOutcomeOfEnvironmentPowerPutResponse>;
|
|
2707
|
-
/**
|
|
2708
|
-
* Set environment idle policy
|
|
2709
|
-
*
|
|
2710
|
-
* Replaces or clears the staged idle policy of a provisioned environment. The power reaper measures the daemon's idle duration against the pause/suspend/stop/close thresholds and escalates through the stages the provider supports.
|
|
2711
|
-
*/
|
|
2712
|
-
readonly environmentsIdlePolicyPut: (client: RpcCaller, params: Api.EnvironmentIdlePolicyPutParams) => Promise<Api.AgentApiOutcomeOfEnvironmentIdlePolicyPutResponse>;
|
|
2713
2766
|
/**
|
|
2714
2767
|
* List environment provider bindings
|
|
2715
2768
|
*
|
|
2716
|
-
* Lists this universe's
|
|
2769
|
+
* Lists this universe's bindings to deployment providers and whether each is enabled.
|
|
2717
2770
|
*/
|
|
2718
2771
|
readonly environmentsProviderBindingsList: (client: RpcCaller, params: Api.EnvironmentProviderBindingListParams) => Promise<Api.AgentApiOutcomeOfEnvironmentProviderBindingListResponse>;
|
|
2719
2772
|
/**
|
|
2720
2773
|
* Read an environment provider binding
|
|
2721
2774
|
*
|
|
2722
|
-
* Returns
|
|
2775
|
+
* Returns this universe's binding to one provider. Templates and physical resource, network, and ingress policy remain provider-owned.
|
|
2723
2776
|
*/
|
|
2724
2777
|
readonly environmentsProviderBindingsRead: (client: RpcCaller, params: Api.EnvironmentProviderBindingReadParams) => Promise<Api.AgentApiOutcomeOfEnvironmentProviderBindingReadResponse>;
|
|
2725
2778
|
/**
|
|
2726
2779
|
* List environment templates
|
|
2727
2780
|
*
|
|
2728
|
-
* Reads
|
|
2781
|
+
* Reads templates live from the controllers of the universe's enabled provider bindings, or of one provider: compute, power states, public ingress, and default idle policy.
|
|
2729
2782
|
*/
|
|
2730
2783
|
readonly environmentsTemplatesList: (client: RpcCaller, params: Api.EnvironmentTemplateListParams) => Promise<Api.AgentApiOutcomeOfEnvironmentTemplateListResponse>;
|
|
2731
2784
|
/**
|
|
2732
2785
|
* Read an environment template
|
|
2733
2786
|
*
|
|
2734
|
-
* Returns one
|
|
2787
|
+
* Returns one template, read live from a bound provider's controller.
|
|
2735
2788
|
*/
|
|
2736
2789
|
readonly environmentsTemplatesRead: (client: RpcCaller, params: Api.EnvironmentTemplateReadParams) => Promise<Api.AgentApiOutcomeOfEnvironmentTemplateReadResponse>;
|
|
2737
2790
|
/**
|
|
2738
2791
|
* Create environment jobs
|
|
2739
2792
|
*
|
|
2740
|
-
* Starts a dependency-aware job group on one environment instance, injecting
|
|
2793
|
+
* Starts a dependency-aware job group on one environment instance, injecting its configured credentials at provider start. requestId is the retry identity; jobs are owned by the instance, not a session. A powered-down environment wakes on its data route; the call fails with environment_not_ready while it wakes or reconnects; retry with backoff.
|
|
2741
2794
|
*/
|
|
2742
2795
|
readonly environmentsJobsCreate: (client: RpcCaller, params: Api.EnvironmentJobCreateParams) => Promise<Api.AgentApiOutcomeOfEnvironmentJobCreateResponse>;
|
|
2743
2796
|
/**
|
|
2744
2797
|
* Read environment jobs
|
|
2745
2798
|
*
|
|
2746
|
-
* Reads selected job handles with bounded output
|
|
2799
|
+
* Reads selected job handles with bounded output from a byte offset or the output tail; continue from each entry's outputNext and poll on the returned status.
|
|
2747
2800
|
*/
|
|
2748
2801
|
readonly environmentsJobsRead: (client: RpcCaller, params: Api.EnvironmentJobReadParams) => Promise<Api.AgentApiOutcomeOfEnvironmentJobReadResponse>;
|
|
2749
2802
|
/**
|
|
@@ -2755,7 +2808,7 @@ export declare const rpc: {
|
|
|
2755
2808
|
/**
|
|
2756
2809
|
* Mint an environment registration key
|
|
2757
2810
|
*
|
|
2758
|
-
* Creates a reusable universe-scoped key that lets outbound envd daemons register as environments. The plaintext secret is returned exactly once; only its hash is stored. Identity mode, active limit, disconnect grace, and expiry are the key's policy. Treat the secret like a cluster-join credential.
|
|
2811
|
+
* Creates a reusable universe-scoped key that lets outbound envd daemons register as environments. The plaintext secret is returned exactly once; only its hash is stored. Identity mode (immutable), active limit, disconnect grace, offline close-after, and expiry are the key's policy. Treat the secret like a cluster-join credential.
|
|
2759
2812
|
*/
|
|
2760
2813
|
readonly environmentsRegistrationKeysCreate: (client: RpcCaller, params: Api.EnvironmentRegistrationKeyCreateParams) => Promise<Api.AgentApiOutcomeOfEnvironmentRegistrationKeyCreateResponse>;
|
|
2761
2814
|
/**
|
|
@@ -2770,6 +2823,18 @@ export declare const rpc: {
|
|
|
2770
2823
|
* Lists this universe's registration keys with policy, status, and derived counts. Each key is the group of the environments it admitted.
|
|
2771
2824
|
*/
|
|
2772
2825
|
readonly environmentsRegistrationKeysList: (client: RpcCaller, params: Api.EnvironmentRegistrationKeyListParams) => Promise<Api.AgentApiOutcomeOfEnvironmentRegistrationKeyListResponse>;
|
|
2826
|
+
/**
|
|
2827
|
+
* Update an environment registration key
|
|
2828
|
+
*
|
|
2829
|
+
* Replaces a key's editable policy: display name, active limit, disconnect grace, offline close-after, and expiry; an omitted field is unset. The identity mode is immutable. The active limit and expiry apply to later admissions; a changed disconnect grace or offline close-after applies at the next sweep to environments whose daemon is away.
|
|
2830
|
+
*/
|
|
2831
|
+
readonly environmentsRegistrationKeysUpdate: (client: RpcCaller, params: Api.EnvironmentRegistrationKeyUpdateParams) => Promise<Api.AgentApiOutcomeOfEnvironmentRegistrationKeyUpdateResponse>;
|
|
2832
|
+
/**
|
|
2833
|
+
* Rotate an environment registration key
|
|
2834
|
+
*
|
|
2835
|
+
* Replaces the key's secret and display prefix and retires the old secret at once. The key keeps its id, group, policy, and the environments it admitted; daemons already registered are unaffected because they never present the key again. Returns the new secret once. Refused for a revoked key.
|
|
2836
|
+
*/
|
|
2837
|
+
readonly environmentsRegistrationKeysRotate: (client: RpcCaller, params: Api.EnvironmentRegistrationKeyRotateParams) => Promise<Api.AgentApiOutcomeOfEnvironmentRegistrationKeyRotateResponse>;
|
|
2773
2838
|
/**
|
|
2774
2839
|
* Revoke an environment registration key
|
|
2775
2840
|
*
|
|
@@ -3073,7 +3138,7 @@ export declare const rpc: {
|
|
|
3073
3138
|
/**
|
|
3074
3139
|
* Delete a bot
|
|
3075
3140
|
*
|
|
3076
|
-
* Closes the bot if needed, waits for its controller to complete,
|
|
3141
|
+
* Closes the bot if needed, waits for its controller to complete, retains its session history, and removes the record so the bot id is free again.
|
|
3077
3142
|
*/
|
|
3078
3143
|
readonly botsDelete: (client: RpcCaller, params: Api.BotDeleteParams) => Promise<Api.AgentApiOutcomeOfBotDeleteResponse>;
|
|
3079
3144
|
/**
|
|
@@ -3196,6 +3261,18 @@ export declare const rpc: {
|
|
|
3196
3261
|
* Queries the conversation workflow's live state for one chat, for debugging; absent when no workflow exists yet.
|
|
3197
3262
|
*/
|
|
3198
3263
|
readonly channelsConversationsRead: (client: RpcCaller, params: Api.ChannelConversationReadParams) => Promise<Api.AgentApiOutcomeOfChannelConversationReadResponse>;
|
|
3264
|
+
/**
|
|
3265
|
+
* List deleted sessions
|
|
3266
|
+
*
|
|
3267
|
+
* Administrative metadata for soft-deleted sessions, ordered by session ID. Unavailable through universe-scoped methods.
|
|
3268
|
+
*/
|
|
3269
|
+
readonly deploymentSessionsDeletedList: (client: RpcCaller, params: Api.DeploymentDeletedSessionsListParams) => Promise<Api.AgentApiOutcomeOfDeploymentDeletedSessionsListResponse>;
|
|
3270
|
+
/**
|
|
3271
|
+
* Permanently delete a session
|
|
3272
|
+
*
|
|
3273
|
+
* Removes a soft-deleted session and its soft-deleted history subtree. Rejects any selected session that has not been soft-deleted. Releases event, checkpoint and blob references; unreferenced blobs follow normal garbage collection. Does not delete external workspaces, environments, backups or Temporal history.
|
|
3274
|
+
*/
|
|
3275
|
+
readonly deploymentSessionsPurge: (client: RpcCaller, params: Api.DeploymentSessionPurgeParams) => Promise<Api.AgentApiOutcomeOfDeploymentSessionPurgeResponse>;
|
|
3199
3276
|
/**
|
|
3200
3277
|
* List a universe's deployment provider bindings
|
|
3201
3278
|
*
|
|
@@ -3259,45 +3336,39 @@ export declare const rpc: {
|
|
|
3259
3336
|
/**
|
|
3260
3337
|
* Put an environment provider
|
|
3261
3338
|
*
|
|
3262
|
-
* Registers or replaces
|
|
3339
|
+
* Registers or replaces a deployment provider: controller endpoint, optional data route base, and optional bearer credential for controller and data routes (write-only: kept when omitted, removed by clearCredential, never returned). The controller is probed: a definitive refusal is invalid_request, unreachable is accepted. The provider never calls Lightspeed.
|
|
3263
3340
|
*/
|
|
3264
3341
|
readonly deploymentEnvironmentProvidersPut: (client: RpcCaller, params: Api.DeploymentEnvironmentProviderPutParams) => Promise<Api.AgentApiOutcomeOfDeploymentEnvironmentProviderPutResponse>;
|
|
3265
3342
|
/**
|
|
3266
3343
|
* List environment providers
|
|
3267
3344
|
*
|
|
3268
|
-
* Returns every deployment-registered
|
|
3345
|
+
* Returns every deployment-registered provider with its controller endpoint, data route base, and whether a credential is stored.
|
|
3269
3346
|
*/
|
|
3270
3347
|
readonly deploymentEnvironmentProvidersList: (client: RpcCaller, params: Api.DeploymentEnvironmentProviderListParams) => Promise<Api.AgentApiOutcomeOfDeploymentEnvironmentProviderListResponse>;
|
|
3271
3348
|
/**
|
|
3272
3349
|
* Read an environment provider
|
|
3273
3350
|
*
|
|
3274
|
-
* Returns one deployment-registered
|
|
3351
|
+
* Returns one deployment-registered provider with its controller endpoint, data route base, and whether a credential is stored.
|
|
3275
3352
|
*/
|
|
3276
3353
|
readonly deploymentEnvironmentProvidersRead: (client: RpcCaller, params: Api.DeploymentEnvironmentProviderReadParams) => Promise<Api.AgentApiOutcomeOfDeploymentEnvironmentProviderReadResponse>;
|
|
3277
3354
|
/**
|
|
3278
3355
|
* Delete an environment provider
|
|
3279
3356
|
*
|
|
3280
|
-
* Deletes a deployment provider only when no universe binding references it.
|
|
3357
|
+
* Deletes a deployment provider only when no universe binding and no non-closed environment references it.
|
|
3281
3358
|
*/
|
|
3282
3359
|
readonly deploymentEnvironmentProvidersDelete: (client: RpcCaller, params: Api.DeploymentEnvironmentProviderDeleteParams) => Promise<Api.AgentApiOutcomeOfDeploymentEnvironmentProviderDeleteResponse>;
|
|
3283
3360
|
/**
|
|
3284
3361
|
* Put an environment provider binding
|
|
3285
3362
|
*
|
|
3286
|
-
* Creates or replaces one universe's
|
|
3363
|
+
* Creates or replaces one universe's binding to a deployment provider. Only an enabled binding admits creates, template listing, and data routes for the universe.
|
|
3287
3364
|
*/
|
|
3288
3365
|
readonly deploymentEnvironmentProvidersBindingsPut: (client: RpcCaller, params: Api.DeploymentProviderBindingPutParams) => Promise<Api.AgentApiOutcomeOfDeploymentProviderBindingPutResponse>;
|
|
3289
3366
|
/**
|
|
3290
3367
|
* Delete an environment provider binding
|
|
3291
3368
|
*
|
|
3292
|
-
* Deletes a universe provider
|
|
3369
|
+
* Deletes a universe's binding to a provider only when the universe has no non-closed environment of that provider.
|
|
3293
3370
|
*/
|
|
3294
3371
|
readonly deploymentEnvironmentProvidersBindingsDelete: (client: RpcCaller, params: Api.DeploymentProviderBindingDeleteParams) => Promise<Api.AgentApiOutcomeOfDeploymentProviderBindingDeleteResponse>;
|
|
3295
|
-
/**
|
|
3296
|
-
* Adopt a provider environment
|
|
3297
|
-
*
|
|
3298
|
-
* Creates a universe environment by transferring an existing provider target into Lightspeed's managed lifecycle. The caller must explicitly accept ownership transfer.
|
|
3299
|
-
*/
|
|
3300
|
-
readonly deploymentEnvironmentsAdopt: (client: RpcCaller, params: Api.DeploymentEnvironmentAdoptParams) => Promise<Api.AgentApiOutcomeOfDeploymentEnvironmentAdoptResponse>;
|
|
3301
3372
|
/**
|
|
3302
3373
|
* List channel accounts across universes
|
|
3303
3374
|
*
|