@soat/sdk 0.100.0 → 0.101.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.cjs CHANGED
@@ -764,7 +764,7 @@ var Agents = class {
764
764
  /**
765
765
  * Create an agent
766
766
  *
767
- * Creates a new agent bound to an AI provider.
767
+ * Creates a new agent bound to an AI provider. A `{{secret:...}}` reference in an inline `tool_bindings[].tool` also needs `secrets:UseSecret` on that secret, else `403`.
768
768
  */
769
769
  static createAgent(options) {
770
770
  return (options.client ?? client).post({
@@ -803,7 +803,7 @@ var Agents = class {
803
803
  /**
804
804
  * Partially update an agent
805
805
  *
806
- * Partially updates an existing agent. Identical to PUT — both perform partial updates.
806
+ * Partially updates an existing agent. Identical to PUT — both perform partial updates. A `{{secret:...}}` reference in an inline `tool_bindings[].tool` also needs `secrets:UseSecret` on that secret, else `403`.
807
807
  */
808
808
  static patchAgent(options) {
809
809
  return (options.client ?? client).patch({
@@ -818,7 +818,7 @@ var Agents = class {
818
818
  /**
819
819
  * Update an agent
820
820
  *
821
- * Updates an existing agent. Identical to PATCH — both perform partial updates.
821
+ * Updates an existing agent. Identical to PATCH — both perform partial updates. A `{{secret:...}}` reference in an inline `tool_bindings[].tool` also needs `secrets:UseSecret` on that secret, else `403`.
822
822
  */
823
823
  static updateAgent(options) {
824
824
  return (options.client ?? client).put({
@@ -975,6 +975,10 @@ var AiProviders = class {
975
975
  * A provider's credential is its linked `secret_id`; `config.apiKey` is
976
976
  * refused with `400 VALIDATION_FAILED`.
977
977
  *
978
+ * A record with both `base_url` and `secret_id` sends the secret to that
979
+ * URL, so creating one also needs `secrets:UseSecret` on the secret, else
980
+ * `403`.
981
+ *
978
982
  * A `bedrock` or `vertex` record must link one. Without it the provider
979
983
  * SDK signs with the server's own credentials (the AWS default credential
980
984
  * chain, Google Application Default Credentials), which is refused with
@@ -1019,7 +1023,7 @@ var AiProviders = class {
1019
1023
  /**
1020
1024
  * Update an AI provider
1021
1025
  *
1022
- * Updates an AI provider configuration
1026
+ * Updates an AI provider configuration. Setting `base_url` or `secret_id` so the record holds both also needs `secrets:UseSecret` on the secret, else `403`.
1023
1027
  */
1024
1028
  static updateAiProvider(options) {
1025
1029
  return (options.client ?? client).patch({
@@ -1531,7 +1535,7 @@ var Deciders = class {
1531
1535
  /**
1532
1536
  * Create a decider
1533
1537
  *
1534
- * Creates a decider at version 1: a named question set and the backend that answers it, exactly one of `agent_id` and `tool_id`. Every question declares a finite answer space, validated here. The backend must be in the decider's project. An agent must carry no tool surface — no tool binding left active by `active_tool_ids` and no `knowledge_config.write_memory_store_id` — or the create is refused with `400 DECIDER_AGENT_NOT_TOOL_LESS`. A tool must be `http` or `pipeline` and must not pin `input` or `questions` in its `preset_parameters`, or the create is refused with `400 DECIDER_TOOL_NOT_CALLABLE`. A duplicate `name` in the project is `409 NAME_CONFLICT`.
1538
+ * Creates a decider at version 1: a named question set and the backend that answers it, exactly one of `agent_id` and `tool_id`. Every question declares a finite answer space, validated here. The backend must be in the decider's project. An agent must carry no tool surface — no tool binding left active by `active_tool_ids` and no `knowledge_config.write_memory_store_id` — or the create is refused with `400 DECIDER_AGENT_NOT_TOOL_LESS`. A tool must run server-side with no `action` (not `client` or `mcp`; a `builtin` tool names its `action` in `preset_parameters`) and must not pin `input` or `questions` there, or the create is refused with `400 DECIDER_TOOL_NOT_CALLABLE`. A duplicate `name` in the project is `409 NAME_CONFLICT`.
1535
1539
  */
1536
1540
  static createDecider(options) {
1537
1541
  return (options.client ?? client).post({
@@ -4152,7 +4156,7 @@ var Projects = class {
4152
4156
  *
4153
4157
  * Deletes a project. Requires admin role. Fails with `409` if the project has any dependent resource, unless `force=true` is passed, in which case those resources are deleted along with the project.
4154
4158
  *
4155
- * Every project-scoped resource counts: agents, ai providers, model routes, tools, ingestion rules, actors, chats, conversations, sessions, generations, traces, datasets, evals, workflows, tasks, triggers, orchestrations and their runs, formations, memory stores, secrets, files, guardrails, quotas, usage history — and the activity, approval, exception and guardrail-evaluation records a project accumulates while it runs. Audit log entries are the one exception: they outlive the project, keeping their record with `project_id` cleared.
4159
+ * Every project-scoped resource counts: agents, ai providers, model routes, tools, ingestion rules, actors, chats, conversations, sessions, generations, traces, datasets, evals, workflows, tasks, triggers, orchestrations and their runs, formations, memory stores, secrets, files, guardrails, quotas, priced usage history — and the activity, approval, exception and guardrail-evaluation records a project accumulates while it runs. Audit log entries are the one exception: they outlive the project, keeping their record with `project_id` cleared. A deleted formation and a usage event with no cost go with the project.
4156
4160
  *
4157
4161
  */
4158
4162
  static deleteProject(options) {
@@ -5026,7 +5030,7 @@ var Triggers = class {
5026
5030
  /**
5027
5031
  * Create a trigger
5028
5032
  *
5029
- * Creates a new trigger for a project
5033
+ * Creates a new trigger for a project. A `{{secret:...}}` reference in `tool_context` also needs `secrets:UseSecret` on that secret, else `403`.
5030
5034
  */
5031
5035
  static createTrigger(options) {
5032
5036
  return (options.client ?? client).post({
@@ -5074,7 +5078,7 @@ var Triggers = class {
5074
5078
  /**
5075
5079
  * Update a trigger
5076
5080
  *
5077
- * Updates an existing trigger's configuration. The type is immutable. Changing `target_type` or `target_id` re-checks the target-start action (`orchestrations:StartRun`, `agents:CreateAgentGeneration` or `tools:CallTool`) against the resulting target, because a firing runs with the trigger creator's authority rather than the updater's. A caller who could not start the new target is answered `403` and the trigger keeps the target it had.
5081
+ * Updates an existing trigger's configuration. The type is immutable. Changing `target_type` or `target_id` re-checks the target-start action (`orchestrations:StartRun`, `agents:CreateAgentGeneration` or `tools:CallTool`) against the resulting target, because a firing runs with the trigger creator's authority rather than the updater's. A caller who could not start the new target is answered `403` and the trigger keeps the target it had. A `{{secret:...}}` reference in a written `tool_context`, or in the stored one when the target changes, also needs `secrets:UseSecret` on that secret, else `403`.
5078
5082
  *
5079
5083
  */
5080
5084
  static updateTrigger(options) {
package/dist/index.d.cts CHANGED
@@ -1888,7 +1888,7 @@ type Decider = {
1888
1888
  */
1889
1889
  agent_id?: string | null;
1890
1890
  /**
1891
- * The http or pipeline tool that answers; null when an agent does
1891
+ * The tool that answers, run with no action; null when an agent does
1892
1892
  */
1893
1893
  tool_id?: string | null;
1894
1894
  /**
@@ -1917,7 +1917,7 @@ type CreateDeciderRequest = {
1917
1917
  */
1918
1918
  agent_id?: string;
1919
1919
  /**
1920
- * An http or pipeline tool that answers
1920
+ * A tool that answers, run with no action
1921
1921
  */
1922
1922
  tool_id?: string;
1923
1923
  questions: DeciderQuestions;
@@ -2002,7 +2002,7 @@ type CreateInlineDecisionRequest = {
2002
2002
  */
2003
2003
  agent_id?: string;
2004
2004
  /**
2005
- * An http or pipeline tool that answers
2005
+ * A tool that answers, run with no action
2006
2006
  */
2007
2007
  tool_id?: string;
2008
2008
  questions: DeciderQuestions;
@@ -3837,7 +3837,7 @@ type IngestionRuleResourceProperties = {
3837
3837
  */
3838
3838
  agent_id?: string | null;
3839
3839
  /**
3840
- * Operation id, required for builtin/mcp tool converters
3840
+ * Operation id, required for mcp tool converters, and for builtin unless a preset_parameters (the rule's or the tool's) names action
3841
3841
  */
3842
3842
  action?: string | null;
3843
3843
  /**
@@ -4094,7 +4094,7 @@ type GuardrailResourceProperties = {
4094
4094
  context_mode?: 'merge' | 'replace' | null;
4095
4095
  };
4096
4096
  /**
4097
- * Creates a decider — a versioned question set answered against a caller's input. Names exactly one backend: `agent_id` (a tool-less agent) or `tool_id` (an `http` or `pipeline` tool), either a `{ "ref": … }` to a resource in the same template. Only a change to `questions` archives a new version. Mirrors the deciders REST contract.
4097
+ * Creates a decider — a versioned question set answered against a caller's input. Names exactly one backend: `agent_id` (a tool-less agent) or `tool_id` (a tool run with no action), either a `{ "ref": … }` to a resource in the same template. Only a change to `questions` archives a new version. Mirrors the deciders REST contract.
4098
4098
  */
4099
4099
  type DeciderResourceProperties = {
4100
4100
  /**
@@ -4110,7 +4110,7 @@ type DeciderResourceProperties = {
4110
4110
  */
4111
4111
  agent_id?: string;
4112
4112
  /**
4113
- * The http or pipeline tool that answers
4113
+ * The tool that answers, run with no action
4114
4114
  */
4115
4115
  tool_id?: string;
4116
4116
  /**
@@ -6036,9 +6036,9 @@ type NodeExecution = {
6036
6036
  */
6037
6037
  type RequiredAction = {
6038
6038
  /**
6039
- * Discriminator identifying the kind of pause. Open enum — new pause kinds may be added in minor releases; clients must tolerate unknown values.
6039
+ * 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.
6040
6040
  */
6041
- type: 'human_input' | 'webhook_receive' | 'approval' | 'paused';
6041
+ type: 'human_input' | 'webhook_receive' | 'approval' | 'paused' | 'child_run';
6042
6042
  /**
6043
6043
  * The node the run is parked at. Absent for a `paused` action, which no node produced.
6044
6044
  */
@@ -17853,7 +17853,7 @@ type CreateIngestionRuleData = {
17853
17853
  */
17854
17854
  agent_id?: string;
17855
17855
  /**
17856
- * Operation id, required for builtin/mcp tool converters
17856
+ * Operation id, required for mcp tool converters, and for builtin unless a preset_parameters (the rule's or the tool's) names action
17857
17857
  */
17858
17858
  action?: string;
17859
17859
  /**
@@ -28745,7 +28745,7 @@ export declare class Agents {
28745
28745
  /**
28746
28746
  * Create an agent
28747
28747
  *
28748
- * Creates a new agent bound to an AI provider.
28748
+ * Creates a new agent bound to an AI provider. A `{{secret:...}}` reference in an inline `tool_bindings[].tool` also needs `secrets:UseSecret` on that secret, else `403`.
28749
28749
  */
28750
28750
  static createAgent<ThrowOnError extends boolean = false>(options: Options<CreateAgentData, ThrowOnError>): RequestResult<CreateAgentResponses, CreateAgentErrors, ThrowOnError>;
28751
28751
  /**
@@ -28765,13 +28765,13 @@ export declare class Agents {
28765
28765
  /**
28766
28766
  * Partially update an agent
28767
28767
  *
28768
- * Partially updates an existing agent. Identical to PUT — both perform partial updates.
28768
+ * Partially updates an existing agent. Identical to PUT — both perform partial updates. A `{{secret:...}}` reference in an inline `tool_bindings[].tool` also needs `secrets:UseSecret` on that secret, else `403`.
28769
28769
  */
28770
28770
  static patchAgent<ThrowOnError extends boolean = false>(options: Options<PatchAgentData, ThrowOnError>): RequestResult<PatchAgentResponses, PatchAgentErrors, ThrowOnError>;
28771
28771
  /**
28772
28772
  * Update an agent
28773
28773
  *
28774
- * Updates an existing agent. Identical to PATCH — both perform partial updates.
28774
+ * Updates an existing agent. Identical to PATCH — both perform partial updates. A `{{secret:...}}` reference in an inline `tool_bindings[].tool` also needs `secrets:UseSecret` on that secret, else `403`.
28775
28775
  */
28776
28776
  static updateAgent<ThrowOnError extends boolean = false>(options: Options<UpdateAgentData, ThrowOnError>): RequestResult<UpdateAgentResponses, UpdateAgentErrors, ThrowOnError>;
28777
28777
  /**
@@ -28858,6 +28858,10 @@ export declare class AiProviders {
28858
28858
  * A provider's credential is its linked `secret_id`; `config.apiKey` is
28859
28859
  * refused with `400 VALIDATION_FAILED`.
28860
28860
  *
28861
+ * A record with both `base_url` and `secret_id` sends the secret to that
28862
+ * URL, so creating one also needs `secrets:UseSecret` on the secret, else
28863
+ * `403`.
28864
+ *
28861
28865
  * A `bedrock` or `vertex` record must link one. Without it the provider
28862
28866
  * SDK signs with the server's own credentials (the AWS default credential
28863
28867
  * chain, Google Application Default Credentials), which is refused with
@@ -28883,7 +28887,7 @@ export declare class AiProviders {
28883
28887
  /**
28884
28888
  * Update an AI provider
28885
28889
  *
28886
- * Updates an AI provider configuration
28890
+ * Updates an AI provider configuration. Setting `base_url` or `secret_id` so the record holds both also needs `secrets:UseSecret` on the secret, else `403`.
28887
28891
  */
28888
28892
  static updateAiProvider<ThrowOnError extends boolean = false>(options: Options<UpdateAiProviderData, ThrowOnError>): RequestResult<UpdateAiProviderResponses, UpdateAiProviderErrors, ThrowOnError>;
28889
28893
  /**
@@ -29150,7 +29154,7 @@ export declare class Deciders {
29150
29154
  /**
29151
29155
  * Create a decider
29152
29156
  *
29153
- * Creates a decider at version 1: a named question set and the backend that answers it, exactly one of `agent_id` and `tool_id`. Every question declares a finite answer space, validated here. The backend must be in the decider's project. An agent must carry no tool surface — no tool binding left active by `active_tool_ids` and no `knowledge_config.write_memory_store_id` — or the create is refused with `400 DECIDER_AGENT_NOT_TOOL_LESS`. A tool must be `http` or `pipeline` and must not pin `input` or `questions` in its `preset_parameters`, or the create is refused with `400 DECIDER_TOOL_NOT_CALLABLE`. A duplicate `name` in the project is `409 NAME_CONFLICT`.
29157
+ * Creates a decider at version 1: a named question set and the backend that answers it, exactly one of `agent_id` and `tool_id`. Every question declares a finite answer space, validated here. The backend must be in the decider's project. An agent must carry no tool surface — no tool binding left active by `active_tool_ids` and no `knowledge_config.write_memory_store_id` — or the create is refused with `400 DECIDER_AGENT_NOT_TOOL_LESS`. A tool must run server-side with no `action` (not `client` or `mcp`; a `builtin` tool names its `action` in `preset_parameters`) and must not pin `input` or `questions` there, or the create is refused with `400 DECIDER_TOOL_NOT_CALLABLE`. A duplicate `name` in the project is `409 NAME_CONFLICT`.
29154
29158
  */
29155
29159
  static createDecider<ThrowOnError extends boolean = false>(options: Options<CreateDeciderData, ThrowOnError>): RequestResult<CreateDeciderResponses, CreateDeciderErrors, ThrowOnError>;
29156
29160
  /**
@@ -30494,7 +30498,7 @@ export declare class Projects {
30494
30498
  *
30495
30499
  * Deletes a project. Requires admin role. Fails with `409` if the project has any dependent resource, unless `force=true` is passed, in which case those resources are deleted along with the project.
30496
30500
  *
30497
- * Every project-scoped resource counts: agents, ai providers, model routes, tools, ingestion rules, actors, chats, conversations, sessions, generations, traces, datasets, evals, workflows, tasks, triggers, orchestrations and their runs, formations, memory stores, secrets, files, guardrails, quotas, usage history — and the activity, approval, exception and guardrail-evaluation records a project accumulates while it runs. Audit log entries are the one exception: they outlive the project, keeping their record with `project_id` cleared.
30501
+ * Every project-scoped resource counts: agents, ai providers, model routes, tools, ingestion rules, actors, chats, conversations, sessions, generations, traces, datasets, evals, workflows, tasks, triggers, orchestrations and their runs, formations, memory stores, secrets, files, guardrails, quotas, priced usage history — and the activity, approval, exception and guardrail-evaluation records a project accumulates while it runs. Audit log entries are the one exception: they outlive the project, keeping their record with `project_id` cleared. A deleted formation and a usage event with no cost go with the project.
30498
30502
  *
30499
30503
  */
30500
30504
  static deleteProject<ThrowOnError extends boolean = false>(options: Options<DeleteProjectData, ThrowOnError>): RequestResult<DeleteProjectResponses, DeleteProjectErrors, ThrowOnError>;
@@ -30935,7 +30939,7 @@ export declare class Triggers {
30935
30939
  /**
30936
30940
  * Create a trigger
30937
30941
  *
30938
- * Creates a new trigger for a project
30942
+ * Creates a new trigger for a project. A `{{secret:...}}` reference in `tool_context` also needs `secrets:UseSecret` on that secret, else `403`.
30939
30943
  */
30940
30944
  static createTrigger<ThrowOnError extends boolean = false>(options: Options<CreateTriggerData, ThrowOnError>): RequestResult<CreateTriggerResponses, CreateTriggerErrors, ThrowOnError>;
30941
30945
  /**
@@ -30959,7 +30963,7 @@ export declare class Triggers {
30959
30963
  /**
30960
30964
  * Update a trigger
30961
30965
  *
30962
- * Updates an existing trigger's configuration. The type is immutable. Changing `target_type` or `target_id` re-checks the target-start action (`orchestrations:StartRun`, `agents:CreateAgentGeneration` or `tools:CallTool`) against the resulting target, because a firing runs with the trigger creator's authority rather than the updater's. A caller who could not start the new target is answered `403` and the trigger keeps the target it had.
30966
+ * Updates an existing trigger's configuration. The type is immutable. Changing `target_type` or `target_id` re-checks the target-start action (`orchestrations:StartRun`, `agents:CreateAgentGeneration` or `tools:CallTool`) against the resulting target, because a firing runs with the trigger creator's authority rather than the updater's. A caller who could not start the new target is answered `403` and the trigger keeps the target it had. A `{{secret:...}}` reference in a written `tool_context`, or in the stored one when the target changes, also needs `secrets:UseSecret` on that secret, else `403`.
30963
30967
  *
30964
30968
  */
30965
30969
  static updateTrigger<ThrowOnError extends boolean = false>(options: Options<UpdateTriggerData, ThrowOnError>): RequestResult<UpdateTriggerResponses, UpdateTriggerErrors, ThrowOnError>;
package/dist/index.d.mts CHANGED
@@ -1888,7 +1888,7 @@ type Decider = {
1888
1888
  */
1889
1889
  agent_id?: string | null;
1890
1890
  /**
1891
- * The http or pipeline tool that answers; null when an agent does
1891
+ * The tool that answers, run with no action; null when an agent does
1892
1892
  */
1893
1893
  tool_id?: string | null;
1894
1894
  /**
@@ -1917,7 +1917,7 @@ type CreateDeciderRequest = {
1917
1917
  */
1918
1918
  agent_id?: string;
1919
1919
  /**
1920
- * An http or pipeline tool that answers
1920
+ * A tool that answers, run with no action
1921
1921
  */
1922
1922
  tool_id?: string;
1923
1923
  questions: DeciderQuestions;
@@ -2002,7 +2002,7 @@ type CreateInlineDecisionRequest = {
2002
2002
  */
2003
2003
  agent_id?: string;
2004
2004
  /**
2005
- * An http or pipeline tool that answers
2005
+ * A tool that answers, run with no action
2006
2006
  */
2007
2007
  tool_id?: string;
2008
2008
  questions: DeciderQuestions;
@@ -3837,7 +3837,7 @@ type IngestionRuleResourceProperties = {
3837
3837
  */
3838
3838
  agent_id?: string | null;
3839
3839
  /**
3840
- * Operation id, required for builtin/mcp tool converters
3840
+ * Operation id, required for mcp tool converters, and for builtin unless a preset_parameters (the rule's or the tool's) names action
3841
3841
  */
3842
3842
  action?: string | null;
3843
3843
  /**
@@ -4094,7 +4094,7 @@ type GuardrailResourceProperties = {
4094
4094
  context_mode?: 'merge' | 'replace' | null;
4095
4095
  };
4096
4096
  /**
4097
- * Creates a decider — a versioned question set answered against a caller's input. Names exactly one backend: `agent_id` (a tool-less agent) or `tool_id` (an `http` or `pipeline` tool), either a `{ "ref": … }` to a resource in the same template. Only a change to `questions` archives a new version. Mirrors the deciders REST contract.
4097
+ * Creates a decider — a versioned question set answered against a caller's input. Names exactly one backend: `agent_id` (a tool-less agent) or `tool_id` (a tool run with no action), either a `{ "ref": … }` to a resource in the same template. Only a change to `questions` archives a new version. Mirrors the deciders REST contract.
4098
4098
  */
4099
4099
  type DeciderResourceProperties = {
4100
4100
  /**
@@ -4110,7 +4110,7 @@ type DeciderResourceProperties = {
4110
4110
  */
4111
4111
  agent_id?: string;
4112
4112
  /**
4113
- * The http or pipeline tool that answers
4113
+ * The tool that answers, run with no action
4114
4114
  */
4115
4115
  tool_id?: string;
4116
4116
  /**
@@ -6036,9 +6036,9 @@ type NodeExecution = {
6036
6036
  */
6037
6037
  type RequiredAction = {
6038
6038
  /**
6039
- * Discriminator identifying the kind of pause. Open enum — new pause kinds may be added in minor releases; clients must tolerate unknown values.
6039
+ * 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.
6040
6040
  */
6041
- type: 'human_input' | 'webhook_receive' | 'approval' | 'paused';
6041
+ type: 'human_input' | 'webhook_receive' | 'approval' | 'paused' | 'child_run';
6042
6042
  /**
6043
6043
  * The node the run is parked at. Absent for a `paused` action, which no node produced.
6044
6044
  */
@@ -17853,7 +17853,7 @@ type CreateIngestionRuleData = {
17853
17853
  */
17854
17854
  agent_id?: string;
17855
17855
  /**
17856
- * Operation id, required for builtin/mcp tool converters
17856
+ * Operation id, required for mcp tool converters, and for builtin unless a preset_parameters (the rule's or the tool's) names action
17857
17857
  */
17858
17858
  action?: string;
17859
17859
  /**
@@ -28745,7 +28745,7 @@ export declare class Agents {
28745
28745
  /**
28746
28746
  * Create an agent
28747
28747
  *
28748
- * Creates a new agent bound to an AI provider.
28748
+ * Creates a new agent bound to an AI provider. A `{{secret:...}}` reference in an inline `tool_bindings[].tool` also needs `secrets:UseSecret` on that secret, else `403`.
28749
28749
  */
28750
28750
  static createAgent<ThrowOnError extends boolean = false>(options: Options<CreateAgentData, ThrowOnError>): RequestResult<CreateAgentResponses, CreateAgentErrors, ThrowOnError>;
28751
28751
  /**
@@ -28765,13 +28765,13 @@ export declare class Agents {
28765
28765
  /**
28766
28766
  * Partially update an agent
28767
28767
  *
28768
- * Partially updates an existing agent. Identical to PUT — both perform partial updates.
28768
+ * Partially updates an existing agent. Identical to PUT — both perform partial updates. A `{{secret:...}}` reference in an inline `tool_bindings[].tool` also needs `secrets:UseSecret` on that secret, else `403`.
28769
28769
  */
28770
28770
  static patchAgent<ThrowOnError extends boolean = false>(options: Options<PatchAgentData, ThrowOnError>): RequestResult<PatchAgentResponses, PatchAgentErrors, ThrowOnError>;
28771
28771
  /**
28772
28772
  * Update an agent
28773
28773
  *
28774
- * Updates an existing agent. Identical to PATCH — both perform partial updates.
28774
+ * Updates an existing agent. Identical to PATCH — both perform partial updates. A `{{secret:...}}` reference in an inline `tool_bindings[].tool` also needs `secrets:UseSecret` on that secret, else `403`.
28775
28775
  */
28776
28776
  static updateAgent<ThrowOnError extends boolean = false>(options: Options<UpdateAgentData, ThrowOnError>): RequestResult<UpdateAgentResponses, UpdateAgentErrors, ThrowOnError>;
28777
28777
  /**
@@ -28858,6 +28858,10 @@ export declare class AiProviders {
28858
28858
  * A provider's credential is its linked `secret_id`; `config.apiKey` is
28859
28859
  * refused with `400 VALIDATION_FAILED`.
28860
28860
  *
28861
+ * A record with both `base_url` and `secret_id` sends the secret to that
28862
+ * URL, so creating one also needs `secrets:UseSecret` on the secret, else
28863
+ * `403`.
28864
+ *
28861
28865
  * A `bedrock` or `vertex` record must link one. Without it the provider
28862
28866
  * SDK signs with the server's own credentials (the AWS default credential
28863
28867
  * chain, Google Application Default Credentials), which is refused with
@@ -28883,7 +28887,7 @@ export declare class AiProviders {
28883
28887
  /**
28884
28888
  * Update an AI provider
28885
28889
  *
28886
- * Updates an AI provider configuration
28890
+ * Updates an AI provider configuration. Setting `base_url` or `secret_id` so the record holds both also needs `secrets:UseSecret` on the secret, else `403`.
28887
28891
  */
28888
28892
  static updateAiProvider<ThrowOnError extends boolean = false>(options: Options<UpdateAiProviderData, ThrowOnError>): RequestResult<UpdateAiProviderResponses, UpdateAiProviderErrors, ThrowOnError>;
28889
28893
  /**
@@ -29150,7 +29154,7 @@ export declare class Deciders {
29150
29154
  /**
29151
29155
  * Create a decider
29152
29156
  *
29153
- * Creates a decider at version 1: a named question set and the backend that answers it, exactly one of `agent_id` and `tool_id`. Every question declares a finite answer space, validated here. The backend must be in the decider's project. An agent must carry no tool surface — no tool binding left active by `active_tool_ids` and no `knowledge_config.write_memory_store_id` — or the create is refused with `400 DECIDER_AGENT_NOT_TOOL_LESS`. A tool must be `http` or `pipeline` and must not pin `input` or `questions` in its `preset_parameters`, or the create is refused with `400 DECIDER_TOOL_NOT_CALLABLE`. A duplicate `name` in the project is `409 NAME_CONFLICT`.
29157
+ * Creates a decider at version 1: a named question set and the backend that answers it, exactly one of `agent_id` and `tool_id`. Every question declares a finite answer space, validated here. The backend must be in the decider's project. An agent must carry no tool surface — no tool binding left active by `active_tool_ids` and no `knowledge_config.write_memory_store_id` — or the create is refused with `400 DECIDER_AGENT_NOT_TOOL_LESS`. A tool must run server-side with no `action` (not `client` or `mcp`; a `builtin` tool names its `action` in `preset_parameters`) and must not pin `input` or `questions` there, or the create is refused with `400 DECIDER_TOOL_NOT_CALLABLE`. A duplicate `name` in the project is `409 NAME_CONFLICT`.
29154
29158
  */
29155
29159
  static createDecider<ThrowOnError extends boolean = false>(options: Options<CreateDeciderData, ThrowOnError>): RequestResult<CreateDeciderResponses, CreateDeciderErrors, ThrowOnError>;
29156
29160
  /**
@@ -30494,7 +30498,7 @@ export declare class Projects {
30494
30498
  *
30495
30499
  * Deletes a project. Requires admin role. Fails with `409` if the project has any dependent resource, unless `force=true` is passed, in which case those resources are deleted along with the project.
30496
30500
  *
30497
- * Every project-scoped resource counts: agents, ai providers, model routes, tools, ingestion rules, actors, chats, conversations, sessions, generations, traces, datasets, evals, workflows, tasks, triggers, orchestrations and their runs, formations, memory stores, secrets, files, guardrails, quotas, usage history — and the activity, approval, exception and guardrail-evaluation records a project accumulates while it runs. Audit log entries are the one exception: they outlive the project, keeping their record with `project_id` cleared.
30501
+ * Every project-scoped resource counts: agents, ai providers, model routes, tools, ingestion rules, actors, chats, conversations, sessions, generations, traces, datasets, evals, workflows, tasks, triggers, orchestrations and their runs, formations, memory stores, secrets, files, guardrails, quotas, priced usage history — and the activity, approval, exception and guardrail-evaluation records a project accumulates while it runs. Audit log entries are the one exception: they outlive the project, keeping their record with `project_id` cleared. A deleted formation and a usage event with no cost go with the project.
30498
30502
  *
30499
30503
  */
30500
30504
  static deleteProject<ThrowOnError extends boolean = false>(options: Options<DeleteProjectData, ThrowOnError>): RequestResult<DeleteProjectResponses, DeleteProjectErrors, ThrowOnError>;
@@ -30935,7 +30939,7 @@ export declare class Triggers {
30935
30939
  /**
30936
30940
  * Create a trigger
30937
30941
  *
30938
- * Creates a new trigger for a project
30942
+ * Creates a new trigger for a project. A `{{secret:...}}` reference in `tool_context` also needs `secrets:UseSecret` on that secret, else `403`.
30939
30943
  */
30940
30944
  static createTrigger<ThrowOnError extends boolean = false>(options: Options<CreateTriggerData, ThrowOnError>): RequestResult<CreateTriggerResponses, CreateTriggerErrors, ThrowOnError>;
30941
30945
  /**
@@ -30959,7 +30963,7 @@ export declare class Triggers {
30959
30963
  /**
30960
30964
  * Update a trigger
30961
30965
  *
30962
- * Updates an existing trigger's configuration. The type is immutable. Changing `target_type` or `target_id` re-checks the target-start action (`orchestrations:StartRun`, `agents:CreateAgentGeneration` or `tools:CallTool`) against the resulting target, because a firing runs with the trigger creator's authority rather than the updater's. A caller who could not start the new target is answered `403` and the trigger keeps the target it had.
30966
+ * Updates an existing trigger's configuration. The type is immutable. Changing `target_type` or `target_id` re-checks the target-start action (`orchestrations:StartRun`, `agents:CreateAgentGeneration` or `tools:CallTool`) against the resulting target, because a firing runs with the trigger creator's authority rather than the updater's. A caller who could not start the new target is answered `403` and the trigger keeps the target it had. A `{{secret:...}}` reference in a written `tool_context`, or in the stored one when the target changes, also needs `secrets:UseSecret` on that secret, else `403`.
30963
30967
  *
30964
30968
  */
30965
30969
  static updateTrigger<ThrowOnError extends boolean = false>(options: Options<UpdateTriggerData, ThrowOnError>): RequestResult<UpdateTriggerResponses, UpdateTriggerErrors, ThrowOnError>;
package/dist/index.mjs CHANGED
@@ -763,7 +763,7 @@ var Agents = class {
763
763
  /**
764
764
  * Create an agent
765
765
  *
766
- * Creates a new agent bound to an AI provider.
766
+ * Creates a new agent bound to an AI provider. A `{{secret:...}}` reference in an inline `tool_bindings[].tool` also needs `secrets:UseSecret` on that secret, else `403`.
767
767
  */
768
768
  static createAgent(options) {
769
769
  return (options.client ?? client).post({
@@ -802,7 +802,7 @@ var Agents = class {
802
802
  /**
803
803
  * Partially update an agent
804
804
  *
805
- * Partially updates an existing agent. Identical to PUT — both perform partial updates.
805
+ * Partially updates an existing agent. Identical to PUT — both perform partial updates. A `{{secret:...}}` reference in an inline `tool_bindings[].tool` also needs `secrets:UseSecret` on that secret, else `403`.
806
806
  */
807
807
  static patchAgent(options) {
808
808
  return (options.client ?? client).patch({
@@ -817,7 +817,7 @@ var Agents = class {
817
817
  /**
818
818
  * Update an agent
819
819
  *
820
- * Updates an existing agent. Identical to PATCH — both perform partial updates.
820
+ * Updates an existing agent. Identical to PATCH — both perform partial updates. A `{{secret:...}}` reference in an inline `tool_bindings[].tool` also needs `secrets:UseSecret` on that secret, else `403`.
821
821
  */
822
822
  static updateAgent(options) {
823
823
  return (options.client ?? client).put({
@@ -974,6 +974,10 @@ var AiProviders = class {
974
974
  * A provider's credential is its linked `secret_id`; `config.apiKey` is
975
975
  * refused with `400 VALIDATION_FAILED`.
976
976
  *
977
+ * A record with both `base_url` and `secret_id` sends the secret to that
978
+ * URL, so creating one also needs `secrets:UseSecret` on the secret, else
979
+ * `403`.
980
+ *
977
981
  * A `bedrock` or `vertex` record must link one. Without it the provider
978
982
  * SDK signs with the server's own credentials (the AWS default credential
979
983
  * chain, Google Application Default Credentials), which is refused with
@@ -1018,7 +1022,7 @@ var AiProviders = class {
1018
1022
  /**
1019
1023
  * Update an AI provider
1020
1024
  *
1021
- * Updates an AI provider configuration
1025
+ * Updates an AI provider configuration. Setting `base_url` or `secret_id` so the record holds both also needs `secrets:UseSecret` on the secret, else `403`.
1022
1026
  */
1023
1027
  static updateAiProvider(options) {
1024
1028
  return (options.client ?? client).patch({
@@ -1530,7 +1534,7 @@ var Deciders = class {
1530
1534
  /**
1531
1535
  * Create a decider
1532
1536
  *
1533
- * Creates a decider at version 1: a named question set and the backend that answers it, exactly one of `agent_id` and `tool_id`. Every question declares a finite answer space, validated here. The backend must be in the decider's project. An agent must carry no tool surface — no tool binding left active by `active_tool_ids` and no `knowledge_config.write_memory_store_id` — or the create is refused with `400 DECIDER_AGENT_NOT_TOOL_LESS`. A tool must be `http` or `pipeline` and must not pin `input` or `questions` in its `preset_parameters`, or the create is refused with `400 DECIDER_TOOL_NOT_CALLABLE`. A duplicate `name` in the project is `409 NAME_CONFLICT`.
1537
+ * Creates a decider at version 1: a named question set and the backend that answers it, exactly one of `agent_id` and `tool_id`. Every question declares a finite answer space, validated here. The backend must be in the decider's project. An agent must carry no tool surface — no tool binding left active by `active_tool_ids` and no `knowledge_config.write_memory_store_id` — or the create is refused with `400 DECIDER_AGENT_NOT_TOOL_LESS`. A tool must run server-side with no `action` (not `client` or `mcp`; a `builtin` tool names its `action` in `preset_parameters`) and must not pin `input` or `questions` there, or the create is refused with `400 DECIDER_TOOL_NOT_CALLABLE`. A duplicate `name` in the project is `409 NAME_CONFLICT`.
1534
1538
  */
1535
1539
  static createDecider(options) {
1536
1540
  return (options.client ?? client).post({
@@ -4151,7 +4155,7 @@ var Projects = class {
4151
4155
  *
4152
4156
  * Deletes a project. Requires admin role. Fails with `409` if the project has any dependent resource, unless `force=true` is passed, in which case those resources are deleted along with the project.
4153
4157
  *
4154
- * Every project-scoped resource counts: agents, ai providers, model routes, tools, ingestion rules, actors, chats, conversations, sessions, generations, traces, datasets, evals, workflows, tasks, triggers, orchestrations and their runs, formations, memory stores, secrets, files, guardrails, quotas, usage history — and the activity, approval, exception and guardrail-evaluation records a project accumulates while it runs. Audit log entries are the one exception: they outlive the project, keeping their record with `project_id` cleared.
4158
+ * Every project-scoped resource counts: agents, ai providers, model routes, tools, ingestion rules, actors, chats, conversations, sessions, generations, traces, datasets, evals, workflows, tasks, triggers, orchestrations and their runs, formations, memory stores, secrets, files, guardrails, quotas, priced usage history — and the activity, approval, exception and guardrail-evaluation records a project accumulates while it runs. Audit log entries are the one exception: they outlive the project, keeping their record with `project_id` cleared. A deleted formation and a usage event with no cost go with the project.
4155
4159
  *
4156
4160
  */
4157
4161
  static deleteProject(options) {
@@ -5025,7 +5029,7 @@ var Triggers = class {
5025
5029
  /**
5026
5030
  * Create a trigger
5027
5031
  *
5028
- * Creates a new trigger for a project
5032
+ * Creates a new trigger for a project. A `{{secret:...}}` reference in `tool_context` also needs `secrets:UseSecret` on that secret, else `403`.
5029
5033
  */
5030
5034
  static createTrigger(options) {
5031
5035
  return (options.client ?? client).post({
@@ -5073,7 +5077,7 @@ var Triggers = class {
5073
5077
  /**
5074
5078
  * Update a trigger
5075
5079
  *
5076
- * Updates an existing trigger's configuration. The type is immutable. Changing `target_type` or `target_id` re-checks the target-start action (`orchestrations:StartRun`, `agents:CreateAgentGeneration` or `tools:CallTool`) against the resulting target, because a firing runs with the trigger creator's authority rather than the updater's. A caller who could not start the new target is answered `403` and the trigger keeps the target it had.
5080
+ * Updates an existing trigger's configuration. The type is immutable. Changing `target_type` or `target_id` re-checks the target-start action (`orchestrations:StartRun`, `agents:CreateAgentGeneration` or `tools:CallTool`) against the resulting target, because a firing runs with the trigger creator's authority rather than the updater's. A caller who could not start the new target is answered `403` and the trigger keeps the target it had. A `{{secret:...}}` reference in a written `tool_context`, or in the stored one when the target changes, also needs `secrets:UseSecret` on that secret, else `403`.
5077
5081
  *
5078
5082
  */
5079
5083
  static updateTrigger(options) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@soat/sdk",
3
- "version": "0.100.0",
3
+ "version": "0.101.1",
4
4
  "description": "TypeScript SDK for SOAT — open-source infrastructure for production-ready AI agents.",
5
5
  "keywords": [
6
6
  "ai-agents",