@arbidocs/client 0.4.76 → 0.4.78

package/dist/index.d.cts

@@ -6336,7 +6336,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' | 'step_started' | 'step_done' | 'step_skipped' | 'step_failed' | 'step_signal' | 'step_ready' | 'step_reminded' | 'step_sent_back' | 'linked_run';
+        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' | 'step_signal' | 'step_ready' | 'step_reminded' | 'step_sent_back' | 'step_waiting' | 'step_progress' | 'linked_run';
         /**
          * ActivityResponse
          * @description One entry of ``GET /v1/conversation/{id}/activity``.
@@ -11369,6 +11369,36 @@ interface components {
              */
             skipped: components['schemas']['DriveSyncSkippedFile'][];
         };
+        /**
+         * EmailDraftAction
+         * @description Prepare a draft in native mail, in the mailbox of the step's assignee (else the run's owner). It is never
+         *     sent automatically: the person sends it, and the step is done when they say so or when the draft is sent.
+         *     ``to``, ``cc``, ``subject`` and ``body_template`` are templates over the run's inputs and earlier steps'
+         *     outputs (``{{field}}``, ``{{step_id.key}}``, ``{{step_id.answer}}``).
+         */
+        EmailDraftAction: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: 'email_draft';
+            /** To */
+            to?: string[];
+            /** Cc */
+            cc?: string[];
+            /**
+             * Subject
+             * @default
+             */
+            subject: string;
+            /**
+             * Body Template
+             * @default
+             */
+            body_template: string;
+            /** Attachments */
+            attachments?: (string | components['schemas']['StepDocumentRef'])[];
+        };
         /**
          * EmailNotificationSettings
          * @description Per-category email notification preferences. All default on; a master
@@ -16948,6 +16978,27 @@ interface components {
              */
             role: 'delegate' | 'write' | 'read' | 'read_basic' | 'freebusy';
         };
+        /**
+         * SignAction
+         * @description Ask people to e-sign a document (``src/core/esign.py``). The step waits until every signer has signed (each
+         *     signs the document's latest version, so later signers counter-sign), then it is done with the signed version.
+         *     A signer who declines, or ``expires_after_hours`` passing, fails the step.
+         */
+        SignAction: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: 'sign';
+            /** Document */
+            document: string | components['schemas']['StepDocumentRef'];
+            /** Signers */
+            signers: components['schemas']['StepAssignee'][];
+            /** Message */
+            message?: string | null;
+            /** Expires After Hours */
+            expires_after_hours?: number | null;
+        };
         /** SignDocumentRequest */
         SignDocumentRequest: {
             signer: components['schemas']['SignerDetails'];
@@ -17261,11 +17312,13 @@ interface components {
          * 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, with what it approved). A step that declares ``fields`` checks
-         *     ``inputs`` against them. ``skip`` passes over a step so what waits for it can go on. ``send_back`` returns the
-         *     work to an earlier step (``to``, default the one this step waits for) with an optional ``note``: that step
-         *     and everything after it are open again, and an agent step runs again with the note.
+         *     ``complete`` finishes a form (``inputs`` merge into the run's inputs), an upload (``documents``: the files
+         *     added; without them, the files the person added while the step waited), a review (the approval: whoever
+         *     completes it is recorded, with what it approved), or an email draft step (the email was sent). A step that
+         *     declares ``fields`` checks ``inputs`` against them. ``skip`` passes over a step so what waits for it can go on.
+         *     ``send_back`` returns the work to an earlier step (``to``, default the one this step waits for) with an
+         *     optional ``note``: that step and everything after it are open again, and an agent step runs again with the
+         *     note. ``decline`` is a signer refusing a signature step (with an optional ``note``): the step fails.
          */
         StepActionRequest: {
             /** Step */
@@ -17274,7 +17327,7 @@ interface components {
              * Action
              * @enum {string}
              */
-            action: 'complete' | 'skip' | 'send_back';
+            action: 'complete' | 'skip' | 'send_back' | 'decline';
             /** Inputs */
             inputs?: {
                 [key: string]: unknown;
@@ -17283,6 +17336,8 @@ interface components {
             to?: string | null;
             /** Note */
             note?: string | null;
+            /** Documents */
+            documents?: string[] | null;
         };
         /**
          * StepAssignee
@@ -17307,6 +17362,22 @@ interface components {
             /** Project Lead */
             project_lead?: true | null;
         };
+        /**
+         * StepDocumentRef
+         * @description A document a step works on, named by where it comes from. Exactly one shape is set:
+         *
+         *     - ``step``: the document(s) an earlier step produced or was given (an upload step's files, an agent step's
+         *       drafts, a signature step's signed copy, a document edit step's new version);
+         *     - ``input``: the document(s) one of the run's inputs names (a document pick, or a ``doc-`` id).
+         *
+         *     A plain ``doc-`` id (optionally ``@v{n}``) names one document directly.
+         */
+        StepDocumentRef: {
+            /** Step */
+            step?: string | null;
+            /** Input */
+            input?: string | null;
+        };
         /**
          * StepField
          * @description One field a step asks for (the shape of a form step's fields): what ``complete`` checks its ``inputs``
@@ -17629,6 +17700,32 @@ interface components {
             /** Row Height */
             row_height?: number | null;
         };
+        /**
+         * TabularReviewAction
+         * @description Run AI review columns (tags with instructions) over documents: the annotation job of a Tabular Review. The
+         *     step is done when the job has finished; its output names the tags and documents, so a client opens the grid.
+         *     ``documents`` is a list of references, ``run_uploads`` (every file the run's upload steps took) or
+         *     ``workspace`` (every processed document in the workspace).
+         */
+        TabularReviewAction: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: 'tabular_review';
+            /** Tags */
+            tags: string[];
+            /**
+             * Documents
+             * @default run_uploads
+             */
+            documents: (string | components['schemas']['StepDocumentRef'])[] | ('run_uploads' | 'workspace');
+            /**
+             * Overwrite
+             * @default false
+             */
+            overwrite: boolean;
+        };
         /**
          * TagBreakdown
          * @description Spend/token breakdown keyed by tag value (e.g. wrk-xxx, usr-xxx).
@@ -17893,6 +17990,9 @@ interface components {
          *     ``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.
+         *     An agent step with ``edit_document`` edits that DOCX with tracked changes and saves it as a new version.
+         *     An ``action`` step uses a platform feature (``action``: e-signing, a mail draft, a tabular review): see
+         *     ``src/core/workflow_actions.py``.
          *     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).
          */
@@ -17905,7 +18005,7 @@ interface components {
              * Kind
              * @enum {string}
              */
-            kind: 'form' | 'upload' | 'agent' | 'review';
+            kind: 'form' | 'upload' | 'agent' | 'review' | 'action';
             /** After */
             after?: string[] | null;
             /** Skill */
@@ -17937,6 +18037,10 @@ interface components {
             remind_after_hours?: number | null;
             /** Fields */
             fields?: components['schemas']['StepField'][] | null;
+            /** Action */
+            action?: (components['schemas']['SignAction'] | components['schemas']['EmailDraftAction'] | components['schemas']['TabularReviewAction']) | null;
+            /** Edit Document */
+            edit_document?: string | components['schemas']['StepDocumentRef'] | null;
         };
         /**
          * TaskUpdateMessage

package/dist/index.d.ts

@@ -6336,7 +6336,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' | 'step_started' | 'step_done' | 'step_skipped' | 'step_failed' | 'step_signal' | 'step_ready' | 'step_reminded' | 'step_sent_back' | 'linked_run';
+        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' | 'step_signal' | 'step_ready' | 'step_reminded' | 'step_sent_back' | 'step_waiting' | 'step_progress' | 'linked_run';
         /**
          * ActivityResponse
          * @description One entry of ``GET /v1/conversation/{id}/activity``.
@@ -11369,6 +11369,36 @@ interface components {
              */
             skipped: components['schemas']['DriveSyncSkippedFile'][];
         };
+        /**
+         * EmailDraftAction
+         * @description Prepare a draft in native mail, in the mailbox of the step's assignee (else the run's owner). It is never
+         *     sent automatically: the person sends it, and the step is done when they say so or when the draft is sent.
+         *     ``to``, ``cc``, ``subject`` and ``body_template`` are templates over the run's inputs and earlier steps'
+         *     outputs (``{{field}}``, ``{{step_id.key}}``, ``{{step_id.answer}}``).
+         */
+        EmailDraftAction: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: 'email_draft';
+            /** To */
+            to?: string[];
+            /** Cc */
+            cc?: string[];
+            /**
+             * Subject
+             * @default
+             */
+            subject: string;
+            /**
+             * Body Template
+             * @default
+             */
+            body_template: string;
+            /** Attachments */
+            attachments?: (string | components['schemas']['StepDocumentRef'])[];
+        };
         /**
          * EmailNotificationSettings
          * @description Per-category email notification preferences. All default on; a master
@@ -16948,6 +16978,27 @@ interface components {
              */
             role: 'delegate' | 'write' | 'read' | 'read_basic' | 'freebusy';
         };
+        /**
+         * SignAction
+         * @description Ask people to e-sign a document (``src/core/esign.py``). The step waits until every signer has signed (each
+         *     signs the document's latest version, so later signers counter-sign), then it is done with the signed version.
+         *     A signer who declines, or ``expires_after_hours`` passing, fails the step.
+         */
+        SignAction: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: 'sign';
+            /** Document */
+            document: string | components['schemas']['StepDocumentRef'];
+            /** Signers */
+            signers: components['schemas']['StepAssignee'][];
+            /** Message */
+            message?: string | null;
+            /** Expires After Hours */
+            expires_after_hours?: number | null;
+        };
         /** SignDocumentRequest */
         SignDocumentRequest: {
             signer: components['schemas']['SignerDetails'];
@@ -17261,11 +17312,13 @@ interface components {
          * 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, with what it approved). A step that declares ``fields`` checks
-         *     ``inputs`` against them. ``skip`` passes over a step so what waits for it can go on. ``send_back`` returns the
-         *     work to an earlier step (``to``, default the one this step waits for) with an optional ``note``: that step
-         *     and everything after it are open again, and an agent step runs again with the note.
+         *     ``complete`` finishes a form (``inputs`` merge into the run's inputs), an upload (``documents``: the files
+         *     added; without them, the files the person added while the step waited), a review (the approval: whoever
+         *     completes it is recorded, with what it approved), or an email draft step (the email was sent). A step that
+         *     declares ``fields`` checks ``inputs`` against them. ``skip`` passes over a step so what waits for it can go on.
+         *     ``send_back`` returns the work to an earlier step (``to``, default the one this step waits for) with an
+         *     optional ``note``: that step and everything after it are open again, and an agent step runs again with the
+         *     note. ``decline`` is a signer refusing a signature step (with an optional ``note``): the step fails.
          */
         StepActionRequest: {
             /** Step */
@@ -17274,7 +17327,7 @@ interface components {
              * Action
              * @enum {string}
              */
-            action: 'complete' | 'skip' | 'send_back';
+            action: 'complete' | 'skip' | 'send_back' | 'decline';
             /** Inputs */
             inputs?: {
                 [key: string]: unknown;
@@ -17283,6 +17336,8 @@ interface components {
             to?: string | null;
             /** Note */
             note?: string | null;
+            /** Documents */
+            documents?: string[] | null;
         };
         /**
          * StepAssignee
@@ -17307,6 +17362,22 @@ interface components {
             /** Project Lead */
             project_lead?: true | null;
         };
+        /**
+         * StepDocumentRef
+         * @description A document a step works on, named by where it comes from. Exactly one shape is set:
+         *
+         *     - ``step``: the document(s) an earlier step produced or was given (an upload step's files, an agent step's
+         *       drafts, a signature step's signed copy, a document edit step's new version);
+         *     - ``input``: the document(s) one of the run's inputs names (a document pick, or a ``doc-`` id).
+         *
+         *     A plain ``doc-`` id (optionally ``@v{n}``) names one document directly.
+         */
+        StepDocumentRef: {
+            /** Step */
+            step?: string | null;
+            /** Input */
+            input?: string | null;
+        };
         /**
          * StepField
          * @description One field a step asks for (the shape of a form step's fields): what ``complete`` checks its ``inputs``
@@ -17629,6 +17700,32 @@ interface components {
             /** Row Height */
             row_height?: number | null;
         };
+        /**
+         * TabularReviewAction
+         * @description Run AI review columns (tags with instructions) over documents: the annotation job of a Tabular Review. The
+         *     step is done when the job has finished; its output names the tags and documents, so a client opens the grid.
+         *     ``documents`` is a list of references, ``run_uploads`` (every file the run's upload steps took) or
+         *     ``workspace`` (every processed document in the workspace).
+         */
+        TabularReviewAction: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: 'tabular_review';
+            /** Tags */
+            tags: string[];
+            /**
+             * Documents
+             * @default run_uploads
+             */
+            documents: (string | components['schemas']['StepDocumentRef'])[] | ('run_uploads' | 'workspace');
+            /**
+             * Overwrite
+             * @default false
+             */
+            overwrite: boolean;
+        };
         /**
          * TagBreakdown
          * @description Spend/token breakdown keyed by tag value (e.g. wrk-xxx, usr-xxx).
@@ -17893,6 +17990,9 @@ interface components {
          *     ``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.
+         *     An agent step with ``edit_document`` edits that DOCX with tracked changes and saves it as a new version.
+         *     An ``action`` step uses a platform feature (``action``: e-signing, a mail draft, a tabular review): see
+         *     ``src/core/workflow_actions.py``.
          *     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).
          */
@@ -17905,7 +18005,7 @@ interface components {
              * Kind
              * @enum {string}
              */
-            kind: 'form' | 'upload' | 'agent' | 'review';
+            kind: 'form' | 'upload' | 'agent' | 'review' | 'action';
             /** After */
             after?: string[] | null;
             /** Skill */
@@ -17937,6 +18037,10 @@ interface components {
             remind_after_hours?: number | null;
             /** Fields */
             fields?: components['schemas']['StepField'][] | null;
+            /** Action */
+            action?: (components['schemas']['SignAction'] | components['schemas']['EmailDraftAction'] | components['schemas']['TabularReviewAction']) | null;
+            /** Edit Document */
+            edit_document?: string | components['schemas']['StepDocumentRef'] | null;
         };
         /**
          * TaskUpdateMessage

package/package.json

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