@soat/sdk 0.18.6 → 0.19.0

package/dist/index.cjs

@@ -2849,7 +2849,7 @@ var Projects = class {
 	/**
 	* Update a project
 	*
-	* Updates a project's name, its attached guardrails (`guardrail_ids` — the project-scope baseline governing every tool call by every agent in the project), its orchestration concurrency limit (`max_concurrent_runs`), its inherited model route (`default_model_route_id`), and/or its read-auditing opt-in (`audit_reads_enabled`). At least one field is required. Requires admin role. Detaching a guardrail (removing an id) additionally requires guardrails:DetachGuardrail.
+	* Updates a project's name, its attached guardrails (`guardrail_ids` — the project-scope baseline governing every tool call by every agent in the project), its orchestration concurrency limit (`max_concurrent_runs`), its inherited model route (`default_model_route_id`), its read-auditing opt-in (`audit_reads_enabled`), its trace-content retention window (`trace_content_retention_days`), and/or its zero-retention setting (`trace_content_mode`). At least one field is required. Requires admin role. Detaching a guardrail (removing an id) additionally requires guardrails:DetachGuardrail.
 	*/
 	static updateProject(options) {
 		return (options.client ?? client).patch({

package/dist/index.d.cts

@@ -538,6 +538,10 @@ type Agent = {
    * When true, only one open session per actor_id is allowed for this agent. Creating a second open session for the same actor returns 409.
    */
   single_session_per_actor?: boolean;
+  /**
+   * Agent-scope zero-retention setting. `null` (the default) inherits the project's `trace_content_mode`; `none` means this agent's trace and generation content is never persisted. An agent may tighten a storing project to `none` but cannot loosen a `none` project back to `full`.
+   */
+  trace_content_mode?: 'full' | 'none' | null;
   /**
    * Current config version. Starts at 1 and increments on every write that changes the config; each increment archives the new config as an `AgentVersion`. A write that changes nothing leaves it untouched.
    */
@@ -732,6 +736,10 @@ type CreateAgentRequest = {
    * When true, only one open session per actor_id is allowed for this agent.
    */
   single_session_per_actor?: boolean;
+  /**
+   * Zero-retention opt-in for this agent. `null` inherits the project's setting; `none` means trace and generation content is never written. Setting `full` under a project whose own mode is `none` is refused with 400 — the project is a floor an agent may only tighten.
+   */
+  trace_content_mode?: 'full' | 'none' | null;
   /**
    * Optional tag for the config version this write archives (e.g. `initial`). Annotates the version only — it is not stored on the agent and is not part of the config, so labelling a change is never itself a change.
    */
@@ -832,6 +840,10 @@ type UpdateAgentRequest = {
    * When true, only one open session per actor_id is allowed for this agent.
    */
   single_session_per_actor?: boolean | null;
+  /**
+   * Zero-retention opt-in for this agent. `null` inherits the project's setting; `none` means trace and generation content is never written. Setting `full` under a project whose own mode is `none` is refused with 400.
+   */
+  trace_content_mode?: 'full' | 'none' | null;
   /**
    * Optional tag for the config version this write archives (e.g. `pre-tone-change`). Annotates the version only — it is not stored on the agent and is not part of the config, so labelling a change is never itself a change. Ignored when the write changes nothing, since no version is created.
    */
@@ -1242,7 +1254,7 @@ type AuditEntry = {
   /**
    * Principal kind; null for platform-originated entries (those are identified by their `action`, e.g. `quotas:MonitorBreach`)
    */
-  principal_type?: 'user' | 'api_key';
+  principal_type?: 'user' | 'api_key' | null;
   /**
    * Public id of the principal (`user_…` or `key_…`); null for platform-originated entries
    */
@@ -1548,7 +1560,7 @@ type ParticipantInput = {
   /**
    * Provider-native reasoning effort for this participant's turns.
    */
-  effort?: 'low' | 'medium' | 'high';
+  effort?: 'low' | 'medium' | 'high' | null;
 };
 type ParticipantRecord = {
   id?: string;
@@ -1593,13 +1605,14 @@ type DiscussionRunRecord = {
   outcome?: string | null;
   conversation_id?: string | null;
   outcome_document_id?: string | null;
-  started_by?: {
-    [key: string]: unknown;
-  } | null;
   /**
-   * Reserved for the generation that started this run. Not currently populated.
+   * Type of the principal that invoked the run. Read-only: derived from the authenticated caller, never accepted from a request body.
    */
-  initiator_generation_id?: string | null;
+  started_by_principal_type?: 'user' | 'api_key' | null;
+  /**
+   * Public id of the principal that invoked the run — the API key's own id (`key_…`) when a key was used, otherwise the user's (`user_…`). Read-only, like `started_by_principal_type`.
+   */
+  started_by_principal_id?: string | null;
   completed_at?: Date | null;
   created_at?: Date;
   updated_at?: Date;
@@ -1638,17 +1651,17 @@ type DocumentRecord = {
    */
   content?: string | null;
   /**
-   * The chunk strategy the document was last (re-)ingested with. `null` when the default (`whole`) was used.
+   * The chunk strategy the document was last (re-)ingested with. Absent when the default (`whole`) was used — the mapper omits the key rather than sending `null`.
    */
   chunk_strategy?: 'page' | 'whole' | 'size';
   /**
-   * Window size in characters used when `chunk_strategy=size`.
+   * Window size in characters used when `chunk_strategy=size`. Absent otherwise.
    */
-  chunk_size?: number | null;
+  chunk_size?: number;
   /**
-   * Overlap in characters between consecutive windows used when `chunk_strategy=size`.
+   * Overlap in characters between consecutive windows used when `chunk_strategy=size`. Absent otherwise.
    */
-  chunk_overlap?: number | null;
+  chunk_overlap?: number;
   created_at?: Date;
   updated_at?: Date;
 };
@@ -2052,6 +2065,10 @@ type AgentResourceProperties = {
    * When true, only one open session per actor_id is allowed for this agent.
    */
   single_session_per_actor?: boolean | null;
+  /**
+   * Agent-scope zero-retention setting (`full` or `none`). `null` inherits the project's setting. `full` is refused when the project's own mode is `none`.
+   */
+  trace_content_mode?: string | null;
   /**
    * Knowledge retrieval configuration. When set, relevant documents and memory entries are injected into every generation.
    */
@@ -2853,7 +2870,7 @@ type GuardrailResourceProperties = {
   /**
    * How tool-fetched context combines with the caller-supplied context.
    */
-  context_mode?: 'merge' | 'replace';
+  context_mode?: 'merge' | 'replace' | null;
 };
 type ResourceDeclaration = {
   /**
@@ -2870,7 +2887,7 @@ type ResourceDeclaration = {
    */
   depends_on?: Array<string> | null;
   /**
-   * Controls what happens to the physical resource when it is removed from the stack. `delete` (default) deletes the physical resource. `retain` keeps the physical resource alive and only removes the formation record.
+   * Controls what happens to the physical resource when it is removed from the stack. `delete` (default) deletes the physical resource. `retain` keeps the physical resource alive and only removes the formation record. Omit it to get `delete`; an explicit `null` is rejected.
    *
    */
   deletion_policy?: 'delete' | 'retain';
@@ -3249,7 +3266,7 @@ type Guardrail = {
    * How tool-fetched context combines with the caller-supplied context.
    *
    */
-  context_mode?: 'merge' | 'replace';
+  context_mode?: 'merge' | 'replace' | null;
   created_at?: Date;
   updated_at?: Date;
 };
@@ -3322,7 +3339,7 @@ type UpdateGuardrailRequest = {
   description?: string | null;
   document?: GuardrailDocument;
   context_tool_id?: string | null;
-  context_mode?: 'merge' | 'replace';
+  context_mode?: 'merge' | 'replace' | null;
 };
 type IngestionRule = {
   id?: string;
@@ -4047,6 +4064,14 @@ type ProjectRecord = {
    * Whether `GET` requests naming this project are recorded in the audit log. `false` by default — v1 audits mutations only.
    */
   audit_reads_enabled?: boolean;
+  /**
+   * Days of trace/generation content retention before the daily sweep purges it. `null` means retention is disabled (the default) and content is kept until purged on demand.
+   */
+  trace_content_retention_days?: number | null;
+  /**
+   * Whether trace/generation content is persisted. `full` by default; `none` is zero-retention — content is never written for any agent in this project.
+   */
+  trace_content_mode?: 'full' | 'none';
   created_at?: Date;
   updated_at?: Date;
 };
@@ -4387,7 +4412,10 @@ type Task = {
   active_dispatch?: {
     [key: string]: unknown;
   } | null;
-  automation_status?: 'running' | 'completed' | 'failed' | 'unrouted';
+  /**
+   * Status of the current state's dispatch. `null` until a state with an automation is entered.
+   */
+  automation_status?: 'running' | 'completed' | 'failed' | 'unrouted' | null;
   /**
    * The name of a `requires_approval` transition parked awaiting a human decision. Non-null while an ApprovalItem gates the move; the task stays in its current state and no other transition may fire until the approval resolves.
    */
@@ -10475,7 +10503,10 @@ type UpdateIngestionRuleData = {
     } | null;
     native_extraction?: 'first' | 'skip';
     file_delivery?: 'base64' | 'download_url';
-    chunk_strategy?: 'page' | 'whole' | 'size';
+    /**
+     * Send `null` to clear the rule's override and fall back to the per-request default.
+     */
+    chunk_strategy?: 'page' | 'whole' | 'size' | null;
     chunk_size?: number | null;
     chunk_overlap?: number | null;
     metadata?: {
@@ -12015,6 +12046,14 @@ type UpdateProjectData = {
      * Opt the project into read auditing. When true, `GET` requests that name this project are recorded in the audit log alongside mutations. Defaults to `false`.
      */
     audit_reads_enabled?: boolean;
+    /**
+     * How long trace and generation content is kept before the daily retention sweep content-purges it. `null` (the default) disables retention; otherwise an integer >= 1. The sweep uses the same purge path as `DELETE /traces/{trace_id}/content`, so the row survives as an auditable skeleton with `content_redacted_at` set.
+     */
+    trace_content_retention_days?: number | null;
+    /**
+     * Whether trace and generation content is persisted at all. `full` (the default) stores it; `none` is zero-retention — content is never written, for every agent in the project. An agent may tighten this to `none` on its own but cannot loosen a `none` project back to `full`.
+     */
+    trace_content_mode?: 'full' | 'none';
   };
   path: {
     /**
@@ -15996,7 +16035,7 @@ declare class Projects {
   /**
    * Update a project
    *
-   * Updates a project's name, its attached guardrails (`guardrail_ids` — the project-scope baseline governing every tool call by every agent in the project), its orchestration concurrency limit (`max_concurrent_runs`), its inherited model route (`default_model_route_id`), and/or its read-auditing opt-in (`audit_reads_enabled`). At least one field is required. Requires admin role. Detaching a guardrail (removing an id) additionally requires guardrails:DetachGuardrail.
+   * Updates a project's name, its attached guardrails (`guardrail_ids` — the project-scope baseline governing every tool call by every agent in the project), its orchestration concurrency limit (`max_concurrent_runs`), its inherited model route (`default_model_route_id`), its read-auditing opt-in (`audit_reads_enabled`), its trace-content retention window (`trace_content_retention_days`), and/or its zero-retention setting (`trace_content_mode`). At least one field is required. Requires admin role. Detaching a guardrail (removing an id) additionally requires guardrails:DetachGuardrail.
    */
   static updateProject<ThrowOnError extends boolean = false>(options: Options<UpdateProjectData, ThrowOnError>): RequestResult<UpdateProjectResponses, UpdateProjectErrors, ThrowOnError>;
   /**

package/dist/index.d.mts

@@ -538,6 +538,10 @@ type Agent = {
    * When true, only one open session per actor_id is allowed for this agent. Creating a second open session for the same actor returns 409.
    */
   single_session_per_actor?: boolean;
+  /**
+   * Agent-scope zero-retention setting. `null` (the default) inherits the project's `trace_content_mode`; `none` means this agent's trace and generation content is never persisted. An agent may tighten a storing project to `none` but cannot loosen a `none` project back to `full`.
+   */
+  trace_content_mode?: 'full' | 'none' | null;
   /**
    * Current config version. Starts at 1 and increments on every write that changes the config; each increment archives the new config as an `AgentVersion`. A write that changes nothing leaves it untouched.
    */
@@ -732,6 +736,10 @@ type CreateAgentRequest = {
    * When true, only one open session per actor_id is allowed for this agent.
    */
   single_session_per_actor?: boolean;
+  /**
+   * Zero-retention opt-in for this agent. `null` inherits the project's setting; `none` means trace and generation content is never written. Setting `full` under a project whose own mode is `none` is refused with 400 — the project is a floor an agent may only tighten.
+   */
+  trace_content_mode?: 'full' | 'none' | null;
   /**
    * Optional tag for the config version this write archives (e.g. `initial`). Annotates the version only — it is not stored on the agent and is not part of the config, so labelling a change is never itself a change.
    */
@@ -832,6 +840,10 @@ type UpdateAgentRequest = {
    * When true, only one open session per actor_id is allowed for this agent.
    */
   single_session_per_actor?: boolean | null;
+  /**
+   * Zero-retention opt-in for this agent. `null` inherits the project's setting; `none` means trace and generation content is never written. Setting `full` under a project whose own mode is `none` is refused with 400.
+   */
+  trace_content_mode?: 'full' | 'none' | null;
   /**
    * Optional tag for the config version this write archives (e.g. `pre-tone-change`). Annotates the version only — it is not stored on the agent and is not part of the config, so labelling a change is never itself a change. Ignored when the write changes nothing, since no version is created.
    */
@@ -1242,7 +1254,7 @@ type AuditEntry = {
   /**
    * Principal kind; null for platform-originated entries (those are identified by their `action`, e.g. `quotas:MonitorBreach`)
    */
-  principal_type?: 'user' | 'api_key';
+  principal_type?: 'user' | 'api_key' | null;
   /**
    * Public id of the principal (`user_…` or `key_…`); null for platform-originated entries
    */
@@ -1548,7 +1560,7 @@ type ParticipantInput = {
   /**
    * Provider-native reasoning effort for this participant's turns.
    */
-  effort?: 'low' | 'medium' | 'high';
+  effort?: 'low' | 'medium' | 'high' | null;
 };
 type ParticipantRecord = {
   id?: string;
@@ -1593,13 +1605,14 @@ type DiscussionRunRecord = {
   outcome?: string | null;
   conversation_id?: string | null;
   outcome_document_id?: string | null;
-  started_by?: {
-    [key: string]: unknown;
-  } | null;
   /**
-   * Reserved for the generation that started this run. Not currently populated.
+   * Type of the principal that invoked the run. Read-only: derived from the authenticated caller, never accepted from a request body.
    */
-  initiator_generation_id?: string | null;
+  started_by_principal_type?: 'user' | 'api_key' | null;
+  /**
+   * Public id of the principal that invoked the run — the API key's own id (`key_…`) when a key was used, otherwise the user's (`user_…`). Read-only, like `started_by_principal_type`.
+   */
+  started_by_principal_id?: string | null;
   completed_at?: Date | null;
   created_at?: Date;
   updated_at?: Date;
@@ -1638,17 +1651,17 @@ type DocumentRecord = {
    */
   content?: string | null;
   /**
-   * The chunk strategy the document was last (re-)ingested with. `null` when the default (`whole`) was used.
+   * The chunk strategy the document was last (re-)ingested with. Absent when the default (`whole`) was used — the mapper omits the key rather than sending `null`.
    */
   chunk_strategy?: 'page' | 'whole' | 'size';
   /**
-   * Window size in characters used when `chunk_strategy=size`.
+   * Window size in characters used when `chunk_strategy=size`. Absent otherwise.
    */
-  chunk_size?: number | null;
+  chunk_size?: number;
   /**
-   * Overlap in characters between consecutive windows used when `chunk_strategy=size`.
+   * Overlap in characters between consecutive windows used when `chunk_strategy=size`. Absent otherwise.
    */
-  chunk_overlap?: number | null;
+  chunk_overlap?: number;
   created_at?: Date;
   updated_at?: Date;
 };
@@ -2052,6 +2065,10 @@ type AgentResourceProperties = {
    * When true, only one open session per actor_id is allowed for this agent.
    */
   single_session_per_actor?: boolean | null;
+  /**
+   * Agent-scope zero-retention setting (`full` or `none`). `null` inherits the project's setting. `full` is refused when the project's own mode is `none`.
+   */
+  trace_content_mode?: string | null;
   /**
    * Knowledge retrieval configuration. When set, relevant documents and memory entries are injected into every generation.
    */
@@ -2853,7 +2870,7 @@ type GuardrailResourceProperties = {
   /**
    * How tool-fetched context combines with the caller-supplied context.
    */
-  context_mode?: 'merge' | 'replace';
+  context_mode?: 'merge' | 'replace' | null;
 };
 type ResourceDeclaration = {
   /**
@@ -2870,7 +2887,7 @@ type ResourceDeclaration = {
    */
   depends_on?: Array<string> | null;
   /**
-   * Controls what happens to the physical resource when it is removed from the stack. `delete` (default) deletes the physical resource. `retain` keeps the physical resource alive and only removes the formation record.
+   * Controls what happens to the physical resource when it is removed from the stack. `delete` (default) deletes the physical resource. `retain` keeps the physical resource alive and only removes the formation record. Omit it to get `delete`; an explicit `null` is rejected.
    *
    */
   deletion_policy?: 'delete' | 'retain';
@@ -3249,7 +3266,7 @@ type Guardrail = {
    * How tool-fetched context combines with the caller-supplied context.
    *
    */
-  context_mode?: 'merge' | 'replace';
+  context_mode?: 'merge' | 'replace' | null;
   created_at?: Date;
   updated_at?: Date;
 };
@@ -3322,7 +3339,7 @@ type UpdateGuardrailRequest = {
   description?: string | null;
   document?: GuardrailDocument;
   context_tool_id?: string | null;
-  context_mode?: 'merge' | 'replace';
+  context_mode?: 'merge' | 'replace' | null;
 };
 type IngestionRule = {
   id?: string;
@@ -4047,6 +4064,14 @@ type ProjectRecord = {
    * Whether `GET` requests naming this project are recorded in the audit log. `false` by default — v1 audits mutations only.
    */
   audit_reads_enabled?: boolean;
+  /**
+   * Days of trace/generation content retention before the daily sweep purges it. `null` means retention is disabled (the default) and content is kept until purged on demand.
+   */
+  trace_content_retention_days?: number | null;
+  /**
+   * Whether trace/generation content is persisted. `full` by default; `none` is zero-retention — content is never written for any agent in this project.
+   */
+  trace_content_mode?: 'full' | 'none';
   created_at?: Date;
   updated_at?: Date;
 };
@@ -4387,7 +4412,10 @@ type Task = {
   active_dispatch?: {
     [key: string]: unknown;
   } | null;
-  automation_status?: 'running' | 'completed' | 'failed' | 'unrouted';
+  /**
+   * Status of the current state's dispatch. `null` until a state with an automation is entered.
+   */
+  automation_status?: 'running' | 'completed' | 'failed' | 'unrouted' | null;
   /**
    * The name of a `requires_approval` transition parked awaiting a human decision. Non-null while an ApprovalItem gates the move; the task stays in its current state and no other transition may fire until the approval resolves.
    */
@@ -10475,7 +10503,10 @@ type UpdateIngestionRuleData = {
     } | null;
     native_extraction?: 'first' | 'skip';
     file_delivery?: 'base64' | 'download_url';
-    chunk_strategy?: 'page' | 'whole' | 'size';
+    /**
+     * Send `null` to clear the rule's override and fall back to the per-request default.
+     */
+    chunk_strategy?: 'page' | 'whole' | 'size' | null;
     chunk_size?: number | null;
     chunk_overlap?: number | null;
     metadata?: {
@@ -12015,6 +12046,14 @@ type UpdateProjectData = {
      * Opt the project into read auditing. When true, `GET` requests that name this project are recorded in the audit log alongside mutations. Defaults to `false`.
      */
     audit_reads_enabled?: boolean;
+    /**
+     * How long trace and generation content is kept before the daily retention sweep content-purges it. `null` (the default) disables retention; otherwise an integer >= 1. The sweep uses the same purge path as `DELETE /traces/{trace_id}/content`, so the row survives as an auditable skeleton with `content_redacted_at` set.
+     */
+    trace_content_retention_days?: number | null;
+    /**
+     * Whether trace and generation content is persisted at all. `full` (the default) stores it; `none` is zero-retention — content is never written, for every agent in the project. An agent may tighten this to `none` on its own but cannot loosen a `none` project back to `full`.
+     */
+    trace_content_mode?: 'full' | 'none';
   };
   path: {
     /**
@@ -15996,7 +16035,7 @@ declare class Projects {
   /**
    * Update a project
    *
-   * Updates a project's name, its attached guardrails (`guardrail_ids` — the project-scope baseline governing every tool call by every agent in the project), its orchestration concurrency limit (`max_concurrent_runs`), its inherited model route (`default_model_route_id`), and/or its read-auditing opt-in (`audit_reads_enabled`). At least one field is required. Requires admin role. Detaching a guardrail (removing an id) additionally requires guardrails:DetachGuardrail.
+   * Updates a project's name, its attached guardrails (`guardrail_ids` — the project-scope baseline governing every tool call by every agent in the project), its orchestration concurrency limit (`max_concurrent_runs`), its inherited model route (`default_model_route_id`), its read-auditing opt-in (`audit_reads_enabled`), its trace-content retention window (`trace_content_retention_days`), and/or its zero-retention setting (`trace_content_mode`). At least one field is required. Requires admin role. Detaching a guardrail (removing an id) additionally requires guardrails:DetachGuardrail.
    */
   static updateProject<ThrowOnError extends boolean = false>(options: Options<UpdateProjectData, ThrowOnError>): RequestResult<UpdateProjectResponses, UpdateProjectErrors, ThrowOnError>;
   /**

package/dist/index.mjs

@@ -2848,7 +2848,7 @@ var Projects = class {
 	/**
 	* Update a project
 	*
-	* Updates a project's name, its attached guardrails (`guardrail_ids` — the project-scope baseline governing every tool call by every agent in the project), its orchestration concurrency limit (`max_concurrent_runs`), its inherited model route (`default_model_route_id`), and/or its read-auditing opt-in (`audit_reads_enabled`). At least one field is required. Requires admin role. Detaching a guardrail (removing an id) additionally requires guardrails:DetachGuardrail.
+	* Updates a project's name, its attached guardrails (`guardrail_ids` — the project-scope baseline governing every tool call by every agent in the project), its orchestration concurrency limit (`max_concurrent_runs`), its inherited model route (`default_model_route_id`), its read-auditing opt-in (`audit_reads_enabled`), its trace-content retention window (`trace_content_retention_days`), and/or its zero-retention setting (`trace_content_mode`). At least one field is required. Requires admin role. Detaching a guardrail (removing an id) additionally requires guardrails:DetachGuardrail.
 	*/
 	static updateProject(options) {
 		return (options.client ?? client).patch({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soat/sdk",
-  "version": "0.18.6",
+  "version": "0.19.0",
   "description": "TypeScript SDK for the SOAT API",
   "type": "module",
   "main": "dist/index.mjs",