@soat/sdk 0.13.8 → 0.13.9

package/dist/index.cjs

@@ -909,7 +909,7 @@ var ApiKeys = class {
 	/**
 	* List API keys
 	*
-	* Lists API keys accessible to the caller. - JWT admin: returns all API keys. - JWT regular user: returns only the user's own API keys. - API key scoped to a project: returns only API keys scoped to that project.
+	* Lists API keys accessible to the caller. - JWT admin: returns all API keys. - JWT regular user: returns only the user's own API keys. - API key: returns only API keys scoped to the key's project.
 	*
 	*/
 	static listApiKeys(options) {
@@ -925,7 +925,7 @@ var ApiKeys = class {
 	/**
 	* Create an API key
 	*
-	* Creates a new API key for the authenticated user. - If `project_id` is provided, the key is scoped to that project. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - If neither is provided, the key inherits the user's full permissions.
+	* Creates a new API key for the authenticated user. - `project_id` is required: every key is scoped to exactly one project. - 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.
 	*
 	*/
 	static createApiKey(options) {
@@ -963,7 +963,7 @@ var ApiKeys = class {
 	/**
 	* Update an API key
 	*
-	* Updates an API key's name, project scope, or policies. Only the owner or an admin can update it.
+	* Updates an API key's name, project scope, or policies. The project scope can be changed to another project but never cleared. Only the owner or an admin can update it.
 	*/
 	static updateApiKey(options) {
 		return (options.client ?? client).put({

package/dist/index.d.cts

@@ -991,9 +991,9 @@ type ApiKeyRecord = {
    */
   user_id?: string;
   /**
-   * Optional project scope
+   * The project this key is scoped to
    */
-  project_id?: string | null;
+  project_id?: string;
   /**
    * Public IDs of policies attached to this key
    */
@@ -1356,7 +1356,7 @@ type UploadFileBase64Request = {
   /**
    * Public ID of the project
    */
-  project_id: string;
+  project_id?: string;
   /**
    * Base64-encoded file content
    */
@@ -1412,9 +1412,9 @@ type PresignedUrlResponse = {
 };
 type UploadFileWithTokenRequest = {
   /**
-   * Base64-encoded file content
+   * Base64-encoded file content (alternative to multipart `file`)
    */
-  content: string;
+  content?: string;
   /**
    * Original / download name (overrides the token's filename)
    */
@@ -1517,6 +1517,11 @@ type ParameterDeclaration = {
    *
    */
   no_echo?: boolean | null;
+  /**
+   * When true, omitting this parameter on update reuses its previously stored value instead of failing the required-parameter check — analogous to CloudFormation's UsePreviousValue, declared in the template. An explicitly supplied value still overrides. Has no effect on create (there is no previous value yet). The value is reused only where the underlying resource retains it (e.g. a secret's encrypted value); otherwise the last-applied value is used.
+   *
+   */
+  use_previous_value?: boolean | null;
 };
 /**
  * Creates an AI agent backed by a provider. The agent handles requests, runs tools, and can be attached to actors.
@@ -2073,7 +2078,7 @@ type SecretResourceProperties = {
   /**
    * The secret value to encrypt and store
    */
-  value?: string | null;
+  value: string;
 };
 /**
  * Creates a session attached to an agent within the formation's project.
@@ -2759,8 +2764,8 @@ type StartRunRequest = {
   };
 };
 type ValidateOrchestrationRequest = {
-  nodes: Array<OrchestrationNode>;
-  edges: Array<OrchestrationEdge>;
+  nodes?: Array<OrchestrationNode>;
+  edges?: Array<OrchestrationEdge>;
   /**
    * Optional JSON Schema for run inputs; its top-level properties seed state.
    */
@@ -2772,6 +2777,13 @@ type PolicyStatement = {
   effect: 'Allow' | 'Deny';
   action: Array<string>;
   resource?: Array<string>;
+  /**
+   * Optional condition block. Keys are condition operators (e.g. StringEquals) mapping to context-key/value maps; evaluated by the policy compiler. Free-form — keys are dynamic, not validated.
+   *
+   */
+  condition?: {
+    [key: string]: unknown;
+  };
 };
 type PolicyDocument = {
   statement: Array<PolicyStatement>;
@@ -3457,6 +3469,10 @@ type CreateActorData = {
      * Optional external identifier (e.g. WhatsApp phone number). If provided and an actor with this externalId already exists in the project, the existing actor is returned (idempotent — 200 OK).
      */
     external_id?: string;
+    /**
+     * Persona-specific instructions composed into the effective system prompt during conversation generation.
+     */
+    instructions?: string | null;
     /**
      * Agent to link this actor to. Mutually exclusive with chat_id.
      */
@@ -3573,10 +3589,22 @@ type GetActorResponse = GetActorResponses[keyof GetActorResponses];
 type UpdateActorData = {
   body: {
     name?: string;
+    /**
+     * External identifier (e.g. WhatsApp phone number)
+     */
+    external_id?: string;
     /**
      * Persona-specific instructions
      */
     instructions?: string;
+    /**
+     * Agent to link this actor to. Mutually exclusive with chat_id.
+     */
+    agent_id?: string | null;
+    /**
+     * Chat to link this actor to. Mutually exclusive with agent_id.
+     */
+    chat_id?: string | null;
     /**
      * Memory ID to link to this actor. Set to null to unlink.
      */
@@ -4174,6 +4202,10 @@ type GetAiProviderResponse = GetAiProviderResponses[keyof GetAiProviderResponses
 type UpdateAiProviderData = {
   body: {
     name?: string;
+    /**
+     * LLM provider
+     */
+    provider?: 'openai' | 'anthropic' | 'google' | 'cohere' | 'mistral';
     default_model?: string;
     secret_id?: string;
     base_url?: string;
@@ -4240,9 +4272,9 @@ type CreateApiKeyData = {
      */
     name: string;
     /**
-     * Optional project ID to scope this key to a specific project
+     * Project ID this key is scoped to. Required — keys cannot span projects.
      */
-    project_id?: string;
+    project_id: string;
     /**
      * Optional list of policy IDs to attach. Key permissions become the intersection of user policies and these policies.
      */
@@ -4338,9 +4370,9 @@ type UpdateApiKeyData = {
   body: {
     name?: string;
     /**
-     * Set to null to remove project scope
+     * Re-scope the key to a different project. Cannot be null — keys are always project-scoped.
      */
-    project_id?: string | null;
+    project_id?: string;
     /**
      * Replace the key's policy list (empty array removes all)
      */
@@ -4714,7 +4746,11 @@ type UpdateConversationData = {
     /**
      * New conversation status
      */
-    status: 'open' | 'closed';
+    status?: 'open' | 'closed';
+    /**
+     * New conversation name
+     */
+    name?: string | null;
   };
   path: {
     /**
@@ -5102,6 +5138,22 @@ type CreateDocumentData = {
      */
     path?: string;
     filename?: string;
+    /**
+     * Document title
+     */
+    title?: string;
+    /**
+     * Arbitrary metadata object
+     */
+    metadata?: {
+      [key: string]: unknown;
+    };
+    /**
+     * Key-value tags
+     */
+    tags?: {
+      [key: string]: string;
+    };
     /**
      * How to split the content into embeddable chunks. `whole` (default) stores the content as a single chunk; `size` splits into fixed-size character windows with overlap. `page` is equivalent to `whole` for plain text.
      */
@@ -6102,7 +6154,7 @@ type ReplaceFileTagsResponses = {
 type ReplaceFileTagsResponse = ReplaceFileTagsResponses[keyof ReplaceFileTagsResponses];
 type ValidateFormationData = {
   body: {
-    template: FormationTemplateInput;
+    template?: FormationTemplateInput;
   };
   path?: never;
   query?: never;
@@ -6133,7 +6185,7 @@ type PlanFormationData = {
     formation_id?: string;
     template: FormationTemplateInput;
     /**
-     * Runtime parameter values that override or supply template parameter defaults. Keys must match parameter names declared in `template.parameters`.
+     * Runtime parameter values that override or supply template parameter defaults. Keys must match parameter names declared in `template.parameters`. A parameter declared with `use_previous_value: true` may be omitted to reuse its stored value.
      *
      */
     parameters?: {
@@ -6308,7 +6360,7 @@ type UpdateFormationData = {
   body?: {
     template?: FormationTemplateInput;
     /**
-     * Runtime parameter values that override or supply template parameter defaults. Keys must match parameter names declared in `template.parameters`. Required parameters (those without a default) must be provided here.
+     * Runtime parameter values that override or supply template parameter defaults. Keys must match parameter names declared in `template.parameters`. Required parameters (those without a default) must be provided here, unless the parameter is declared with `use_previous_value: true`, in which case omitting it reuses the previously stored value.
      *
      */
     parameters?: {
@@ -9180,14 +9232,14 @@ declare class ApiKeys {
   /**
    * List API keys
    *
-   * Lists API keys accessible to the caller. - JWT admin: returns all API keys. - JWT regular user: returns only the user's own API keys. - API key scoped to a project: returns only API keys scoped to that project.
+   * Lists API keys accessible to the caller. - JWT admin: returns all API keys. - JWT regular user: returns only the user's own API keys. - API key: returns only API keys scoped to the key's project.
    *
    */
   static listApiKeys<ThrowOnError extends boolean = false>(options?: Options<ListApiKeysData, ThrowOnError>): RequestResult<ListApiKeysResponses, ListApiKeysErrors, ThrowOnError>;
   /**
    * Create an API key
    *
-   * Creates a new API key for the authenticated user. - If `project_id` is provided, the key is scoped to that project. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - If neither is provided, the key inherits the user's full permissions.
+   * Creates a new API key for the authenticated user. - `project_id` is required: every key is scoped to exactly one project. - 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.
    *
    */
   static createApiKey<ThrowOnError extends boolean = false>(options: Options<CreateApiKeyData, ThrowOnError>): RequestResult<CreateApiKeyResponses, CreateApiKeyErrors, ThrowOnError>;
@@ -9206,7 +9258,7 @@ declare class ApiKeys {
   /**
    * Update an API key
    *
-   * Updates an API key's name, project scope, or policies. Only the owner or an admin can update it.
+   * Updates an API key's name, project scope, or policies. The project scope can be changed to another project but never cleared. Only the owner or an admin can update it.
    */
   static updateApiKey<ThrowOnError extends boolean = false>(options: Options<UpdateApiKeyData, ThrowOnError>): RequestResult<UpdateApiKeyResponses, UpdateApiKeyErrors, ThrowOnError>;
 }

package/dist/index.d.mts

@@ -991,9 +991,9 @@ type ApiKeyRecord = {
    */
   user_id?: string;
   /**
-   * Optional project scope
+   * The project this key is scoped to
    */
-  project_id?: string | null;
+  project_id?: string;
   /**
    * Public IDs of policies attached to this key
    */
@@ -1356,7 +1356,7 @@ type UploadFileBase64Request = {
   /**
    * Public ID of the project
    */
-  project_id: string;
+  project_id?: string;
   /**
    * Base64-encoded file content
    */
@@ -1412,9 +1412,9 @@ type PresignedUrlResponse = {
 };
 type UploadFileWithTokenRequest = {
   /**
-   * Base64-encoded file content
+   * Base64-encoded file content (alternative to multipart `file`)
    */
-  content: string;
+  content?: string;
   /**
    * Original / download name (overrides the token's filename)
    */
@@ -1517,6 +1517,11 @@ type ParameterDeclaration = {
    *
    */
   no_echo?: boolean | null;
+  /**
+   * When true, omitting this parameter on update reuses its previously stored value instead of failing the required-parameter check — analogous to CloudFormation's UsePreviousValue, declared in the template. An explicitly supplied value still overrides. Has no effect on create (there is no previous value yet). The value is reused only where the underlying resource retains it (e.g. a secret's encrypted value); otherwise the last-applied value is used.
+   *
+   */
+  use_previous_value?: boolean | null;
 };
 /**
  * Creates an AI agent backed by a provider. The agent handles requests, runs tools, and can be attached to actors.
@@ -2073,7 +2078,7 @@ type SecretResourceProperties = {
   /**
    * The secret value to encrypt and store
    */
-  value?: string | null;
+  value: string;
 };
 /**
  * Creates a session attached to an agent within the formation's project.
@@ -2759,8 +2764,8 @@ type StartRunRequest = {
   };
 };
 type ValidateOrchestrationRequest = {
-  nodes: Array<OrchestrationNode>;
-  edges: Array<OrchestrationEdge>;
+  nodes?: Array<OrchestrationNode>;
+  edges?: Array<OrchestrationEdge>;
   /**
    * Optional JSON Schema for run inputs; its top-level properties seed state.
    */
@@ -2772,6 +2777,13 @@ type PolicyStatement = {
   effect: 'Allow' | 'Deny';
   action: Array<string>;
   resource?: Array<string>;
+  /**
+   * Optional condition block. Keys are condition operators (e.g. StringEquals) mapping to context-key/value maps; evaluated by the policy compiler. Free-form — keys are dynamic, not validated.
+   *
+   */
+  condition?: {
+    [key: string]: unknown;
+  };
 };
 type PolicyDocument = {
   statement: Array<PolicyStatement>;
@@ -3457,6 +3469,10 @@ type CreateActorData = {
      * Optional external identifier (e.g. WhatsApp phone number). If provided and an actor with this externalId already exists in the project, the existing actor is returned (idempotent — 200 OK).
      */
     external_id?: string;
+    /**
+     * Persona-specific instructions composed into the effective system prompt during conversation generation.
+     */
+    instructions?: string | null;
     /**
      * Agent to link this actor to. Mutually exclusive with chat_id.
      */
@@ -3573,10 +3589,22 @@ type GetActorResponse = GetActorResponses[keyof GetActorResponses];
 type UpdateActorData = {
   body: {
     name?: string;
+    /**
+     * External identifier (e.g. WhatsApp phone number)
+     */
+    external_id?: string;
     /**
      * Persona-specific instructions
      */
     instructions?: string;
+    /**
+     * Agent to link this actor to. Mutually exclusive with chat_id.
+     */
+    agent_id?: string | null;
+    /**
+     * Chat to link this actor to. Mutually exclusive with agent_id.
+     */
+    chat_id?: string | null;
     /**
      * Memory ID to link to this actor. Set to null to unlink.
      */
@@ -4174,6 +4202,10 @@ type GetAiProviderResponse = GetAiProviderResponses[keyof GetAiProviderResponses
 type UpdateAiProviderData = {
   body: {
     name?: string;
+    /**
+     * LLM provider
+     */
+    provider?: 'openai' | 'anthropic' | 'google' | 'cohere' | 'mistral';
     default_model?: string;
     secret_id?: string;
     base_url?: string;
@@ -4240,9 +4272,9 @@ type CreateApiKeyData = {
      */
     name: string;
     /**
-     * Optional project ID to scope this key to a specific project
+     * Project ID this key is scoped to. Required — keys cannot span projects.
      */
-    project_id?: string;
+    project_id: string;
     /**
      * Optional list of policy IDs to attach. Key permissions become the intersection of user policies and these policies.
      */
@@ -4338,9 +4370,9 @@ type UpdateApiKeyData = {
   body: {
     name?: string;
     /**
-     * Set to null to remove project scope
+     * Re-scope the key to a different project. Cannot be null — keys are always project-scoped.
      */
-    project_id?: string | null;
+    project_id?: string;
     /**
      * Replace the key's policy list (empty array removes all)
      */
@@ -4714,7 +4746,11 @@ type UpdateConversationData = {
     /**
      * New conversation status
      */
-    status: 'open' | 'closed';
+    status?: 'open' | 'closed';
+    /**
+     * New conversation name
+     */
+    name?: string | null;
   };
   path: {
     /**
@@ -5102,6 +5138,22 @@ type CreateDocumentData = {
      */
     path?: string;
     filename?: string;
+    /**
+     * Document title
+     */
+    title?: string;
+    /**
+     * Arbitrary metadata object
+     */
+    metadata?: {
+      [key: string]: unknown;
+    };
+    /**
+     * Key-value tags
+     */
+    tags?: {
+      [key: string]: string;
+    };
     /**
      * How to split the content into embeddable chunks. `whole` (default) stores the content as a single chunk; `size` splits into fixed-size character windows with overlap. `page` is equivalent to `whole` for plain text.
      */
@@ -6102,7 +6154,7 @@ type ReplaceFileTagsResponses = {
 type ReplaceFileTagsResponse = ReplaceFileTagsResponses[keyof ReplaceFileTagsResponses];
 type ValidateFormationData = {
   body: {
-    template: FormationTemplateInput;
+    template?: FormationTemplateInput;
   };
   path?: never;
   query?: never;
@@ -6133,7 +6185,7 @@ type PlanFormationData = {
     formation_id?: string;
     template: FormationTemplateInput;
     /**
-     * Runtime parameter values that override or supply template parameter defaults. Keys must match parameter names declared in `template.parameters`.
+     * Runtime parameter values that override or supply template parameter defaults. Keys must match parameter names declared in `template.parameters`. A parameter declared with `use_previous_value: true` may be omitted to reuse its stored value.
      *
      */
     parameters?: {
@@ -6308,7 +6360,7 @@ type UpdateFormationData = {
   body?: {
     template?: FormationTemplateInput;
     /**
-     * Runtime parameter values that override or supply template parameter defaults. Keys must match parameter names declared in `template.parameters`. Required parameters (those without a default) must be provided here.
+     * Runtime parameter values that override or supply template parameter defaults. Keys must match parameter names declared in `template.parameters`. Required parameters (those without a default) must be provided here, unless the parameter is declared with `use_previous_value: true`, in which case omitting it reuses the previously stored value.
      *
      */
     parameters?: {
@@ -9180,14 +9232,14 @@ declare class ApiKeys {
   /**
    * List API keys
    *
-   * Lists API keys accessible to the caller. - JWT admin: returns all API keys. - JWT regular user: returns only the user's own API keys. - API key scoped to a project: returns only API keys scoped to that project.
+   * Lists API keys accessible to the caller. - JWT admin: returns all API keys. - JWT regular user: returns only the user's own API keys. - API key: returns only API keys scoped to the key's project.
    *
    */
   static listApiKeys<ThrowOnError extends boolean = false>(options?: Options<ListApiKeysData, ThrowOnError>): RequestResult<ListApiKeysResponses, ListApiKeysErrors, ThrowOnError>;
   /**
    * Create an API key
    *
-   * Creates a new API key for the authenticated user. - If `project_id` is provided, the key is scoped to that project. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - If neither is provided, the key inherits the user's full permissions.
+   * Creates a new API key for the authenticated user. - `project_id` is required: every key is scoped to exactly one project. - 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.
    *
    */
   static createApiKey<ThrowOnError extends boolean = false>(options: Options<CreateApiKeyData, ThrowOnError>): RequestResult<CreateApiKeyResponses, CreateApiKeyErrors, ThrowOnError>;
@@ -9206,7 +9258,7 @@ declare class ApiKeys {
   /**
    * Update an API key
    *
-   * Updates an API key's name, project scope, or policies. Only the owner or an admin can update it.
+   * Updates an API key's name, project scope, or policies. The project scope can be changed to another project but never cleared. Only the owner or an admin can update it.
    */
   static updateApiKey<ThrowOnError extends boolean = false>(options: Options<UpdateApiKeyData, ThrowOnError>): RequestResult<UpdateApiKeyResponses, UpdateApiKeyErrors, ThrowOnError>;
 }

package/dist/index.mjs

@@ -908,7 +908,7 @@ var ApiKeys = class {
 	/**
 	* List API keys
 	*
-	* Lists API keys accessible to the caller. - JWT admin: returns all API keys. - JWT regular user: returns only the user's own API keys. - API key scoped to a project: returns only API keys scoped to that project.
+	* Lists API keys accessible to the caller. - JWT admin: returns all API keys. - JWT regular user: returns only the user's own API keys. - API key: returns only API keys scoped to the key's project.
 	*
 	*/
 	static listApiKeys(options) {
@@ -924,7 +924,7 @@ var ApiKeys = class {
 	/**
 	* Create an API key
 	*
-	* Creates a new API key for the authenticated user. - If `project_id` is provided, the key is scoped to that project. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - If neither is provided, the key inherits the user's full permissions.
+	* Creates a new API key for the authenticated user. - `project_id` is required: every key is scoped to exactly one project. - 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.
 	*
 	*/
 	static createApiKey(options) {
@@ -962,7 +962,7 @@ var ApiKeys = class {
 	/**
 	* Update an API key
 	*
-	* Updates an API key's name, project scope, or policies. Only the owner or an admin can update it.
+	* Updates an API key's name, project scope, or policies. The project scope can be changed to another project but never cleared. Only the owner or an admin can update it.
 	*/
 	static updateApiKey(options) {
 		return (options.client ?? client).put({

package/package.json

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