@arbidocs/client 0.4.125 → 0.4.127

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1185,6 +1185,79 @@ interface paths {
1185
1185
  patch?: never;
1186
1186
  trace?: never;
1187
1187
  };
1188
+ '/v1/storage/projects': {
1189
+ parameters: {
1190
+ query?: never;
1191
+ header?: never;
1192
+ path?: never;
1193
+ cookie?: never;
1194
+ };
1195
+ /**
1196
+ * List Storage Projects
1197
+ * @description Storage used by each project: everything it pays for (trash included, until purged) against its limit, by
1198
+ * kind (document, version, derived, coedit, mail, mail_draft, chat_attachment, recording, other), with the trash
1199
+ * part, and — for a personal project — its mail by folder. ``scope=deployment`` adds the deployment's totals
1200
+ * against the Box licence.
1201
+ */
1202
+ get: operations['list_storage_projects'];
1203
+ put?: never;
1204
+ post?: never;
1205
+ delete?: never;
1206
+ options?: never;
1207
+ head?: never;
1208
+ patch?: never;
1209
+ trace?: never;
1210
+ };
1211
+ '/v1/storage/items': {
1212
+ parameters: {
1213
+ query?: never;
1214
+ header?: never;
1215
+ path?: never;
1216
+ cookie?: never;
1217
+ };
1218
+ /**
1219
+ * List Storage Items
1220
+ * @description The largest items stored, largest first: a document (with all its versions, renditions and co-editing
1221
+ * state, ``breakdown``), a mail message, a recording, a chat attachment, a draft. ``state=trash`` is the
1222
+ * Recently deleted list (still counted until purged). Names are not included: ``ref`` is the item's external id
1223
+ * for the client to resolve where it can read it.
1224
+ */
1225
+ get: operations['list_storage_items'];
1226
+ put?: never;
1227
+ post?: never;
1228
+ /**
1229
+ * Purge Storage Items
1230
+ * @description Delete permanently what is in a project's trash now (Empty trash), or only some of it: deleted workspaces
1231
+ * and documents, mail in the Trash, orphaned files. It stops counting at once. This cannot be undone. Items not
1232
+ * in the trash are never touched.
1233
+ */
1234
+ delete: operations['purge_storage_items'];
1235
+ options?: never;
1236
+ head?: never;
1237
+ patch?: never;
1238
+ trace?: never;
1239
+ };
1240
+ '/v1/storage/snapshots': {
1241
+ parameters: {
1242
+ query?: never;
1243
+ header?: never;
1244
+ path?: never;
1245
+ cookie?: never;
1246
+ };
1247
+ /**
1248
+ * List Storage Snapshots
1249
+ * @description The deployment's storage day by day (what each nightly reconcile found), newest first. Box admins and
1250
+ * billing managers.
1251
+ */
1252
+ get: operations['list_storage_snapshots'];
1253
+ put?: never;
1254
+ post?: never;
1255
+ delete?: never;
1256
+ options?: never;
1257
+ head?: never;
1258
+ patch?: never;
1259
+ trace?: never;
1260
+ };
1188
1261
  '/v1/user/identity': {
1189
1262
  parameters: {
1190
1263
  query?: never;
@@ -1525,6 +1598,27 @@ interface paths {
1525
1598
  patch: operations['update_workspace'];
1526
1599
  trace?: never;
1527
1600
  };
1601
+ '/v1/workspace/restore': {
1602
+ parameters: {
1603
+ query?: never;
1604
+ header?: never;
1605
+ path?: never;
1606
+ cookie?: never;
1607
+ };
1608
+ get?: never;
1609
+ put?: never;
1610
+ /**
1611
+ * Restore Workspaces
1612
+ * @description Restore deleted workspaces (from Recently deleted) exactly as they were. Their owner only; returns the
1613
+ * workspaces restored. A workspace whose project was deleted cannot come back.
1614
+ */
1615
+ post: operations['restore_workspaces'];
1616
+ delete?: never;
1617
+ options?: never;
1618
+ head?: never;
1619
+ patch?: never;
1620
+ trace?: never;
1621
+ };
1528
1622
  '/v1/workspace/{workspace_ext_id}/project': {
1529
1623
  parameters: {
1530
1624
  query?: never;
@@ -2318,6 +2412,29 @@ interface paths {
2318
2412
  patch?: never;
2319
2413
  trace?: never;
2320
2414
  };
2415
+ '/v1/document/{document_ext_id}/finalise-translation': {
2416
+ parameters: {
2417
+ query?: never;
2418
+ header?: never;
2419
+ path?: never;
2420
+ cookie?: never;
2421
+ };
2422
+ get?: never;
2423
+ put?: never;
2424
+ /**
2425
+ * Finalise Translation Endpoint
2426
+ * @description Save a translation's current version as a new PDF document, labelled "Translation" and linked to the
2427
+ * original it translates (``translation``) and to the translation version (``final``). The editable
2428
+ * translation is unchanged. 409 while the translation's PDF is still being prepared; 400 for a document that is
2429
+ * not a translation.
2430
+ */
2431
+ post: operations['finalise_translation'];
2432
+ delete?: never;
2433
+ options?: never;
2434
+ head?: never;
2435
+ patch?: never;
2436
+ trace?: never;
2437
+ };
2321
2438
  '/v1/document/doctag/generate': {
2322
2439
  parameters: {
2323
2440
  query?: never;
@@ -2399,6 +2516,57 @@ interface paths {
2399
2516
  patch?: never;
2400
2517
  trace?: never;
2401
2518
  };
2519
+ '/v1/document/deleted': {
2520
+ parameters: {
2521
+ query?: never;
2522
+ header?: never;
2523
+ path?: never;
2524
+ cookie?: never;
2525
+ };
2526
+ /**
2527
+ * List Deleted Documents
2528
+ * @description The workspace's deleted documents the caller could see live (shared, or theirs), most recently deleted first,
2529
+ * with their names, what they still store and what the caller may do; for a manager, how much other members keep
2530
+ * private in the trash (count and bytes only).
2531
+ */
2532
+ get: operations['list_deleted_documents'];
2533
+ put?: never;
2534
+ post?: never;
2535
+ /**
2536
+ * Purge Deleted Documents
2537
+ * @description Delete deleted documents for good now (Delete permanently / Empty trash): rows, files and search index.
2538
+ * They stop counting against the project's storage. This cannot be undone.
2539
+ *
2540
+ * Empty trash (no ``external_ids``): a manager empties everything they can see (theirs and shared), plus other
2541
+ * members' private deleted documents only with ``include_others_private``; anyone else empties their own.
2542
+ */
2543
+ delete: operations['purge_deleted_documents'];
2544
+ options?: never;
2545
+ head?: never;
2546
+ patch?: never;
2547
+ trace?: never;
2548
+ };
2549
+ '/v1/document/restore': {
2550
+ parameters: {
2551
+ query?: never;
2552
+ header?: never;
2553
+ path?: never;
2554
+ cookie?: never;
2555
+ };
2556
+ get?: never;
2557
+ put?: never;
2558
+ /**
2559
+ * Restore Documents
2560
+ * @description Restore deleted documents (with whatever was deleted together with them: versions' family, an email's
2561
+ * attachments). They are re-indexed in the background from their stored parse output, then searchable again.
2562
+ */
2563
+ post: operations['restore_documents'];
2564
+ delete?: never;
2565
+ options?: never;
2566
+ head?: never;
2567
+ patch?: never;
2568
+ trace?: never;
2569
+ };
2402
2570
  '/v1/document/{document_ext_id}/sign/prepare': {
2403
2571
  parameters: {
2404
2572
  query?: never;
@@ -7297,7 +7465,12 @@ interface paths {
7297
7465
  get: operations['messages_v1_mail_accounts__account_id__messages_get'];
7298
7466
  put?: never;
7299
7467
  post?: never;
7300
- delete?: never;
7468
+ /**
7469
+ * Empty Trash
7470
+ * @description Empty the Trash: every message in it is deleted for good. (Messages left there are purged after the
7471
+ * retention window anyway.)
7472
+ */
7473
+ delete: operations['empty_trash_v1_mail_accounts__account_id__messages_delete'];
7301
7474
  options?: never;
7302
7475
  head?: never;
7303
7476
  patch?: never;
@@ -7314,7 +7487,11 @@ interface paths {
7314
7487
  get: operations['message_v1_mail_accounts__account_id__messages__message_id__get'];
7315
7488
  put?: never;
7316
7489
  post?: never;
7317
- delete?: never;
7490
+ /**
7491
+ * Delete Message
7492
+ * @description Delete a message for good (Delete forever): it stops counting against the personal project's storage.
7493
+ */
7494
+ delete: operations['delete_message_v1_mail_accounts__account_id__messages__message_id__delete'];
7318
7495
  options?: never;
7319
7496
  head?: never;
7320
7497
  /** Update */
@@ -8894,6 +9071,21 @@ interface components {
8894
9071
  * }
8895
9072
  */
8896
9073
  DoctagLLM: components['schemas']['DoctagLLMConfig'];
9074
+ /**
9075
+ * @default {
9076
+ * "API_TYPE": "remote",
9077
+ * "ENABLE_THINKING": false,
9078
+ * "MODEL_NAME": "Fast",
9079
+ * "SYSTEM_INSTRUCTION": "You are a professional translator of legal, commercial and technical documents.\n\nYou translate the numbered passages you are given into the target language, faithfully and completely:\n- Translate every passage in full. Never summarise, shorten, merge, split, reorder, explain or comment.\n- Keep the Markdown structure of each passage exactly: headings (#), lists, emphasis, tables (same rows and columns), links and line breaks.\n- Keep unchanged: numbers, dates as written, amounts, currencies, clause and section numbering, cross-references, citations, case names, statute names, email addresses, URLs and code.\n- Keep proper names of people, companies and places as they are written, unless the glossary gives a translation.\n- Use the glossary's translation for every glossary term, every time it occurs.\n- A defined term (a capitalised or quoted term given a meaning in the document) is translated the same way everywhere.\n- A passage already in the target language, or with nothing to translate (a number, a signature line, a blank form field), is returned as it is.\n- The context passages before and after are there only so the translation reads on from its neighbours. Never translate or return them.",
9080
+ * "TEMPERATURE": 0.2,
9081
+ * "MAX_TOKENS": 0,
9082
+ * "WINDOW_TOKENS": 3000,
9083
+ * "CONTEXT_TOKENS": 600,
9084
+ * "GLOSSARY_TOKENS": 6000,
9085
+ * "MAX_CONCURRENT": 8
9086
+ * }
9087
+ */
9088
+ TranslationLLM: components['schemas']['TranslationLLMConfig'];
8897
9089
  /**
8898
9090
  * @default {
8899
9091
  * "API_TYPE": "remote",
@@ -11803,6 +11995,7 @@ interface components {
11803
11995
  TitleLLM?: components['schemas']['TitleLLMConfig'] | null;
11804
11996
  SummariseLLM?: components['schemas']['SummariseLLMConfig'] | null;
11805
11997
  DoctagLLM?: components['schemas']['DoctagLLMConfig'] | null;
11998
+ TranslationLLM?: components['schemas']['TranslationLLMConfig'] | null;
11806
11999
  MemoryLLM?: components['schemas']['MemoryLLMConfig'] | null;
11807
12000
  PlanningLLM?: components['schemas']['PlanningLLMConfig'] | null;
11808
12001
  FilterPlanLLM?: components['schemas']['FilterPlanLLMConfig'] | null;
@@ -13481,6 +13674,61 @@ interface components {
13481
13674
  /** External Ids */
13482
13675
  external_ids: string[];
13483
13676
  };
13677
+ /** DeletedDocument */
13678
+ DeletedDocument: {
13679
+ /** External Id */
13680
+ external_id: string;
13681
+ /** File Name */
13682
+ file_name: string | null;
13683
+ /** File Type */
13684
+ file_type: string | null;
13685
+ /**
13686
+ * Deleted At
13687
+ * Format: date-time
13688
+ */
13689
+ deleted_at: string;
13690
+ /** Bytes */
13691
+ bytes: number;
13692
+ /** Objects */
13693
+ objects: number;
13694
+ /** Can Restore */
13695
+ can_restore: boolean;
13696
+ /** Can Delete */
13697
+ can_delete: boolean;
13698
+ /** Mine */
13699
+ mine: boolean;
13700
+ };
13701
+ /** DeletedDocumentsPage */
13702
+ DeletedDocumentsPage: {
13703
+ /** Items */
13704
+ items: components['schemas']['DeletedDocument'][];
13705
+ /** Can Manage */
13706
+ can_manage: boolean;
13707
+ others_private?: components['schemas']['OthersPrivateTrash'] | null;
13708
+ };
13709
+ /**
13710
+ * DeletedDocumentsPurge
13711
+ * @description Which deleted documents to delete for good: these, or (omitted) every one the caller may (Empty trash).
13712
+ */
13713
+ DeletedDocumentsPurge: {
13714
+ /** External Ids */
13715
+ external_ids?: string[] | null;
13716
+ /**
13717
+ * Include Others Private
13718
+ * @default false
13719
+ */
13720
+ include_others_private: boolean;
13721
+ };
13722
+ /** DeletedDocumentsRequest */
13723
+ DeletedDocumentsRequest: {
13724
+ /** External Ids */
13725
+ external_ids: string[];
13726
+ };
13727
+ /** DeletedDocumentsResult */
13728
+ DeletedDocumentsResult: {
13729
+ /** External Ids */
13730
+ external_ids: string[];
13731
+ };
13484
13732
  /** DeploymentUserResponse */
13485
13733
  DeploymentUserResponse: {
13486
13734
  /** External Id */
@@ -13529,7 +13777,7 @@ interface components {
13529
13777
  * Versions are not relations: they live inside their document (``docs.versions``).
13530
13778
  * @enum {string}
13531
13779
  */
13532
- DocRelationRole: 'crop' | 'redline_base' | 'redline_revised' | 'redaction' | 'annotated' | 'production';
13780
+ DocRelationRole: 'crop' | 'redline_base' | 'redline_revised' | 'redaction' | 'annotated' | 'production' | 'translation' | 'final';
13533
13781
  /** DocResponse */
13534
13782
  DocResponse: {
13535
13783
  /** External Id */
@@ -14843,6 +15091,27 @@ interface components {
14843
15091
  */
14844
15092
  MAX_TOKENS: number;
14845
15093
  };
15094
+ /**
15095
+ * FinalisedTranslationResponse
15096
+ * @description The new PDF a finalised translation was saved as.
15097
+ */
15098
+ FinalisedTranslationResponse: {
15099
+ /**
15100
+ * Document Ext Id
15101
+ * @description The new PDF document
15102
+ */
15103
+ document_ext_id: string;
15104
+ /**
15105
+ * Translation Ref
15106
+ * @description The translation version made final (doc-…@vN)
15107
+ */
15108
+ translation_ref: string;
15109
+ /**
15110
+ * Source Ref
15111
+ * @description The original version it translates (doc-…@vN)
15112
+ */
15113
+ source_ref?: string | null;
15114
+ };
14846
15115
  /** FindTimeRequest */
14847
15116
  FindTimeRequest: {
14848
15117
  /** Attendees */
@@ -15965,7 +16234,7 @@ interface components {
15965
16234
  /** Folder Id */
15966
16235
  folder_id?: string | null;
15967
16236
  /** Action */
15968
- action?: 'trash' | null;
16237
+ action?: ('trash' | 'restore') | null;
15969
16238
  };
15970
16239
  /**
15971
16240
  * MailPolicyRead
@@ -16142,6 +16411,8 @@ interface components {
16142
16411
  id: string;
16143
16412
  /** Status */
16144
16413
  status: string;
16414
+ /** Delivery Status */
16415
+ delivery_status?: ('sent' | 'delivered' | 'delayed' | 'partially_bounced' | 'bounced') | null;
16145
16416
  };
16146
16417
  /** MailServerProfileRead */
16147
16418
  MailServerProfileRead: {
@@ -16152,6 +16423,11 @@ interface components {
16152
16423
  /** Provider */
16153
16424
  provider: string;
16154
16425
  };
16426
+ /** MailTrashEmptied */
16427
+ MailTrashEmptied: {
16428
+ /** Deleted */
16429
+ deleted: number;
16430
+ };
16155
16431
  /**
16156
16432
  * MailboxSyncRead
16157
16433
  * @description Public shape for a MailboxSync row returned by the enable-sync endpoint.
@@ -17028,7 +17304,7 @@ interface components {
17028
17304
  * Type is self-descriptive, no need to parse content field.
17029
17305
  * @enum {string}
17030
17306
  */
17031
- NotificationType: 'workspaceuser_added_owner' | 'workspaceuser_added_collaborator' | 'workspaceuser_added_guest' | 'workspaceuser_removed' | 'workspaceuser_updated_owner' | 'workspaceuser_updated_collaborator' | 'workspaceuser_updated_guest' | 'contact_accepted' | 'signup_reward' | 'referral_reward' | 'box_seat_refused' | 'native_mail_received' | 'mail_draft_ready' | 'email_reply' | 'quota_threshold_50' | 'quota_threshold_90' | 'quota_threshold_100' | 'doc_shared' | 'docx_mention' | 'signature_requested' | 'signature_completed' | 'signature_declined' | 'workspace_access_request' | 'conversation_ready' | 'conversation_done' | 'conversation_notified' | 'workflow_failed' | 'agent_input_requested' | 'workflow_completed' | 'workflow_signal' | 'step_ready' | 'task_started' | 'task_completed' | 'mailbox_sync_complete' | 'drive_sync_complete' | 'activity' | 'mention' | 'thread_reply' | 'document_activity' | 'call_missed' | 'calendar_invite' | 'calendar_update' | 'calendar_cancel' | 'calendar_reply' | 'calendar_counter' | 'calendar_reminder' | 'calendar_share';
17307
+ NotificationType: 'workspaceuser_added_owner' | 'workspaceuser_added_collaborator' | 'workspaceuser_added_guest' | 'workspaceuser_removed' | 'workspaceuser_updated_owner' | 'workspaceuser_updated_collaborator' | 'workspaceuser_updated_guest' | 'contact_accepted' | 'signup_reward' | 'referral_reward' | 'box_seat_refused' | 'native_mail_received' | 'mail_draft_ready' | 'email_reply' | 'quota_threshold_50' | 'quota_threshold_90' | 'quota_threshold_100' | 'storage_quota_exceeded' | 'doc_shared' | 'docx_mention' | 'signature_requested' | 'signature_completed' | 'signature_declined' | 'workspace_access_request' | 'conversation_ready' | 'conversation_done' | 'conversation_notified' | 'workflow_failed' | 'agent_input_requested' | 'workflow_completed' | 'workflow_signal' | 'step_ready' | 'task_started' | 'task_completed' | 'mailbox_sync_complete' | 'drive_sync_complete' | 'activity' | 'mention' | 'thread_reply' | 'document_activity' | 'document_processed' | 'call_missed' | 'calendar_invite' | 'calendar_update' | 'calendar_cancel' | 'calendar_reply' | 'calendar_counter' | 'calendar_reminder' | 'calendar_share';
17032
17308
  /**
17033
17309
  * NotificationUpdate
17034
17310
  * @description Single notification update for bulk PATCH.
@@ -17062,6 +17338,16 @@ interface components {
17062
17338
  */
17063
17339
  background_sync: boolean;
17064
17340
  };
17341
+ /**
17342
+ * OthersPrivateTrash
17343
+ * @description Other members' private deleted documents: never listed, only counted, for a workspace manager.
17344
+ */
17345
+ OthersPrivateTrash: {
17346
+ /** Count */
17347
+ count: number;
17348
+ /** Bytes */
17349
+ bytes: number;
17350
+ };
17065
17351
  /**
17066
17352
  * OutputMessage
17067
17353
  * @description A `message` output_item — assistant text (Responses-standard).
@@ -19485,6 +19771,8 @@ interface components {
19485
19771
  metadata?: {
19486
19772
  [key: string]: unknown;
19487
19773
  } | null;
19774
+ /** Conversation Ext Id */
19775
+ conversation_ext_id?: string | null;
19488
19776
  };
19489
19777
  /**
19490
19778
  * ResponsesAPIUsage
@@ -20603,7 +20891,7 @@ interface components {
20603
20891
  * SkillSummaryResponse
20604
20892
  * @description One row of ``GET /v1/assistant/skills``.
20605
20893
  *
20606
- * Lightweight projection — never includes the SKILL.md body. Clients
20894
+ * Lightweight projection — never includes a document skill's SKILL.md body (a built-in carries its own). Clients
20607
20895
  * use this to populate slash-command autocomplete (name / description
20608
20896
  * / arg_hint) and to know which doc to fetch when the user wants to
20609
20897
  * inspect the full source via ``GET /v1/document/.../parsed-content``.
@@ -20645,23 +20933,22 @@ interface components {
20645
20933
  skill_type: string;
20646
20934
  /**
20647
20935
  * Workspace Ext Id
20648
- * @description External ID of the workspace the skill lives in
20936
+ * @description External ID of the workspace the skill lives in (None for a built-in skill)
20649
20937
  */
20650
- workspace_ext_id: string;
20938
+ workspace_ext_id?: string | null;
20651
20939
  /**
20652
20940
  * Doc Ext Id
20653
- * @description External ID of the SKILL.md doc (use for /parsed-content)
20941
+ * @description External ID of the SKILL.md doc (use for /parsed-content); None for a built-in skill
20654
20942
  */
20655
- doc_ext_id: string;
20943
+ doc_ext_id?: string | null;
20656
20944
  /**
20657
20945
  * Updated At
20658
- * Format: date-time
20659
20946
  * @description Last modification time of the main file
20660
20947
  */
20661
- updated_at: string;
20948
+ updated_at?: string | null;
20662
20949
  /**
20663
20950
  * Visibility
20664
- * @description ``mine`` (private to the caller) or ``global`` (shared into the marketplace)
20951
+ * @description ``mine`` (private to the caller), ``global`` (shared into the marketplace) or ``builtin`` (shipped with ARBI)
20665
20952
  * @default mine
20666
20953
  */
20667
20954
  visibility: string;
@@ -20671,6 +20958,11 @@ interface components {
20671
20958
  * @default true
20672
20959
  */
20673
20960
  is_owner: boolean;
20961
+ /**
20962
+ * Content
20963
+ * @description The SKILL.md of a built-in skill (it has no document); None for document skills
20964
+ */
20965
+ content?: string | null;
20674
20966
  };
20675
20967
  /**
20676
20968
  * SkillsListResponse
@@ -20926,6 +21218,175 @@ interface components {
20926
21218
  */
20927
21219
  model?: string | null;
20928
21220
  };
21221
+ /**
21222
+ * StorageDeploymentUsage
21223
+ * @description The whole deployment (Box admins / billing managers): every project's bytes against the licence.
21224
+ */
21225
+ StorageDeploymentUsage: {
21226
+ /** Bytes */
21227
+ bytes: number;
21228
+ /** Trash Bytes */
21229
+ trash_bytes: number;
21230
+ /** Limit Bytes */
21231
+ limit_bytes: number | null;
21232
+ /** Orphaned Bytes */
21233
+ orphaned_bytes: number;
21234
+ /** Unattributed Bytes */
21235
+ unattributed_bytes: number;
21236
+ /** By Kind */
21237
+ by_kind: components['schemas']['StorageKindUsage'][];
21238
+ };
21239
+ /**
21240
+ * StorageItem
21241
+ * @description One thing a person would delete: a document (all its versions and files), a mail message, a recording, a chat
21242
+ * attachment, a draft. Names are not here — they are encrypted; clients resolve ``ref`` where they can read it.
21243
+ */
21244
+ StorageItem: {
21245
+ /** Kind */
21246
+ kind: string;
21247
+ /** Ref */
21248
+ ref: string | null;
21249
+ /** Project Ext Id */
21250
+ project_ext_id: string | null;
21251
+ /** Workspace Ext Id */
21252
+ workspace_ext_id: string | null;
21253
+ /** Workspace Name */
21254
+ workspace_name: string | null;
21255
+ /** Bytes */
21256
+ bytes: number;
21257
+ /** Trash Bytes */
21258
+ trash_bytes: number;
21259
+ /** Objects */
21260
+ objects: number;
21261
+ /** Breakdown */
21262
+ breakdown: {
21263
+ [key: string]: number;
21264
+ };
21265
+ /** Trashed */
21266
+ trashed: boolean;
21267
+ /** Folder */
21268
+ folder?: string | null;
21269
+ /** Created At */
21270
+ created_at: string | null;
21271
+ /** Name */
21272
+ name?: string | null;
21273
+ };
21274
+ /** StorageItemsResponse */
21275
+ StorageItemsResponse: {
21276
+ /** Items */
21277
+ items: components['schemas']['StorageItem'][];
21278
+ /** Total */
21279
+ total: number;
21280
+ };
21281
+ /** StorageKindUsage */
21282
+ StorageKindUsage: {
21283
+ /** Kind */
21284
+ kind: string;
21285
+ /** Bytes */
21286
+ bytes: number;
21287
+ /** Trash Bytes */
21288
+ trash_bytes: number;
21289
+ /** Objects */
21290
+ objects: number;
21291
+ };
21292
+ /**
21293
+ * StorageProjectUsage
21294
+ * @description A project's stored bytes. ``bytes`` counts everything it pays for (trash included) against ``limit_bytes``
21295
+ * (None: no limit, billing off); ``trash_bytes`` is the part that is deleted but not yet purged.
21296
+ */
21297
+ StorageProjectUsage: {
21298
+ /** Project Ext Id */
21299
+ project_ext_id: string;
21300
+ /** Name */
21301
+ name: string;
21302
+ /** Personal */
21303
+ personal: boolean;
21304
+ /** Owner Ext Id */
21305
+ owner_ext_id?: string | null;
21306
+ /** Owner Email */
21307
+ owner_email?: string | null;
21308
+ /** Bytes */
21309
+ bytes: number;
21310
+ /** Trash Bytes */
21311
+ trash_bytes: number;
21312
+ /** Limit Bytes */
21313
+ limit_bytes: number | null;
21314
+ /** By Kind */
21315
+ by_kind: components['schemas']['StorageKindUsage'][];
21316
+ /** Workspaces */
21317
+ workspaces?: components['schemas']['StorageWorkspaceUsage'][] | null;
21318
+ /** Mail Folders */
21319
+ mail_folders?: {
21320
+ [key: string]: number;
21321
+ } | null;
21322
+ /** Last Activity At */
21323
+ last_activity_at?: string | null;
21324
+ };
21325
+ /** StorageProjectsResponse */
21326
+ StorageProjectsResponse: {
21327
+ /** Projects */
21328
+ projects: components['schemas']['StorageProjectUsage'][];
21329
+ deployment?: components['schemas']['StorageDeploymentUsage'] | null;
21330
+ };
21331
+ /**
21332
+ * StoragePurgeResult
21333
+ * @description What a Delete permanently / Empty trash removed, and the bytes it freed.
21334
+ */
21335
+ StoragePurgeResult: {
21336
+ /** Workspaces */
21337
+ workspaces: number;
21338
+ /** Documents */
21339
+ documents: number;
21340
+ /** Mail */
21341
+ mail: number;
21342
+ /** Objects */
21343
+ objects: number;
21344
+ /** Bytes */
21345
+ bytes: number;
21346
+ };
21347
+ /** StorageSnapshotRead */
21348
+ StorageSnapshotRead: {
21349
+ /**
21350
+ * Taken At
21351
+ * Format: date-time
21352
+ */
21353
+ taken_at: string;
21354
+ /** Bucket Bytes */
21355
+ bucket_bytes: number;
21356
+ /** Bucket Objects */
21357
+ bucket_objects: number;
21358
+ /** Counted Bytes */
21359
+ counted_bytes: number;
21360
+ /** Trash Bytes */
21361
+ trash_bytes: number;
21362
+ /** Orphaned Bytes */
21363
+ orphaned_bytes: number;
21364
+ /** Unattributed Bytes */
21365
+ unattributed_bytes: number;
21366
+ /** By Kind */
21367
+ by_kind: {
21368
+ [key: string]: number;
21369
+ };
21370
+ /** Repaired */
21371
+ repaired: {
21372
+ [key: string]: number;
21373
+ };
21374
+ };
21375
+ /** StorageWorkspaceUsage */
21376
+ StorageWorkspaceUsage: {
21377
+ /** Workspace Ext Id */
21378
+ workspace_ext_id: string;
21379
+ /** Name */
21380
+ name: string;
21381
+ /** Deleted */
21382
+ deleted: boolean;
21383
+ /** Bytes */
21384
+ bytes: number;
21385
+ /** Trash Bytes */
21386
+ trash_bytes: number;
21387
+ /** By Kind */
21388
+ by_kind: components['schemas']['StorageKindUsage'][];
21389
+ };
20929
21390
  /** StreamEventsTool */
20930
21391
  StreamEventsTool: {
20931
21392
  /**
@@ -22103,6 +22564,87 @@ interface components {
22103
22564
  */
22104
22565
  issues: components['schemas']['TransferItemResult'][];
22105
22566
  };
22567
+ /**
22568
+ * TranslationLLMConfig
22569
+ * @description Configuration for TranslationLLM — translates a document passage by passage (``translate_document``).
22570
+ *
22571
+ * The source text is never sent back through the model: each call returns only the translations of the passages
22572
+ * it was given, in order. Terminology is agreed once per document (a glossary pass over its opening), and every
22573
+ * window sees its neighbouring source passages as read-only context, so windows translate concurrently yet read
22574
+ * as one text.
22575
+ */
22576
+ TranslationLLMConfig: {
22577
+ /**
22578
+ * Api Type
22579
+ * @description The inference type (local or remote).
22580
+ * @default remote
22581
+ * @enum {string}
22582
+ */
22583
+ API_TYPE: 'local' | 'remote';
22584
+ /**
22585
+ * Enable Thinking
22586
+ * @description Enable reasoning/thinking mode.
22587
+ * @default false
22588
+ */
22589
+ ENABLE_THINKING: boolean;
22590
+ /**
22591
+ * Model Name
22592
+ * @description The name of the non-reasoning model to be used.
22593
+ * @default Fast
22594
+ */
22595
+ MODEL_NAME: string;
22596
+ /**
22597
+ * System Instruction
22598
+ * @default You are a professional translator of legal, commercial and technical documents.
22599
+ *
22600
+ * You translate the numbered passages you are given into the target language, faithfully and completely:
22601
+ * - Translate every passage in full. Never summarise, shorten, merge, split, reorder, explain or comment.
22602
+ * - Keep the Markdown structure of each passage exactly: headings (#), lists, emphasis, tables (same rows and columns), links and line breaks.
22603
+ * - Keep unchanged: numbers, dates as written, amounts, currencies, clause and section numbering, cross-references, citations, case names, statute names, email addresses, URLs and code.
22604
+ * - Keep proper names of people, companies and places as they are written, unless the glossary gives a translation.
22605
+ * - Use the glossary's translation for every glossary term, every time it occurs.
22606
+ * - A defined term (a capitalised or quoted term given a meaning in the document) is translated the same way everywhere.
22607
+ * - A passage already in the target language, or with nothing to translate (a number, a signature line, a blank form field), is returned as it is.
22608
+ * - The context passages before and after are there only so the translation reads on from its neighbours. Never translate or return them.
22609
+ */
22610
+ SYSTEM_INSTRUCTION: string;
22611
+ /**
22612
+ * Temperature
22613
+ * @description Low temperature for faithful translation.
22614
+ * @default 0.2
22615
+ */
22616
+ TEMPERATURE: number;
22617
+ /**
22618
+ * Max Tokens
22619
+ * @description Max output tokens per call; 0 = uncapped (run to EOS).
22620
+ * @default 0
22621
+ */
22622
+ MAX_TOKENS: number;
22623
+ /**
22624
+ * Window Tokens
22625
+ * @description Source tokens translated per call (whole passages; a larger passage goes alone).
22626
+ * @default 3000
22627
+ */
22628
+ WINDOW_TOKENS: number;
22629
+ /**
22630
+ * Context Tokens
22631
+ * @description Source tokens before and after a window shown as read-only context.
22632
+ * @default 600
22633
+ */
22634
+ CONTEXT_TOKENS: number;
22635
+ /**
22636
+ * Glossary Tokens
22637
+ * @description Source tokens read (headings first) to agree terminology before translating.
22638
+ * @default 6000
22639
+ */
22640
+ GLOSSARY_TOKENS: number;
22641
+ /**
22642
+ * Max Concurrent
22643
+ * @description Maximum concurrent translation calls.
22644
+ * @default 8
22645
+ */
22646
+ MAX_CONCURRENT: number;
22647
+ };
22106
22648
  /**
22107
22649
  * UpdateAgentRequest
22108
22650
  * @description Mutable agent fields. Only appearance for now — identity (name/email/keys)
@@ -25384,6 +25926,153 @@ interface operations {
25384
25926
  };
25385
25927
  };
25386
25928
  };
25929
+ list_storage_projects: {
25930
+ parameters: {
25931
+ query?: {
25932
+ /** @description mine: the caller's projects; deployment: every project (Box admins, managers) */
25933
+ scope?: 'mine' | 'deployment';
25934
+ /** @description Only this project (external id) */
25935
+ project?: string | null;
25936
+ /** @description workspaces: each workspace's usage */
25937
+ include?: 'workspaces'[];
25938
+ };
25939
+ header?: never;
25940
+ path?: never;
25941
+ cookie?: never;
25942
+ };
25943
+ requestBody?: never;
25944
+ responses: {
25945
+ /** @description Successful Response */
25946
+ 200: {
25947
+ headers: {
25948
+ [name: string]: unknown;
25949
+ };
25950
+ content: {
25951
+ 'application/json': components['schemas']['StorageProjectsResponse'];
25952
+ };
25953
+ };
25954
+ /** @description Validation Error */
25955
+ 422: {
25956
+ headers: {
25957
+ [name: string]: unknown;
25958
+ };
25959
+ content: {
25960
+ 'application/json': components['schemas']['HTTPValidationError'];
25961
+ };
25962
+ };
25963
+ };
25964
+ };
25965
+ list_storage_items: {
25966
+ parameters: {
25967
+ query?: {
25968
+ /** @description mine: the caller's projects; deployment: every project (Box admins, managers) */
25969
+ scope?: 'mine' | 'deployment';
25970
+ /** @description Only this project (external id) */
25971
+ project?: string | null;
25972
+ /** @description Only this workspace (external id) */
25973
+ workspace?: string | null;
25974
+ kind?: ('document' | 'mail' | 'mail_draft' | 'recording' | 'chat_attachment' | 'other') | null;
25975
+ state?: 'live' | 'trash' | 'all';
25976
+ limit?: number;
25977
+ offset?: number;
25978
+ /** @description names: decrypt documents' names (needs ``workspace`` and its key on the session) */
25979
+ include?: 'names'[];
25980
+ };
25981
+ header?: never;
25982
+ path?: never;
25983
+ cookie?: never;
25984
+ };
25985
+ requestBody?: never;
25986
+ responses: {
25987
+ /** @description Successful Response */
25988
+ 200: {
25989
+ headers: {
25990
+ [name: string]: unknown;
25991
+ };
25992
+ content: {
25993
+ 'application/json': components['schemas']['StorageItemsResponse'];
25994
+ };
25995
+ };
25996
+ /** @description Validation Error */
25997
+ 422: {
25998
+ headers: {
25999
+ [name: string]: unknown;
26000
+ };
26001
+ content: {
26002
+ 'application/json': components['schemas']['HTTPValidationError'];
26003
+ };
26004
+ };
26005
+ };
26006
+ };
26007
+ purge_storage_items: {
26008
+ parameters: {
26009
+ query: {
26010
+ /** @description The project whose trash to empty (its owner only) */
26011
+ project: string;
26012
+ /** @description Only this workspace's trash */
26013
+ workspace?: string | null;
26014
+ /** @description Only these items (refs from GET /items?state=trash) */
26015
+ refs?: string[];
26016
+ /** @description Also other members' private deleted documents (never listed to the owner; off unless asked) */
26017
+ include_others_private?: boolean;
26018
+ };
26019
+ header?: never;
26020
+ path?: never;
26021
+ cookie?: never;
26022
+ };
26023
+ requestBody?: never;
26024
+ responses: {
26025
+ /** @description Successful Response */
26026
+ 200: {
26027
+ headers: {
26028
+ [name: string]: unknown;
26029
+ };
26030
+ content: {
26031
+ 'application/json': components['schemas']['StoragePurgeResult'];
26032
+ };
26033
+ };
26034
+ /** @description Validation Error */
26035
+ 422: {
26036
+ headers: {
26037
+ [name: string]: unknown;
26038
+ };
26039
+ content: {
26040
+ 'application/json': components['schemas']['HTTPValidationError'];
26041
+ };
26042
+ };
26043
+ };
26044
+ };
26045
+ list_storage_snapshots: {
26046
+ parameters: {
26047
+ query?: {
26048
+ limit?: number;
26049
+ };
26050
+ header?: never;
26051
+ path?: never;
26052
+ cookie?: never;
26053
+ };
26054
+ requestBody?: never;
26055
+ responses: {
26056
+ /** @description Successful Response */
26057
+ 200: {
26058
+ headers: {
26059
+ [name: string]: unknown;
26060
+ };
26061
+ content: {
26062
+ 'application/json': components['schemas']['StorageSnapshotRead'][];
26063
+ };
26064
+ };
26065
+ /** @description Validation Error */
26066
+ 422: {
26067
+ headers: {
26068
+ [name: string]: unknown;
26069
+ };
26070
+ content: {
26071
+ 'application/json': components['schemas']['HTTPValidationError'];
26072
+ };
26073
+ };
26074
+ };
26075
+ };
25387
26076
  get_identity_verification: {
25388
26077
  parameters: {
25389
26078
  query?: never;
@@ -25859,6 +26548,39 @@ interface operations {
25859
26548
  };
25860
26549
  };
25861
26550
  };
26551
+ restore_workspaces: {
26552
+ parameters: {
26553
+ query?: never;
26554
+ header?: never;
26555
+ path?: never;
26556
+ cookie?: never;
26557
+ };
26558
+ requestBody: {
26559
+ content: {
26560
+ 'application/json': components['schemas']['DeleteWorkspacesRequest'];
26561
+ };
26562
+ };
26563
+ responses: {
26564
+ /** @description Successful Response */
26565
+ 200: {
26566
+ headers: {
26567
+ [name: string]: unknown;
26568
+ };
26569
+ content: {
26570
+ 'application/json': string[];
26571
+ };
26572
+ };
26573
+ /** @description Validation Error */
26574
+ 422: {
26575
+ headers: {
26576
+ [name: string]: unknown;
26577
+ };
26578
+ content: {
26579
+ 'application/json': components['schemas']['HTTPValidationError'];
26580
+ };
26581
+ };
26582
+ };
26583
+ };
25862
26584
  move_workspace_to_project: {
25863
26585
  parameters: {
25864
26586
  query?: never;
@@ -27131,6 +27853,37 @@ interface operations {
27131
27853
  };
27132
27854
  };
27133
27855
  };
27856
+ finalise_translation: {
27857
+ parameters: {
27858
+ query?: never;
27859
+ header?: never;
27860
+ path: {
27861
+ document_ext_id: string;
27862
+ };
27863
+ cookie?: never;
27864
+ };
27865
+ requestBody?: never;
27866
+ responses: {
27867
+ /** @description Successful Response */
27868
+ 200: {
27869
+ headers: {
27870
+ [name: string]: unknown;
27871
+ };
27872
+ content: {
27873
+ 'application/json': components['schemas']['FinalisedTranslationResponse'];
27874
+ };
27875
+ };
27876
+ /** @description Validation Error */
27877
+ 422: {
27878
+ headers: {
27879
+ [name: string]: unknown;
27880
+ };
27881
+ content: {
27882
+ 'application/json': components['schemas']['HTTPValidationError'];
27883
+ };
27884
+ };
27885
+ };
27886
+ };
27134
27887
  generate_doctags: {
27135
27888
  parameters: {
27136
27889
  query?: {
@@ -27307,6 +28060,110 @@ interface operations {
27307
28060
  };
27308
28061
  };
27309
28062
  };
28063
+ list_deleted_documents: {
28064
+ parameters: {
28065
+ query?: {
28066
+ /** @description Destination workspace; defaults to the active workspace */
28067
+ workspace_ext_id?: string | null;
28068
+ };
28069
+ header?: never;
28070
+ path?: never;
28071
+ cookie?: never;
28072
+ };
28073
+ requestBody?: never;
28074
+ responses: {
28075
+ /** @description Successful Response */
28076
+ 200: {
28077
+ headers: {
28078
+ [name: string]: unknown;
28079
+ };
28080
+ content: {
28081
+ 'application/json': components['schemas']['DeletedDocumentsPage'];
28082
+ };
28083
+ };
28084
+ /** @description Validation Error */
28085
+ 422: {
28086
+ headers: {
28087
+ [name: string]: unknown;
28088
+ };
28089
+ content: {
28090
+ 'application/json': components['schemas']['HTTPValidationError'];
28091
+ };
28092
+ };
28093
+ };
28094
+ };
28095
+ purge_deleted_documents: {
28096
+ parameters: {
28097
+ query?: {
28098
+ /** @description Destination workspace; defaults to the active workspace */
28099
+ workspace_ext_id?: string | null;
28100
+ };
28101
+ header?: never;
28102
+ path?: never;
28103
+ cookie?: never;
28104
+ };
28105
+ requestBody?: {
28106
+ content: {
28107
+ 'application/json': components['schemas']['DeletedDocumentsPurge'];
28108
+ };
28109
+ };
28110
+ responses: {
28111
+ /** @description Successful Response */
28112
+ 200: {
28113
+ headers: {
28114
+ [name: string]: unknown;
28115
+ };
28116
+ content: {
28117
+ 'application/json': components['schemas']['DeletedDocumentsResult'];
28118
+ };
28119
+ };
28120
+ /** @description Validation Error */
28121
+ 422: {
28122
+ headers: {
28123
+ [name: string]: unknown;
28124
+ };
28125
+ content: {
28126
+ 'application/json': components['schemas']['HTTPValidationError'];
28127
+ };
28128
+ };
28129
+ };
28130
+ };
28131
+ restore_documents: {
28132
+ parameters: {
28133
+ query?: {
28134
+ /** @description Destination workspace; defaults to the active workspace */
28135
+ workspace_ext_id?: string | null;
28136
+ };
28137
+ header?: never;
28138
+ path?: never;
28139
+ cookie?: never;
28140
+ };
28141
+ requestBody: {
28142
+ content: {
28143
+ 'application/json': components['schemas']['DeletedDocumentsRequest'];
28144
+ };
28145
+ };
28146
+ responses: {
28147
+ /** @description Successful Response */
28148
+ 200: {
28149
+ headers: {
28150
+ [name: string]: unknown;
28151
+ };
28152
+ content: {
28153
+ 'application/json': components['schemas']['DeletedDocumentsResult'];
28154
+ };
28155
+ };
28156
+ /** @description Validation Error */
28157
+ 422: {
28158
+ headers: {
28159
+ [name: string]: unknown;
28160
+ };
28161
+ content: {
28162
+ 'application/json': components['schemas']['HTTPValidationError'];
28163
+ };
28164
+ };
28165
+ };
28166
+ };
27310
28167
  prepare_document_signature: {
27311
28168
  parameters: {
27312
28169
  query?: never;
@@ -35778,6 +36635,40 @@ interface operations {
35778
36635
  };
35779
36636
  };
35780
36637
  };
36638
+ empty_trash_v1_mail_accounts__account_id__messages_delete: {
36639
+ parameters: {
36640
+ query: {
36641
+ /** @description Only the Trash can be emptied */
36642
+ folder: 'trash';
36643
+ };
36644
+ header?: never;
36645
+ path: {
36646
+ account_id: string;
36647
+ };
36648
+ cookie?: never;
36649
+ };
36650
+ requestBody?: never;
36651
+ responses: {
36652
+ /** @description Successful Response */
36653
+ 200: {
36654
+ headers: {
36655
+ [name: string]: unknown;
36656
+ };
36657
+ content: {
36658
+ 'application/json': components['schemas']['MailTrashEmptied'];
36659
+ };
36660
+ };
36661
+ /** @description Validation Error */
36662
+ 422: {
36663
+ headers: {
36664
+ [name: string]: unknown;
36665
+ };
36666
+ content: {
36667
+ 'application/json': components['schemas']['HTTPValidationError'];
36668
+ };
36669
+ };
36670
+ };
36671
+ };
35781
36672
  message_v1_mail_accounts__account_id__messages__message_id__get: {
35782
36673
  parameters: {
35783
36674
  query?: never;
@@ -35810,6 +36701,36 @@ interface operations {
35810
36701
  };
35811
36702
  };
35812
36703
  };
36704
+ delete_message_v1_mail_accounts__account_id__messages__message_id__delete: {
36705
+ parameters: {
36706
+ query?: never;
36707
+ header?: never;
36708
+ path: {
36709
+ message_id: string;
36710
+ account_id: string;
36711
+ };
36712
+ cookie?: never;
36713
+ };
36714
+ requestBody?: never;
36715
+ responses: {
36716
+ /** @description Successful Response */
36717
+ 204: {
36718
+ headers: {
36719
+ [name: string]: unknown;
36720
+ };
36721
+ content?: never;
36722
+ };
36723
+ /** @description Validation Error */
36724
+ 422: {
36725
+ headers: {
36726
+ [name: string]: unknown;
36727
+ };
36728
+ content: {
36729
+ 'application/json': components['schemas']['HTTPValidationError'];
36730
+ };
36731
+ };
36732
+ };
36733
+ };
35813
36734
  update_v1_mail_accounts__account_id__messages__message_id__patch: {
35814
36735
  parameters: {
35815
36736
  query?: never;