@soat/sdk 0.99.2 → 0.100.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/dist/index.cjs +11 -9
- package/dist/index.d.cts +28 -22
- package/dist/index.d.mts +28 -22
- package/dist/index.mjs +11 -9
- package/package.json +1 -1
package/dist/index.cjs
CHANGED
|
@@ -972,8 +972,10 @@ var AiProviders = class {
|
|
|
972
972
|
*
|
|
973
973
|
* Creates a new LLM provider configuration.
|
|
974
974
|
*
|
|
975
|
-
* A
|
|
976
|
-
*
|
|
975
|
+
* A provider's credential is its linked `secret_id`; `config.apiKey` is
|
|
976
|
+
* refused with `400 VALIDATION_FAILED`.
|
|
977
|
+
*
|
|
978
|
+
* A `bedrock` or `vertex` record must link one. Without it the provider
|
|
977
979
|
* SDK signs with the server's own credentials (the AWS default credential
|
|
978
980
|
* chain, Google Application Default Credentials), which is refused with
|
|
979
981
|
* `400 VALIDATION_FAILED` unless the deployment allows it.
|
|
@@ -1100,7 +1102,7 @@ var ApiKeys = class {
|
|
|
1100
1102
|
/**
|
|
1101
1103
|
* Create an API key
|
|
1102
1104
|
*
|
|
1103
|
-
* Creates a new API key for the authenticated user. - `project_id` is optional. When set, the key is scoped to that single project. When omitted or null, the key is **unscoped** and spans every project its owner can reach. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - Otherwise the key inherits the user's permissions (confined to the key's project when scoped). - When the request is authenticated with a **project-scoped
|
|
1105
|
+
* Creates a new API key for the authenticated user. - `project_id` is optional. When set, the key is scoped to that single project. When omitted or null, the key is **unscoped** and spans every project its owner can reach. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - Otherwise the key inherits the user's permissions (confined to the key's project when scoped). - When the request is authenticated with a **project-scoped token** (an OAuth access token, a trigger run-as token or a run token), it returns `403 API_KEY_SCOPED_TOKEN`: such a token never creates a key. - When the request is authenticated with a **project-scoped API key**, the new key is confined to that same project: omitting `project_id` defaults to it, naming a different project returns `403 API_KEY_PROJECT_SCOPE`, and `project_id: null` (an unscoped key) is likewise refused. Minting an unscoped key requires an unscoped credential. - When the request is authenticated with an **API key narrowed by `policy_ids`**, the new key stays inside that boundary: omitting `policy_ids` inherits the caller's own, a non-empty subset of them is accepted, and an empty list or any other policy returns `403 API_KEY_POLICY_BOUNDARY`.
|
|
1104
1106
|
*
|
|
1105
1107
|
*/
|
|
1106
1108
|
static createApiKey(options) {
|
|
@@ -1138,7 +1140,7 @@ var ApiKeys = class {
|
|
|
1138
1140
|
/**
|
|
1139
1141
|
* Update an API key
|
|
1140
1142
|
*
|
|
1141
|
-
* Updates an API key's name, project scope, or policies. The project scope can be changed to another project, set (scoping a previously unscoped key), or cleared with null (unscoping the key). Only the owner or an admin can update it. A project-scoped credential can only update keys in its own project, and cannot move a key to another project or unscope it. An API key narrowed by `policy_ids` can only set `policy_ids` to a non-empty subset of its own (`403 API_KEY_POLICY_BOUNDARY` otherwise).
|
|
1143
|
+
* Updates an API key's name, project scope, or policies. The project scope can be changed to another project, set (scoping a previously unscoped key), or cleared with null (unscoping the key). Only the owner or an admin can update it. A project-scoped credential can only update keys in its own project, and cannot move a key to another project or unscope it. An API key narrowed by `policy_ids` can only set `policy_ids` to a non-empty subset of its own (`403 API_KEY_POLICY_BOUNDARY` otherwise). A project-scoped token (OAuth, trigger or run) never updates a key (`403 API_KEY_SCOPED_TOKEN`).
|
|
1142
1144
|
*/
|
|
1143
1145
|
static updateApiKey(options) {
|
|
1144
1146
|
return (options.client ?? client).put({
|
|
@@ -3703,7 +3705,7 @@ var Playbooks = class {
|
|
|
3703
3705
|
*
|
|
3704
3706
|
* Creates a playbook at version 1. The definition is refused with `400 PLAYBOOK_VALIDATION_FAILED` when it holds a duplicate node or input, an input reading a missing node or field, an `execute` node without an executor or another kind with one, transformations on a non-final node, or a cycle; `meta.problems` lists every one. A duplicate `name` in the project is `409 NAME_CONFLICT`.
|
|
3705
3707
|
*
|
|
3706
|
-
* The caller becomes the version's author, whom its executors run as, so it must be allowed to start every executor the definition names (`403 PLAYBOOK_EXECUTOR_FORBIDDEN`), and each must exist in the project, or be an agent or tool shared with it (`400 PLAYBOOK_VALIDATION_FAILED`, an `EXECUTOR_NOT_FOUND` problem). A `tool` executor on an `mcp` tool must name in `operation_id` an action the tool's binding allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). A definition with executors written with a trigger or OAuth token is `409 PLAYBOOK_AUTHOR_UNAVAILABLE`: those carry their boundary in the token, so no run can act as them.
|
|
3708
|
+
* The caller becomes the version's author, whom its executors run as, so it must be allowed to start every executor the definition names (`403 PLAYBOOK_EXECUTOR_FORBIDDEN`), and each must exist in the project, or be an agent or tool shared with it (`400 PLAYBOOK_VALIDATION_FAILED`, an `EXECUTOR_NOT_FOUND` problem). A `tool` executor on an `mcp` tool must name in `operation_id` an action the tool's binding allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). An executor cannot be a `client` tool (`EXECUTOR_TOOL_UNSUPPORTED`), nor a transformation's tool a `client` or `mcp` tool (`TRANSFORMATION_TOOL_UNSUPPORTED`). A definition with executors written with a trigger or OAuth token is `409 PLAYBOOK_AUTHOR_UNAVAILABLE`: those carry their boundary in the token, so no run can act as them.
|
|
3707
3709
|
*/
|
|
3708
3710
|
static createPlaybook(options) {
|
|
3709
3711
|
return (options.client ?? client).post({
|
|
@@ -3720,7 +3722,7 @@ var Playbooks = class {
|
|
|
3720
3722
|
*
|
|
3721
3723
|
* Answers what a create or update would be told about a definition, without writing: `valid`, and every graph problem it holds. A definition whose shape cannot be read is `400 VALIDATION_FAILED`, as on a write.
|
|
3722
3724
|
*
|
|
3723
|
-
* With `project_id`, the references are checked too, as a write there would check them: the upstreams against that project's playbooks, and each executor the caller may start must exist (`EXECUTOR_NOT_FOUND`) and name an action its `mcp` tool allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). The caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
|
|
3725
|
+
* With `project_id`, the references are checked too, as a write there would check them: the upstreams against that project's playbooks, and each executor the caller may start must exist (`EXECUTOR_NOT_FOUND`) and name an action its `mcp` tool allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`) and not be a `client` tool (`EXECUTOR_TOOL_UNSUPPORTED`), and each transformation's tool must not be a `client` or `mcp` tool (`TRANSFORMATION_TOOL_UNSUPPORTED`). The caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
|
|
3724
3726
|
*/
|
|
3725
3727
|
static validatePlaybook(options) {
|
|
3726
3728
|
return (options.client ?? client).post({
|
|
@@ -3759,7 +3761,7 @@ var Playbooks = class {
|
|
|
3759
3761
|
*
|
|
3760
3762
|
* Updates any of `name`, `description` and `definition`. Only a change to `definition` archives a new version; a rename or a rewrite of the definition the playbook already holds leaves `version` where it is. A case keeps the version it was created on.
|
|
3761
3763
|
*
|
|
3762
|
-
* A new version is authored by the caller, checked as on create: `403 PLAYBOOK_EXECUTOR_FORBIDDEN` for an executor it may not start, an `EXECUTOR_NOT_FOUND` problem for one that does not exist, `EXECUTOR_ACTION_REQUIRED` or `EXECUTOR_ACTION_UNAVAILABLE` for an `mcp` tool action a run could not call, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
3764
|
+
* A new version is authored by the caller, checked as on create: `403 PLAYBOOK_EXECUTOR_FORBIDDEN` for an executor it may not start, an `EXECUTOR_NOT_FOUND` problem for one that does not exist, `EXECUTOR_ACTION_REQUIRED` or `EXECUTOR_ACTION_UNAVAILABLE` for an `mcp` tool action a run could not call, `EXECUTOR_TOOL_UNSUPPORTED` for a `client` tool executor, `TRANSFORMATION_TOOL_UNSUPPORTED` for a `client` or `mcp` transformation tool, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
3763
3765
|
*/
|
|
3764
3766
|
static updatePlaybook(options) {
|
|
3765
3767
|
return (options.client ?? client).patch({
|
|
@@ -4078,7 +4080,7 @@ var Policies = class {
|
|
|
4078
4080
|
/**
|
|
4079
4081
|
* Delete a policy
|
|
4080
4082
|
*
|
|
4081
|
-
* Deletes a global policy. Requires admin role.
|
|
4083
|
+
* Deletes a global policy. Requires admin role. Refused with `409 POLICY_HAS_DEPENDENTS` while a trigger's `policy_id` names it.
|
|
4082
4084
|
*/
|
|
4083
4085
|
static deletePolicy(options) {
|
|
4084
4086
|
return (options.client ?? client).delete({
|
|
@@ -4173,7 +4175,7 @@ var Projects = class {
|
|
|
4173
4175
|
/**
|
|
4174
4176
|
* Update a project
|
|
4175
4177
|
*
|
|
4176
|
-
* Updates a project's name, its attached guardrails (`guardrail_ids` — the project-scope baseline governing every tool call by every agent in the project), its orchestration concurrency limit (`max_concurrent_runs`), its continuation-chain ceiling (`max_chain_generations`), its orchestration nesting bound (`max_orchestration_run_depth`), its inherited model route (`default_model_route_id`), its read-auditing opt-in (`audit_reads_enabled`), its priced-model requirement (`require_priced_model`), its trace-content retention window (`trace_content_retention_days`), and/or its zero-retention setting (`trace_content_mode`). At least one field is required. Requires
|
|
4178
|
+
* Updates a project's name, its attached guardrails (`guardrail_ids` — the project-scope baseline governing every tool call by every agent in the project), its orchestration concurrency limit (`max_concurrent_runs`), its continuation-chain ceiling (`max_chain_generations`), its orchestration nesting bound (`max_orchestration_run_depth`), its inherited model route (`default_model_route_id`), its read-auditing opt-in (`audit_reads_enabled`), its priced-model requirement (`require_priced_model`), its trace-content retention window (`trace_content_retention_days`), and/or its zero-retention setting (`trace_content_mode`). At least one field is required. Requires projects:UpdateProject on the project, which a project-scoped policy can grant. Detaching a guardrail (removing an id) additionally requires guardrails:DetachGuardrail.
|
|
4177
4179
|
*/
|
|
4178
4180
|
static updateProject(options) {
|
|
4179
4181
|
return (options.client ?? client).patch({
|
package/dist/index.d.cts
CHANGED
|
@@ -6338,7 +6338,7 @@ type UpdatePlaybookRequest = {
|
|
|
6338
6338
|
};
|
|
6339
6339
|
type ValidatePlaybookRequest = {
|
|
6340
6340
|
/**
|
|
6341
|
-
* Also check the references against this project: the upstreams (`UNKNOWN_UPSTREAM`, and the `MISSING_NODE` and `UNKNOWN_FIELD` of what an upstream node pulls) and the executors (`EXECUTOR_NOT_FOUND`, `EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`).
|
|
6341
|
+
* Also check the references against this project: the upstreams (`UNKNOWN_UPSTREAM`, and the `MISSING_NODE` and `UNKNOWN_FIELD` of what an upstream node pulls) and the executors (`EXECUTOR_NOT_FOUND`, `EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`, `EXECUTOR_TOOL_UNSUPPORTED`, `TRANSFORMATION_TOOL_UNSUPPORTED`).
|
|
6342
6342
|
*/
|
|
6343
6343
|
project_id?: string;
|
|
6344
6344
|
/**
|
|
@@ -6353,7 +6353,7 @@ type ValidatePlaybookRequest = {
|
|
|
6353
6353
|
type PlaybookValidationResult = {
|
|
6354
6354
|
valid: boolean;
|
|
6355
6355
|
/**
|
|
6356
|
-
* Every reason the definition cannot be stored: `DUPLICATE_NODE`, `DUPLICATE_INPUT`, `MISSING_NODE`, `UNKNOWN_FIELD`, `EXECUTOR_REQUIRED`, `EXECUTOR_FORBIDDEN`, `TRANSFORMATIONS_NOT_FINAL`, `DUPLICATE_TRANSFORMATION`, `CYCLE`, and, with `project_id`, `UNKNOWN_UPSTREAM`, `UPSTREAM_CYCLE`, `EXECUTOR_NOT_FOUND`, `EXECUTOR_ACTION_REQUIRED` or `
|
|
6356
|
+
* Every reason the definition cannot be stored: `DUPLICATE_NODE`, `DUPLICATE_INPUT`, `MISSING_NODE`, `UNKNOWN_FIELD`, `EXECUTOR_REQUIRED`, `EXECUTOR_FORBIDDEN`, `TRANSFORMATIONS_NOT_FINAL`, `DUPLICATE_TRANSFORMATION`, `CYCLE`, and, with `project_id`, `UNKNOWN_UPSTREAM`, `UPSTREAM_CYCLE`, `EXECUTOR_NOT_FOUND`, `EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`, `EXECUTOR_TOOL_UNSUPPORTED` or `TRANSFORMATION_TOOL_UNSUPPORTED`. The same items a refused write lists under `meta.problems`.
|
|
6357
6357
|
*/
|
|
6358
6358
|
problems: Array<ValidationProblem>;
|
|
6359
6359
|
};
|
|
@@ -7261,7 +7261,7 @@ type ShareReference = {
|
|
|
7261
7261
|
/**
|
|
7262
7262
|
* The kind of the grantee's resource.
|
|
7263
7263
|
*/
|
|
7264
|
-
type: 'agent' | 'tool' | 'decider' | 'ingestion_rule' | 'orchestration' | 'workflow' | 'playbook' | 'eval' | 'trigger' | 'formation';
|
|
7264
|
+
type: 'agent' | 'tool' | 'guardrail' | 'decider' | 'ingestion_rule' | 'orchestration' | 'workflow' | 'playbook' | 'eval' | 'trigger' | 'formation';
|
|
7265
7265
|
/**
|
|
7266
7266
|
* Its public ID.
|
|
7267
7267
|
*/
|
|
@@ -10527,7 +10527,7 @@ type ListAiProvidersResponses = {
|
|
|
10527
10527
|
*/
|
|
10528
10528
|
base_url?: string;
|
|
10529
10529
|
/**
|
|
10530
|
-
* Additional provider-specific configuration. Absent when the record sets none.
|
|
10530
|
+
* Additional provider-specific configuration. Absent when the record sets none. Never carries a credential.
|
|
10531
10531
|
*/
|
|
10532
10532
|
config?: {
|
|
10533
10533
|
[key: string]: unknown;
|
|
@@ -10558,7 +10558,7 @@ type CreateAiProviderData = {
|
|
|
10558
10558
|
*/
|
|
10559
10559
|
default_model: string;
|
|
10560
10560
|
/**
|
|
10561
|
-
* Secret ID containing API credentials. Required for `bedrock` and `vertex
|
|
10561
|
+
* Secret ID containing API credentials. Required for `bedrock` and `vertex`.
|
|
10562
10562
|
*/
|
|
10563
10563
|
secret_id?: string;
|
|
10564
10564
|
/**
|
|
@@ -10566,7 +10566,7 @@ type CreateAiProviderData = {
|
|
|
10566
10566
|
*/
|
|
10567
10567
|
base_url?: string;
|
|
10568
10568
|
/**
|
|
10569
|
-
* Additional provider-specific configuration. `
|
|
10569
|
+
* Additional provider-specific configuration. `apiKey` is refused: the credential goes in the linked secret.
|
|
10570
10570
|
*/
|
|
10571
10571
|
config?: {
|
|
10572
10572
|
[key: string]: unknown;
|
|
@@ -10725,7 +10725,7 @@ type GetAiProviderResponses = {
|
|
|
10725
10725
|
secret_id?: string | null;
|
|
10726
10726
|
base_url?: string;
|
|
10727
10727
|
/**
|
|
10728
|
-
* Additional provider-specific configuration.
|
|
10728
|
+
* Additional provider-specific configuration. Never carries a credential.
|
|
10729
10729
|
*/
|
|
10730
10730
|
config?: {
|
|
10731
10731
|
[key: string]: unknown;
|
|
@@ -10746,7 +10746,7 @@ type UpdateAiProviderData = {
|
|
|
10746
10746
|
secret_id?: string | null;
|
|
10747
10747
|
base_url?: string;
|
|
10748
10748
|
/**
|
|
10749
|
-
* Replaces the whole configuration
|
|
10749
|
+
* Replaces the whole configuration. `apiKey` is refused: the credential goes in the linked secret.
|
|
10750
10750
|
*/
|
|
10751
10751
|
config?: {
|
|
10752
10752
|
[key: string]: unknown;
|
|
@@ -11028,7 +11028,7 @@ type CreateApiKeyErrors = {
|
|
|
11028
11028
|
*/
|
|
11029
11029
|
401: ErrorResponse;
|
|
11030
11030
|
/**
|
|
11031
|
-
* Forbidden (a project-scoped
|
|
11031
|
+
* Forbidden (a project-scoped token; a project-scoped key named a different project, or asked for an unscoped key; or a key narrowed by `policy_ids` asked for a key outside its boundary)
|
|
11032
11032
|
*/
|
|
11033
11033
|
403: ErrorResponse;
|
|
11034
11034
|
/**
|
|
@@ -11173,7 +11173,7 @@ type UpdateApiKeyErrors = {
|
|
|
11173
11173
|
*/
|
|
11174
11174
|
401: ErrorResponse;
|
|
11175
11175
|
/**
|
|
11176
|
-
* Forbidden (not the key owner or admin, the credential is scoped to a different project, or a key narrowed by `policy_ids` asked for policies outside its boundary)
|
|
11176
|
+
* Forbidden (a project-scoped token, not the key owner or admin, the credential is scoped to a different project, or a key narrowed by `policy_ids` asked for policies outside its boundary)
|
|
11177
11177
|
*/
|
|
11178
11178
|
403: ErrorResponse;
|
|
11179
11179
|
/**
|
|
@@ -13730,7 +13730,7 @@ type UpdateDocumentErrors = {
|
|
|
13730
13730
|
*/
|
|
13731
13731
|
404: ErrorResponse;
|
|
13732
13732
|
/**
|
|
13733
|
-
* The document has moved past the version this write read (`VERSION_CONFLICT`, with `meta.current_version`),
|
|
13733
|
+
* The document has moved past the version this write read (`VERSION_CONFLICT`, with `meta.current_version`), `path` is held by another file in the project (`NAME_CONFLICT`), or new `content` would exceed the project's `storage_bytes` quota (`QUOTA_STORAGE_EXCEEDED`, no `Retry-After`). Nothing is written.
|
|
13734
13734
|
*/
|
|
13735
13735
|
409: ErrorResponse;
|
|
13736
13736
|
/**
|
|
@@ -14147,7 +14147,7 @@ type RestoreDocumentVersionErrors = {
|
|
|
14147
14147
|
*/
|
|
14148
14148
|
404: ErrorResponse;
|
|
14149
14149
|
/**
|
|
14150
|
-
* Another write took the document's version first (`VERSION_CONFLICT`, with `meta.current_version`),
|
|
14150
|
+
* Another write took the document's version first (`VERSION_CONFLICT`, with `meta.current_version`), the restored `path` is held by another file in the project (`NAME_CONFLICT`), or the restored content would exceed the project's `storage_bytes` quota (`QUOTA_STORAGE_EXCEEDED`, no `Retry-After`). Nothing is written.
|
|
14151
14151
|
*/
|
|
14152
14152
|
409: ErrorResponse;
|
|
14153
14153
|
/**
|
|
@@ -18477,7 +18477,7 @@ type UpdateMemoryErrors = {
|
|
|
18477
18477
|
*/
|
|
18478
18478
|
404: ErrorResponse;
|
|
18479
18479
|
/**
|
|
18480
|
-
* The
|
|
18480
|
+
* The memory has moved past the version this write read (`VERSION_CONFLICT`, with `meta.current_version`), or new `content` would exceed the project's `storage_bytes` quota (`QUOTA_STORAGE_EXCEEDED`, no `Retry-After`). Nothing is written.
|
|
18481
18481
|
*/
|
|
18482
18482
|
409: ErrorResponse;
|
|
18483
18483
|
/**
|
|
@@ -22755,6 +22755,10 @@ type DeletePolicyErrors = {
|
|
|
22755
22755
|
* Policy not found
|
|
22756
22756
|
*/
|
|
22757
22757
|
404: ErrorResponse;
|
|
22758
|
+
/**
|
|
22759
|
+
* `POLICY_HAS_DEPENDENTS`: a trigger's `policy_id` still names the policy. Detach it from those triggers or delete them first.
|
|
22760
|
+
*/
|
|
22761
|
+
409: ErrorResponse;
|
|
22758
22762
|
/**
|
|
22759
22763
|
* `QUOTA_EXCEEDED` — a `requests` quota on the calling API key or its project is spent for the window; `Retry-After` says when it reopens
|
|
22760
22764
|
*/
|
|
@@ -28851,8 +28855,10 @@ export declare class AiProviders {
|
|
|
28851
28855
|
*
|
|
28852
28856
|
* Creates a new LLM provider configuration.
|
|
28853
28857
|
*
|
|
28854
|
-
* A
|
|
28855
|
-
*
|
|
28858
|
+
* A provider's credential is its linked `secret_id`; `config.apiKey` is
|
|
28859
|
+
* refused with `400 VALIDATION_FAILED`.
|
|
28860
|
+
*
|
|
28861
|
+
* A `bedrock` or `vertex` record must link one. Without it the provider
|
|
28856
28862
|
* SDK signs with the server's own credentials (the AWS default credential
|
|
28857
28863
|
* chain, Google Application Default Credentials), which is refused with
|
|
28858
28864
|
* `400 VALIDATION_FAILED` unless the deployment allows it.
|
|
@@ -28923,7 +28929,7 @@ export declare class ApiKeys {
|
|
|
28923
28929
|
/**
|
|
28924
28930
|
* Create an API key
|
|
28925
28931
|
*
|
|
28926
|
-
* Creates a new API key for the authenticated user. - `project_id` is optional. When set, the key is scoped to that single project. When omitted or null, the key is **unscoped** and spans every project its owner can reach. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - Otherwise the key inherits the user's permissions (confined to the key's project when scoped). - When the request is authenticated with a **project-scoped
|
|
28932
|
+
* Creates a new API key for the authenticated user. - `project_id` is optional. When set, the key is scoped to that single project. When omitted or null, the key is **unscoped** and spans every project its owner can reach. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - Otherwise the key inherits the user's permissions (confined to the key's project when scoped). - When the request is authenticated with a **project-scoped token** (an OAuth access token, a trigger run-as token or a run token), it returns `403 API_KEY_SCOPED_TOKEN`: such a token never creates a key. - When the request is authenticated with a **project-scoped API key**, the new key is confined to that same project: omitting `project_id` defaults to it, naming a different project returns `403 API_KEY_PROJECT_SCOPE`, and `project_id: null` (an unscoped key) is likewise refused. Minting an unscoped key requires an unscoped credential. - When the request is authenticated with an **API key narrowed by `policy_ids`**, the new key stays inside that boundary: omitting `policy_ids` inherits the caller's own, a non-empty subset of them is accepted, and an empty list or any other policy returns `403 API_KEY_POLICY_BOUNDARY`.
|
|
28927
28933
|
*
|
|
28928
28934
|
*/
|
|
28929
28935
|
static createApiKey<ThrowOnError extends boolean = false>(options: Options<CreateApiKeyData, ThrowOnError>): RequestResult<CreateApiKeyResponses, CreateApiKeyErrors, ThrowOnError>;
|
|
@@ -28942,7 +28948,7 @@ export declare class ApiKeys {
|
|
|
28942
28948
|
/**
|
|
28943
28949
|
* Update an API key
|
|
28944
28950
|
*
|
|
28945
|
-
* Updates an API key's name, project scope, or policies. The project scope can be changed to another project, set (scoping a previously unscoped key), or cleared with null (unscoping the key). Only the owner or an admin can update it. A project-scoped credential can only update keys in its own project, and cannot move a key to another project or unscope it. An API key narrowed by `policy_ids` can only set `policy_ids` to a non-empty subset of its own (`403 API_KEY_POLICY_BOUNDARY` otherwise).
|
|
28951
|
+
* Updates an API key's name, project scope, or policies. The project scope can be changed to another project, set (scoping a previously unscoped key), or cleared with null (unscoping the key). Only the owner or an admin can update it. A project-scoped credential can only update keys in its own project, and cannot move a key to another project or unscope it. An API key narrowed by `policy_ids` can only set `policy_ids` to a non-empty subset of its own (`403 API_KEY_POLICY_BOUNDARY` otherwise). A project-scoped token (OAuth, trigger or run) never updates a key (`403 API_KEY_SCOPED_TOKEN`).
|
|
28946
28952
|
*/
|
|
28947
28953
|
static updateApiKey<ThrowOnError extends boolean = false>(options: Options<UpdateApiKeyData, ThrowOnError>): RequestResult<UpdateApiKeyResponses, UpdateApiKeyErrors, ThrowOnError>;
|
|
28948
28954
|
}
|
|
@@ -30262,7 +30268,7 @@ export declare class Playbooks {
|
|
|
30262
30268
|
*
|
|
30263
30269
|
* Creates a playbook at version 1. The definition is refused with `400 PLAYBOOK_VALIDATION_FAILED` when it holds a duplicate node or input, an input reading a missing node or field, an `execute` node without an executor or another kind with one, transformations on a non-final node, or a cycle; `meta.problems` lists every one. A duplicate `name` in the project is `409 NAME_CONFLICT`.
|
|
30264
30270
|
*
|
|
30265
|
-
* The caller becomes the version's author, whom its executors run as, so it must be allowed to start every executor the definition names (`403 PLAYBOOK_EXECUTOR_FORBIDDEN`), and each must exist in the project, or be an agent or tool shared with it (`400 PLAYBOOK_VALIDATION_FAILED`, an `EXECUTOR_NOT_FOUND` problem). A `tool` executor on an `mcp` tool must name in `operation_id` an action the tool's binding allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). A definition with executors written with a trigger or OAuth token is `409 PLAYBOOK_AUTHOR_UNAVAILABLE`: those carry their boundary in the token, so no run can act as them.
|
|
30271
|
+
* The caller becomes the version's author, whom its executors run as, so it must be allowed to start every executor the definition names (`403 PLAYBOOK_EXECUTOR_FORBIDDEN`), and each must exist in the project, or be an agent or tool shared with it (`400 PLAYBOOK_VALIDATION_FAILED`, an `EXECUTOR_NOT_FOUND` problem). A `tool` executor on an `mcp` tool must name in `operation_id` an action the tool's binding allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). An executor cannot be a `client` tool (`EXECUTOR_TOOL_UNSUPPORTED`), nor a transformation's tool a `client` or `mcp` tool (`TRANSFORMATION_TOOL_UNSUPPORTED`). A definition with executors written with a trigger or OAuth token is `409 PLAYBOOK_AUTHOR_UNAVAILABLE`: those carry their boundary in the token, so no run can act as them.
|
|
30266
30272
|
*/
|
|
30267
30273
|
static createPlaybook<ThrowOnError extends boolean = false>(options: Options<CreatePlaybookData, ThrowOnError>): RequestResult<CreatePlaybookResponses, CreatePlaybookErrors, ThrowOnError>;
|
|
30268
30274
|
/**
|
|
@@ -30270,7 +30276,7 @@ export declare class Playbooks {
|
|
|
30270
30276
|
*
|
|
30271
30277
|
* Answers what a create or update would be told about a definition, without writing: `valid`, and every graph problem it holds. A definition whose shape cannot be read is `400 VALIDATION_FAILED`, as on a write.
|
|
30272
30278
|
*
|
|
30273
|
-
* With `project_id`, the references are checked too, as a write there would check them: the upstreams against that project's playbooks, and each executor the caller may start must exist (`EXECUTOR_NOT_FOUND`) and name an action its `mcp` tool allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). The caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
|
|
30279
|
+
* With `project_id`, the references are checked too, as a write there would check them: the upstreams against that project's playbooks, and each executor the caller may start must exist (`EXECUTOR_NOT_FOUND`) and name an action its `mcp` tool allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`) and not be a `client` tool (`EXECUTOR_TOOL_UNSUPPORTED`), and each transformation's tool must not be a `client` or `mcp` tool (`TRANSFORMATION_TOOL_UNSUPPORTED`). The caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
|
|
30274
30280
|
*/
|
|
30275
30281
|
static validatePlaybook<ThrowOnError extends boolean = false>(options: Options<ValidatePlaybookData, ThrowOnError>): RequestResult<ValidatePlaybookResponses, ValidatePlaybookErrors, ThrowOnError>;
|
|
30276
30282
|
/**
|
|
@@ -30290,7 +30296,7 @@ export declare class Playbooks {
|
|
|
30290
30296
|
*
|
|
30291
30297
|
* Updates any of `name`, `description` and `definition`. Only a change to `definition` archives a new version; a rename or a rewrite of the definition the playbook already holds leaves `version` where it is. A case keeps the version it was created on.
|
|
30292
30298
|
*
|
|
30293
|
-
* A new version is authored by the caller, checked as on create: `403 PLAYBOOK_EXECUTOR_FORBIDDEN` for an executor it may not start, an `EXECUTOR_NOT_FOUND` problem for one that does not exist, `EXECUTOR_ACTION_REQUIRED` or `EXECUTOR_ACTION_UNAVAILABLE` for an `mcp` tool action a run could not call, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
30299
|
+
* A new version is authored by the caller, checked as on create: `403 PLAYBOOK_EXECUTOR_FORBIDDEN` for an executor it may not start, an `EXECUTOR_NOT_FOUND` problem for one that does not exist, `EXECUTOR_ACTION_REQUIRED` or `EXECUTOR_ACTION_UNAVAILABLE` for an `mcp` tool action a run could not call, `EXECUTOR_TOOL_UNSUPPORTED` for a `client` tool executor, `TRANSFORMATION_TOOL_UNSUPPORTED` for a `client` or `mcp` transformation tool, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
30294
30300
|
*/
|
|
30295
30301
|
static updatePlaybook<ThrowOnError extends boolean = false>(options: Options<UpdatePlaybookData, ThrowOnError>): RequestResult<UpdatePlaybookResponses, UpdatePlaybookErrors, ThrowOnError>;
|
|
30296
30302
|
/**
|
|
@@ -30453,7 +30459,7 @@ export declare class Policies {
|
|
|
30453
30459
|
/**
|
|
30454
30460
|
* Delete a policy
|
|
30455
30461
|
*
|
|
30456
|
-
* Deletes a global policy. Requires admin role.
|
|
30462
|
+
* Deletes a global policy. Requires admin role. Refused with `409 POLICY_HAS_DEPENDENTS` while a trigger's `policy_id` names it.
|
|
30457
30463
|
*/
|
|
30458
30464
|
static deletePolicy<ThrowOnError extends boolean = false>(options: Options<DeletePolicyData, ThrowOnError>): RequestResult<DeletePolicyResponses, DeletePolicyErrors, ThrowOnError>;
|
|
30459
30465
|
/**
|
|
@@ -30501,7 +30507,7 @@ export declare class Projects {
|
|
|
30501
30507
|
/**
|
|
30502
30508
|
* Update a project
|
|
30503
30509
|
*
|
|
30504
|
-
* Updates a project's name, its attached guardrails (`guardrail_ids` — the project-scope baseline governing every tool call by every agent in the project), its orchestration concurrency limit (`max_concurrent_runs`), its continuation-chain ceiling (`max_chain_generations`), its orchestration nesting bound (`max_orchestration_run_depth`), its inherited model route (`default_model_route_id`), its read-auditing opt-in (`audit_reads_enabled`), its priced-model requirement (`require_priced_model`), its trace-content retention window (`trace_content_retention_days`), and/or its zero-retention setting (`trace_content_mode`). At least one field is required. Requires
|
|
30510
|
+
* Updates a project's name, its attached guardrails (`guardrail_ids` — the project-scope baseline governing every tool call by every agent in the project), its orchestration concurrency limit (`max_concurrent_runs`), its continuation-chain ceiling (`max_chain_generations`), its orchestration nesting bound (`max_orchestration_run_depth`), its inherited model route (`default_model_route_id`), its read-auditing opt-in (`audit_reads_enabled`), its priced-model requirement (`require_priced_model`), its trace-content retention window (`trace_content_retention_days`), and/or its zero-retention setting (`trace_content_mode`). At least one field is required. Requires projects:UpdateProject on the project, which a project-scoped policy can grant. Detaching a guardrail (removing an id) additionally requires guardrails:DetachGuardrail.
|
|
30505
30511
|
*/
|
|
30506
30512
|
static updateProject<ThrowOnError extends boolean = false>(options: Options<UpdateProjectData, ThrowOnError>): RequestResult<UpdateProjectResponses, UpdateProjectErrors, ThrowOnError>;
|
|
30507
30513
|
/**
|
package/dist/index.d.mts
CHANGED
|
@@ -6338,7 +6338,7 @@ type UpdatePlaybookRequest = {
|
|
|
6338
6338
|
};
|
|
6339
6339
|
type ValidatePlaybookRequest = {
|
|
6340
6340
|
/**
|
|
6341
|
-
* Also check the references against this project: the upstreams (`UNKNOWN_UPSTREAM`, and the `MISSING_NODE` and `UNKNOWN_FIELD` of what an upstream node pulls) and the executors (`EXECUTOR_NOT_FOUND`, `EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`).
|
|
6341
|
+
* Also check the references against this project: the upstreams (`UNKNOWN_UPSTREAM`, and the `MISSING_NODE` and `UNKNOWN_FIELD` of what an upstream node pulls) and the executors (`EXECUTOR_NOT_FOUND`, `EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`, `EXECUTOR_TOOL_UNSUPPORTED`, `TRANSFORMATION_TOOL_UNSUPPORTED`).
|
|
6342
6342
|
*/
|
|
6343
6343
|
project_id?: string;
|
|
6344
6344
|
/**
|
|
@@ -6353,7 +6353,7 @@ type ValidatePlaybookRequest = {
|
|
|
6353
6353
|
type PlaybookValidationResult = {
|
|
6354
6354
|
valid: boolean;
|
|
6355
6355
|
/**
|
|
6356
|
-
* Every reason the definition cannot be stored: `DUPLICATE_NODE`, `DUPLICATE_INPUT`, `MISSING_NODE`, `UNKNOWN_FIELD`, `EXECUTOR_REQUIRED`, `EXECUTOR_FORBIDDEN`, `TRANSFORMATIONS_NOT_FINAL`, `DUPLICATE_TRANSFORMATION`, `CYCLE`, and, with `project_id`, `UNKNOWN_UPSTREAM`, `UPSTREAM_CYCLE`, `EXECUTOR_NOT_FOUND`, `EXECUTOR_ACTION_REQUIRED` or `
|
|
6356
|
+
* Every reason the definition cannot be stored: `DUPLICATE_NODE`, `DUPLICATE_INPUT`, `MISSING_NODE`, `UNKNOWN_FIELD`, `EXECUTOR_REQUIRED`, `EXECUTOR_FORBIDDEN`, `TRANSFORMATIONS_NOT_FINAL`, `DUPLICATE_TRANSFORMATION`, `CYCLE`, and, with `project_id`, `UNKNOWN_UPSTREAM`, `UPSTREAM_CYCLE`, `EXECUTOR_NOT_FOUND`, `EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`, `EXECUTOR_TOOL_UNSUPPORTED` or `TRANSFORMATION_TOOL_UNSUPPORTED`. The same items a refused write lists under `meta.problems`.
|
|
6357
6357
|
*/
|
|
6358
6358
|
problems: Array<ValidationProblem>;
|
|
6359
6359
|
};
|
|
@@ -7261,7 +7261,7 @@ type ShareReference = {
|
|
|
7261
7261
|
/**
|
|
7262
7262
|
* The kind of the grantee's resource.
|
|
7263
7263
|
*/
|
|
7264
|
-
type: 'agent' | 'tool' | 'decider' | 'ingestion_rule' | 'orchestration' | 'workflow' | 'playbook' | 'eval' | 'trigger' | 'formation';
|
|
7264
|
+
type: 'agent' | 'tool' | 'guardrail' | 'decider' | 'ingestion_rule' | 'orchestration' | 'workflow' | 'playbook' | 'eval' | 'trigger' | 'formation';
|
|
7265
7265
|
/**
|
|
7266
7266
|
* Its public ID.
|
|
7267
7267
|
*/
|
|
@@ -10527,7 +10527,7 @@ type ListAiProvidersResponses = {
|
|
|
10527
10527
|
*/
|
|
10528
10528
|
base_url?: string;
|
|
10529
10529
|
/**
|
|
10530
|
-
* Additional provider-specific configuration. Absent when the record sets none.
|
|
10530
|
+
* Additional provider-specific configuration. Absent when the record sets none. Never carries a credential.
|
|
10531
10531
|
*/
|
|
10532
10532
|
config?: {
|
|
10533
10533
|
[key: string]: unknown;
|
|
@@ -10558,7 +10558,7 @@ type CreateAiProviderData = {
|
|
|
10558
10558
|
*/
|
|
10559
10559
|
default_model: string;
|
|
10560
10560
|
/**
|
|
10561
|
-
* Secret ID containing API credentials. Required for `bedrock` and `vertex
|
|
10561
|
+
* Secret ID containing API credentials. Required for `bedrock` and `vertex`.
|
|
10562
10562
|
*/
|
|
10563
10563
|
secret_id?: string;
|
|
10564
10564
|
/**
|
|
@@ -10566,7 +10566,7 @@ type CreateAiProviderData = {
|
|
|
10566
10566
|
*/
|
|
10567
10567
|
base_url?: string;
|
|
10568
10568
|
/**
|
|
10569
|
-
* Additional provider-specific configuration. `
|
|
10569
|
+
* Additional provider-specific configuration. `apiKey` is refused: the credential goes in the linked secret.
|
|
10570
10570
|
*/
|
|
10571
10571
|
config?: {
|
|
10572
10572
|
[key: string]: unknown;
|
|
@@ -10725,7 +10725,7 @@ type GetAiProviderResponses = {
|
|
|
10725
10725
|
secret_id?: string | null;
|
|
10726
10726
|
base_url?: string;
|
|
10727
10727
|
/**
|
|
10728
|
-
* Additional provider-specific configuration.
|
|
10728
|
+
* Additional provider-specific configuration. Never carries a credential.
|
|
10729
10729
|
*/
|
|
10730
10730
|
config?: {
|
|
10731
10731
|
[key: string]: unknown;
|
|
@@ -10746,7 +10746,7 @@ type UpdateAiProviderData = {
|
|
|
10746
10746
|
secret_id?: string | null;
|
|
10747
10747
|
base_url?: string;
|
|
10748
10748
|
/**
|
|
10749
|
-
* Replaces the whole configuration
|
|
10749
|
+
* Replaces the whole configuration. `apiKey` is refused: the credential goes in the linked secret.
|
|
10750
10750
|
*/
|
|
10751
10751
|
config?: {
|
|
10752
10752
|
[key: string]: unknown;
|
|
@@ -11028,7 +11028,7 @@ type CreateApiKeyErrors = {
|
|
|
11028
11028
|
*/
|
|
11029
11029
|
401: ErrorResponse;
|
|
11030
11030
|
/**
|
|
11031
|
-
* Forbidden (a project-scoped
|
|
11031
|
+
* Forbidden (a project-scoped token; a project-scoped key named a different project, or asked for an unscoped key; or a key narrowed by `policy_ids` asked for a key outside its boundary)
|
|
11032
11032
|
*/
|
|
11033
11033
|
403: ErrorResponse;
|
|
11034
11034
|
/**
|
|
@@ -11173,7 +11173,7 @@ type UpdateApiKeyErrors = {
|
|
|
11173
11173
|
*/
|
|
11174
11174
|
401: ErrorResponse;
|
|
11175
11175
|
/**
|
|
11176
|
-
* Forbidden (not the key owner or admin, the credential is scoped to a different project, or a key narrowed by `policy_ids` asked for policies outside its boundary)
|
|
11176
|
+
* Forbidden (a project-scoped token, not the key owner or admin, the credential is scoped to a different project, or a key narrowed by `policy_ids` asked for policies outside its boundary)
|
|
11177
11177
|
*/
|
|
11178
11178
|
403: ErrorResponse;
|
|
11179
11179
|
/**
|
|
@@ -13730,7 +13730,7 @@ type UpdateDocumentErrors = {
|
|
|
13730
13730
|
*/
|
|
13731
13731
|
404: ErrorResponse;
|
|
13732
13732
|
/**
|
|
13733
|
-
* The document has moved past the version this write read (`VERSION_CONFLICT`, with `meta.current_version`),
|
|
13733
|
+
* The document has moved past the version this write read (`VERSION_CONFLICT`, with `meta.current_version`), `path` is held by another file in the project (`NAME_CONFLICT`), or new `content` would exceed the project's `storage_bytes` quota (`QUOTA_STORAGE_EXCEEDED`, no `Retry-After`). Nothing is written.
|
|
13734
13734
|
*/
|
|
13735
13735
|
409: ErrorResponse;
|
|
13736
13736
|
/**
|
|
@@ -14147,7 +14147,7 @@ type RestoreDocumentVersionErrors = {
|
|
|
14147
14147
|
*/
|
|
14148
14148
|
404: ErrorResponse;
|
|
14149
14149
|
/**
|
|
14150
|
-
* Another write took the document's version first (`VERSION_CONFLICT`, with `meta.current_version`),
|
|
14150
|
+
* Another write took the document's version first (`VERSION_CONFLICT`, with `meta.current_version`), the restored `path` is held by another file in the project (`NAME_CONFLICT`), or the restored content would exceed the project's `storage_bytes` quota (`QUOTA_STORAGE_EXCEEDED`, no `Retry-After`). Nothing is written.
|
|
14151
14151
|
*/
|
|
14152
14152
|
409: ErrorResponse;
|
|
14153
14153
|
/**
|
|
@@ -18477,7 +18477,7 @@ type UpdateMemoryErrors = {
|
|
|
18477
18477
|
*/
|
|
18478
18478
|
404: ErrorResponse;
|
|
18479
18479
|
/**
|
|
18480
|
-
* The
|
|
18480
|
+
* The memory has moved past the version this write read (`VERSION_CONFLICT`, with `meta.current_version`), or new `content` would exceed the project's `storage_bytes` quota (`QUOTA_STORAGE_EXCEEDED`, no `Retry-After`). Nothing is written.
|
|
18481
18481
|
*/
|
|
18482
18482
|
409: ErrorResponse;
|
|
18483
18483
|
/**
|
|
@@ -22755,6 +22755,10 @@ type DeletePolicyErrors = {
|
|
|
22755
22755
|
* Policy not found
|
|
22756
22756
|
*/
|
|
22757
22757
|
404: ErrorResponse;
|
|
22758
|
+
/**
|
|
22759
|
+
* `POLICY_HAS_DEPENDENTS`: a trigger's `policy_id` still names the policy. Detach it from those triggers or delete them first.
|
|
22760
|
+
*/
|
|
22761
|
+
409: ErrorResponse;
|
|
22758
22762
|
/**
|
|
22759
22763
|
* `QUOTA_EXCEEDED` — a `requests` quota on the calling API key or its project is spent for the window; `Retry-After` says when it reopens
|
|
22760
22764
|
*/
|
|
@@ -28851,8 +28855,10 @@ export declare class AiProviders {
|
|
|
28851
28855
|
*
|
|
28852
28856
|
* Creates a new LLM provider configuration.
|
|
28853
28857
|
*
|
|
28854
|
-
* A
|
|
28855
|
-
*
|
|
28858
|
+
* A provider's credential is its linked `secret_id`; `config.apiKey` is
|
|
28859
|
+
* refused with `400 VALIDATION_FAILED`.
|
|
28860
|
+
*
|
|
28861
|
+
* A `bedrock` or `vertex` record must link one. Without it the provider
|
|
28856
28862
|
* SDK signs with the server's own credentials (the AWS default credential
|
|
28857
28863
|
* chain, Google Application Default Credentials), which is refused with
|
|
28858
28864
|
* `400 VALIDATION_FAILED` unless the deployment allows it.
|
|
@@ -28923,7 +28929,7 @@ export declare class ApiKeys {
|
|
|
28923
28929
|
/**
|
|
28924
28930
|
* Create an API key
|
|
28925
28931
|
*
|
|
28926
|
-
* Creates a new API key for the authenticated user. - `project_id` is optional. When set, the key is scoped to that single project. When omitted or null, the key is **unscoped** and spans every project its owner can reach. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - Otherwise the key inherits the user's permissions (confined to the key's project when scoped). - When the request is authenticated with a **project-scoped
|
|
28932
|
+
* Creates a new API key for the authenticated user. - `project_id` is optional. When set, the key is scoped to that single project. When omitted or null, the key is **unscoped** and spans every project its owner can reach. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - Otherwise the key inherits the user's permissions (confined to the key's project when scoped). - When the request is authenticated with a **project-scoped token** (an OAuth access token, a trigger run-as token or a run token), it returns `403 API_KEY_SCOPED_TOKEN`: such a token never creates a key. - When the request is authenticated with a **project-scoped API key**, the new key is confined to that same project: omitting `project_id` defaults to it, naming a different project returns `403 API_KEY_PROJECT_SCOPE`, and `project_id: null` (an unscoped key) is likewise refused. Minting an unscoped key requires an unscoped credential. - When the request is authenticated with an **API key narrowed by `policy_ids`**, the new key stays inside that boundary: omitting `policy_ids` inherits the caller's own, a non-empty subset of them is accepted, and an empty list or any other policy returns `403 API_KEY_POLICY_BOUNDARY`.
|
|
28927
28933
|
*
|
|
28928
28934
|
*/
|
|
28929
28935
|
static createApiKey<ThrowOnError extends boolean = false>(options: Options<CreateApiKeyData, ThrowOnError>): RequestResult<CreateApiKeyResponses, CreateApiKeyErrors, ThrowOnError>;
|
|
@@ -28942,7 +28948,7 @@ export declare class ApiKeys {
|
|
|
28942
28948
|
/**
|
|
28943
28949
|
* Update an API key
|
|
28944
28950
|
*
|
|
28945
|
-
* Updates an API key's name, project scope, or policies. The project scope can be changed to another project, set (scoping a previously unscoped key), or cleared with null (unscoping the key). Only the owner or an admin can update it. A project-scoped credential can only update keys in its own project, and cannot move a key to another project or unscope it. An API key narrowed by `policy_ids` can only set `policy_ids` to a non-empty subset of its own (`403 API_KEY_POLICY_BOUNDARY` otherwise).
|
|
28951
|
+
* Updates an API key's name, project scope, or policies. The project scope can be changed to another project, set (scoping a previously unscoped key), or cleared with null (unscoping the key). Only the owner or an admin can update it. A project-scoped credential can only update keys in its own project, and cannot move a key to another project or unscope it. An API key narrowed by `policy_ids` can only set `policy_ids` to a non-empty subset of its own (`403 API_KEY_POLICY_BOUNDARY` otherwise). A project-scoped token (OAuth, trigger or run) never updates a key (`403 API_KEY_SCOPED_TOKEN`).
|
|
28946
28952
|
*/
|
|
28947
28953
|
static updateApiKey<ThrowOnError extends boolean = false>(options: Options<UpdateApiKeyData, ThrowOnError>): RequestResult<UpdateApiKeyResponses, UpdateApiKeyErrors, ThrowOnError>;
|
|
28948
28954
|
}
|
|
@@ -30262,7 +30268,7 @@ export declare class Playbooks {
|
|
|
30262
30268
|
*
|
|
30263
30269
|
* Creates a playbook at version 1. The definition is refused with `400 PLAYBOOK_VALIDATION_FAILED` when it holds a duplicate node or input, an input reading a missing node or field, an `execute` node without an executor or another kind with one, transformations on a non-final node, or a cycle; `meta.problems` lists every one. A duplicate `name` in the project is `409 NAME_CONFLICT`.
|
|
30264
30270
|
*
|
|
30265
|
-
* The caller becomes the version's author, whom its executors run as, so it must be allowed to start every executor the definition names (`403 PLAYBOOK_EXECUTOR_FORBIDDEN`), and each must exist in the project, or be an agent or tool shared with it (`400 PLAYBOOK_VALIDATION_FAILED`, an `EXECUTOR_NOT_FOUND` problem). A `tool` executor on an `mcp` tool must name in `operation_id` an action the tool's binding allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). A definition with executors written with a trigger or OAuth token is `409 PLAYBOOK_AUTHOR_UNAVAILABLE`: those carry their boundary in the token, so no run can act as them.
|
|
30271
|
+
* The caller becomes the version's author, whom its executors run as, so it must be allowed to start every executor the definition names (`403 PLAYBOOK_EXECUTOR_FORBIDDEN`), and each must exist in the project, or be an agent or tool shared with it (`400 PLAYBOOK_VALIDATION_FAILED`, an `EXECUTOR_NOT_FOUND` problem). A `tool` executor on an `mcp` tool must name in `operation_id` an action the tool's binding allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). An executor cannot be a `client` tool (`EXECUTOR_TOOL_UNSUPPORTED`), nor a transformation's tool a `client` or `mcp` tool (`TRANSFORMATION_TOOL_UNSUPPORTED`). A definition with executors written with a trigger or OAuth token is `409 PLAYBOOK_AUTHOR_UNAVAILABLE`: those carry their boundary in the token, so no run can act as them.
|
|
30266
30272
|
*/
|
|
30267
30273
|
static createPlaybook<ThrowOnError extends boolean = false>(options: Options<CreatePlaybookData, ThrowOnError>): RequestResult<CreatePlaybookResponses, CreatePlaybookErrors, ThrowOnError>;
|
|
30268
30274
|
/**
|
|
@@ -30270,7 +30276,7 @@ export declare class Playbooks {
|
|
|
30270
30276
|
*
|
|
30271
30277
|
* Answers what a create or update would be told about a definition, without writing: `valid`, and every graph problem it holds. A definition whose shape cannot be read is `400 VALIDATION_FAILED`, as on a write.
|
|
30272
30278
|
*
|
|
30273
|
-
* With `project_id`, the references are checked too, as a write there would check them: the upstreams against that project's playbooks, and each executor the caller may start must exist (`EXECUTOR_NOT_FOUND`) and name an action its `mcp` tool allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). The caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
|
|
30279
|
+
* With `project_id`, the references are checked too, as a write there would check them: the upstreams against that project's playbooks, and each executor the caller may start must exist (`EXECUTOR_NOT_FOUND`) and name an action its `mcp` tool allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`) and not be a `client` tool (`EXECUTOR_TOOL_UNSUPPORTED`), and each transformation's tool must not be a `client` or `mcp` tool (`TRANSFORMATION_TOOL_UNSUPPORTED`). The caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
|
|
30274
30280
|
*/
|
|
30275
30281
|
static validatePlaybook<ThrowOnError extends boolean = false>(options: Options<ValidatePlaybookData, ThrowOnError>): RequestResult<ValidatePlaybookResponses, ValidatePlaybookErrors, ThrowOnError>;
|
|
30276
30282
|
/**
|
|
@@ -30290,7 +30296,7 @@ export declare class Playbooks {
|
|
|
30290
30296
|
*
|
|
30291
30297
|
* Updates any of `name`, `description` and `definition`. Only a change to `definition` archives a new version; a rename or a rewrite of the definition the playbook already holds leaves `version` where it is. A case keeps the version it was created on.
|
|
30292
30298
|
*
|
|
30293
|
-
* A new version is authored by the caller, checked as on create: `403 PLAYBOOK_EXECUTOR_FORBIDDEN` for an executor it may not start, an `EXECUTOR_NOT_FOUND` problem for one that does not exist, `EXECUTOR_ACTION_REQUIRED` or `EXECUTOR_ACTION_UNAVAILABLE` for an `mcp` tool action a run could not call, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
30299
|
+
* A new version is authored by the caller, checked as on create: `403 PLAYBOOK_EXECUTOR_FORBIDDEN` for an executor it may not start, an `EXECUTOR_NOT_FOUND` problem for one that does not exist, `EXECUTOR_ACTION_REQUIRED` or `EXECUTOR_ACTION_UNAVAILABLE` for an `mcp` tool action a run could not call, `EXECUTOR_TOOL_UNSUPPORTED` for a `client` tool executor, `TRANSFORMATION_TOOL_UNSUPPORTED` for a `client` or `mcp` transformation tool, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
30294
30300
|
*/
|
|
30295
30301
|
static updatePlaybook<ThrowOnError extends boolean = false>(options: Options<UpdatePlaybookData, ThrowOnError>): RequestResult<UpdatePlaybookResponses, UpdatePlaybookErrors, ThrowOnError>;
|
|
30296
30302
|
/**
|
|
@@ -30453,7 +30459,7 @@ export declare class Policies {
|
|
|
30453
30459
|
/**
|
|
30454
30460
|
* Delete a policy
|
|
30455
30461
|
*
|
|
30456
|
-
* Deletes a global policy. Requires admin role.
|
|
30462
|
+
* Deletes a global policy. Requires admin role. Refused with `409 POLICY_HAS_DEPENDENTS` while a trigger's `policy_id` names it.
|
|
30457
30463
|
*/
|
|
30458
30464
|
static deletePolicy<ThrowOnError extends boolean = false>(options: Options<DeletePolicyData, ThrowOnError>): RequestResult<DeletePolicyResponses, DeletePolicyErrors, ThrowOnError>;
|
|
30459
30465
|
/**
|
|
@@ -30501,7 +30507,7 @@ export declare class Projects {
|
|
|
30501
30507
|
/**
|
|
30502
30508
|
* Update a project
|
|
30503
30509
|
*
|
|
30504
|
-
* Updates a project's name, its attached guardrails (`guardrail_ids` — the project-scope baseline governing every tool call by every agent in the project), its orchestration concurrency limit (`max_concurrent_runs`), its continuation-chain ceiling (`max_chain_generations`), its orchestration nesting bound (`max_orchestration_run_depth`), its inherited model route (`default_model_route_id`), its read-auditing opt-in (`audit_reads_enabled`), its priced-model requirement (`require_priced_model`), its trace-content retention window (`trace_content_retention_days`), and/or its zero-retention setting (`trace_content_mode`). At least one field is required. Requires
|
|
30510
|
+
* Updates a project's name, its attached guardrails (`guardrail_ids` — the project-scope baseline governing every tool call by every agent in the project), its orchestration concurrency limit (`max_concurrent_runs`), its continuation-chain ceiling (`max_chain_generations`), its orchestration nesting bound (`max_orchestration_run_depth`), its inherited model route (`default_model_route_id`), its read-auditing opt-in (`audit_reads_enabled`), its priced-model requirement (`require_priced_model`), its trace-content retention window (`trace_content_retention_days`), and/or its zero-retention setting (`trace_content_mode`). At least one field is required. Requires projects:UpdateProject on the project, which a project-scoped policy can grant. Detaching a guardrail (removing an id) additionally requires guardrails:DetachGuardrail.
|
|
30505
30511
|
*/
|
|
30506
30512
|
static updateProject<ThrowOnError extends boolean = false>(options: Options<UpdateProjectData, ThrowOnError>): RequestResult<UpdateProjectResponses, UpdateProjectErrors, ThrowOnError>;
|
|
30507
30513
|
/**
|
package/dist/index.mjs
CHANGED
|
@@ -971,8 +971,10 @@ var AiProviders = class {
|
|
|
971
971
|
*
|
|
972
972
|
* Creates a new LLM provider configuration.
|
|
973
973
|
*
|
|
974
|
-
* A
|
|
975
|
-
*
|
|
974
|
+
* A provider's credential is its linked `secret_id`; `config.apiKey` is
|
|
975
|
+
* refused with `400 VALIDATION_FAILED`.
|
|
976
|
+
*
|
|
977
|
+
* A `bedrock` or `vertex` record must link one. Without it the provider
|
|
976
978
|
* SDK signs with the server's own credentials (the AWS default credential
|
|
977
979
|
* chain, Google Application Default Credentials), which is refused with
|
|
978
980
|
* `400 VALIDATION_FAILED` unless the deployment allows it.
|
|
@@ -1099,7 +1101,7 @@ var ApiKeys = class {
|
|
|
1099
1101
|
/**
|
|
1100
1102
|
* Create an API key
|
|
1101
1103
|
*
|
|
1102
|
-
* Creates a new API key for the authenticated user. - `project_id` is optional. When set, the key is scoped to that single project. When omitted or null, the key is **unscoped** and spans every project its owner can reach. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - Otherwise the key inherits the user's permissions (confined to the key's project when scoped). - When the request is authenticated with a **project-scoped
|
|
1104
|
+
* Creates a new API key for the authenticated user. - `project_id` is optional. When set, the key is scoped to that single project. When omitted or null, the key is **unscoped** and spans every project its owner can reach. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - Otherwise the key inherits the user's permissions (confined to the key's project when scoped). - When the request is authenticated with a **project-scoped token** (an OAuth access token, a trigger run-as token or a run token), it returns `403 API_KEY_SCOPED_TOKEN`: such a token never creates a key. - When the request is authenticated with a **project-scoped API key**, the new key is confined to that same project: omitting `project_id` defaults to it, naming a different project returns `403 API_KEY_PROJECT_SCOPE`, and `project_id: null` (an unscoped key) is likewise refused. Minting an unscoped key requires an unscoped credential. - When the request is authenticated with an **API key narrowed by `policy_ids`**, the new key stays inside that boundary: omitting `policy_ids` inherits the caller's own, a non-empty subset of them is accepted, and an empty list or any other policy returns `403 API_KEY_POLICY_BOUNDARY`.
|
|
1103
1105
|
*
|
|
1104
1106
|
*/
|
|
1105
1107
|
static createApiKey(options) {
|
|
@@ -1137,7 +1139,7 @@ var ApiKeys = class {
|
|
|
1137
1139
|
/**
|
|
1138
1140
|
* Update an API key
|
|
1139
1141
|
*
|
|
1140
|
-
* Updates an API key's name, project scope, or policies. The project scope can be changed to another project, set (scoping a previously unscoped key), or cleared with null (unscoping the key). Only the owner or an admin can update it. A project-scoped credential can only update keys in its own project, and cannot move a key to another project or unscope it. An API key narrowed by `policy_ids` can only set `policy_ids` to a non-empty subset of its own (`403 API_KEY_POLICY_BOUNDARY` otherwise).
|
|
1142
|
+
* Updates an API key's name, project scope, or policies. The project scope can be changed to another project, set (scoping a previously unscoped key), or cleared with null (unscoping the key). Only the owner or an admin can update it. A project-scoped credential can only update keys in its own project, and cannot move a key to another project or unscope it. An API key narrowed by `policy_ids` can only set `policy_ids` to a non-empty subset of its own (`403 API_KEY_POLICY_BOUNDARY` otherwise). A project-scoped token (OAuth, trigger or run) never updates a key (`403 API_KEY_SCOPED_TOKEN`).
|
|
1141
1143
|
*/
|
|
1142
1144
|
static updateApiKey(options) {
|
|
1143
1145
|
return (options.client ?? client).put({
|
|
@@ -3702,7 +3704,7 @@ var Playbooks = class {
|
|
|
3702
3704
|
*
|
|
3703
3705
|
* Creates a playbook at version 1. The definition is refused with `400 PLAYBOOK_VALIDATION_FAILED` when it holds a duplicate node or input, an input reading a missing node or field, an `execute` node without an executor or another kind with one, transformations on a non-final node, or a cycle; `meta.problems` lists every one. A duplicate `name` in the project is `409 NAME_CONFLICT`.
|
|
3704
3706
|
*
|
|
3705
|
-
* The caller becomes the version's author, whom its executors run as, so it must be allowed to start every executor the definition names (`403 PLAYBOOK_EXECUTOR_FORBIDDEN`), and each must exist in the project, or be an agent or tool shared with it (`400 PLAYBOOK_VALIDATION_FAILED`, an `EXECUTOR_NOT_FOUND` problem). A `tool` executor on an `mcp` tool must name in `operation_id` an action the tool's binding allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). A definition with executors written with a trigger or OAuth token is `409 PLAYBOOK_AUTHOR_UNAVAILABLE`: those carry their boundary in the token, so no run can act as them.
|
|
3707
|
+
* The caller becomes the version's author, whom its executors run as, so it must be allowed to start every executor the definition names (`403 PLAYBOOK_EXECUTOR_FORBIDDEN`), and each must exist in the project, or be an agent or tool shared with it (`400 PLAYBOOK_VALIDATION_FAILED`, an `EXECUTOR_NOT_FOUND` problem). A `tool` executor on an `mcp` tool must name in `operation_id` an action the tool's binding allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). An executor cannot be a `client` tool (`EXECUTOR_TOOL_UNSUPPORTED`), nor a transformation's tool a `client` or `mcp` tool (`TRANSFORMATION_TOOL_UNSUPPORTED`). A definition with executors written with a trigger or OAuth token is `409 PLAYBOOK_AUTHOR_UNAVAILABLE`: those carry their boundary in the token, so no run can act as them.
|
|
3706
3708
|
*/
|
|
3707
3709
|
static createPlaybook(options) {
|
|
3708
3710
|
return (options.client ?? client).post({
|
|
@@ -3719,7 +3721,7 @@ var Playbooks = class {
|
|
|
3719
3721
|
*
|
|
3720
3722
|
* Answers what a create or update would be told about a definition, without writing: `valid`, and every graph problem it holds. A definition whose shape cannot be read is `400 VALIDATION_FAILED`, as on a write.
|
|
3721
3723
|
*
|
|
3722
|
-
* With `project_id`, the references are checked too, as a write there would check them: the upstreams against that project's playbooks, and each executor the caller may start must exist (`EXECUTOR_NOT_FOUND`) and name an action its `mcp` tool allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). The caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
|
|
3724
|
+
* With `project_id`, the references are checked too, as a write there would check them: the upstreams against that project's playbooks, and each executor the caller may start must exist (`EXECUTOR_NOT_FOUND`) and name an action its `mcp` tool allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`) and not be a `client` tool (`EXECUTOR_TOOL_UNSUPPORTED`), and each transformation's tool must not be a `client` or `mcp` tool (`TRANSFORMATION_TOOL_UNSUPPORTED`). The caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
|
|
3723
3725
|
*/
|
|
3724
3726
|
static validatePlaybook(options) {
|
|
3725
3727
|
return (options.client ?? client).post({
|
|
@@ -3758,7 +3760,7 @@ var Playbooks = class {
|
|
|
3758
3760
|
*
|
|
3759
3761
|
* Updates any of `name`, `description` and `definition`. Only a change to `definition` archives a new version; a rename or a rewrite of the definition the playbook already holds leaves `version` where it is. A case keeps the version it was created on.
|
|
3760
3762
|
*
|
|
3761
|
-
* A new version is authored by the caller, checked as on create: `403 PLAYBOOK_EXECUTOR_FORBIDDEN` for an executor it may not start, an `EXECUTOR_NOT_FOUND` problem for one that does not exist, `EXECUTOR_ACTION_REQUIRED` or `EXECUTOR_ACTION_UNAVAILABLE` for an `mcp` tool action a run could not call, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
3763
|
+
* A new version is authored by the caller, checked as on create: `403 PLAYBOOK_EXECUTOR_FORBIDDEN` for an executor it may not start, an `EXECUTOR_NOT_FOUND` problem for one that does not exist, `EXECUTOR_ACTION_REQUIRED` or `EXECUTOR_ACTION_UNAVAILABLE` for an `mcp` tool action a run could not call, `EXECUTOR_TOOL_UNSUPPORTED` for a `client` tool executor, `TRANSFORMATION_TOOL_UNSUPPORTED` for a `client` or `mcp` transformation tool, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
3762
3764
|
*/
|
|
3763
3765
|
static updatePlaybook(options) {
|
|
3764
3766
|
return (options.client ?? client).patch({
|
|
@@ -4077,7 +4079,7 @@ var Policies = class {
|
|
|
4077
4079
|
/**
|
|
4078
4080
|
* Delete a policy
|
|
4079
4081
|
*
|
|
4080
|
-
* Deletes a global policy. Requires admin role.
|
|
4082
|
+
* Deletes a global policy. Requires admin role. Refused with `409 POLICY_HAS_DEPENDENTS` while a trigger's `policy_id` names it.
|
|
4081
4083
|
*/
|
|
4082
4084
|
static deletePolicy(options) {
|
|
4083
4085
|
return (options.client ?? client).delete({
|
|
@@ -4172,7 +4174,7 @@ var Projects = class {
|
|
|
4172
4174
|
/**
|
|
4173
4175
|
* Update a project
|
|
4174
4176
|
*
|
|
4175
|
-
* Updates a project's name, its attached guardrails (`guardrail_ids` — the project-scope baseline governing every tool call by every agent in the project), its orchestration concurrency limit (`max_concurrent_runs`), its continuation-chain ceiling (`max_chain_generations`), its orchestration nesting bound (`max_orchestration_run_depth`), its inherited model route (`default_model_route_id`), its read-auditing opt-in (`audit_reads_enabled`), its priced-model requirement (`require_priced_model`), its trace-content retention window (`trace_content_retention_days`), and/or its zero-retention setting (`trace_content_mode`). At least one field is required. Requires
|
|
4177
|
+
* Updates a project's name, its attached guardrails (`guardrail_ids` — the project-scope baseline governing every tool call by every agent in the project), its orchestration concurrency limit (`max_concurrent_runs`), its continuation-chain ceiling (`max_chain_generations`), its orchestration nesting bound (`max_orchestration_run_depth`), its inherited model route (`default_model_route_id`), its read-auditing opt-in (`audit_reads_enabled`), its priced-model requirement (`require_priced_model`), its trace-content retention window (`trace_content_retention_days`), and/or its zero-retention setting (`trace_content_mode`). At least one field is required. Requires projects:UpdateProject on the project, which a project-scoped policy can grant. Detaching a guardrail (removing an id) additionally requires guardrails:DetachGuardrail.
|
|
4176
4178
|
*/
|
|
4177
4179
|
static updateProject(options) {
|
|
4178
4180
|
return (options.client ?? client).patch({
|