@arbidocs/client 0.4.147 → 0.4.148

package/dist/index.d.cts

@@ -1194,10 +1194,11 @@ interface paths {
         };
         /**
          * List Storage Projects
-         * @description Storage used by each project: everything it pays for (trash included, until purged) against its limit, by
-         *     kind (document, version, derived, coedit, mail, mail_draft, chat_attachment, recording, other), with the trash
-         *     part, and — for a personal project — its mail by folder. ``scope=deployment`` adds the deployment's totals
-         *     against the Box licence.
+         * @description Storage used by each project: everything it stores, by kind (document, version, derived, coedit, mail,
+         *     mail_draft, chat_attachment, recording, other), split into live, archived (archived workspaces) and trash
+         *     (deleted, until purged), and what counts against its limit (``billable_bytes``: live in full, archived and trash
+         *     at ``reduced_rate``) — for a personal project also its mail by folder. ``scope=deployment`` adds the
+         *     deployment's totals against the Box licence.
          */
         get: operations['list_storage_projects'];
         put?: never;
@@ -1611,6 +1612,9 @@ interface paths {
          * Restore Workspaces
          * @description Restore deleted workspaces (from Recently deleted) exactly as they were. Their owner only; returns the
          *     workspaces restored. A workspace whose project was deleted cannot come back.
+         *
+         *     Its files were moved to the archive tier while it was deleted: it comes back closed (``archive`` status
+         *     ``restoring``, like an unarchive) until they are back, then opens by itself. Its search index was kept.
          */
         post: operations['restore_workspaces'];
         delete?: never;
@@ -1828,6 +1832,55 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    '/v1/workspace/{workspace_ext_id}/archive': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get Workspace Archive
+         * @description The workspace's archive state, its bytes in each storage tier and, while it is archived, the estimate of
+         *     what unarchiving costs (documents to re-index, minutes, £ of AI usage).
+         */
+        get: operations['get_workspace_archive'];
+        put?: never;
+        /**
+         * Archive Workspace
+         * @description Archive the workspace: nobody can open it until it is unarchived, its files move to the archive tier (they
+         *     count at 10% against storage) and its search index is deleted. 409 when this deployment has no archive tier.
+         */
+        post: operations['archive_workspace'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/v1/workspace/{workspace_ext_id}/unarchive': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Unarchive Workspace
+         * @description Unarchive the workspace: its files come back and every document is re-indexed from its stored parse output
+         *     (AI usage, billed to the project: checked first — 402 when the budget can't cover it). It stays closed, status
+         *     ``restoring`` with progress, until that is done. Needs the workspace key on the session (409
+         *     ``workspace_key_required``: deposit it with ``/prime-key`` and retry).
+         */
+        post: operations['unarchive_workspace'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/v1/editor/{document_id}/mentions': {
         parameters: {
             query?: never;
@@ -2558,7 +2611,9 @@ interface paths {
         /**
          * Restore Documents
          * @description Restore deleted documents (with whatever was deleted together with them: versions' family, an email's
-         *     attachments). They are re-indexed in the background from their stored parse output, then searchable again.
+         *     attachments). Their files are copied back from the archive tier first — meanwhile they are listed as
+         *     ``restoring`` — then they reappear and are re-indexed in the background from their stored parse output.
+         *     Returns the documents being restored.
          */
         post: operations['restore_documents'];
         delete?: never;
@@ -6098,68 +6153,6 @@ interface paths {
         patch?: never;
         trace?: never;
     };
-    '/v1/calendar/app-passwords': {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /** List App Passwords */
-        get: operations['list_calendar_app_passwords'];
-        put?: never;
-        /**
-         * Create App Password
-         * @description An app-specific password for CalDAV / CardDAV clients (Apple Calendar, Thunderbird, DAVx5, eM Client). It
-         *     can read only the calendars it was created for; revoke it per device.
-         */
-        post: operations['create_calendar_app_password'];
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    '/v1/calendar/feeds': {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        /**
-         * Create Feed
-         * @description A secret read-only ICS URL to subscribe to from Outlook, Google or Apple (full details or free/busy only).
-         */
-        post: operations['create_calendar_feed'];
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    '/v1/calendar/app-passwords/{apw_id}': {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        post?: never;
-        /**
-         * Revoke App Password
-         * @description Revoke an app password or a feed URL (its key wraps are deleted).
-         */
-        delete: operations['revoke_calendar_app_password'];
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     '/v1/calendar/booking-pages': {
         parameters: {
             query?: never;
@@ -6261,7 +6254,9 @@ interface paths {
          * Create Contact
          * @description Create a contact. ``card`` alone (or ``email`` without ``invite``) makes an encrypted card in the default
          *     address book. ``invite=true`` links ``email`` (sending the platform invitation when it is not registered yet,
-         *     with the ``invite_contacts`` outcomes) and stores ``card`` on that contact when given.
+         *     with the ``invite_contacts`` outcomes) and stores ``card`` on that contact when given. One person = one row:
+         *     a card with an address another contact already has is refused with 409 ``{detail, contact_id}``; inviting an
+         *     address that is on a card links that card.
          */
         post: operations['create_contact'];
         delete?: never;
@@ -6300,7 +6295,9 @@ interface paths {
         };
         /**
          * Search Contacts
-         * @description Picker / attendee autocomplete: your contacts and registered people who share a workspace with you.
+         * @description Picker / attendee autocomplete — the one people source: the contacts of every address book you can see
+         *     (yours, and books shared with you; ``address_book_ext_id`` says which) and registered people who share a
+         *     workspace with you. One entry per address.
          */
         get: operations['search_contacts'];
         put?: never;
@@ -6323,7 +6320,7 @@ interface paths {
         post?: never;
         /**
          * Delete Contact
-         * @description Delete a contact (a CardDAV tombstone). A still-pending invite that also shared a workspace gives up its
+         * @description Delete a contact (a tombstone). A still-pending invite that also shared a workspace gives up its
          *     pending grant now, rather than leaving it to expire: the invite is gone, in full.
          */
         delete: operations['delete_contact'];
@@ -9320,76 +9317,6 @@ interface components {
              */
             last_input_tokens: number;
         };
-        /** AppPasswordCreate */
-        AppPasswordCreate: {
-            /**
-             * Label
-             * @description Device name, e.g. 'iPhone'
-             */
-            label: string;
-            /**
-             * Calendar Ids
-             * @description cal- ids to expose; default: every calendar you can read
-             */
-            calendar_ids?: string[] | null;
-        };
-        /**
-         * AppPasswordCreated
-         * @description Shown once: the secret is not stored.
-         */
-        AppPasswordCreated: {
-            /** Id */
-            id: string;
-            /**
-             * Kind
-             * @enum {string}
-             */
-            kind: 'dav' | 'feed' | 'freebusy';
-            /** Label */
-            label: string;
-            /** Calendar Ids */
-            calendar_ids?: string[];
-            /** Feed Level */
-            feed_level?: string | null;
-            /**
-             * Created At
-             * Format: date-time
-             */
-            created_at: string;
-            /** Last Used At */
-            last_used_at?: string | null;
-            /** Password */
-            password?: string | null;
-            /** Username */
-            username?: string | null;
-            /** Server Url */
-            server_url?: string | null;
-            /** Feed Url */
-            feed_url?: string | null;
-        };
-        /** AppPasswordRead */
-        AppPasswordRead: {
-            /** Id */
-            id: string;
-            /**
-             * Kind
-             * @enum {string}
-             */
-            kind: 'dav' | 'feed' | 'freebusy';
-            /** Label */
-            label: string;
-            /** Calendar Ids */
-            calendar_ids?: string[];
-            /** Feed Level */
-            feed_level?: string | null;
-            /**
-             * Created At
-             * Format: date-time
-             */
-            created_at: string;
-            /** Last Used At */
-            last_used_at?: string | null;
-        };
         /**
          * ArbiErrorEvent
          * @description ``arbi.error`` — a structured mid-stream error (e.g. AI-quota exceeded).
@@ -10300,7 +10227,7 @@ interface components {
              * Kind
              * @enum {string}
              */
-            kind: 'calendar' | 'resource' | 'subscription' | 'holidays' | 'birthdays' | 'addressbook';
+            kind: 'calendar' | 'resource' | 'subscription' | 'holidays' | 'addressbook';
             /**
              * Role
              * @enum {string}
@@ -12236,7 +12163,7 @@ interface components {
         };
         /**
          * ContactCard
-         * @description Decrypted view of a contact's vCard (lax: a card from a CardDAV client may exceed the write limits).
+         * @description Decrypted view of a contact's vCard (lax: a stored or imported card may exceed the write limits).
          */
         ContactCard: {
             /** Uid */
@@ -13722,6 +13649,11 @@ interface components {
             can_delete: boolean;
             /** Mine */
             mine: boolean;
+            /**
+             * Restoring
+             * @default false
+             */
+            restoring: boolean;
         };
         /** DeletedDocumentsPage */
         DeletedDocumentsPage: {
@@ -14297,6 +14229,16 @@ interface components {
              */
             skipped: components['schemas']['DriveSyncSkippedFile'][];
         };
+        /**
+         * DuplicateContactError
+         * @description 409 from a contact write: one of the addresses is already another contact's (one person = one row).
+         */
+        DuplicateContactError: {
+            /** Detail */
+            detail: string;
+            /** Contact Id */
+            contact_id?: string | null;
+        };
         /**
          * EmailDraftAction
          * @description Prepare a draft in native mail, in the mailbox of the step's assignee (else the run's owner). It is never
@@ -14906,22 +14848,6 @@ interface components {
             /** Reason */
             reason?: ('pro_required' | 'external_user' | 'not_entitled') | null;
         };
-        /** FeedCreate */
-        FeedCreate: {
-            /** Calendar Id */
-            calendar_id: string;
-            /**
-             * Level
-             * @default full
-             * @enum {string}
-             */
-            level: 'full' | 'freebusy';
-            /**
-             * Label
-             * @default Feed
-             */
-            label: string;
-        };
         /**
          * FieldDefinition
          * @description A field as the API returns it — decrypted.
@@ -17661,6 +17587,13 @@ interface components {
             user_id?: string | null;
             /** Contact Id */
             contact_id?: string | null;
+            /** Address Book Ext Id */
+            address_book_ext_id?: string | null;
+            /**
+             * Registered
+             * @default false
+             */
+            registered: boolean;
             /**
              * Source
              * @enum {string}
@@ -21259,13 +21192,21 @@ interface components {
         };
         /**
          * StorageDeploymentUsage
-         * @description The whole deployment (Box admins / billing managers): every project's bytes against the licence.
+         * @description The whole deployment (Box admins / billing managers): every project's bytes against the licence
+         *     (``billable_bytes``, counted as for a project).
          */
         StorageDeploymentUsage: {
             /** Bytes */
             bytes: number;
             /** Trash Bytes */
             trash_bytes: number;
+            /**
+             * Archived Bytes
+             * @default 0
+             */
+            archived_bytes: number;
+            /** Billable Bytes */
+            billable_bytes: number;
             /** Limit Bytes */
             limit_bytes: number | null;
             /** Orphaned Bytes */
@@ -21325,13 +21266,20 @@ interface components {
             bytes: number;
             /** Trash Bytes */
             trash_bytes: number;
+            /**
+             * Archived Bytes
+             * @default 0
+             */
+            archived_bytes: number;
             /** Objects */
             objects: number;
         };
         /**
          * StorageProjectUsage
-         * @description A project's stored bytes. ``bytes`` counts everything it pays for (trash included) against ``limit_bytes``
-         *     (None: no limit, billing off); ``trash_bytes`` is the part that is deleted but not yet purged.
+         * @description A project's stored bytes. ``bytes`` is everything stored: live, archived (``archived_bytes``: in archived
+         *     workspaces) and deleted but not yet purged (``trash_bytes``). Archived and deleted bytes count at
+         *     ``REDUCED_RATE`` (10%): ``billable_bytes`` = live + 10% of the rest is what counts against ``limit_bytes``
+         *     (None: no limit, billing off).
          */
         StorageProjectUsage: {
             /** Project Ext Id */
@@ -21348,6 +21296,13 @@ interface components {
             bytes: number;
             /** Trash Bytes */
             trash_bytes: number;
+            /**
+             * Archived Bytes
+             * @default 0
+             */
+            archived_bytes: number;
+            /** Billable Bytes */
+            billable_bytes: number;
             /** Limit Bytes */
             limit_bytes: number | null;
             /** By Kind */
@@ -21366,6 +21321,16 @@ interface components {
             /** Projects */
             projects: components['schemas']['StorageProjectUsage'][];
             deployment?: components['schemas']['StorageDeploymentUsage'] | null;
+            /**
+             * Reduced Rate
+             * @default 0.1
+             */
+            reduced_rate: number;
+            /**
+             * Archive Available
+             * @default false
+             */
+            archive_available: boolean;
         };
         /**
          * StoragePurgeResult
@@ -21402,6 +21367,11 @@ interface components {
             orphaned_bytes: number;
             /** Unattributed Bytes */
             unattributed_bytes: number;
+            /**
+             * Archive Tier Bytes
+             * @default 0
+             */
+            archive_tier_bytes: number;
             /** By Kind */
             by_kind: {
                 [key: string]: number;
@@ -21419,10 +21389,20 @@ interface components {
             name: string;
             /** Deleted */
             deleted: boolean;
+            /**
+             * Archived
+             * @default false
+             */
+            archived: boolean;
             /** Bytes */
             bytes: number;
             /** Trash Bytes */
             trash_bytes: number;
+            /**
+             * Archived Bytes
+             * @default 0
+             */
+            archived_bytes: number;
             /** By Kind */
             by_kind: components['schemas']['StorageKindUsage'][];
         };
@@ -22684,6 +22664,24 @@ interface components {
              */
             MAX_CONCURRENT: number;
         };
+        /**
+         * UnarchiveEstimate
+         * @description What unarchiving costs (``storage_restore.estimate``): its live documents are re-indexed from their stored
+         *     parse output — embeddings plus one DoctagLLM call each, billed to the project. ``gbp`` is None when the models'
+         *     prices are not known here (a local-LLM deployment).
+         */
+        UnarchiveEstimate: {
+            /** Documents */
+            documents: number;
+            /** Chunks */
+            chunks: number;
+            /** Bytes */
+            bytes: number;
+            /** Minutes */
+            minutes: number;
+            /** Gbp */
+            gbp: number | null;
+        };
         /**
          * UpdateAgentRequest
          * @description Mutable agent fields. Only appearance for now — identity (name/email/keys)
@@ -24006,6 +24004,73 @@ interface components {
          * @enum {string}
          */
         WorkspaceActivitySource: 'thread' | 'message' | 'document' | 'workflow';
+        /**
+         * WorkspaceArchiveRead
+         * @description A workspace's archive state: ``live`` (open as usual), ``archiving``, ``archived`` or ``restoring``
+         *     (``documents_done`` of ``documents_total`` re-indexed). ``can_manage``: the caller may archive / unarchive it
+         *     (its owner, or its project's owner); ``available``: this deployment has an archive tier.
+         */
+        WorkspaceArchiveRead: {
+            /** Workspace Ext Id */
+            workspace_ext_id: string;
+            /**
+             * Status
+             * @enum {string}
+             */
+            status: 'live' | 'archiving' | 'archived' | 'restoring';
+            /** Archived At */
+            archived_at: string | null;
+            /**
+             * Documents Done
+             * @default 0
+             */
+            documents_done: number;
+            /**
+             * Documents Total
+             * @default 0
+             */
+            documents_total: number;
+            /** Can Manage */
+            can_manage: boolean;
+            /** Available */
+            available: boolean;
+            /** Live Bytes */
+            live_bytes: number;
+            /** Archived Bytes */
+            archived_bytes: number;
+            /** Error */
+            error?: string | null;
+            estimate?: components['schemas']['UnarchiveEstimate'] | null;
+        };
+        /**
+         * WorkspaceArchiveState
+         * @description An archived workspace (closed: nothing in it can be opened until it is unarchived).
+         *
+         *     ``archiving``: its files are moving to the archive tier; ``archived``: they are there; ``restoring``: an unarchive
+         *     is bringing them back and re-indexing its documents (``documents_done`` of ``documents_total``).
+         */
+        WorkspaceArchiveState: {
+            /**
+             * Status
+             * @enum {string}
+             */
+            status: 'archiving' | 'archived' | 'restoring';
+            /**
+             * Archived At
+             * Format: date-time
+             */
+            archived_at: string;
+            /**
+             * Documents Done
+             * @default 0
+             */
+            documents_done: number;
+            /**
+             * Documents Total
+             * @default 0
+             */
+            documents_total: number;
+        };
         /** WorkspaceCreateRequest */
         WorkspaceCreateRequest: {
             /** Name */
@@ -24164,6 +24229,7 @@ interface components {
             project_owner_ext_id?: string | null;
             /** House Template Ext Id */
             house_template_ext_id?: string | null;
+            archive?: components['schemas']['WorkspaceArchiveState'] | null;
         };
         /**
          * WorkspaceRole
@@ -26937,6 +27003,99 @@ interface operations {
             };
         };
     };
+    get_workspace_archive: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspace_ext_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['WorkspaceArchiveRead'];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['HTTPValidationError'];
+                };
+            };
+        };
+    };
+    archive_workspace: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspace_ext_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['WorkspaceArchiveRead'];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['HTTPValidationError'];
+                };
+            };
+        };
+    };
+    unarchive_workspace: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspace_ext_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['WorkspaceArchiveRead'];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['HTTPValidationError'];
+                };
+            };
+        };
+    };
     request_docx_agent_v1_editor__document_id__mentions_post: {
         parameters: {
             query?: never;
@@ -34384,121 +34543,6 @@ interface operations {
             };
         };
     };
-    list_calendar_app_passwords: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/json': components['schemas']['AppPasswordRead'][];
-                };
-            };
-        };
-    };
-    create_calendar_app_password: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody: {
-            content: {
-                'application/json': components['schemas']['AppPasswordCreate'];
-            };
-        };
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/json': components['schemas']['AppPasswordCreated'];
-                };
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/json': components['schemas']['HTTPValidationError'];
-                };
-            };
-        };
-    };
-    create_calendar_feed: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody: {
-            content: {
-                'application/json': components['schemas']['FeedCreate'];
-            };
-        };
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/json': components['schemas']['AppPasswordCreated'];
-                };
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/json': components['schemas']['HTTPValidationError'];
-                };
-            };
-        };
-    };
-    revoke_calendar_app_password: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                apw_id: string;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Successful Response */
-            204: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/json': components['schemas']['HTTPValidationError'];
-                };
-            };
-        };
-    };
     list_booking_pages: {
         parameters: {
             query?: never;
@@ -34691,6 +34735,15 @@ interface operations {
                     'application/json': components['schemas']['ContactResponse'];
                 };
             };
+            /** @description This person is already a contact */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['DuplicateContactError'];
+                };
+            };
             /** @description Validation Error */
             422: {
                 headers: {
@@ -34819,6 +34872,15 @@ interface operations {
                     'application/json': components['schemas']['ContactResponse'];
                 };
             };
+            /** @description This person is already a contact */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['DuplicateContactError'];
+                };
+            };
             /** @description Validation Error */
             422: {
                 headers: {