@arbidocs/client 0.4.59 → 0.4.61

package/dist/index.d.cts

@@ -4323,6 +4323,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;
+    };
 }
 type webhooks = Record<string, never>;
 interface components {
@@ -14090,6 +14150,148 @@ 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;
@@ -20784,6 +20986,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'];
+                };
+            };
+        };
+    };
 }
 
 /**

package/dist/index.d.ts

@@ -4323,6 +4323,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;
+    };
 }
 type webhooks = Record<string, never>;
 interface components {
@@ -14090,6 +14150,148 @@ 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;
@@ -20784,6 +20986,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'];
+                };
+            };
+        };
+    };
 }
 
 /**

package/package.json

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