@soat/sdk 0.108.0 → 0.109.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 CHANGED
@@ -1086,7 +1086,7 @@ var ApiKeys = class {
1086
1086
  /**
1087
1087
  * List API keys
1088
1088
  *
1089
- * Lists API keys accessible to the caller. - JWT admin: returns all API keys. - JWT regular user: returns only the user's own API keys. - Project-scoped credential (API key or OAuth token): returns the caller's own
1089
+ * Lists API keys accessible to the caller. - An unrestricted admin (a login, or a key bound to no project and narrowed by no policy): returns all API keys. - Any other unscoped credential: returns only its user's own API keys. - Project-scoped credential (API key or OAuth token): returns the caller's own
1090
1090
  * keys scoped to that project, or every key scoped to it when the credential
1091
1091
  * holds `api-keys:ListApiKeys` on the project. Confinement to a project is not
1092
1092
  * authority over it, and a key's metadata names its owner, prefix and attached
@@ -1106,7 +1106,7 @@ var ApiKeys = class {
1106
1106
  /**
1107
1107
  * Create an API key
1108
1108
  *
1109
- * 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, a run token or an IAM 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`.
1109
+ * 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 narrowed beyond its credential's own grant (an OAuth access token, a trigger run-as token, a run token, an IAM token, or an `On-Behalf-Of` assertion), it returns `403 CREDENTIAL_NARROWED`: a key would outlive that narrowing. - 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`.
1110
1110
  *
1111
1111
  */
1112
1112
  static createApiKey(options) {
@@ -1122,7 +1122,7 @@ var ApiKeys = class {
1122
1122
  /**
1123
1123
  * Delete an API key
1124
1124
  *
1125
- * Deletes an API key. Only the owner or an admin can delete it, and a project-scoped credential can only delete keys in its own project.
1125
+ * Deletes an API key. Only the owner or an unrestricted admin can delete it, and a project-scoped credential can only delete keys in its own project.
1126
1126
  */
1127
1127
  static deleteApiKey(options) {
1128
1128
  return (options.client ?? client).delete({
@@ -1133,7 +1133,7 @@ var ApiKeys = class {
1133
1133
  /**
1134
1134
  * Get an API key
1135
1135
  *
1136
- * Returns details of an API key. Only the owner or an admin can access it, and a project-scoped credential can only reach keys in its own project.
1136
+ * Returns details of an API key. Only the owner or an unrestricted admin can access it, and a project-scoped credential can only reach keys in its own project.
1137
1137
  */
1138
1138
  static getApiKey(options) {
1139
1139
  return (options.client ?? client).get({
@@ -1144,7 +1144,7 @@ var ApiKeys = class {
1144
1144
  /**
1145
1145
  * Update an API key
1146
1146
  *
1147
- * 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, run or IAM) never updates a key (`403 API_KEY_SCOPED_TOKEN`).
1147
+ * 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 unrestricted admin (a login, or a key bound to no project and narrowed by no policy) 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 request narrowed beyond its credential's own grant (OAuth, trigger, run or IAM token, or `On-Behalf-Of`) never updates a key (`403 CREDENTIAL_NARROWED`).
1148
1148
  */
1149
1149
  static updateApiKey(options) {
1150
1150
  return (options.client ?? client).put({
@@ -3040,7 +3040,7 @@ var Iam = class {
3040
3040
  /**
3041
3041
  * Check a permission of the calling credential
3042
3042
  *
3043
- * Evaluates the calling credential's own policies (its owner's and, for an API key or OAuth token, its boundary and project scope) for an action the deployment registered (`IAM_REGISTRATIONS_CONFIG`), or an action the writer rule asks of whoever writes a resource that acts later (a target's start action, `secrets:UseSecret`), on an SRN, with the engine the runtime's own routes use. A denial is `200` with `allowed: false`, never `403`. Only policies are evaluated: the answer says nothing about whether the resource exists.
3043
+ * Evaluates the calling credential's own policies (its owner's and, for an API key or OAuth token, its boundary and project scope) for an action the deployment registered (`IAM_REGISTRATIONS_CONFIG`) or any built-in action, such as one a resource the deployment stores will perform later, on an SRN, with the engine the runtime's own routes use. A denial is `200` with `allowed: false`, never `403`. Only policies are evaluated: the answer says nothing about whether the resource exists.
3044
3044
  */
3045
3045
  static checkIamPermission(options) {
3046
3046
  return (options.client ?? client).post({
@@ -4411,7 +4411,7 @@ var Policies = class {
4411
4411
  /**
4412
4412
  * Delete a policy
4413
4413
  *
4414
- * Deletes a policy. A project policy needs `policies:DeletePolicy` in its project; a global one, the unrestricted admin. Refused with `409 POLICY_HAS_DEPENDENTS` while a trigger, agent or webhook names it in its `policy_ids`.
4414
+ * Deletes a policy. A project policy needs `policies:DeletePolicy` in its project; a global one, the unrestricted admin. Refused with `409 POLICY_HAS_DEPENDENTS` while a trigger, agent, webhook, user or API key names it in its `policy_ids`.
4415
4415
  */
4416
4416
  static deletePolicy(options) {
4417
4417
  return (options.client ?? client).delete({
package/dist/index.d.cts CHANGED
@@ -5033,11 +5033,11 @@ type UpdateGuardrailRequest = {
5033
5033
  };
5034
5034
  type IamCheckRequest = {
5035
5035
  /**
5036
- * A `module:Operation` action the deployment registered, or one the writer rule asks (`agents:CreateAgentGeneration`, `tools:CallTool`, `deciders:CreateDecision`, `tasks:CreateTask`, `orchestrations:StartRun`, `evaluations:RunEval`, `secrets:UseSecret`); any other built-in action or a wildcard is `400`.
5036
+ * A `module:Operation` action the deployment registered or a built-in one (`agents:DeleteAgent`); an unknown action or a wildcard is `400`.
5037
5037
  */
5038
5038
  action: string;
5039
5039
  /**
5040
- * `srn:<project_id>:<resource_type>:<id>`, where the type is one the action's module registered and `<id>` may be `*` for an action on no single resource (a create or a list).
5040
+ * `srn:<project_id>:<resource_type>:<id>`, where the type is one the action's module registered, or for a built-in action one its module's routes check it on, and `<id>` may be `*` for an action on no single resource (a create or a list).
5041
5041
  */
5042
5042
  resource: string;
5043
5043
  /**
@@ -5269,6 +5269,10 @@ type MemoryKnowledgeResult = {
5269
5269
  type Memory = {
5270
5270
  id?: string;
5271
5271
  memory_store_id?: string;
5272
+ /**
5273
+ * The end user the memory belongs to; null for none. Set on create and never changed; a replacement written by a supersede belongs to the same actor.
5274
+ */
5275
+ actor_id?: string | null;
5272
5276
  /**
5273
5277
  * The text this memory currently holds. Stored once per distinct text per store and shared with every assertion that stated it, so a memory carries no copy of its own.
5274
5278
  */
@@ -5897,6 +5901,12 @@ type OrchestrationNode = {
5897
5901
  * For loop and sub_orchestration nodes — allowlist of the run's `tool_context` keys the child run inherits. When `null` (the default), the child inherits the parent's whole bag. When set, only the listed keys are handed down, so a run holding a broad credential can delegate one step to a shared sub-graph without passing on what that sub-graph does not need; `[]` hands down nothing. Matching is case-insensitive, since an entry names a key that becomes an HTTP header name; an entry outside that grammar is rejected at write time with `INVALID_TOOL_CONTEXT_KEY`. The server-derived identity keys (`session_id`, `actor_id`, `actor_external_id`) are unaffected — they are re-derived per generation in the child regardless of this list. Ignored for other node types.
5898
5902
  */
5899
5903
  context_keys?: Array<string> | null;
5904
+ /**
5905
+ * For loop nodes — per-item `tool_context` keys for each child run. Each key is a `tool_context` key; each value is JSON Logic evaluated against `{ <item_variable>: <item>, "state": <run state> }`. A child's bag is the inherited one (after `context_keys`) with these keys laid over it, matched case-insensitively. A value evaluating to `null` drops the key, the inherited value included. A value that evaluates to anything else but a string, or throws, fails that item: under `on_item_error: fail` the node fails before any child starts; under `collect` the item's entry in `results` is `{ "error": { "code", "message" } }` and no child runs for it. A key outside the header-name grammar, two keys differing only in case, or a server-reserved key (`session_id`, `actor_id`, `actor_external_id`, `calling_project_id`) is rejected at write time with `INVALID_TOOL_CONTEXT_KEY`. Ignored for other node types.
5906
+ */
5907
+ item_tool_context?: {
5908
+ [key: string]: unknown;
5909
+ };
5900
5910
  /**
5901
5911
  * For poll nodes — wait between attempts. Accepts a friendly suffix form (`5s`, `30s`, `5m`, `2h`, `500ms`) or ISO 8601 (e.g. PT5S).
5902
5912
  *
@@ -6295,7 +6305,7 @@ type NodeExecution = {
6295
6305
  */
6296
6306
  type RequiredAction = {
6297
6307
  /**
6298
- * Discriminator identifying the kind of pause. Open enum — new pause kinds may be added in minor releases; clients must tolerate unknown values. `child_run` is a `loop` or `sub_orchestration` node whose child runs, listed in `context.orchestration_run_ids`, have not settled; their settle resumes it, and it accepts no human input.
6308
+ * Discriminator identifying the kind of pause. Open enum — new pause kinds may be added in minor releases; clients must tolerate unknown values. `child_run` is a `loop` or `sub_orchestration` node whose child runs, listed in `context.orchestration_run_ids`, have not settled; their settle resumes it, and it accepts no human input. A `loop` collecting item errors also lists, in `context.item_errors` (`[{ index, code, message }]`), the items whose `item_tool_context` failed and started no child.
6299
6309
  */
6300
6310
  type: 'human_input' | 'webhook_receive' | 'approval' | 'paused' | 'child_run';
6301
6311
  /**
@@ -9423,6 +9433,10 @@ type FileRecordWritable = {
9423
9433
  */
9424
9434
  updated_at?: Date;
9425
9435
  };
9436
+ /**
9437
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
9438
+ */
9439
+ type ActorPin = string;
9426
9440
  /**
9427
9441
  * Agent public ID
9428
9442
  */
@@ -9503,10 +9517,6 @@ type PlaybookId = string;
9503
9517
  * The case ID
9504
9518
  */
9505
9519
  type CaseId = string;
9506
- /**
9507
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
9508
- */
9509
- type ActorPin = string;
9510
9520
  /**
9511
9521
  * The ID of a node of the case's playbook version
9512
9522
  */
@@ -19437,6 +19447,10 @@ type SearchKnowledgeData = {
19437
19447
  * Search memories within these specific memory stores
19438
19448
  */
19439
19449
  memory_store_ids?: Array<string>;
19450
+ /**
19451
+ * Searches only the memories that belong to this actor; documents are not narrowed. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent searches the memories of the end user it serves only.
19452
+ */
19453
+ actor_id?: string;
19440
19454
  /**
19441
19455
  * Filter results to documents whose file path starts with one of these prefixes
19442
19456
  */
@@ -19506,6 +19520,10 @@ type ListMemoriesData = {
19506
19520
  * Memory store to list memories from (mstore_...)
19507
19521
  */
19508
19522
  memory_store_id: string;
19523
+ /**
19524
+ * Only the memories that belong to this actor. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent lists the memories of the end user it serves only.
19525
+ */
19526
+ actor_id?: string;
19509
19527
  /**
19510
19528
  * Filter by tag pairs, written `key:value` (split on the first colon, so a value may contain colons). Repeat the parameter for several pairs; **all** must be present with exactly that value.
19511
19529
  *
@@ -19572,6 +19590,10 @@ type CreateMemoryData = {
19572
19590
  * The text content of the memory
19573
19591
  */
19574
19592
  content: string;
19593
+ /**
19594
+ * The end user the memory belongs to, an actor of the memory store's project; an unknown one is `400 ACTOR_NOT_FOUND`. The write compares, supersedes and creates among that actor's memories only. Omitted, the memory belongs to no actor and is compared with the other memories of no actor.
19595
+ */
19596
+ actor_id?: string;
19575
19597
  /**
19576
19598
  * Whether there is a source to point at. `conversation` requires `source_id`; `manual` rejects it.
19577
19599
  */
@@ -19661,6 +19683,10 @@ type DeleteMemoryData = {
19661
19683
  * Pins the call to memories of this store, the same parameter that scopes the listing. A memory of another store is `404`, as if it did not exist.
19662
19684
  */
19663
19685
  memory_store_id?: string;
19686
+ /**
19687
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
19688
+ */
19689
+ actor_id?: string;
19664
19690
  };
19665
19691
  url: '/api/v1/memories/{memory_id}';
19666
19692
  };
@@ -19708,6 +19734,10 @@ type GetMemoryData = {
19708
19734
  * Pins the call to memories of this store, the same parameter that scopes the listing. A memory of another store is `404`, as if it did not exist.
19709
19735
  */
19710
19736
  memory_store_id?: string;
19737
+ /**
19738
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
19739
+ */
19740
+ actor_id?: string;
19711
19741
  };
19712
19742
  url: '/api/v1/memories/{memory_id}';
19713
19743
  };
@@ -19778,6 +19808,10 @@ type UpdateMemoryData = {
19778
19808
  * Pins the call to memories of this store, the same parameter that scopes the listing. A memory of another store is `404`, as if it did not exist.
19779
19809
  */
19780
19810
  memory_store_id?: string;
19811
+ /**
19812
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
19813
+ */
19814
+ actor_id?: string;
19781
19815
  };
19782
19816
  url: '/api/v1/memories/{memory_id}';
19783
19817
  };
@@ -19844,6 +19878,10 @@ type RetractMemoryData = {
19844
19878
  * Pins the call to memories of this store, the same parameter that scopes the listing. A memory of another store is `404`, as if it did not exist.
19845
19879
  */
19846
19880
  memory_store_id?: string;
19881
+ /**
19882
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
19883
+ */
19884
+ actor_id?: string;
19847
19885
  };
19848
19886
  url: '/api/v1/memories/{memory_id}/retract';
19849
19887
  };
@@ -19899,6 +19937,10 @@ type ListMemoryAssertionsData = {
19899
19937
  * Pins the call to memories of this store, the same parameter that scopes the listing. A memory of another store is `404`, as if it did not exist.
19900
19938
  */
19901
19939
  memory_store_id?: string;
19940
+ /**
19941
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
19942
+ */
19943
+ actor_id?: string;
19902
19944
  /**
19903
19945
  * Results per page. Above the maximum it is clamped; below 1 or not an integer it is `400 VALIDATION_FAILED`.
19904
19946
  */
@@ -19959,6 +20001,10 @@ type GetMemoryTagsData = {
19959
20001
  * Pins the call to memories of this store, the same parameter that scopes the listing. A memory of another store is `404`, as if it did not exist.
19960
20002
  */
19961
20003
  memory_store_id?: string;
20004
+ /**
20005
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
20006
+ */
20007
+ actor_id?: string;
19962
20008
  };
19963
20009
  url: '/api/v1/memories/{memory_id}/tags';
19964
20010
  };
@@ -20009,6 +20055,10 @@ type MergeMemoryTagsData = {
20009
20055
  * Pins the call to memories of this store, the same parameter that scopes the listing. A memory of another store is `404`, as if it did not exist.
20010
20056
  */
20011
20057
  memory_store_id?: string;
20058
+ /**
20059
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
20060
+ */
20061
+ actor_id?: string;
20012
20062
  };
20013
20063
  url: '/api/v1/memories/{memory_id}/tags';
20014
20064
  };
@@ -20063,6 +20113,10 @@ type ReplaceMemoryTagsData = {
20063
20113
  * Pins the call to memories of this store, the same parameter that scopes the listing. A memory of another store is `404`, as if it did not exist.
20064
20114
  */
20065
20115
  memory_store_id?: string;
20116
+ /**
20117
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
20118
+ */
20119
+ actor_id?: string;
20066
20120
  };
20067
20121
  url: '/api/v1/memories/{memory_id}/tags';
20068
20122
  };
@@ -20684,6 +20738,10 @@ type ListMemoryStoreAssertionsData = {
20684
20738
  memory_store_id: string;
20685
20739
  };
20686
20740
  query?: {
20741
+ /**
20742
+ * Only the writes that resolved into this actor's memories. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` to confine it to the end user an agent serves.
20743
+ */
20744
+ actor_id?: string;
20687
20745
  /**
20688
20746
  * Only assertions that came through this door.
20689
20747
  */
@@ -20760,6 +20818,10 @@ type ExportMemoriesData = {
20760
20818
  memory_store_id: string;
20761
20819
  };
20762
20820
  query?: {
20821
+ /**
20822
+ * Only the memories that belong to this actor.
20823
+ */
20824
+ actor_id?: string;
20763
20825
  /**
20764
20826
  * Include memories that were retracted or superseded
20765
20827
  */
@@ -23605,7 +23667,7 @@ type DeletePlaybookCaseData = {
23605
23667
  };
23606
23668
  query?: {
23607
23669
  /**
23608
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
23670
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
23609
23671
  */
23610
23672
  actor_id?: string;
23611
23673
  };
@@ -23659,7 +23721,7 @@ type GetPlaybookCaseData = {
23659
23721
  };
23660
23722
  query?: {
23661
23723
  /**
23662
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
23724
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
23663
23725
  */
23664
23726
  actor_id?: string;
23665
23727
  };
@@ -23709,7 +23771,7 @@ type WritePlaybookCaseInputsData = {
23709
23771
  };
23710
23772
  query?: {
23711
23773
  /**
23712
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
23774
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
23713
23775
  */
23714
23776
  actor_id?: string;
23715
23777
  };
@@ -23767,7 +23829,7 @@ type GetPlaybookCaseMissingData = {
23767
23829
  };
23768
23830
  query: {
23769
23831
  /**
23770
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
23832
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
23771
23833
  */
23772
23834
  actor_id?: string;
23773
23835
  /**
@@ -23817,7 +23879,7 @@ type ListPlaybookCaseEntriesData = {
23817
23879
  };
23818
23880
  query?: {
23819
23881
  /**
23820
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
23882
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
23821
23883
  */
23822
23884
  actor_id?: string;
23823
23885
  /**
@@ -23881,7 +23943,7 @@ type RunPlaybookCaseNodeData = {
23881
23943
  };
23882
23944
  query?: {
23883
23945
  /**
23884
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
23946
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
23885
23947
  */
23886
23948
  actor_id?: string;
23887
23949
  };
@@ -23939,7 +24001,7 @@ type ListPlaybookCaseExecutionsData = {
23939
24001
  };
23940
24002
  query?: {
23941
24003
  /**
23942
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
24004
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
23943
24005
  */
23944
24006
  actor_id?: string;
23945
24007
  /**
@@ -24003,7 +24065,7 @@ type GetPlaybookCaseExecutionData = {
24003
24065
  };
24004
24066
  query?: {
24005
24067
  /**
24006
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
24068
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
24007
24069
  */
24008
24070
  actor_id?: string;
24009
24071
  };
@@ -24053,7 +24115,7 @@ type ExportPlaybookCaseNodeData = {
24053
24115
  };
24054
24116
  query?: {
24055
24117
  /**
24056
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
24118
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
24057
24119
  */
24058
24120
  actor_id?: string;
24059
24121
  };
@@ -24113,7 +24175,7 @@ type ListPlaybookCaseExportsData = {
24113
24175
  };
24114
24176
  query?: {
24115
24177
  /**
24116
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
24178
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
24117
24179
  */
24118
24180
  actor_id?: string;
24119
24181
  /**
@@ -24181,7 +24243,7 @@ type GetPlaybookCaseExportData = {
24181
24243
  };
24182
24244
  query?: {
24183
24245
  /**
24184
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
24246
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
24185
24247
  */
24186
24248
  actor_id?: string;
24187
24249
  };
@@ -24227,7 +24289,7 @@ type UpgradePlaybookCaseData = {
24227
24289
  };
24228
24290
  query?: {
24229
24291
  /**
24230
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
24292
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
24231
24293
  */
24232
24294
  actor_id?: string;
24233
24295
  };
@@ -24285,7 +24347,7 @@ type ListPlaybookCaseUpgradesData = {
24285
24347
  };
24286
24348
  query?: {
24287
24349
  /**
24288
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
24350
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
24289
24351
  */
24290
24352
  actor_id?: string;
24291
24353
  /**
@@ -24341,7 +24403,7 @@ type PausePlaybookCaseData = {
24341
24403
  };
24342
24404
  query?: {
24343
24405
  /**
24344
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
24406
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
24345
24407
  */
24346
24408
  actor_id?: string;
24347
24409
  };
@@ -24391,7 +24453,7 @@ type ResumePlaybookCaseData = {
24391
24453
  };
24392
24454
  query?: {
24393
24455
  /**
24394
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
24456
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
24395
24457
  */
24396
24458
  actor_id?: string;
24397
24459
  };
@@ -24449,7 +24511,7 @@ type ConfirmPlaybookCaseNodeData = {
24449
24511
  };
24450
24512
  query?: {
24451
24513
  /**
24452
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
24514
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
24453
24515
  */
24454
24516
  actor_id?: string;
24455
24517
  };
@@ -24629,7 +24691,7 @@ type DeletePolicyErrors = {
24629
24691
  */
24630
24692
  404: ErrorResponse;
24631
24693
  /**
24632
- * `POLICY_HAS_DEPENDENTS`: a trigger, agent or webhook still names the policy in its `policy_ids`. Detach it or delete them first.
24694
+ * `POLICY_HAS_DEPENDENTS`: a trigger, agent, webhook, user or API key still names the policy in its `policy_ids`. Detach it or delete them first.
24633
24695
  */
24634
24696
  409: ErrorResponse;
24635
24697
  /**
@@ -30853,7 +30915,7 @@ export declare class ApiKeys {
30853
30915
  /**
30854
30916
  * List API keys
30855
30917
  *
30856
- * Lists API keys accessible to the caller. - JWT admin: returns all API keys. - JWT regular user: returns only the user's own API keys. - Project-scoped credential (API key or OAuth token): returns the caller's own
30918
+ * Lists API keys accessible to the caller. - An unrestricted admin (a login, or a key bound to no project and narrowed by no policy): returns all API keys. - Any other unscoped credential: returns only its user's own API keys. - Project-scoped credential (API key or OAuth token): returns the caller's own
30857
30919
  * keys scoped to that project, or every key scoped to it when the credential
30858
30920
  * holds `api-keys:ListApiKeys` on the project. Confinement to a project is not
30859
30921
  * authority over it, and a key's metadata names its owner, prefix and attached
@@ -30864,26 +30926,26 @@ export declare class ApiKeys {
30864
30926
  /**
30865
30927
  * Create an API key
30866
30928
  *
30867
- * 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, a run token or an IAM 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`.
30929
+ * 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 narrowed beyond its credential's own grant (an OAuth access token, a trigger run-as token, a run token, an IAM token, or an `On-Behalf-Of` assertion), it returns `403 CREDENTIAL_NARROWED`: a key would outlive that narrowing. - 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`.
30868
30930
  *
30869
30931
  */
30870
30932
  static createApiKey<ThrowOnError extends boolean = false>(options: Options<CreateApiKeyData, ThrowOnError>): RequestResult<CreateApiKeyResponses, CreateApiKeyErrors, ThrowOnError>;
30871
30933
  /**
30872
30934
  * Delete an API key
30873
30935
  *
30874
- * Deletes an API key. Only the owner or an admin can delete it, and a project-scoped credential can only delete keys in its own project.
30936
+ * Deletes an API key. Only the owner or an unrestricted admin can delete it, and a project-scoped credential can only delete keys in its own project.
30875
30937
  */
30876
30938
  static deleteApiKey<ThrowOnError extends boolean = false>(options: Options<DeleteApiKeyData, ThrowOnError>): RequestResult<DeleteApiKeyResponses, DeleteApiKeyErrors, ThrowOnError>;
30877
30939
  /**
30878
30940
  * Get an API key
30879
30941
  *
30880
- * Returns details of an API key. Only the owner or an admin can access it, and a project-scoped credential can only reach keys in its own project.
30942
+ * Returns details of an API key. Only the owner or an unrestricted admin can access it, and a project-scoped credential can only reach keys in its own project.
30881
30943
  */
30882
30944
  static getApiKey<ThrowOnError extends boolean = false>(options: Options<GetApiKeyData, ThrowOnError>): RequestResult<GetApiKeyResponses, GetApiKeyErrors, ThrowOnError>;
30883
30945
  /**
30884
30946
  * Update an API key
30885
30947
  *
30886
- * 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, run or IAM) never updates a key (`403 API_KEY_SCOPED_TOKEN`).
30948
+ * 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 unrestricted admin (a login, or a key bound to no project and narrowed by no policy) 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 request narrowed beyond its credential's own grant (OAuth, trigger, run or IAM token, or `On-Behalf-Of`) never updates a key (`403 CREDENTIAL_NARROWED`).
30887
30949
  */
30888
30950
  static updateApiKey<ThrowOnError extends boolean = false>(options: Options<UpdateApiKeyData, ThrowOnError>): RequestResult<UpdateApiKeyResponses, UpdateApiKeyErrors, ThrowOnError>;
30889
30951
  }
@@ -31867,7 +31929,7 @@ export declare class Iam {
31867
31929
  /**
31868
31930
  * Check a permission of the calling credential
31869
31931
  *
31870
- * Evaluates the calling credential's own policies (its owner's and, for an API key or OAuth token, its boundary and project scope) for an action the deployment registered (`IAM_REGISTRATIONS_CONFIG`), or an action the writer rule asks of whoever writes a resource that acts later (a target's start action, `secrets:UseSecret`), on an SRN, with the engine the runtime's own routes use. A denial is `200` with `allowed: false`, never `403`. Only policies are evaluated: the answer says nothing about whether the resource exists.
31932
+ * Evaluates the calling credential's own policies (its owner's and, for an API key or OAuth token, its boundary and project scope) for an action the deployment registered (`IAM_REGISTRATIONS_CONFIG`) or any built-in action, such as one a resource the deployment stores will perform later, on an SRN, with the engine the runtime's own routes use. A denial is `200` with `allowed: false`, never `403`. Only policies are evaluated: the answer says nothing about whether the resource exists.
31871
31933
  */
31872
31934
  static checkIamPermission<ThrowOnError extends boolean = false>(options: Options<CheckIamPermissionData, ThrowOnError>): RequestResult<CheckIamPermissionResponses, CheckIamPermissionErrors, ThrowOnError>;
31873
31935
  /**
@@ -32552,7 +32614,7 @@ export declare class Policies {
32552
32614
  /**
32553
32615
  * Delete a policy
32554
32616
  *
32555
- * Deletes a policy. A project policy needs `policies:DeletePolicy` in its project; a global one, the unrestricted admin. Refused with `409 POLICY_HAS_DEPENDENTS` while a trigger, agent or webhook names it in its `policy_ids`.
32617
+ * Deletes a policy. A project policy needs `policies:DeletePolicy` in its project; a global one, the unrestricted admin. Refused with `409 POLICY_HAS_DEPENDENTS` while a trigger, agent, webhook, user or API key names it in its `policy_ids`.
32556
32618
  */
32557
32619
  static deletePolicy<ThrowOnError extends boolean = false>(options: Options<DeletePolicyData, ThrowOnError>): RequestResult<DeletePolicyResponses, DeletePolicyErrors, ThrowOnError>;
32558
32620
  /**
package/dist/index.d.mts CHANGED
@@ -5033,11 +5033,11 @@ type UpdateGuardrailRequest = {
5033
5033
  };
5034
5034
  type IamCheckRequest = {
5035
5035
  /**
5036
- * A `module:Operation` action the deployment registered, or one the writer rule asks (`agents:CreateAgentGeneration`, `tools:CallTool`, `deciders:CreateDecision`, `tasks:CreateTask`, `orchestrations:StartRun`, `evaluations:RunEval`, `secrets:UseSecret`); any other built-in action or a wildcard is `400`.
5036
+ * A `module:Operation` action the deployment registered or a built-in one (`agents:DeleteAgent`); an unknown action or a wildcard is `400`.
5037
5037
  */
5038
5038
  action: string;
5039
5039
  /**
5040
- * `srn:<project_id>:<resource_type>:<id>`, where the type is one the action's module registered and `<id>` may be `*` for an action on no single resource (a create or a list).
5040
+ * `srn:<project_id>:<resource_type>:<id>`, where the type is one the action's module registered, or for a built-in action one its module's routes check it on, and `<id>` may be `*` for an action on no single resource (a create or a list).
5041
5041
  */
5042
5042
  resource: string;
5043
5043
  /**
@@ -5269,6 +5269,10 @@ type MemoryKnowledgeResult = {
5269
5269
  type Memory = {
5270
5270
  id?: string;
5271
5271
  memory_store_id?: string;
5272
+ /**
5273
+ * The end user the memory belongs to; null for none. Set on create and never changed; a replacement written by a supersede belongs to the same actor.
5274
+ */
5275
+ actor_id?: string | null;
5272
5276
  /**
5273
5277
  * The text this memory currently holds. Stored once per distinct text per store and shared with every assertion that stated it, so a memory carries no copy of its own.
5274
5278
  */
@@ -5897,6 +5901,12 @@ type OrchestrationNode = {
5897
5901
  * For loop and sub_orchestration nodes — allowlist of the run's `tool_context` keys the child run inherits. When `null` (the default), the child inherits the parent's whole bag. When set, only the listed keys are handed down, so a run holding a broad credential can delegate one step to a shared sub-graph without passing on what that sub-graph does not need; `[]` hands down nothing. Matching is case-insensitive, since an entry names a key that becomes an HTTP header name; an entry outside that grammar is rejected at write time with `INVALID_TOOL_CONTEXT_KEY`. The server-derived identity keys (`session_id`, `actor_id`, `actor_external_id`) are unaffected — they are re-derived per generation in the child regardless of this list. Ignored for other node types.
5898
5902
  */
5899
5903
  context_keys?: Array<string> | null;
5904
+ /**
5905
+ * For loop nodes — per-item `tool_context` keys for each child run. Each key is a `tool_context` key; each value is JSON Logic evaluated against `{ <item_variable>: <item>, "state": <run state> }`. A child's bag is the inherited one (after `context_keys`) with these keys laid over it, matched case-insensitively. A value evaluating to `null` drops the key, the inherited value included. A value that evaluates to anything else but a string, or throws, fails that item: under `on_item_error: fail` the node fails before any child starts; under `collect` the item's entry in `results` is `{ "error": { "code", "message" } }` and no child runs for it. A key outside the header-name grammar, two keys differing only in case, or a server-reserved key (`session_id`, `actor_id`, `actor_external_id`, `calling_project_id`) is rejected at write time with `INVALID_TOOL_CONTEXT_KEY`. Ignored for other node types.
5906
+ */
5907
+ item_tool_context?: {
5908
+ [key: string]: unknown;
5909
+ };
5900
5910
  /**
5901
5911
  * For poll nodes — wait between attempts. Accepts a friendly suffix form (`5s`, `30s`, `5m`, `2h`, `500ms`) or ISO 8601 (e.g. PT5S).
5902
5912
  *
@@ -6295,7 +6305,7 @@ type NodeExecution = {
6295
6305
  */
6296
6306
  type RequiredAction = {
6297
6307
  /**
6298
- * Discriminator identifying the kind of pause. Open enum — new pause kinds may be added in minor releases; clients must tolerate unknown values. `child_run` is a `loop` or `sub_orchestration` node whose child runs, listed in `context.orchestration_run_ids`, have not settled; their settle resumes it, and it accepts no human input.
6308
+ * Discriminator identifying the kind of pause. Open enum — new pause kinds may be added in minor releases; clients must tolerate unknown values. `child_run` is a `loop` or `sub_orchestration` node whose child runs, listed in `context.orchestration_run_ids`, have not settled; their settle resumes it, and it accepts no human input. A `loop` collecting item errors also lists, in `context.item_errors` (`[{ index, code, message }]`), the items whose `item_tool_context` failed and started no child.
6299
6309
  */
6300
6310
  type: 'human_input' | 'webhook_receive' | 'approval' | 'paused' | 'child_run';
6301
6311
  /**
@@ -9423,6 +9433,10 @@ type FileRecordWritable = {
9423
9433
  */
9424
9434
  updated_at?: Date;
9425
9435
  };
9436
+ /**
9437
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
9438
+ */
9439
+ type ActorPin = string;
9426
9440
  /**
9427
9441
  * Agent public ID
9428
9442
  */
@@ -9503,10 +9517,6 @@ type PlaybookId = string;
9503
9517
  * The case ID
9504
9518
  */
9505
9519
  type CaseId = string;
9506
- /**
9507
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
9508
- */
9509
- type ActorPin = string;
9510
9520
  /**
9511
9521
  * The ID of a node of the case's playbook version
9512
9522
  */
@@ -19437,6 +19447,10 @@ type SearchKnowledgeData = {
19437
19447
  * Search memories within these specific memory stores
19438
19448
  */
19439
19449
  memory_store_ids?: Array<string>;
19450
+ /**
19451
+ * Searches only the memories that belong to this actor; documents are not narrowed. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent searches the memories of the end user it serves only.
19452
+ */
19453
+ actor_id?: string;
19440
19454
  /**
19441
19455
  * Filter results to documents whose file path starts with one of these prefixes
19442
19456
  */
@@ -19506,6 +19520,10 @@ type ListMemoriesData = {
19506
19520
  * Memory store to list memories from (mstore_...)
19507
19521
  */
19508
19522
  memory_store_id: string;
19523
+ /**
19524
+ * Only the memories that belong to this actor. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent lists the memories of the end user it serves only.
19525
+ */
19526
+ actor_id?: string;
19509
19527
  /**
19510
19528
  * Filter by tag pairs, written `key:value` (split on the first colon, so a value may contain colons). Repeat the parameter for several pairs; **all** must be present with exactly that value.
19511
19529
  *
@@ -19572,6 +19590,10 @@ type CreateMemoryData = {
19572
19590
  * The text content of the memory
19573
19591
  */
19574
19592
  content: string;
19593
+ /**
19594
+ * The end user the memory belongs to, an actor of the memory store's project; an unknown one is `400 ACTOR_NOT_FOUND`. The write compares, supersedes and creates among that actor's memories only. Omitted, the memory belongs to no actor and is compared with the other memories of no actor.
19595
+ */
19596
+ actor_id?: string;
19575
19597
  /**
19576
19598
  * Whether there is a source to point at. `conversation` requires `source_id`; `manual` rejects it.
19577
19599
  */
@@ -19661,6 +19683,10 @@ type DeleteMemoryData = {
19661
19683
  * Pins the call to memories of this store, the same parameter that scopes the listing. A memory of another store is `404`, as if it did not exist.
19662
19684
  */
19663
19685
  memory_store_id?: string;
19686
+ /**
19687
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
19688
+ */
19689
+ actor_id?: string;
19664
19690
  };
19665
19691
  url: '/api/v1/memories/{memory_id}';
19666
19692
  };
@@ -19708,6 +19734,10 @@ type GetMemoryData = {
19708
19734
  * Pins the call to memories of this store, the same parameter that scopes the listing. A memory of another store is `404`, as if it did not exist.
19709
19735
  */
19710
19736
  memory_store_id?: string;
19737
+ /**
19738
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
19739
+ */
19740
+ actor_id?: string;
19711
19741
  };
19712
19742
  url: '/api/v1/memories/{memory_id}';
19713
19743
  };
@@ -19778,6 +19808,10 @@ type UpdateMemoryData = {
19778
19808
  * Pins the call to memories of this store, the same parameter that scopes the listing. A memory of another store is `404`, as if it did not exist.
19779
19809
  */
19780
19810
  memory_store_id?: string;
19811
+ /**
19812
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
19813
+ */
19814
+ actor_id?: string;
19781
19815
  };
19782
19816
  url: '/api/v1/memories/{memory_id}';
19783
19817
  };
@@ -19844,6 +19878,10 @@ type RetractMemoryData = {
19844
19878
  * Pins the call to memories of this store, the same parameter that scopes the listing. A memory of another store is `404`, as if it did not exist.
19845
19879
  */
19846
19880
  memory_store_id?: string;
19881
+ /**
19882
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
19883
+ */
19884
+ actor_id?: string;
19847
19885
  };
19848
19886
  url: '/api/v1/memories/{memory_id}/retract';
19849
19887
  };
@@ -19899,6 +19937,10 @@ type ListMemoryAssertionsData = {
19899
19937
  * Pins the call to memories of this store, the same parameter that scopes the listing. A memory of another store is `404`, as if it did not exist.
19900
19938
  */
19901
19939
  memory_store_id?: string;
19940
+ /**
19941
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
19942
+ */
19943
+ actor_id?: string;
19902
19944
  /**
19903
19945
  * Results per page. Above the maximum it is clamped; below 1 or not an integer it is `400 VALIDATION_FAILED`.
19904
19946
  */
@@ -19959,6 +20001,10 @@ type GetMemoryTagsData = {
19959
20001
  * Pins the call to memories of this store, the same parameter that scopes the listing. A memory of another store is `404`, as if it did not exist.
19960
20002
  */
19961
20003
  memory_store_id?: string;
20004
+ /**
20005
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
20006
+ */
20007
+ actor_id?: string;
19962
20008
  };
19963
20009
  url: '/api/v1/memories/{memory_id}/tags';
19964
20010
  };
@@ -20009,6 +20055,10 @@ type MergeMemoryTagsData = {
20009
20055
  * Pins the call to memories of this store, the same parameter that scopes the listing. A memory of another store is `404`, as if it did not exist.
20010
20056
  */
20011
20057
  memory_store_id?: string;
20058
+ /**
20059
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
20060
+ */
20061
+ actor_id?: string;
20012
20062
  };
20013
20063
  url: '/api/v1/memories/{memory_id}/tags';
20014
20064
  };
@@ -20063,6 +20113,10 @@ type ReplaceMemoryTagsData = {
20063
20113
  * Pins the call to memories of this store, the same parameter that scopes the listing. A memory of another store is `404`, as if it did not exist.
20064
20114
  */
20065
20115
  memory_store_id?: string;
20116
+ /**
20117
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
20118
+ */
20119
+ actor_id?: string;
20066
20120
  };
20067
20121
  url: '/api/v1/memories/{memory_id}/tags';
20068
20122
  };
@@ -20684,6 +20738,10 @@ type ListMemoryStoreAssertionsData = {
20684
20738
  memory_store_id: string;
20685
20739
  };
20686
20740
  query?: {
20741
+ /**
20742
+ * Only the writes that resolved into this actor's memories. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` to confine it to the end user an agent serves.
20743
+ */
20744
+ actor_id?: string;
20687
20745
  /**
20688
20746
  * Only assertions that came through this door.
20689
20747
  */
@@ -20760,6 +20818,10 @@ type ExportMemoriesData = {
20760
20818
  memory_store_id: string;
20761
20819
  };
20762
20820
  query?: {
20821
+ /**
20822
+ * Only the memories that belong to this actor.
20823
+ */
20824
+ actor_id?: string;
20763
20825
  /**
20764
20826
  * Include memories that were retracted or superseded
20765
20827
  */
@@ -23605,7 +23667,7 @@ type DeletePlaybookCaseData = {
23605
23667
  };
23606
23668
  query?: {
23607
23669
  /**
23608
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
23670
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
23609
23671
  */
23610
23672
  actor_id?: string;
23611
23673
  };
@@ -23659,7 +23721,7 @@ type GetPlaybookCaseData = {
23659
23721
  };
23660
23722
  query?: {
23661
23723
  /**
23662
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
23724
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
23663
23725
  */
23664
23726
  actor_id?: string;
23665
23727
  };
@@ -23709,7 +23771,7 @@ type WritePlaybookCaseInputsData = {
23709
23771
  };
23710
23772
  query?: {
23711
23773
  /**
23712
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
23774
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
23713
23775
  */
23714
23776
  actor_id?: string;
23715
23777
  };
@@ -23767,7 +23829,7 @@ type GetPlaybookCaseMissingData = {
23767
23829
  };
23768
23830
  query: {
23769
23831
  /**
23770
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
23832
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
23771
23833
  */
23772
23834
  actor_id?: string;
23773
23835
  /**
@@ -23817,7 +23879,7 @@ type ListPlaybookCaseEntriesData = {
23817
23879
  };
23818
23880
  query?: {
23819
23881
  /**
23820
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
23882
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
23821
23883
  */
23822
23884
  actor_id?: string;
23823
23885
  /**
@@ -23881,7 +23943,7 @@ type RunPlaybookCaseNodeData = {
23881
23943
  };
23882
23944
  query?: {
23883
23945
  /**
23884
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
23946
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
23885
23947
  */
23886
23948
  actor_id?: string;
23887
23949
  };
@@ -23939,7 +24001,7 @@ type ListPlaybookCaseExecutionsData = {
23939
24001
  };
23940
24002
  query?: {
23941
24003
  /**
23942
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
24004
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
23943
24005
  */
23944
24006
  actor_id?: string;
23945
24007
  /**
@@ -24003,7 +24065,7 @@ type GetPlaybookCaseExecutionData = {
24003
24065
  };
24004
24066
  query?: {
24005
24067
  /**
24006
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
24068
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
24007
24069
  */
24008
24070
  actor_id?: string;
24009
24071
  };
@@ -24053,7 +24115,7 @@ type ExportPlaybookCaseNodeData = {
24053
24115
  };
24054
24116
  query?: {
24055
24117
  /**
24056
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
24118
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
24057
24119
  */
24058
24120
  actor_id?: string;
24059
24121
  };
@@ -24113,7 +24175,7 @@ type ListPlaybookCaseExportsData = {
24113
24175
  };
24114
24176
  query?: {
24115
24177
  /**
24116
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
24178
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
24117
24179
  */
24118
24180
  actor_id?: string;
24119
24181
  /**
@@ -24181,7 +24243,7 @@ type GetPlaybookCaseExportData = {
24181
24243
  };
24182
24244
  query?: {
24183
24245
  /**
24184
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
24246
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
24185
24247
  */
24186
24248
  actor_id?: string;
24187
24249
  };
@@ -24227,7 +24289,7 @@ type UpgradePlaybookCaseData = {
24227
24289
  };
24228
24290
  query?: {
24229
24291
  /**
24230
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
24292
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
24231
24293
  */
24232
24294
  actor_id?: string;
24233
24295
  };
@@ -24285,7 +24347,7 @@ type ListPlaybookCaseUpgradesData = {
24285
24347
  };
24286
24348
  query?: {
24287
24349
  /**
24288
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
24350
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
24289
24351
  */
24290
24352
  actor_id?: string;
24291
24353
  /**
@@ -24341,7 +24403,7 @@ type PausePlaybookCaseData = {
24341
24403
  };
24342
24404
  query?: {
24343
24405
  /**
24344
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
24406
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
24345
24407
  */
24346
24408
  actor_id?: string;
24347
24409
  };
@@ -24391,7 +24453,7 @@ type ResumePlaybookCaseData = {
24391
24453
  };
24392
24454
  query?: {
24393
24455
  /**
24394
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
24456
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
24395
24457
  */
24396
24458
  actor_id?: string;
24397
24459
  };
@@ -24449,7 +24511,7 @@ type ConfirmPlaybookCaseNodeData = {
24449
24511
  };
24450
24512
  query?: {
24451
24513
  /**
24452
- * Acts only on a case that belongs to this actor: any other case, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's cases only.
24514
+ * Acts only on an item that belongs to this actor: any other item, one that belongs to no actor included, is `404` as if it did not exist. Pin it in a tool's `preset_parameters` as `{{context:actor_id}}` so an agent serving an end user reaches that user's items only.
24453
24515
  */
24454
24516
  actor_id?: string;
24455
24517
  };
@@ -24629,7 +24691,7 @@ type DeletePolicyErrors = {
24629
24691
  */
24630
24692
  404: ErrorResponse;
24631
24693
  /**
24632
- * `POLICY_HAS_DEPENDENTS`: a trigger, agent or webhook still names the policy in its `policy_ids`. Detach it or delete them first.
24694
+ * `POLICY_HAS_DEPENDENTS`: a trigger, agent, webhook, user or API key still names the policy in its `policy_ids`. Detach it or delete them first.
24633
24695
  */
24634
24696
  409: ErrorResponse;
24635
24697
  /**
@@ -30853,7 +30915,7 @@ export declare class ApiKeys {
30853
30915
  /**
30854
30916
  * List API keys
30855
30917
  *
30856
- * Lists API keys accessible to the caller. - JWT admin: returns all API keys. - JWT regular user: returns only the user's own API keys. - Project-scoped credential (API key or OAuth token): returns the caller's own
30918
+ * Lists API keys accessible to the caller. - An unrestricted admin (a login, or a key bound to no project and narrowed by no policy): returns all API keys. - Any other unscoped credential: returns only its user's own API keys. - Project-scoped credential (API key or OAuth token): returns the caller's own
30857
30919
  * keys scoped to that project, or every key scoped to it when the credential
30858
30920
  * holds `api-keys:ListApiKeys` on the project. Confinement to a project is not
30859
30921
  * authority over it, and a key's metadata names its owner, prefix and attached
@@ -30864,26 +30926,26 @@ export declare class ApiKeys {
30864
30926
  /**
30865
30927
  * Create an API key
30866
30928
  *
30867
- * 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, a run token or an IAM 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`.
30929
+ * 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 narrowed beyond its credential's own grant (an OAuth access token, a trigger run-as token, a run token, an IAM token, or an `On-Behalf-Of` assertion), it returns `403 CREDENTIAL_NARROWED`: a key would outlive that narrowing. - 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`.
30868
30930
  *
30869
30931
  */
30870
30932
  static createApiKey<ThrowOnError extends boolean = false>(options: Options<CreateApiKeyData, ThrowOnError>): RequestResult<CreateApiKeyResponses, CreateApiKeyErrors, ThrowOnError>;
30871
30933
  /**
30872
30934
  * Delete an API key
30873
30935
  *
30874
- * Deletes an API key. Only the owner or an admin can delete it, and a project-scoped credential can only delete keys in its own project.
30936
+ * Deletes an API key. Only the owner or an unrestricted admin can delete it, and a project-scoped credential can only delete keys in its own project.
30875
30937
  */
30876
30938
  static deleteApiKey<ThrowOnError extends boolean = false>(options: Options<DeleteApiKeyData, ThrowOnError>): RequestResult<DeleteApiKeyResponses, DeleteApiKeyErrors, ThrowOnError>;
30877
30939
  /**
30878
30940
  * Get an API key
30879
30941
  *
30880
- * Returns details of an API key. Only the owner or an admin can access it, and a project-scoped credential can only reach keys in its own project.
30942
+ * Returns details of an API key. Only the owner or an unrestricted admin can access it, and a project-scoped credential can only reach keys in its own project.
30881
30943
  */
30882
30944
  static getApiKey<ThrowOnError extends boolean = false>(options: Options<GetApiKeyData, ThrowOnError>): RequestResult<GetApiKeyResponses, GetApiKeyErrors, ThrowOnError>;
30883
30945
  /**
30884
30946
  * Update an API key
30885
30947
  *
30886
- * 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, run or IAM) never updates a key (`403 API_KEY_SCOPED_TOKEN`).
30948
+ * 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 unrestricted admin (a login, or a key bound to no project and narrowed by no policy) 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 request narrowed beyond its credential's own grant (OAuth, trigger, run or IAM token, or `On-Behalf-Of`) never updates a key (`403 CREDENTIAL_NARROWED`).
30887
30949
  */
30888
30950
  static updateApiKey<ThrowOnError extends boolean = false>(options: Options<UpdateApiKeyData, ThrowOnError>): RequestResult<UpdateApiKeyResponses, UpdateApiKeyErrors, ThrowOnError>;
30889
30951
  }
@@ -31867,7 +31929,7 @@ export declare class Iam {
31867
31929
  /**
31868
31930
  * Check a permission of the calling credential
31869
31931
  *
31870
- * Evaluates the calling credential's own policies (its owner's and, for an API key or OAuth token, its boundary and project scope) for an action the deployment registered (`IAM_REGISTRATIONS_CONFIG`), or an action the writer rule asks of whoever writes a resource that acts later (a target's start action, `secrets:UseSecret`), on an SRN, with the engine the runtime's own routes use. A denial is `200` with `allowed: false`, never `403`. Only policies are evaluated: the answer says nothing about whether the resource exists.
31932
+ * Evaluates the calling credential's own policies (its owner's and, for an API key or OAuth token, its boundary and project scope) for an action the deployment registered (`IAM_REGISTRATIONS_CONFIG`) or any built-in action, such as one a resource the deployment stores will perform later, on an SRN, with the engine the runtime's own routes use. A denial is `200` with `allowed: false`, never `403`. Only policies are evaluated: the answer says nothing about whether the resource exists.
31871
31933
  */
31872
31934
  static checkIamPermission<ThrowOnError extends boolean = false>(options: Options<CheckIamPermissionData, ThrowOnError>): RequestResult<CheckIamPermissionResponses, CheckIamPermissionErrors, ThrowOnError>;
31873
31935
  /**
@@ -32552,7 +32614,7 @@ export declare class Policies {
32552
32614
  /**
32553
32615
  * Delete a policy
32554
32616
  *
32555
- * Deletes a policy. A project policy needs `policies:DeletePolicy` in its project; a global one, the unrestricted admin. Refused with `409 POLICY_HAS_DEPENDENTS` while a trigger, agent or webhook names it in its `policy_ids`.
32617
+ * Deletes a policy. A project policy needs `policies:DeletePolicy` in its project; a global one, the unrestricted admin. Refused with `409 POLICY_HAS_DEPENDENTS` while a trigger, agent, webhook, user or API key names it in its `policy_ids`.
32556
32618
  */
32557
32619
  static deletePolicy<ThrowOnError extends boolean = false>(options: Options<DeletePolicyData, ThrowOnError>): RequestResult<DeletePolicyResponses, DeletePolicyErrors, ThrowOnError>;
32558
32620
  /**
package/dist/index.mjs CHANGED
@@ -1085,7 +1085,7 @@ var ApiKeys = class {
1085
1085
  /**
1086
1086
  * List API keys
1087
1087
  *
1088
- * Lists API keys accessible to the caller. - JWT admin: returns all API keys. - JWT regular user: returns only the user's own API keys. - Project-scoped credential (API key or OAuth token): returns the caller's own
1088
+ * Lists API keys accessible to the caller. - An unrestricted admin (a login, or a key bound to no project and narrowed by no policy): returns all API keys. - Any other unscoped credential: returns only its user's own API keys. - Project-scoped credential (API key or OAuth token): returns the caller's own
1089
1089
  * keys scoped to that project, or every key scoped to it when the credential
1090
1090
  * holds `api-keys:ListApiKeys` on the project. Confinement to a project is not
1091
1091
  * authority over it, and a key's metadata names its owner, prefix and attached
@@ -1105,7 +1105,7 @@ var ApiKeys = class {
1105
1105
  /**
1106
1106
  * Create an API key
1107
1107
  *
1108
- * 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, a run token or an IAM 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`.
1108
+ * 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 narrowed beyond its credential's own grant (an OAuth access token, a trigger run-as token, a run token, an IAM token, or an `On-Behalf-Of` assertion), it returns `403 CREDENTIAL_NARROWED`: a key would outlive that narrowing. - 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`.
1109
1109
  *
1110
1110
  */
1111
1111
  static createApiKey(options) {
@@ -1121,7 +1121,7 @@ var ApiKeys = class {
1121
1121
  /**
1122
1122
  * Delete an API key
1123
1123
  *
1124
- * Deletes an API key. Only the owner or an admin can delete it, and a project-scoped credential can only delete keys in its own project.
1124
+ * Deletes an API key. Only the owner or an unrestricted admin can delete it, and a project-scoped credential can only delete keys in its own project.
1125
1125
  */
1126
1126
  static deleteApiKey(options) {
1127
1127
  return (options.client ?? client).delete({
@@ -1132,7 +1132,7 @@ var ApiKeys = class {
1132
1132
  /**
1133
1133
  * Get an API key
1134
1134
  *
1135
- * Returns details of an API key. Only the owner or an admin can access it, and a project-scoped credential can only reach keys in its own project.
1135
+ * Returns details of an API key. Only the owner or an unrestricted admin can access it, and a project-scoped credential can only reach keys in its own project.
1136
1136
  */
1137
1137
  static getApiKey(options) {
1138
1138
  return (options.client ?? client).get({
@@ -1143,7 +1143,7 @@ var ApiKeys = class {
1143
1143
  /**
1144
1144
  * Update an API key
1145
1145
  *
1146
- * 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, run or IAM) never updates a key (`403 API_KEY_SCOPED_TOKEN`).
1146
+ * 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 unrestricted admin (a login, or a key bound to no project and narrowed by no policy) 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 request narrowed beyond its credential's own grant (OAuth, trigger, run or IAM token, or `On-Behalf-Of`) never updates a key (`403 CREDENTIAL_NARROWED`).
1147
1147
  */
1148
1148
  static updateApiKey(options) {
1149
1149
  return (options.client ?? client).put({
@@ -3039,7 +3039,7 @@ var Iam = class {
3039
3039
  /**
3040
3040
  * Check a permission of the calling credential
3041
3041
  *
3042
- * Evaluates the calling credential's own policies (its owner's and, for an API key or OAuth token, its boundary and project scope) for an action the deployment registered (`IAM_REGISTRATIONS_CONFIG`), or an action the writer rule asks of whoever writes a resource that acts later (a target's start action, `secrets:UseSecret`), on an SRN, with the engine the runtime's own routes use. A denial is `200` with `allowed: false`, never `403`. Only policies are evaluated: the answer says nothing about whether the resource exists.
3042
+ * Evaluates the calling credential's own policies (its owner's and, for an API key or OAuth token, its boundary and project scope) for an action the deployment registered (`IAM_REGISTRATIONS_CONFIG`) or any built-in action, such as one a resource the deployment stores will perform later, on an SRN, with the engine the runtime's own routes use. A denial is `200` with `allowed: false`, never `403`. Only policies are evaluated: the answer says nothing about whether the resource exists.
3043
3043
  */
3044
3044
  static checkIamPermission(options) {
3045
3045
  return (options.client ?? client).post({
@@ -4410,7 +4410,7 @@ var Policies = class {
4410
4410
  /**
4411
4411
  * Delete a policy
4412
4412
  *
4413
- * Deletes a policy. A project policy needs `policies:DeletePolicy` in its project; a global one, the unrestricted admin. Refused with `409 POLICY_HAS_DEPENDENTS` while a trigger, agent or webhook names it in its `policy_ids`.
4413
+ * Deletes a policy. A project policy needs `policies:DeletePolicy` in its project; a global one, the unrestricted admin. Refused with `409 POLICY_HAS_DEPENDENTS` while a trigger, agent, webhook, user or API key names it in its `policy_ids`.
4414
4414
  */
4415
4415
  static deletePolicy(options) {
4416
4416
  return (options.client ?? client).delete({
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@soat/sdk",
3
- "version": "0.108.0",
3
+ "version": "0.109.0",
4
4
  "description": "TypeScript SDK for SOAT — open-source infrastructure for production-ready AI agents.",
5
5
  "keywords": [
6
6
  "ai-agents",