@arbidocs/client 0.4.72 → 0.4.73

package/dist/index.d.cts

@@ -787,6 +787,7 @@ interface paths {
          * @description Update user's display profile (given_name, family_name, picture).
          *
          *     Pass an empty string to clear family_name or picture; null means "leave unchanged".
+         *     A verified name is locked (409) except for case/accent changes; see identity.check_rename.
          */
         patch: operations['update_profile'];
         trace?: never;
@@ -2565,6 +2566,31 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    '/v1/conversation/{conversation_ext_id}/step': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Act On Step
+         * @description A person finishes a step of a workflow run: fills in a form (its ``inputs`` join the run's inputs), adds
+         *     the files, approves a review, or skips a step. The run then goes on to its next agent step, under the
+         *     caller's session (they are present: no access question).
+         *
+         *     400 when the step is not this run's, or not ready (what it waits for has not finished); 409 while a turn is
+         *     running for a step a person does (an agent step can only be skipped once it has failed or not started).
+         */
+        post: operations['act_on_step'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/v1/conversation/{conversation_ext_id}/activity': {
         parameters: {
             query?: never;
@@ -6045,7 +6071,7 @@ interface components {
          * @description What happened to a task, in the order a person reads its history.
          * @enum {string}
          */
-        ActivityKind: 'created' | 'run_started' | 'awaiting_access' | 'access_granted' | 'done' | 'reopened' | 'failed' | 'participant_joined' | 'assistant_responded' | 'assistant_stopped' | 'artifact_created' | 'artifact_edited' | 'document_added' | 'document_removed' | 'notified';
+        ActivityKind: 'created' | 'run_started' | 'awaiting_access' | 'access_granted' | 'done' | 'reopened' | 'failed' | 'participant_joined' | 'assistant_responded' | 'assistant_stopped' | 'artifact_created' | 'artifact_edited' | 'document_added' | 'document_removed' | 'notified' | 'step_started' | 'step_done' | 'step_skipped' | 'step_failed';
         /**
          * ActivityResponse
          * @description One entry of ``GET /v1/conversation/{id}/activity``.
@@ -9689,6 +9715,10 @@ interface components {
             agent_ext_id?: string | null;
             /** Skill Ref */
             skill_ref?: string | null;
+            /** Skill Inputs */
+            skill_inputs?: {
+                [key: string]: unknown;
+            } | null;
             /**
              * Has Agent Action
              * @default false
@@ -16583,6 +16613,26 @@ interface components {
             /** Color */
             color: string;
         };
+        /**
+         * StepActionRequest
+         * @description A person finishes a step of a workflow run (``POST /v1/conversation/{id}/step``).
+         *
+         *     ``complete`` finishes a form (``inputs`` merge into the run's inputs), an upload, or a review (the
+         *     approval: whoever completes it is recorded). ``skip`` passes over a step so what waits for it can go on.
+         */
+        StepActionRequest: {
+            /** Step */
+            step: string;
+            /**
+             * Action
+             * @enum {string}
+             */
+            action: 'complete' | 'skip';
+            /** Inputs */
+            inputs?: {
+                [key: string]: unknown;
+            } | null;
+        };
         /**
          * StepUsage
          * @description Per-step token usage from a single LLM call.
@@ -16972,6 +17022,11 @@ interface components {
              * @default []
              */
             documents: string[];
+            /**
+             * Steps
+             * @default []
+             */
+            steps: components['schemas']['TaskPlanStep'][];
         };
         /**
          * TaskPlanCriterion
@@ -16984,6 +17039,51 @@ interface components {
             /** Text */
             text: string;
         };
+        /**
+         * TaskPlanStep
+         * @description One named step of a workflow run (see ``src/core/workflow_steps.py``).
+         *
+         *     ``form`` / ``upload`` / ``review`` steps wait for a person; an ``agent`` step is a turn the assistant
+         *     takes in the thread, running a ``skill`` (with ``inputs`` templated from the run's inputs) or a
+         *     ``prompt`` template. A ``branch`` agent step runs off the main line and delivers only its result to it.
+         *     The structure is plaintext (the scheduler reads it to start each step, like ``Convos.prompt``); the
+         *     ``title`` is encrypted on the conversation. ``ui`` carries what a client shows (form fields, icon).
+         */
+        TaskPlanStep: {
+            /** Id */
+            id: string;
+            /** Title */
+            title: string;
+            /**
+             * Kind
+             * @enum {string}
+             */
+            kind: 'form' | 'upload' | 'agent' | 'review';
+            /** After */
+            after?: string[] | null;
+            /** Skill */
+            skill?: string | null;
+            /** Prompt */
+            prompt?: string | null;
+            /** Inputs */
+            inputs?: {
+                [key: string]: string;
+            } | null;
+            /**
+             * Branch
+             * @default false
+             */
+            branch: boolean;
+            /**
+             * Requires Files
+             * @default false
+             */
+            requires_files: boolean;
+            /** Ui */
+            ui?: {
+                [key: string]: unknown;
+            } | null;
+        };
         /**
          * TaskUpdateMessage
          * @description Document processing progress update.
@@ -22730,6 +22830,41 @@ interface operations {
             };
         };
     };
+    act_on_step: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                conversation_ext_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': components['schemas']['StepActionRequest'];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['ConversationResponse'];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['HTTPValidationError'];
+                };
+            };
+        };
+    };
     get_conversation_activity: {
         parameters: {
             query?: never;

package/dist/index.d.ts

@@ -787,6 +787,7 @@ interface paths {
          * @description Update user's display profile (given_name, family_name, picture).
          *
          *     Pass an empty string to clear family_name or picture; null means "leave unchanged".
+         *     A verified name is locked (409) except for case/accent changes; see identity.check_rename.
          */
         patch: operations['update_profile'];
         trace?: never;
@@ -2565,6 +2566,31 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    '/v1/conversation/{conversation_ext_id}/step': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Act On Step
+         * @description A person finishes a step of a workflow run: fills in a form (its ``inputs`` join the run's inputs), adds
+         *     the files, approves a review, or skips a step. The run then goes on to its next agent step, under the
+         *     caller's session (they are present: no access question).
+         *
+         *     400 when the step is not this run's, or not ready (what it waits for has not finished); 409 while a turn is
+         *     running for a step a person does (an agent step can only be skipped once it has failed or not started).
+         */
+        post: operations['act_on_step'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/v1/conversation/{conversation_ext_id}/activity': {
         parameters: {
             query?: never;
@@ -6045,7 +6071,7 @@ interface components {
          * @description What happened to a task, in the order a person reads its history.
          * @enum {string}
          */
-        ActivityKind: 'created' | 'run_started' | 'awaiting_access' | 'access_granted' | 'done' | 'reopened' | 'failed' | 'participant_joined' | 'assistant_responded' | 'assistant_stopped' | 'artifact_created' | 'artifact_edited' | 'document_added' | 'document_removed' | 'notified';
+        ActivityKind: 'created' | 'run_started' | 'awaiting_access' | 'access_granted' | 'done' | 'reopened' | 'failed' | 'participant_joined' | 'assistant_responded' | 'assistant_stopped' | 'artifact_created' | 'artifact_edited' | 'document_added' | 'document_removed' | 'notified' | 'step_started' | 'step_done' | 'step_skipped' | 'step_failed';
         /**
          * ActivityResponse
          * @description One entry of ``GET /v1/conversation/{id}/activity``.
@@ -9689,6 +9715,10 @@ interface components {
             agent_ext_id?: string | null;
             /** Skill Ref */
             skill_ref?: string | null;
+            /** Skill Inputs */
+            skill_inputs?: {
+                [key: string]: unknown;
+            } | null;
             /**
              * Has Agent Action
              * @default false
@@ -16583,6 +16613,26 @@ interface components {
             /** Color */
             color: string;
         };
+        /**
+         * StepActionRequest
+         * @description A person finishes a step of a workflow run (``POST /v1/conversation/{id}/step``).
+         *
+         *     ``complete`` finishes a form (``inputs`` merge into the run's inputs), an upload, or a review (the
+         *     approval: whoever completes it is recorded). ``skip`` passes over a step so what waits for it can go on.
+         */
+        StepActionRequest: {
+            /** Step */
+            step: string;
+            /**
+             * Action
+             * @enum {string}
+             */
+            action: 'complete' | 'skip';
+            /** Inputs */
+            inputs?: {
+                [key: string]: unknown;
+            } | null;
+        };
         /**
          * StepUsage
          * @description Per-step token usage from a single LLM call.
@@ -16972,6 +17022,11 @@ interface components {
              * @default []
              */
             documents: string[];
+            /**
+             * Steps
+             * @default []
+             */
+            steps: components['schemas']['TaskPlanStep'][];
         };
         /**
          * TaskPlanCriterion
@@ -16984,6 +17039,51 @@ interface components {
             /** Text */
             text: string;
         };
+        /**
+         * TaskPlanStep
+         * @description One named step of a workflow run (see ``src/core/workflow_steps.py``).
+         *
+         *     ``form`` / ``upload`` / ``review`` steps wait for a person; an ``agent`` step is a turn the assistant
+         *     takes in the thread, running a ``skill`` (with ``inputs`` templated from the run's inputs) or a
+         *     ``prompt`` template. A ``branch`` agent step runs off the main line and delivers only its result to it.
+         *     The structure is plaintext (the scheduler reads it to start each step, like ``Convos.prompt``); the
+         *     ``title`` is encrypted on the conversation. ``ui`` carries what a client shows (form fields, icon).
+         */
+        TaskPlanStep: {
+            /** Id */
+            id: string;
+            /** Title */
+            title: string;
+            /**
+             * Kind
+             * @enum {string}
+             */
+            kind: 'form' | 'upload' | 'agent' | 'review';
+            /** After */
+            after?: string[] | null;
+            /** Skill */
+            skill?: string | null;
+            /** Prompt */
+            prompt?: string | null;
+            /** Inputs */
+            inputs?: {
+                [key: string]: string;
+            } | null;
+            /**
+             * Branch
+             * @default false
+             */
+            branch: boolean;
+            /**
+             * Requires Files
+             * @default false
+             */
+            requires_files: boolean;
+            /** Ui */
+            ui?: {
+                [key: string]: unknown;
+            } | null;
+        };
         /**
          * TaskUpdateMessage
          * @description Document processing progress update.
@@ -22730,6 +22830,41 @@ interface operations {
             };
         };
     };
+    act_on_step: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                conversation_ext_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': components['schemas']['StepActionRequest'];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['ConversationResponse'];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['HTTPValidationError'];
+                };
+            };
+        };
+    };
     get_conversation_activity: {
         parameters: {
             query?: never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arbidocs/client",
-  "version": "0.4.72",
+  "version": "0.4.73",
   "description": "TypeScript SDK for the ARBI API — zero-knowledge auth, E2E encryption, and type-safe REST client",
   "type": "module",
   "sideEffects": false,