@arbidocs/client 0.4.57 → 0.4.59

package/dist/index.d.cts

@@ -1093,7 +1093,10 @@ interface paths {
         };
         get?: never;
         put?: never;
-        /** Create Docx Note */
+        /**
+         * Create Docx Note
+         * @description Store a DOCX note: a new document, or (``version_of``) the next version of an editable one.
+         */
         post: operations['create_docx_note_v1_editor_notes_post'];
         delete?: never;
         options?: never;
@@ -1144,7 +1147,13 @@ interface paths {
         };
         get?: never;
         put?: never;
-        /** Create Word Redline */
+        /**
+         * Create Word Redline
+         * @description Compare two documents into a NEW redline document (base -> revised).
+         *
+         *     Without ``base_ext_id`` the base is the revised document's previous version.
+         *     The redline records both inputs as provenance and is shared only if both are.
+         */
         post: operations['create_word_redline_v1_editor_redline_post'];
         delete?: never;
         options?: never;
@@ -1227,6 +1236,10 @@ interface paths {
         /**
          * Delete Documents
          * @description Delete one or more documents.
+         *
+         *     A document is deleted with all its versions (any version's id names it), and an
+         *     email with its attachments (an archive with its messages). In-flight processing
+         *     is cancelled so a deleted row does not pop back into the Processing tab.
          */
         delete: operations['delete_documents'];
         options?: never;
@@ -1251,6 +1264,29 @@ interface paths {
         patch: operations['update_documents'];
         trace?: never;
     };
+    '/v1/document/{document_ext_id}/versions': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List Document Versions
+         * @description Every version of the document ``document_ext_id`` belongs to (any version's id), oldest first.
+         *
+         *     ``is_current`` marks the current one. Lists and search show only current
+         *     versions; this is how older ones are reached.
+         */
+        get: operations['list_document_versions'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/v1/document/doctag': {
         parameters: {
             query?: never;
@@ -1297,8 +1333,9 @@ interface paths {
          *     - For file uploads: standard multipart form with files
          *     - For artifacts/content: create a file from text content on the client side
          *
-         *     Optional parameters for version tracking and document typing:
-         *     - parent_ext_id: Links new document as child of parent (version chain)
+         *     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)
          *     - 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')
@@ -5685,10 +5722,10 @@ interface components {
              */
             version: number;
             /**
-             * Parent Doc Ext Id
+             * Version Of
              * @description Document this artifact updates; it is saved as the next version in that document's chain
              */
-            parent_doc_ext_id?: string | null;
+            version_of?: string | null;
             /**
              * Message Ext Id
              * @description External ID of the assistant message that generated this artifact
@@ -7321,6 +7358,15 @@ interface components {
             /** External Ids */
             external_ids: string[];
         };
+        /**
+         * DerivedFrom
+         * @description One provenance link of a document: it was made from ``doc_ext_id`` as ``role``.
+         */
+        DerivedFrom: {
+            /** Doc Ext Id */
+            doc_ext_id: string;
+            role: components['schemas']['DocRelationRole'];
+        };
         /**
          * DmAttachmentUploadResponse
          * @description An uploaded, client-encrypted DM attachment blob.
@@ -7347,6 +7393,12 @@ interface components {
             /** Title */
             title?: string | null;
         };
+        /**
+         * DocRelationRole
+         * @description How ``from_doc`` was derived from ``to_doc`` (provenance only, no behaviour).
+         * @enum {string}
+         */
+        DocRelationRole: 'edit' | 'sync' | 'crop' | 'redline_base' | 'redline_revised';
         /** DocResponse */
         DocResponse: {
             /** External Id */
@@ -7385,6 +7437,25 @@ interface components {
             config_ext_id?: string | null;
             /** Parent Ext Id */
             parent_ext_id?: string | null;
+            /** Lineage Id */
+            lineage_id?: string | null;
+            /**
+             * Version Number
+             * @default 1
+             */
+            version_number: number;
+            /**
+             * Is Current
+             * @default true
+             */
+            is_current: boolean;
+            /** Thread Id */
+            thread_id?: string | null;
+            /**
+             * Derived From
+             * @default []
+             */
+            derived_from: components['schemas']['DerivedFrom'][];
             /** Source Message Ext Id */
             source_message_ext_id?: string | null;
             /** Conversation Ext Id */
@@ -13004,8 +13075,11 @@ interface components {
             shared: boolean;
             /** Config Ext Id */
             config_ext_id?: string | null;
-            /** Parent Ext Id */
-            parent_ext_id?: string | null;
+            /**
+             * Version Of
+             * @description Upload as the next version of this document (any of its versions)
+             */
+            version_of?: string | null;
             /** Wp Type */
             wp_type?: string | null;
             /** Tag Ext Id */
@@ -15620,7 +15694,7 @@ interface operations {
         parameters: {
             query?: {
                 title?: string;
-                parent_ext_id?: string | null;
+                version_of?: string | null;
             };
             header?: never;
             path?: never;
@@ -15913,6 +15987,37 @@ interface operations {
             };
         };
     };
+    list_document_versions: {
+        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']['DocResponse'][];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['HTTPValidationError'];
+                };
+            };
+        };
+    };
     create_doctags: {
         parameters: {
             query?: never;
@@ -16017,8 +16122,12 @@ interface operations {
                 shared?: boolean;
                 /** @description Configuration to use for processing */
                 config_ext_id?: string | null;
-                /** @description Parent document ID for version tracking */
-                parent_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 How it was made from `derived_from` */
+                derived_role?: ('crop' | 'redline_base' | 'redline_revised') | null;
                 /** @description Work product type: source, skill, memory, artifact */
                 wp_type?: string | null;
                 /** @description Tag to link the document to */

package/dist/index.d.ts

@@ -1093,7 +1093,10 @@ interface paths {
         };
         get?: never;
         put?: never;
-        /** Create Docx Note */
+        /**
+         * Create Docx Note
+         * @description Store a DOCX note: a new document, or (``version_of``) the next version of an editable one.
+         */
         post: operations['create_docx_note_v1_editor_notes_post'];
         delete?: never;
         options?: never;
@@ -1144,7 +1147,13 @@ interface paths {
         };
         get?: never;
         put?: never;
-        /** Create Word Redline */
+        /**
+         * Create Word Redline
+         * @description Compare two documents into a NEW redline document (base -> revised).
+         *
+         *     Without ``base_ext_id`` the base is the revised document's previous version.
+         *     The redline records both inputs as provenance and is shared only if both are.
+         */
         post: operations['create_word_redline_v1_editor_redline_post'];
         delete?: never;
         options?: never;
@@ -1227,6 +1236,10 @@ interface paths {
         /**
          * Delete Documents
          * @description Delete one or more documents.
+         *
+         *     A document is deleted with all its versions (any version's id names it), and an
+         *     email with its attachments (an archive with its messages). In-flight processing
+         *     is cancelled so a deleted row does not pop back into the Processing tab.
          */
         delete: operations['delete_documents'];
         options?: never;
@@ -1251,6 +1264,29 @@ interface paths {
         patch: operations['update_documents'];
         trace?: never;
     };
+    '/v1/document/{document_ext_id}/versions': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List Document Versions
+         * @description Every version of the document ``document_ext_id`` belongs to (any version's id), oldest first.
+         *
+         *     ``is_current`` marks the current one. Lists and search show only current
+         *     versions; this is how older ones are reached.
+         */
+        get: operations['list_document_versions'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/v1/document/doctag': {
         parameters: {
             query?: never;
@@ -1297,8 +1333,9 @@ interface paths {
          *     - For file uploads: standard multipart form with files
          *     - For artifacts/content: create a file from text content on the client side
          *
-         *     Optional parameters for version tracking and document typing:
-         *     - parent_ext_id: Links new document as child of parent (version chain)
+         *     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)
          *     - 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')
@@ -5685,10 +5722,10 @@ interface components {
              */
             version: number;
             /**
-             * Parent Doc Ext Id
+             * Version Of
              * @description Document this artifact updates; it is saved as the next version in that document's chain
              */
-            parent_doc_ext_id?: string | null;
+            version_of?: string | null;
             /**
              * Message Ext Id
              * @description External ID of the assistant message that generated this artifact
@@ -7321,6 +7358,15 @@ interface components {
             /** External Ids */
             external_ids: string[];
         };
+        /**
+         * DerivedFrom
+         * @description One provenance link of a document: it was made from ``doc_ext_id`` as ``role``.
+         */
+        DerivedFrom: {
+            /** Doc Ext Id */
+            doc_ext_id: string;
+            role: components['schemas']['DocRelationRole'];
+        };
         /**
          * DmAttachmentUploadResponse
          * @description An uploaded, client-encrypted DM attachment blob.
@@ -7347,6 +7393,12 @@ interface components {
             /** Title */
             title?: string | null;
         };
+        /**
+         * DocRelationRole
+         * @description How ``from_doc`` was derived from ``to_doc`` (provenance only, no behaviour).
+         * @enum {string}
+         */
+        DocRelationRole: 'edit' | 'sync' | 'crop' | 'redline_base' | 'redline_revised';
         /** DocResponse */
         DocResponse: {
             /** External Id */
@@ -7385,6 +7437,25 @@ interface components {
             config_ext_id?: string | null;
             /** Parent Ext Id */
             parent_ext_id?: string | null;
+            /** Lineage Id */
+            lineage_id?: string | null;
+            /**
+             * Version Number
+             * @default 1
+             */
+            version_number: number;
+            /**
+             * Is Current
+             * @default true
+             */
+            is_current: boolean;
+            /** Thread Id */
+            thread_id?: string | null;
+            /**
+             * Derived From
+             * @default []
+             */
+            derived_from: components['schemas']['DerivedFrom'][];
             /** Source Message Ext Id */
             source_message_ext_id?: string | null;
             /** Conversation Ext Id */
@@ -13004,8 +13075,11 @@ interface components {
             shared: boolean;
             /** Config Ext Id */
             config_ext_id?: string | null;
-            /** Parent Ext Id */
-            parent_ext_id?: string | null;
+            /**
+             * Version Of
+             * @description Upload as the next version of this document (any of its versions)
+             */
+            version_of?: string | null;
             /** Wp Type */
             wp_type?: string | null;
             /** Tag Ext Id */
@@ -15620,7 +15694,7 @@ interface operations {
         parameters: {
             query?: {
                 title?: string;
-                parent_ext_id?: string | null;
+                version_of?: string | null;
             };
             header?: never;
             path?: never;
@@ -15913,6 +15987,37 @@ interface operations {
             };
         };
     };
+    list_document_versions: {
+        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']['DocResponse'][];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['HTTPValidationError'];
+                };
+            };
+        };
+    };
     create_doctags: {
         parameters: {
             query?: never;
@@ -16017,8 +16122,12 @@ interface operations {
                 shared?: boolean;
                 /** @description Configuration to use for processing */
                 config_ext_id?: string | null;
-                /** @description Parent document ID for version tracking */
-                parent_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 How it was made from `derived_from` */
+                derived_role?: ('crop' | 'redline_base' | 'redline_revised') | null;
                 /** @description Work product type: source, skill, memory, artifact */
                 wp_type?: string | null;
                 /** @description Tag to link the document to */

package/package.json

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