@arbidocs/client 0.4.60 → 0.4.62

package/dist/index.d.ts

@@ -1335,7 +1335,8 @@ interface paths {
          *
          *     Optional parameters for versions, provenance and document typing:
          *     - version_of: Saves the file as the next version of that document
-         *     - derived_from + derived_role: Records that the new document was made from another (a crop)
+         *     - derived_from + derived_role: Records that the new document was made from another (a crop, a
+         *       redacted or annotated copy) or, with derived_from repeated, from several (a production set)
          *     - wp_type: Document type (source, skill, memory, artifact). Defaults to 'source'.
          *     - tag_ext_id: Links document to a tag
          *     - folder: Logical folder path for grouping (URL safe, e.g., 'skills/weather')
@@ -1582,6 +1583,66 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    '/v1/document/{document_ext_id}/sign/prepare': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Prepare Document Signature
+         * @description Return the exact statement the signer's key must sign, and the hash of the PDF they are shown.
+         */
+        post: operations['prepare_document_signature'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/v1/document/{document_ext_id}/sign': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Sign Document
+         * @description Sign a document: verify the signer's statement, seal a signed copy, save it as a new child document.
+         */
+        post: operations['sign_document'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/v1/document/{document_ext_id}/signatures': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get Document Signature Status
+         * @description Is this document a signed copy, and is it unchanged since signing? Read from the PDF itself.
+         */
+        get: operations['get_document_signature_status'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/v1/conversation/list': {
         parameters: {
             query?: never;
@@ -4323,66 +4384,6 @@ interface paths {
         patch?: never;
         trace?: never;
     };
-    '/v1/document/{document_ext_id}/sign/prepare': {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        /**
-         * Prepare Document Signature
-         * @description Return the exact statement the signer's key must sign, and the hash of the PDF they are shown.
-         */
-        post: operations['prepare_document_signature'];
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    '/v1/document/{document_ext_id}/sign': {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        /**
-         * Sign Document
-         * @description Sign a document: verify the signer's statement, seal a signed copy, save it as a new child document.
-         */
-        post: operations['sign_document'];
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    '/v1/document/{document_ext_id}/signatures': {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * Get Document Signature Status
-         * @description Is this document a signed copy, and is it unchanged since signing? Read from the PDF itself.
-         */
-        get: operations['get_document_signature_status'];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
 }
 type webhooks = Record<string, never>;
 interface components {
@@ -7458,7 +7459,7 @@ interface components {
          * @description How ``from_doc`` was derived from ``to_doc`` (provenance only, no behaviour).
          * @enum {string}
          */
-        DocRelationRole: 'edit' | 'sync' | 'crop' | 'redline_base' | 'redline_revised';
+        DocRelationRole: 'edit' | 'sync' | 'crop' | 'redline_base' | 'redline_revised' | 'redaction' | 'annotated' | 'production';
         /** DocResponse */
         DocResponse: {
             /** External Id */
@@ -10232,6 +10233,32 @@ interface components {
              */
             content: string;
         };
+        /** PrepareSignatureRequest */
+        PrepareSignatureRequest: {
+            signer: components['schemas']['SignerDetails'];
+            /** @description Omit for the bottom of the last page */
+            appearance?: components['schemas']['SignatureAppearance'] | null;
+        };
+        /** PrepareSignatureResponse */
+        PrepareSignatureResponse: {
+            /**
+             * Statement
+             * @description The exact text to sign with the user's Ed25519 key
+             */
+            statement: string;
+            /**
+             * Intent
+             * @description The statement of intent shown to the signer
+             */
+            intent: string;
+            /**
+             * Source Sha256
+             * @description SHA-256 of the PDF the signer is shown (the /view rendition)
+             */
+            source_sha256: string;
+            /** Timestamp */
+            timestamp: number;
+        };
         /**
          * PresenceUpdateMessage
          * @description Sent when a contact's online status changes or is no longer tracked.
@@ -12130,78 +12157,209 @@ interface components {
             /** Auto Sync Workspace Ext Id */
             auto_sync_workspace_ext_id?: string | null;
         };
+        /** SignDocumentRequest */
+        SignDocumentRequest: {
+            signer: components['schemas']['SignerDetails'];
+            /** @description Omit for the bottom of the last page */
+            appearance?: components['schemas']['SignatureAppearance'] | null;
+            /** Timestamp */
+            timestamp: number;
+            /**
+             * Signature
+             * @description Ed25519 signature (base64) of the prepared statement
+             */
+            signature: string;
+        };
+        /** SignDocumentResponse */
+        SignDocumentResponse: {
+            /** Signed Doc Ext Id */
+            signed_doc_ext_id: string;
+            signature: components['schemas']['SignatureRecord'];
+        };
         /**
-         * SkillSummaryResponse
-         * @description One row of ``GET /v1/assistant/skills``.
-         *
-         *     Lightweight projection — never includes the SKILL.md body. Clients
-         *     use this to populate slash-command autocomplete (name / description
-         *     / arg_hint) and to know which doc to fetch when the user wants to
-         *     inspect the full source via ``GET /v1/document/.../parsed-content``.
+         * SignatureAppearance
+         * @description Where the visible signature goes. Coordinates are fractions of the page, origin top-left.
          */
-        SkillSummaryResponse: {
+        SignatureAppearance: {
             /**
-             * Name
-             * @description Skill display name (frontmatter ``name``, falls back to slug)
+             * Page
+             * @description 0-based page index; negative counts from the end (-1 = last page)
+             * @default -1
              */
-            name: string;
+            page: number;
             /**
-             * Slug
-             * @description Folder-safe identifier used by ``/<slug>`` slash invocation
+             * X
+             * @default 0.08
              */
-            slug: string;
+            x: number;
             /**
-             * Description
-             * @description One-line description from frontmatter
-             * @default
+             * Y
+             * @default 0.8
              */
-            description: string;
+            y: number;
             /**
-             * User Invocable
-             * @description Whether the skill appears in slash menus
-             * @default true
+             * Width
+             * @default 0.4
              */
-            user_invocable: boolean;
+            width: number;
             /**
-             * Arg Hint
-             * @description Optional args hint (e.g. ``"<env> [--dry-run]"``)
-             * @default
+             * Height
+             * @default 0.1
              */
-            arg_hint: string;
+            height: number;
+        };
+        /** SignatureRecord */
+        SignatureRecord: {
+            /** Reference */
+            reference: string;
+            /** Signer Email */
+            signer_email: string;
+            /** Intent */
+            intent: string;
             /**
-             * Skill Type
-             * @description ``markdown`` | ``python`` | ``shell`` | ``javascript`` | ``typescript``
-             * @default markdown
+             * Source Doc Ext Id
+             * @description The document that was signed
              */
-            skill_type: string;
+            source_doc_ext_id: string;
+            /** Source Sha256 */
+            source_sha256: string;
             /**
-             * Workspace Ext Id
-             * @description External ID of the workspace the skill lives in
+             * Signed At
+             * Format: date-time
              */
-            workspace_ext_id: string;
+            signed_at: string;
             /**
-             * Doc Ext Id
-             * @description External ID of the SKILL.md doc (use for /parsed-content)
+             * Statement Valid
+             * @description The signer's Ed25519 signature over the statement verifies
              */
-            doc_ext_id: string;
+            statement_valid: boolean;
             /**
-             * Updated At
-             * Format: date-time
-             * @description Last modification time of the main file
+             * Signer Name
+             * @description The name the signer signed as
              */
-            updated_at: string;
+            signer_name?: string | null;
             /**
-             * Visibility
-             * @description ``mine`` (private to the caller) or ``global`` (shared into the marketplace)
-             * @default mine
+             * Capacity
+             * @description The signer's role, e.g. 'Partner'
              */
-            visibility: string;
+            capacity?: string | null;
             /**
-             * Is Owner
-             * @description Whether the caller owns the skill (gates edit/publish/unpublish in the UI)
-             * @default true
+             * On Behalf Of
+             * @description Who the signer signed for, e.g. a firm
              */
-            is_owner: boolean;
+            on_behalf_of?: string | null;
+        };
+        /** SignatureStatusResponse */
+        SignatureStatusResponse: {
+            /**
+             * Signed
+             * @description This document is a PDF signed and sealed by ARBI
+             */
+            signed: boolean;
+            /**
+             * Intact
+             * @description The seal verifies: nothing changed since signing
+             */
+            intact: boolean;
+            /**
+             * Timestamped
+             * @description The seal carries an RFC 3161 timestamp
+             * @default false
+             */
+            timestamped: boolean;
+            /**
+             * Signatures
+             * @default []
+             */
+            signatures: components['schemas']['SignatureRecord'][];
+        };
+        /** SignerDetails */
+        SignerDetails: {
+            /** Name */
+            name: string;
+            /**
+             * Capacity
+             * @description e.g. 'Partner', 'Solicitor'
+             */
+            capacity?: string | null;
+            /**
+             * On Behalf Of
+             * @description e.g. the firm's name
+             */
+            on_behalf_of?: string | null;
+        };
+        /**
+         * SkillSummaryResponse
+         * @description One row of ``GET /v1/assistant/skills``.
+         *
+         *     Lightweight projection — never includes the SKILL.md body. Clients
+         *     use this to populate slash-command autocomplete (name / description
+         *     / arg_hint) and to know which doc to fetch when the user wants to
+         *     inspect the full source via ``GET /v1/document/.../parsed-content``.
+         */
+        SkillSummaryResponse: {
+            /**
+             * Name
+             * @description Skill display name (frontmatter ``name``, falls back to slug)
+             */
+            name: string;
+            /**
+             * Slug
+             * @description Folder-safe identifier used by ``/<slug>`` slash invocation
+             */
+            slug: string;
+            /**
+             * Description
+             * @description One-line description from frontmatter
+             * @default
+             */
+            description: string;
+            /**
+             * User Invocable
+             * @description Whether the skill appears in slash menus
+             * @default true
+             */
+            user_invocable: boolean;
+            /**
+             * Arg Hint
+             * @description Optional args hint (e.g. ``"<env> [--dry-run]"``)
+             * @default
+             */
+            arg_hint: string;
+            /**
+             * Skill Type
+             * @description ``markdown`` | ``python`` | ``shell`` | ``javascript`` | ``typescript``
+             * @default markdown
+             */
+            skill_type: string;
+            /**
+             * Workspace Ext Id
+             * @description External ID of the workspace the skill lives in
+             */
+            workspace_ext_id: string;
+            /**
+             * Doc Ext Id
+             * @description External ID of the SKILL.md doc (use for /parsed-content)
+             */
+            doc_ext_id: string;
+            /**
+             * Updated At
+             * Format: date-time
+             * @description Last modification time of the main file
+             */
+            updated_at: string;
+            /**
+             * Visibility
+             * @description ``mine`` (private to the caller) or ``global`` (shared into the marketplace)
+             * @default mine
+             */
+            visibility: string;
+            /**
+             * Is Owner
+             * @description Whether the caller owns the skill (gates edit/publish/unpublish in the UI)
+             * @default true
+             */
+            is_owner: boolean;
         };
         /**
          * SkillsListResponse
@@ -14150,148 +14308,6 @@ interface components {
          * @enum {string}
          */
         src__models__workflow__AuthMode: 'run_now_temp' | 'scheduled_require_auth' | 'scheduled_permanent';
-        /** PrepareSignatureRequest */
-        PrepareSignatureRequest: {
-            signer: components['schemas']['SignerDetails'];
-            /** @description Omit for the bottom of the last page */
-            appearance?: components['schemas']['SignatureAppearance'] | null;
-        };
-        /** PrepareSignatureResponse */
-        PrepareSignatureResponse: {
-            /**
-             * Statement
-             * @description The exact text to sign with the user's Ed25519 key
-             */
-            statement: string;
-            /**
-             * Intent
-             * @description The statement of intent shown to the signer
-             */
-            intent: string;
-            /**
-             * Source Sha256
-             * @description SHA-256 of the PDF the signer is shown (the /view rendition)
-             */
-            source_sha256: string;
-            /** Timestamp */
-            timestamp: number;
-        };
-        /** SignDocumentRequest */
-        SignDocumentRequest: {
-            signer: components['schemas']['SignerDetails'];
-            /** @description Omit for the bottom of the last page */
-            appearance?: components['schemas']['SignatureAppearance'] | null;
-            /** Timestamp */
-            timestamp: number;
-            /**
-             * Signature
-             * @description Ed25519 signature (base64) of the prepared statement
-             */
-            signature: string;
-        };
-        /** SignDocumentResponse */
-        SignDocumentResponse: {
-            /** Signed Doc Ext Id */
-            signed_doc_ext_id: string;
-            signature: components['schemas']['SignatureRecord'];
-        };
-        /**
-         * SignatureAppearance
-         * @description Where the visible signature goes. Coordinates are fractions of the page, origin top-left.
-         */
-        SignatureAppearance: {
-            /**
-             * Page
-             * @description 0-based page index; negative counts from the end (-1 = last page)
-             * @default -1
-             */
-            page: number;
-            /**
-             * X
-             * @default 0.08
-             */
-            x: number;
-            /**
-             * Y
-             * @default 0.8
-             */
-            y: number;
-            /**
-             * Width
-             * @default 0.4
-             */
-            width: number;
-            /**
-             * Height
-             * @default 0.1
-             */
-            height: number;
-        };
-        /** SignerDetails */
-        SignerDetails: {
-            /** Name */
-            name: string;
-            /**
-             * Capacity
-             * @description e.g. 'Partner', 'Solicitor'
-             */
-            capacity?: string | null;
-            /**
-             * On Behalf Of
-             * @description e.g. the firm's name
-             */
-            on_behalf_of?: string | null;
-        };
-        /** SignatureRecord */
-        SignatureRecord: {
-            /** Reference */
-            reference: string;
-            /** Signer Email */
-            signer_email: string;
-            /** Intent */
-            intent: string;
-            /**
-             * Source Doc Ext Id
-             * @description The document that was signed
-             */
-            source_doc_ext_id: string;
-            /** Source Sha256 */
-            source_sha256: string;
-            /**
-             * Signed At
-             * Format: date-time
-             */
-            signed_at: string;
-            /**
-             * Statement Valid
-             * @description The signer's Ed25519 signature over the statement verifies
-             */
-            statement_valid: boolean;
-        };
-        /** SignatureStatusResponse */
-        SignatureStatusResponse: {
-            /**
-             * Signed
-             * @description This document is a PDF signed and sealed by ARBI
-             */
-            signed: boolean;
-            /**
-             * Intact
-             * @description The seal verifies: nothing changed since signing
-             */
-            intact: boolean;
-            /**
-             * Timestamped
-             * @description The seal carries an RFC 3161 timestamp
-             * @default false
-             */
-            timestamped: boolean;
-            /**
-             * Signatures
-             * @default []
-             */
-            signatures: components['schemas']['SignatureRecord'][];
-        };
     };
     responses: never;
     parameters: never;
@@ -16326,10 +16342,10 @@ interface operations {
                 config_ext_id?: string | null;
                 /** @description Upload a single file as the next version of this document (any of its versions). It becomes the current version and takes the document's sharing, folder and labels. */
                 version_of?: string | null;
-                /** @description A new, separate document made from this one (e.g. a crop); recorded as provenance only */
-                derived_from?: string | null;
+                /** @description A new, separate document made from this one (a crop, a redacted copy) or, repeated, from several (a production set); recorded as provenance only */
+                derived_from?: string[] | null;
                 /** @description How it was made from `derived_from` */
-                derived_role?: ('crop' | 'redline_base' | 'redline_revised') | null;
+                derived_role?: ('crop' | 'redline_base' | 'redline_revised' | 'redaction' | 'annotated' | 'production') | null;
                 /** @description Work product type: source, skill, memory, artifact */
                 wp_type?: string | null;
                 /** @description Tag to link the document to */
@@ -16668,6 +16684,107 @@ interface operations {
             };
         };
     };
+    prepare_document_signature: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                document_ext_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': components['schemas']['PrepareSignatureRequest'];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['PrepareSignatureResponse'];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['HTTPValidationError'];
+                };
+            };
+        };
+    };
+    sign_document: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                document_ext_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': components['schemas']['SignDocumentRequest'];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['SignDocumentResponse'];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['HTTPValidationError'];
+                };
+            };
+        };
+    };
+    get_document_signature_status: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                document_ext_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['SignatureStatusResponse'];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['HTTPValidationError'];
+                };
+            };
+        };
+    };
     list_conversations: {
         parameters: {
             query?: never;
@@ -20986,107 +21103,6 @@ interface operations {
             };
         };
     };
-    prepare_document_signature: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                document_ext_id: string;
-            };
-            cookie?: never;
-        };
-        requestBody: {
-            content: {
-                'application/json': components['schemas']['PrepareSignatureRequest'];
-            };
-        };
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/json': components['schemas']['PrepareSignatureResponse'];
-                };
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/json': components['schemas']['HTTPValidationError'];
-                };
-            };
-        };
-    };
-    sign_document: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                document_ext_id: string;
-            };
-            cookie?: never;
-        };
-        requestBody: {
-            content: {
-                'application/json': components['schemas']['SignDocumentRequest'];
-            };
-        };
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/json': components['schemas']['SignDocumentResponse'];
-                };
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/json': components['schemas']['HTTPValidationError'];
-                };
-            };
-        };
-    };
-    get_document_signature_status: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                document_ext_id: string;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/json': components['schemas']['SignatureStatusResponse'];
-                };
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/json': components['schemas']['HTTPValidationError'];
-                };
-            };
-        };
-    };
 }
 
 /**