@unofficialbox/box-open-sdk 0.3.1 → 0.4.1

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.
Files changed (371) hide show
  1. package/README.md +2 -0
  2. package/dist/cjs/auth.js +3 -3
  3. package/dist/cjs/buildinfo.js +2 -2
  4. package/dist/cjs/client.js +3 -0
  5. package/dist/cjs/jwt.js +1 -1
  6. package/dist/cjs/managers/collaboration_allowlist_entries.js +6 -6
  7. package/dist/cjs/managers/collaboration_allowlist_exempt_targets.js +6 -6
  8. package/dist/cjs/managers/index.js +1 -0
  9. package/dist/cjs/managers/memberships.js +4 -4
  10. package/dist/cjs/managers/query.js +68 -0
  11. package/dist/cjs/models/schemas/ai.js +3 -0
  12. package/dist/cjs/models/schemas/ai_studio.js +3 -0
  13. package/dist/cjs/models/schemas/app_item_associations.js +3 -0
  14. package/dist/cjs/models/schemas/archives.js +3 -0
  15. package/dist/cjs/models/schemas/authorization.js +3 -0
  16. package/dist/cjs/models/schemas/automate_workflows.js +3 -0
  17. package/dist/cjs/models/schemas/avatars.js +3 -0
  18. package/dist/cjs/models/schemas/chunked_uploads.js +3 -0
  19. package/dist/cjs/models/schemas/classifications.js +3 -0
  20. package/dist/cjs/models/schemas/collaboration_allowlist_entries.js +3 -0
  21. package/dist/cjs/models/schemas/collaboration_allowlist_exempt_targets.js +3 -0
  22. package/dist/cjs/models/schemas/collections.js +3 -0
  23. package/dist/cjs/models/schemas/comments.js +3 -0
  24. package/dist/cjs/models/schemas/device_pinners.js +3 -0
  25. package/dist/cjs/models/schemas/docgen.js +3 -0
  26. package/dist/cjs/models/schemas/docgen_template.js +3 -0
  27. package/dist/cjs/models/schemas/email_aliases.js +3 -0
  28. package/dist/cjs/models/schemas/enterprise_configurations.js +3 -0
  29. package/dist/cjs/models/schemas/events.js +3 -0
  30. package/dist/cjs/models/schemas/external_users.js +3 -0
  31. package/dist/cjs/models/schemas/file_requests.js +3 -0
  32. package/dist/cjs/models/schemas/file_version_legal_holds.js +3 -0
  33. package/dist/cjs/models/schemas/file_version_retentions.js +3 -0
  34. package/dist/cjs/models/schemas/file_versions.js +3 -0
  35. package/dist/cjs/models/schemas/files.js +3 -0
  36. package/dist/cjs/models/schemas/folder_locks.js +3 -0
  37. package/dist/cjs/models/schemas/folders.js +3 -0
  38. package/dist/cjs/models/schemas/groups.js +3 -0
  39. package/dist/cjs/models/schemas/hub_collaborations.js +3 -0
  40. package/dist/cjs/models/schemas/hub_document.js +3 -0
  41. package/dist/cjs/models/schemas/hub_items.js +3 -0
  42. package/dist/cjs/models/schemas/hubs.js +3 -0
  43. package/dist/cjs/models/schemas/integration_mappings.js +3 -0
  44. package/dist/cjs/models/schemas/invites.js +3 -0
  45. package/dist/cjs/models/schemas/legal_hold_policies.js +3 -0
  46. package/dist/cjs/models/schemas/legal_hold_policy_assignments.js +3 -0
  47. package/dist/cjs/models/schemas/list_collaborations.js +3 -0
  48. package/dist/cjs/models/schemas/memberships.js +3 -0
  49. package/dist/cjs/models/schemas/metadata_cascade_policies.js +3 -0
  50. package/dist/cjs/models/schemas/metadata_taxonomies.js +3 -0
  51. package/dist/cjs/models/schemas/metadata_templates.js +3 -0
  52. package/dist/cjs/models/schemas/notes.js +3 -0
  53. package/dist/cjs/models/schemas/query.js +3 -0
  54. package/dist/cjs/models/schemas/recent_items.js +3 -0
  55. package/dist/cjs/models/schemas/retention_policies.js +3 -0
  56. package/dist/cjs/models/schemas/retention_policy_assignments.js +3 -0
  57. package/dist/cjs/models/schemas/search.js +3 -0
  58. package/dist/cjs/models/schemas/session_termination.js +3 -0
  59. package/dist/cjs/models/schemas/shared_links_folders.js +3 -0
  60. package/dist/cjs/models/schemas/shield_information_barrier_reports.js +3 -0
  61. package/dist/cjs/models/schemas/shield_information_barrier_segment_members.js +3 -0
  62. package/dist/cjs/models/schemas/shield_information_barrier_segment_restrictions.js +3 -0
  63. package/dist/cjs/models/schemas/shield_information_barrier_segments.js +3 -0
  64. package/dist/cjs/models/schemas/shield_information_barriers.js +3 -0
  65. package/dist/cjs/models/schemas/shield_lists.js +3 -0
  66. package/dist/cjs/models/schemas/sign_requests.js +3 -0
  67. package/dist/cjs/models/schemas/sign_templates.js +3 -0
  68. package/dist/cjs/models/schemas/skills.js +3 -0
  69. package/dist/cjs/models/schemas/storage_policies.js +3 -0
  70. package/dist/cjs/models/schemas/storage_policy_assignments.js +3 -0
  71. package/dist/cjs/models/schemas/task_assignments.js +3 -0
  72. package/dist/cjs/models/schemas/tasks.js +3 -0
  73. package/dist/cjs/models/schemas/terms_of_service_user_statuses.js +3 -0
  74. package/dist/cjs/models/schemas/terms_of_services.js +3 -0
  75. package/dist/cjs/models/schemas/transfer.js +3 -0
  76. package/dist/cjs/models/schemas/trashed_files.js +3 -0
  77. package/dist/cjs/models/schemas/trashed_folders.js +3 -0
  78. package/dist/cjs/models/schemas/trashed_items.js +3 -0
  79. package/dist/cjs/models/schemas/trashed_web_links.js +3 -0
  80. package/dist/cjs/models/schemas/uploads.js +3 -0
  81. package/dist/cjs/models/schemas/user_collaborations.js +3 -0
  82. package/dist/cjs/models/schemas/users.js +3 -0
  83. package/dist/cjs/models/schemas/web_links.js +3 -0
  84. package/dist/cjs/models/schemas/webhooks.js +3 -0
  85. package/dist/cjs/models/schemas/workflows.js +3 -0
  86. package/dist/cjs/models/schemas/zip_downloads.js +3 -0
  87. package/dist/cjs/models/schemas.js +91 -1
  88. package/dist/cjs/runtime.js +8 -3
  89. package/dist/cjs/tokens.js +5 -3
  90. package/dist/esm/auth.js +3 -3
  91. package/dist/esm/buildinfo.js +2 -2
  92. package/dist/esm/client.js +3 -0
  93. package/dist/esm/jwt.js +1 -1
  94. package/dist/esm/managers/collaboration_allowlist_entries.js +6 -6
  95. package/dist/esm/managers/collaboration_allowlist_exempt_targets.js +6 -6
  96. package/dist/esm/managers/index.js +1 -0
  97. package/dist/esm/managers/memberships.js +4 -4
  98. package/dist/esm/managers/query.js +31 -0
  99. package/dist/esm/models/schemas/ai.js +2 -0
  100. package/dist/esm/models/schemas/ai_studio.js +2 -0
  101. package/dist/esm/models/schemas/app_item_associations.js +2 -0
  102. package/dist/esm/models/schemas/archives.js +2 -0
  103. package/dist/esm/models/schemas/authorization.js +2 -0
  104. package/dist/esm/models/schemas/automate_workflows.js +2 -0
  105. package/dist/esm/models/schemas/avatars.js +2 -0
  106. package/dist/esm/models/schemas/chunked_uploads.js +2 -0
  107. package/dist/esm/models/schemas/classifications.js +2 -0
  108. package/dist/esm/models/schemas/collaboration_allowlist_entries.js +2 -0
  109. package/dist/esm/models/schemas/collaboration_allowlist_exempt_targets.js +2 -0
  110. package/dist/esm/models/schemas/collections.js +2 -0
  111. package/dist/esm/models/schemas/comments.js +2 -0
  112. package/dist/esm/models/schemas/device_pinners.js +2 -0
  113. package/dist/esm/models/schemas/docgen.js +2 -0
  114. package/dist/esm/models/schemas/docgen_template.js +2 -0
  115. package/dist/esm/models/schemas/email_aliases.js +2 -0
  116. package/dist/esm/models/schemas/enterprise_configurations.js +2 -0
  117. package/dist/esm/models/schemas/events.js +2 -0
  118. package/dist/esm/models/schemas/external_users.js +2 -0
  119. package/dist/esm/models/schemas/file_requests.js +2 -0
  120. package/dist/esm/models/schemas/file_version_legal_holds.js +2 -0
  121. package/dist/esm/models/schemas/file_version_retentions.js +2 -0
  122. package/dist/esm/models/schemas/file_versions.js +2 -0
  123. package/dist/esm/models/schemas/files.js +2 -0
  124. package/dist/esm/models/schemas/folder_locks.js +2 -0
  125. package/dist/esm/models/schemas/folders.js +2 -0
  126. package/dist/esm/models/schemas/groups.js +2 -0
  127. package/dist/esm/models/schemas/hub_collaborations.js +2 -0
  128. package/dist/esm/models/schemas/hub_document.js +2 -0
  129. package/dist/esm/models/schemas/hub_items.js +2 -0
  130. package/dist/esm/models/schemas/hubs.js +2 -0
  131. package/dist/esm/models/schemas/integration_mappings.js +2 -0
  132. package/dist/esm/models/schemas/invites.js +2 -0
  133. package/dist/esm/models/schemas/legal_hold_policies.js +2 -0
  134. package/dist/esm/models/schemas/legal_hold_policy_assignments.js +2 -0
  135. package/dist/esm/models/schemas/list_collaborations.js +2 -0
  136. package/dist/esm/models/schemas/memberships.js +2 -0
  137. package/dist/esm/models/schemas/metadata_cascade_policies.js +2 -0
  138. package/dist/esm/models/schemas/metadata_taxonomies.js +2 -0
  139. package/dist/esm/models/schemas/metadata_templates.js +2 -0
  140. package/dist/esm/models/schemas/notes.js +2 -0
  141. package/dist/esm/models/schemas/query.js +2 -0
  142. package/dist/esm/models/schemas/recent_items.js +2 -0
  143. package/dist/esm/models/schemas/retention_policies.js +2 -0
  144. package/dist/esm/models/schemas/retention_policy_assignments.js +2 -0
  145. package/dist/esm/models/schemas/search.js +2 -0
  146. package/dist/esm/models/schemas/session_termination.js +2 -0
  147. package/dist/esm/models/schemas/shared_links_folders.js +2 -0
  148. package/dist/esm/models/schemas/shield_information_barrier_reports.js +2 -0
  149. package/dist/esm/models/schemas/shield_information_barrier_segment_members.js +2 -0
  150. package/dist/esm/models/schemas/shield_information_barrier_segment_restrictions.js +2 -0
  151. package/dist/esm/models/schemas/shield_information_barrier_segments.js +2 -0
  152. package/dist/esm/models/schemas/shield_information_barriers.js +2 -0
  153. package/dist/esm/models/schemas/shield_lists.js +2 -0
  154. package/dist/esm/models/schemas/sign_requests.js +2 -0
  155. package/dist/esm/models/schemas/sign_templates.js +2 -0
  156. package/dist/esm/models/schemas/skills.js +2 -0
  157. package/dist/esm/models/schemas/storage_policies.js +2 -0
  158. package/dist/esm/models/schemas/storage_policy_assignments.js +2 -0
  159. package/dist/esm/models/schemas/task_assignments.js +2 -0
  160. package/dist/esm/models/schemas/tasks.js +2 -0
  161. package/dist/esm/models/schemas/terms_of_service_user_statuses.js +2 -0
  162. package/dist/esm/models/schemas/terms_of_services.js +2 -0
  163. package/dist/esm/models/schemas/transfer.js +2 -0
  164. package/dist/esm/models/schemas/trashed_files.js +2 -0
  165. package/dist/esm/models/schemas/trashed_folders.js +2 -0
  166. package/dist/esm/models/schemas/trashed_items.js +2 -0
  167. package/dist/esm/models/schemas/trashed_web_links.js +2 -0
  168. package/dist/esm/models/schemas/uploads.js +2 -0
  169. package/dist/esm/models/schemas/user_collaborations.js +2 -0
  170. package/dist/esm/models/schemas/users.js +2 -0
  171. package/dist/esm/models/schemas/web_links.js +2 -0
  172. package/dist/esm/models/schemas/webhooks.js +2 -0
  173. package/dist/esm/models/schemas/workflows.js +2 -0
  174. package/dist/esm/models/schemas/zip_downloads.js +2 -0
  175. package/dist/esm/models/schemas.js +77 -2
  176. package/dist/esm/runtime.js +8 -3
  177. package/dist/esm/tokens.js +5 -3
  178. package/dist/types/auth.d.ts +8 -0
  179. package/dist/types/buildinfo.d.ts +1 -1
  180. package/dist/types/client.d.ts +2 -0
  181. package/dist/types/jwt.d.ts +4 -0
  182. package/dist/types/managers/archives.d.ts +2 -2
  183. package/dist/types/managers/avatars.d.ts +1 -1
  184. package/dist/types/managers/chunked_uploads.d.ts +3 -3
  185. package/dist/types/managers/classifications.d.ts +3 -3
  186. package/dist/types/managers/collaboration_allowlist_entries.d.ts +7 -7
  187. package/dist/types/managers/collaboration_allowlist_exempt_targets.d.ts +7 -7
  188. package/dist/types/managers/comments.d.ts +2 -2
  189. package/dist/types/managers/email_aliases.d.ts +1 -1
  190. package/dist/types/managers/file_classifications.d.ts +2 -2
  191. package/dist/types/managers/file_metadata.d.ts +4 -4
  192. package/dist/types/managers/file_versions.d.ts +2 -2
  193. package/dist/types/managers/file_watermarks.d.ts +1 -1
  194. package/dist/types/managers/files.d.ts +2 -2
  195. package/dist/types/managers/folder_classifications.d.ts +2 -2
  196. package/dist/types/managers/folder_locks.d.ts +1 -1
  197. package/dist/types/managers/folder_metadata.d.ts +4 -4
  198. package/dist/types/managers/folder_watermarks.d.ts +1 -1
  199. package/dist/types/managers/folders.d.ts +3 -3
  200. package/dist/types/managers/groups.d.ts +2 -2
  201. package/dist/types/managers/index.d.ts +1 -0
  202. package/dist/types/managers/integration_mappings.d.ts +2 -2
  203. package/dist/types/managers/invites.d.ts +1 -1
  204. package/dist/types/managers/legal_hold_policies.d.ts +2 -2
  205. package/dist/types/managers/legal_hold_policy_assignments.d.ts +1 -1
  206. package/dist/types/managers/memberships.d.ts +10 -10
  207. package/dist/types/managers/metadata_cascade_policies.d.ts +2 -2
  208. package/dist/types/managers/metadata_taxonomies.d.ts +6 -6
  209. package/dist/types/managers/metadata_templates.d.ts +4 -4
  210. package/dist/types/managers/query.d.ts +9 -0
  211. package/dist/types/managers/retention_policies.d.ts +2 -2
  212. package/dist/types/managers/retention_policy_assignments.d.ts +1 -1
  213. package/dist/types/managers/session_termination.d.ts +2 -2
  214. package/dist/types/managers/shared_links_files.d.ts +3 -3
  215. package/dist/types/managers/shared_links_folders.d.ts +3 -3
  216. package/dist/types/managers/shared_links_web_links.d.ts +3 -3
  217. package/dist/types/managers/shield_information_barrier_segment_members.d.ts +1 -1
  218. package/dist/types/managers/shield_information_barrier_segment_restrictions.d.ts +1 -1
  219. package/dist/types/managers/shield_information_barrier_segments.d.ts +2 -2
  220. package/dist/types/managers/shield_information_barriers.d.ts +2 -2
  221. package/dist/types/managers/skills.d.ts +3 -3
  222. package/dist/types/managers/storage_policy_assignments.d.ts +2 -2
  223. package/dist/types/managers/task_assignments.d.ts +2 -2
  224. package/dist/types/managers/tasks.d.ts +2 -2
  225. package/dist/types/managers/terms_of_service_user_statuses.d.ts +2 -2
  226. package/dist/types/managers/terms_of_services.d.ts +2 -2
  227. package/dist/types/managers/transfer.d.ts +1 -1
  228. package/dist/types/managers/trashed_files.d.ts +1 -1
  229. package/dist/types/managers/trashed_folders.d.ts +1 -1
  230. package/dist/types/managers/trashed_web_links.d.ts +1 -1
  231. package/dist/types/managers/uploads.d.ts +2 -2
  232. package/dist/types/managers/user_collaborations.d.ts +2 -2
  233. package/dist/types/managers/users.d.ts +2 -2
  234. package/dist/types/managers/web_links.d.ts +2 -2
  235. package/dist/types/managers/webhooks.d.ts +2 -2
  236. package/dist/types/managers/workflows.d.ts +1 -1
  237. package/dist/types/models/schemas/ai.d.ts +240 -0
  238. package/dist/types/models/schemas/ai_studio.d.ts +172 -0
  239. package/dist/types/models/schemas/app_item_associations.d.ts +34 -0
  240. package/dist/types/models/schemas/archives.d.ts +27 -0
  241. package/dist/types/models/schemas/authorization.d.ts +43 -0
  242. package/dist/types/models/schemas/automate_workflows.d.ts +29 -0
  243. package/dist/types/models/schemas/avatars.d.ts +11 -0
  244. package/dist/types/models/schemas/chunked_uploads.d.ts +47 -0
  245. package/dist/types/models/schemas/classifications.d.ts +66 -0
  246. package/dist/types/models/schemas/collaboration_allowlist_entries.d.ts +21 -0
  247. package/dist/types/models/schemas/collaboration_allowlist_exempt_targets.d.ts +19 -0
  248. package/dist/types/models/schemas/collections.d.ts +15 -0
  249. package/dist/types/models/schemas/comments.d.ts +33 -0
  250. package/dist/types/models/schemas/device_pinners.d.ts +20 -0
  251. package/dist/types/models/schemas/docgen.d.ts +40 -0
  252. package/dist/types/models/schemas/docgen_template.d.ts +29 -0
  253. package/dist/types/models/schemas/email_aliases.d.ts +14 -0
  254. package/dist/types/models/schemas/enterprise_configurations.d.ts +251 -0
  255. package/dist/types/models/schemas/events.d.ts +71 -0
  256. package/dist/types/models/schemas/external_users.d.ts +16 -0
  257. package/dist/types/models/schemas/file_requests.d.ts +41 -0
  258. package/dist/types/models/schemas/file_version_legal_holds.d.ts +16 -0
  259. package/dist/types/models/schemas/file_version_retentions.d.ts +17 -0
  260. package/dist/types/models/schemas/file_versions.d.ts +32 -0
  261. package/dist/types/models/schemas/files.d.ts +27 -0
  262. package/dist/types/models/schemas/folder_locks.d.ts +27 -0
  263. package/dist/types/models/schemas/folders.d.ts +28 -0
  264. package/dist/types/models/schemas/groups.d.ts +42 -0
  265. package/dist/types/models/schemas/hub_collaborations.d.ts +57 -0
  266. package/dist/types/models/schemas/hub_document.d.ts +67 -0
  267. package/dist/types/models/schemas/hub_items.d.ts +46 -0
  268. package/dist/types/models/schemas/hubs.d.ts +43 -0
  269. package/dist/types/models/schemas/integration_mappings.d.ts +83 -0
  270. package/dist/types/models/schemas/invites.d.ts +19 -0
  271. package/dist/types/models/schemas/legal_hold_policies.d.ts +43 -0
  272. package/dist/types/models/schemas/legal_hold_policy_assignments.d.ts +43 -0
  273. package/dist/types/models/schemas/list_collaborations.d.ts +14 -0
  274. package/dist/types/models/schemas/memberships.d.ts +29 -0
  275. package/dist/types/models/schemas/metadata_cascade_policies.d.ts +29 -0
  276. package/dist/types/models/schemas/metadata_taxonomies.d.ts +60 -0
  277. package/dist/types/models/schemas/metadata_templates.d.ts +71 -0
  278. package/dist/types/models/schemas/notes.d.ts +13 -0
  279. package/dist/types/models/schemas/query.d.ts +62 -0
  280. package/dist/types/models/schemas/recent_items.d.ts +25 -0
  281. package/dist/types/models/schemas/retention_policies.d.ts +60 -0
  282. package/dist/types/models/schemas/retention_policy_assignments.d.ts +47 -0
  283. package/dist/types/models/schemas/search.d.ts +98 -0
  284. package/dist/types/models/schemas/session_termination.d.ts +10 -0
  285. package/dist/types/models/schemas/shared_links_folders.d.ts +11 -0
  286. package/dist/types/models/schemas/shield_information_barrier_reports.d.ts +27 -0
  287. package/dist/types/models/schemas/shield_information_barrier_segment_members.d.ts +24 -0
  288. package/dist/types/models/schemas/shield_information_barrier_segment_restrictions.d.ts +24 -0
  289. package/dist/types/models/schemas/shield_information_barrier_segments.d.ts +26 -0
  290. package/dist/types/models/schemas/shield_information_barriers.d.ts +31 -0
  291. package/dist/types/models/schemas/shield_lists.d.ts +88 -0
  292. package/dist/types/models/schemas/sign_requests.d.ts +136 -0
  293. package/dist/types/models/schemas/sign_templates.d.ts +90 -0
  294. package/dist/types/models/schemas/skills.d.ts +120 -0
  295. package/dist/types/models/schemas/storage_policies.d.ts +12 -0
  296. package/dist/types/models/schemas/storage_policy_assignments.d.ts +34 -0
  297. package/dist/types/models/schemas/task_assignments.d.ts +17 -0
  298. package/dist/types/models/schemas/tasks.d.ts +37 -0
  299. package/dist/types/models/schemas/terms_of_service_user_statuses.d.ts +27 -0
  300. package/dist/types/models/schemas/terms_of_services.d.ts +27 -0
  301. package/dist/types/models/schemas/transfer.d.ts +4 -0
  302. package/dist/types/models/schemas/trashed_files.d.ts +49 -0
  303. package/dist/types/models/schemas/trashed_folders.d.ts +47 -0
  304. package/dist/types/models/schemas/trashed_items.d.ts +1 -0
  305. package/dist/types/models/schemas/trashed_web_links.d.ts +41 -0
  306. package/dist/types/models/schemas/uploads.d.ts +28 -0
  307. package/dist/types/models/schemas/user_collaborations.d.ts +26 -0
  308. package/dist/types/models/schemas/users.d.ts +98 -0
  309. package/dist/types/models/schemas/web_links.d.ts +20 -0
  310. package/dist/types/models/schemas/webhooks.d.ts +37 -0
  311. package/dist/types/models/schemas/workflows.d.ts +93 -0
  312. package/dist/types/models/schemas/zip_downloads.d.ts +29 -0
  313. package/dist/types/models/schemas.d.ts +157 -3493
  314. package/dist/types/runtime.d.ts +10 -0
  315. package/dist/types/tokens.d.ts +4 -2
  316. package/docs/README.md +1 -0
  317. package/docs/managers/archives.md +2 -2
  318. package/docs/managers/avatars.md +1 -1
  319. package/docs/managers/chunked_uploads.md +3 -3
  320. package/docs/managers/classifications.md +3 -3
  321. package/docs/managers/collaboration_allowlist_entries.md +10 -10
  322. package/docs/managers/collaboration_allowlist_exempt_targets.md +10 -10
  323. package/docs/managers/comments.md +2 -2
  324. package/docs/managers/email_aliases.md +1 -1
  325. package/docs/managers/file_classifications.md +2 -2
  326. package/docs/managers/file_metadata.md +5 -5
  327. package/docs/managers/file_versions.md +2 -2
  328. package/docs/managers/file_watermarks.md +1 -1
  329. package/docs/managers/files.md +2 -2
  330. package/docs/managers/folder_classifications.md +2 -2
  331. package/docs/managers/folder_locks.md +1 -1
  332. package/docs/managers/folder_metadata.md +5 -5
  333. package/docs/managers/folder_watermarks.md +1 -1
  334. package/docs/managers/folders.md +3 -3
  335. package/docs/managers/groups.md +2 -2
  336. package/docs/managers/integration_mappings.md +2 -2
  337. package/docs/managers/invites.md +1 -1
  338. package/docs/managers/legal_hold_policies.md +2 -2
  339. package/docs/managers/legal_hold_policy_assignments.md +1 -1
  340. package/docs/managers/memberships.md +10 -10
  341. package/docs/managers/metadata_cascade_policies.md +2 -2
  342. package/docs/managers/metadata_taxonomies.md +6 -6
  343. package/docs/managers/metadata_templates.md +5 -5
  344. package/docs/managers/query.md +33 -0
  345. package/docs/managers/retention_policies.md +2 -2
  346. package/docs/managers/retention_policy_assignments.md +1 -1
  347. package/docs/managers/session_termination.md +2 -2
  348. package/docs/managers/shared_links_files.md +3 -3
  349. package/docs/managers/shared_links_folders.md +3 -3
  350. package/docs/managers/shared_links_web_links.md +3 -3
  351. package/docs/managers/shield_information_barrier_segment_members.md +1 -1
  352. package/docs/managers/shield_information_barrier_segment_restrictions.md +1 -1
  353. package/docs/managers/shield_information_barrier_segments.md +2 -2
  354. package/docs/managers/shield_information_barriers.md +2 -2
  355. package/docs/managers/skills.md +3 -3
  356. package/docs/managers/storage_policy_assignments.md +2 -2
  357. package/docs/managers/task_assignments.md +2 -2
  358. package/docs/managers/tasks.md +2 -2
  359. package/docs/managers/terms_of_service_user_statuses.md +2 -2
  360. package/docs/managers/terms_of_services.md +2 -2
  361. package/docs/managers/transfer.md +1 -1
  362. package/docs/managers/trashed_files.md +1 -1
  363. package/docs/managers/trashed_folders.md +1 -1
  364. package/docs/managers/trashed_web_links.md +1 -1
  365. package/docs/managers/uploads.md +2 -2
  366. package/docs/managers/user_collaborations.md +2 -2
  367. package/docs/managers/users.md +2 -2
  368. package/docs/managers/web_links.md +2 -2
  369. package/docs/managers/webhooks.md +2 -2
  370. package/docs/managers/workflows.md +1 -1
  371. package/package.json +1 -1
@@ -1,57 +1,87 @@
1
- export interface AccessToken {
2
- access_token?: string;
3
- expires_in?: number;
4
- token_type?: AccessTokenTokenType;
5
- restricted_to?: Array<ResourceScope>;
6
- refresh_token?: string;
7
- issued_token_type?: AccessTokenIssuedTokenType;
8
- }
9
- export type AiAgent = (AiAgentAsk & {
10
- type: "ai_agent_ask";
11
- }) | (AiAgentTextGen & {
12
- type: "ai_agent_text_gen";
13
- }) | (AiAgentExtract & {
14
- type: "ai_agent_extract";
15
- }) | (AiAgentExtractStructured & {
16
- type: "ai_agent_extract_structured";
17
- }) | {
18
- type: string;
19
- [key: string]: unknown;
20
- };
21
- export type AiAgentAllowedEntity = (UserBase & {
22
- type: "user";
23
- }) | (GroupBase & {
24
- type: "group";
25
- }) | {
26
- type: string;
27
- [key: string]: unknown;
28
- };
29
- export interface AiAgentAsk {
30
- type: AiAgentAskType;
31
- long_text?: AiAgentLongTextTool;
32
- basic_text?: AiAgentBasicTextTool;
33
- spreadsheet?: AiAgentSpreadsheetTool;
34
- long_text_multi?: AiAgentLongTextTool;
35
- basic_text_multi?: AiAgentBasicTextTool;
36
- basic_image?: AiAgentBasicTextTool;
37
- basic_image_multi?: AiAgentBasicTextTool;
38
- }
39
- export interface AiAgentBasicGenTool {
40
- model?: string;
41
- num_tokens_for_completion?: number;
42
- llm_endpoint_params?: AiLlmEndpointParams;
43
- system_message?: string;
44
- prompt_template?: string;
45
- embeddings?: AiAgentBasicGenToolEmbeddings;
46
- content_template?: string;
47
- }
48
- export interface AiAgentBasicTextTool {
49
- model?: string;
50
- num_tokens_for_completion?: number;
51
- llm_endpoint_params?: AiLlmEndpointParams;
52
- system_message?: string;
53
- prompt_template?: string;
54
- }
1
+ import type { AiAgentAllowedEntity, AiSingleAgentResponseType } from './schemas/ai_studio.js';
2
+ import type { CommentType } from './schemas/comments.js';
3
+ import type { IntegrationMappingType } from './schemas/integration_mappings.js';
4
+ import type { ShieldInformationBarrierReportType } from './schemas/shield_information_barrier_reports.js';
5
+ import type { ShieldInformationBarrierSegmentMemberType } from './schemas/shield_information_barrier_segment_members.js';
6
+ import type { ShieldInformationBarrierSegmentRestrictionType } from './schemas/shield_information_barrier_segment_restrictions.js';
7
+ import type { SignRequestPrefillTag } from './schemas/sign_requests.js';
8
+ import type { WorkflowType } from './schemas/workflows.js';
9
+ export * from './schemas/ai.js';
10
+ export * from './schemas/ai_studio.js';
11
+ export * from './schemas/app_item_associations.js';
12
+ export * from './schemas/archives.js';
13
+ export * from './schemas/authorization.js';
14
+ export * from './schemas/automate_workflows.js';
15
+ export * from './schemas/avatars.js';
16
+ export * from './schemas/chunked_uploads.js';
17
+ export * from './schemas/classifications.js';
18
+ export * from './schemas/collaboration_allowlist_entries.js';
19
+ export * from './schemas/collaboration_allowlist_exempt_targets.js';
20
+ export * from './schemas/collections.js';
21
+ export * from './schemas/comments.js';
22
+ export * from './schemas/device_pinners.js';
23
+ export * from './schemas/docgen.js';
24
+ export * from './schemas/docgen_template.js';
25
+ export * from './schemas/email_aliases.js';
26
+ export * from './schemas/enterprise_configurations.js';
27
+ export * from './schemas/events.js';
28
+ export * from './schemas/external_users.js';
29
+ export * from './schemas/file_requests.js';
30
+ export * from './schemas/file_version_legal_holds.js';
31
+ export * from './schemas/file_version_retentions.js';
32
+ export * from './schemas/file_versions.js';
33
+ export * from './schemas/files.js';
34
+ export * from './schemas/folder_locks.js';
35
+ export * from './schemas/folders.js';
36
+ export * from './schemas/groups.js';
37
+ export * from './schemas/hub_collaborations.js';
38
+ export * from './schemas/hub_document.js';
39
+ export * from './schemas/hub_items.js';
40
+ export * from './schemas/hubs.js';
41
+ export * from './schemas/integration_mappings.js';
42
+ export * from './schemas/invites.js';
43
+ export * from './schemas/legal_hold_policies.js';
44
+ export * from './schemas/legal_hold_policy_assignments.js';
45
+ export * from './schemas/list_collaborations.js';
46
+ export * from './schemas/memberships.js';
47
+ export * from './schemas/metadata_cascade_policies.js';
48
+ export * from './schemas/metadata_taxonomies.js';
49
+ export * from './schemas/metadata_templates.js';
50
+ export * from './schemas/notes.js';
51
+ export * from './schemas/query.js';
52
+ export * from './schemas/recent_items.js';
53
+ export * from './schemas/retention_policies.js';
54
+ export * from './schemas/retention_policy_assignments.js';
55
+ export * from './schemas/search.js';
56
+ export * from './schemas/session_termination.js';
57
+ export * from './schemas/shared_links_folders.js';
58
+ export * from './schemas/shield_information_barrier_reports.js';
59
+ export * from './schemas/shield_information_barrier_segment_members.js';
60
+ export * from './schemas/shield_information_barrier_segment_restrictions.js';
61
+ export * from './schemas/shield_information_barrier_segments.js';
62
+ export * from './schemas/shield_information_barriers.js';
63
+ export * from './schemas/shield_lists.js';
64
+ export * from './schemas/sign_requests.js';
65
+ export * from './schemas/sign_templates.js';
66
+ export * from './schemas/skills.js';
67
+ export * from './schemas/storage_policies.js';
68
+ export * from './schemas/storage_policy_assignments.js';
69
+ export * from './schemas/task_assignments.js';
70
+ export * from './schemas/tasks.js';
71
+ export * from './schemas/terms_of_service_user_statuses.js';
72
+ export * from './schemas/terms_of_services.js';
73
+ export * from './schemas/transfer.js';
74
+ export * from './schemas/trashed_files.js';
75
+ export * from './schemas/trashed_folders.js';
76
+ export * from './schemas/trashed_items.js';
77
+ export * from './schemas/trashed_web_links.js';
78
+ export * from './schemas/uploads.js';
79
+ export * from './schemas/user_collaborations.js';
80
+ export * from './schemas/users.js';
81
+ export * from './schemas/web_links.js';
82
+ export * from './schemas/webhooks.js';
83
+ export * from './schemas/workflows.js';
84
+ export * from './schemas/zip_downloads.js';
55
85
  export interface AiAgentBasicTextToolBase {
56
86
  model?: string;
57
87
  num_tokens_for_completion?: number;
@@ -64,30 +94,6 @@ export interface AiAgentBasicTextToolTextGen {
64
94
  system_message?: string;
65
95
  prompt_template?: string;
66
96
  }
67
- export interface AiAgentExtract {
68
- type: AiAgentExtractType;
69
- long_text?: AiAgentLongTextTool;
70
- basic_text?: AiAgentBasicTextTool;
71
- basic_image?: AiAgentBasicTextTool;
72
- }
73
- export interface AiAgentExtractStructured {
74
- type: AiAgentExtractStructuredType;
75
- long_text?: AiAgentLongTextTool;
76
- basic_text?: AiAgentBasicTextTool;
77
- basic_image?: AiAgentBasicTextTool;
78
- }
79
- export interface AiAgentInfo {
80
- models?: Array<AiAgentInfoModels>;
81
- processor?: string;
82
- }
83
- export interface AiAgentLongTextTool {
84
- model?: string;
85
- num_tokens_for_completion?: number;
86
- llm_endpoint_params?: AiLlmEndpointParams;
87
- system_message?: string;
88
- prompt_template?: string;
89
- embeddings?: AiAgentBasicGenToolEmbeddings;
90
- }
91
97
  export interface AiAgentLongTextToolTextGen {
92
98
  model?: string;
93
99
  num_tokens_for_completion?: number;
@@ -96,106 +102,11 @@ export interface AiAgentLongTextToolTextGen {
96
102
  prompt_template?: string;
97
103
  embeddings?: AiAgentBasicGenToolEmbeddings;
98
104
  }
99
- export interface AiAgentReference {
100
- type: AiAgentReferenceType;
101
- id: string;
102
- }
103
105
  export interface AiAgentSpreadsheetTool {
104
106
  model?: string;
105
107
  num_tokens_for_completion?: number;
106
108
  llm_endpoint_params?: AiLlmEndpointParams;
107
109
  }
108
- export interface AiAgentTextGen {
109
- type: AiAgentTextGenType;
110
- basic_gen?: AiAgentBasicGenTool;
111
- }
112
- export interface AiAsk {
113
- mode: AiAskMode;
114
- prompt: string;
115
- items: Array<AiItemAsk>;
116
- dialogue_history?: Array<AiDialogueHistory>;
117
- include_citations?: boolean;
118
- ai_agent?: AiAskAgent;
119
- }
120
- export type AiAskAgent = (AiAgentReference & {
121
- type: "ai_agent_id";
122
- }) | (AiAgentAsk & {
123
- type: "ai_agent_ask";
124
- }) | {
125
- type: string;
126
- [key: string]: unknown;
127
- };
128
- export interface AiCitation {
129
- content?: string;
130
- id?: string;
131
- type?: AiCitationType;
132
- name?: string;
133
- }
134
- export interface AiDialogueHistory {
135
- prompt?: string;
136
- answer?: string;
137
- created_at?: string;
138
- }
139
- export interface AiExtract {
140
- prompt: string;
141
- items: Array<AiItemBase>;
142
- ai_agent?: AiExtractAgent;
143
- }
144
- export type AiExtractAgent = (AiAgentReference & {
145
- type: "ai_agent_id";
146
- }) | (AiAgentExtract & {
147
- type: "ai_agent_extract";
148
- }) | {
149
- type: string;
150
- [key: string]: unknown;
151
- };
152
- export interface AiExtractFieldOption {
153
- key: string;
154
- }
155
- export type AiExtractResponse = Record<string, never>;
156
- export interface AiExtractStructured {
157
- items: Array<AiItemBase>;
158
- metadata_template?: AiExtractStructuredMetadataTemplate;
159
- fields?: Array<AiExtractStructuredFields>;
160
- ai_agent?: AiExtractStructuredAgent;
161
- include_confidence_score?: boolean;
162
- include_reference?: boolean;
163
- taxonomy_sources?: Array<AiTaxonomySource>;
164
- }
165
- export type AiExtractStructuredAgent = (AiAgentReference & {
166
- type: "ai_agent_id";
167
- }) | (AiAgentExtractStructured & {
168
- type: "ai_agent_extract_structured";
169
- }) | {
170
- type: string;
171
- [key: string]: unknown;
172
- };
173
- export interface AiExtractStructuredResponse {
174
- answer: AiExtractResponse;
175
- created_at: string;
176
- completion_reason?: string;
177
- confidence_score?: Record<string, unknown>;
178
- reference?: Record<string, unknown>;
179
- ai_agent_info?: AiAgentInfo;
180
- }
181
- export interface AiExtractSubField {
182
- key: string;
183
- description?: string;
184
- displayName?: string;
185
- prompt?: string;
186
- type?: string;
187
- options?: Array<AiExtractFieldOption>;
188
- }
189
- export interface AiItemBase {
190
- id: string;
191
- type: AiCitationType;
192
- content?: string;
193
- }
194
- export interface AiItemAsk {
195
- id: string;
196
- type: AiItemAskType;
197
- content?: string;
198
- }
199
110
  export type AiLlmEndpointParams = (AiLlmEndpointParamsOpenAi & {
200
111
  type: "openai_params";
201
112
  }) | (AiLlmEndpointParamsGoogle & {
@@ -233,29 +144,6 @@ export interface AiLlmEndpointParamsOpenAi {
233
144
  presence_penalty?: number | null;
234
145
  stop?: string | null;
235
146
  }
236
- export interface AiMultipleAgentResponse {
237
- limit?: number;
238
- next_marker?: string | null;
239
- prev_marker?: string | null;
240
- entries: Array<AiSingleAgentResponseFull>;
241
- }
242
- export interface AiOptionsRules {
243
- multi_select?: boolean;
244
- selectable_levels?: Array<number>;
245
- }
246
- export interface AiResponse {
247
- answer: string;
248
- created_at: string;
249
- completion_reason?: string;
250
- ai_agent_info?: AiAgentInfo;
251
- }
252
- export interface AiResponseFull {
253
- answer: string;
254
- created_at: string;
255
- completion_reason?: string;
256
- ai_agent_info?: AiAgentInfo;
257
- citations?: Array<AiCitation>;
258
- }
259
147
  export interface AiSingleAgentResponse {
260
148
  id: string;
261
149
  type?: AiSingleAgentResponseType;
@@ -269,214 +157,11 @@ export interface AiSingleAgentResponse {
269
157
  icon_reference?: string;
270
158
  allowed_entities?: Array<AiAgentAllowedEntity>;
271
159
  }
272
- export interface AiSingleAgentResponseFull {
273
- id: string;
274
- type?: AiSingleAgentResponseType;
275
- origin: string;
276
- name: string;
277
- access_state: string;
278
- created_by?: UserBase;
279
- created_at?: string;
280
- modified_by?: UserBase;
281
- modified_at?: string;
282
- icon_reference?: string;
283
- allowed_entities?: Array<AiAgentAllowedEntity>;
284
- ask?: AiStudioAgentAskResponse;
285
- text_gen?: AiStudioAgentTextGenResponse;
286
- extract?: AiStudioAgentExtractResponse;
287
- }
288
- export interface AiStudioAgentAsk {
289
- type: AiAgentAskType;
290
- access_state: string;
291
- description: string;
292
- custom_instructions?: string | null;
293
- suggested_questions?: Array<string>;
294
- long_text?: AiStudioAgentLongTextTool;
295
- basic_text?: AiStudioAgentBasicTextTool;
296
- basic_image?: AiStudioAgentBasicTextTool;
297
- spreadsheet?: AiStudioAgentSpreadsheetTool;
298
- long_text_multi?: AiStudioAgentLongTextTool;
299
- basic_text_multi?: AiStudioAgentBasicTextTool;
300
- basic_image_multi?: AiStudioAgentBasicTextTool;
301
- }
302
- export interface AiStudioAgentAskResponse {
303
- type: AiAgentAskType;
304
- access_state: string;
305
- description: string;
306
- custom_instructions?: string | null;
307
- suggested_questions?: Array<string>;
308
- long_text?: AiStudioAgentLongTextToolResponse;
309
- basic_text?: AiStudioAgentBasicTextToolResponse;
310
- basic_image?: AiStudioAgentBasicTextToolResponse;
311
- spreadsheet?: AiStudioAgentSpreadsheetToolResponse;
312
- long_text_multi?: AiStudioAgentLongTextToolResponse;
313
- basic_text_multi?: AiStudioAgentBasicTextToolResponse;
314
- basic_image_multi?: AiStudioAgentBasicTextToolResponse;
315
- }
316
- export interface AiStudioAgentBasicGenTool {
317
- model?: string;
318
- num_tokens_for_completion?: number;
319
- llm_endpoint_params?: AiLlmEndpointParams;
320
- system_message?: string;
321
- prompt_template?: string;
322
- embeddings?: AiAgentBasicGenToolEmbeddings;
323
- content_template?: string;
324
- is_custom_instructions_included?: boolean;
325
- }
326
- export interface AiStudioAgentBasicGenToolResponse {
327
- model?: string;
328
- num_tokens_for_completion?: number;
329
- llm_endpoint_params?: AiLlmEndpointParams;
330
- system_message?: string;
331
- prompt_template?: string;
332
- embeddings?: AiAgentBasicGenToolEmbeddings;
333
- content_template?: string;
334
- is_custom_instructions_included?: boolean;
335
- warnings?: Array<string>;
336
- }
337
- export interface AiStudioAgentBasicTextTool {
338
- model?: string;
339
- num_tokens_for_completion?: number;
340
- llm_endpoint_params?: AiLlmEndpointParams;
341
- system_message?: string;
342
- prompt_template?: string;
343
- is_custom_instructions_included?: boolean;
344
- }
345
- export interface AiStudioAgentBasicTextToolResponse {
346
- model?: string;
347
- num_tokens_for_completion?: number;
348
- llm_endpoint_params?: AiLlmEndpointParams;
349
- system_message?: string;
350
- prompt_template?: string;
351
- is_custom_instructions_included?: boolean;
352
- warnings?: Array<string>;
353
- }
354
- export interface AiStudioAgentExtract {
355
- type: AiAgentExtractType;
356
- access_state: string;
357
- description: string;
358
- custom_instructions?: string | null;
359
- long_text?: AiStudioAgentLongTextTool;
360
- basic_text?: AiStudioAgentBasicTextTool;
361
- basic_image?: AiStudioAgentBasicTextTool;
362
- }
363
- export interface AiStudioAgentExtractResponse {
364
- type: AiAgentExtractType;
365
- access_state: string;
366
- description: string;
367
- custom_instructions?: string | null;
368
- long_text?: AiStudioAgentLongTextToolResponse;
369
- basic_text?: AiStudioAgentBasicTextToolResponse;
370
- basic_image?: AiStudioAgentBasicTextToolResponse;
371
- }
372
- export interface AiStudioAgentLongTextTool {
373
- model?: string;
374
- num_tokens_for_completion?: number;
375
- llm_endpoint_params?: AiLlmEndpointParams;
376
- system_message?: string;
377
- prompt_template?: string;
378
- embeddings?: AiAgentBasicGenToolEmbeddings;
379
- is_custom_instructions_included?: boolean;
380
- }
381
- export interface AiStudioAgentLongTextToolResponse {
382
- model?: string;
383
- num_tokens_for_completion?: number;
384
- llm_endpoint_params?: AiLlmEndpointParams;
385
- system_message?: string;
386
- prompt_template?: string;
387
- embeddings?: AiAgentBasicGenToolEmbeddings;
388
- is_custom_instructions_included?: boolean;
389
- warnings?: Array<string>;
390
- }
391
- export type AiStudioAgentSpreadsheetTool = AiAgentSpreadsheetTool;
392
- export interface AiStudioAgentSpreadsheetToolResponse {
393
- model?: string;
394
- num_tokens_for_completion?: number;
395
- llm_endpoint_params?: AiLlmEndpointParams;
396
- warnings?: Array<string>;
397
- }
398
- export interface AiStudioAgentTextGen {
399
- type: AiAgentTextGenType;
400
- access_state: string;
401
- description: string;
402
- custom_instructions?: string | null;
403
- suggested_questions?: Array<string>;
404
- basic_gen?: AiStudioAgentBasicGenTool;
405
- }
406
- export interface AiStudioAgentTextGenResponse {
407
- type: AiAgentTextGenType;
408
- access_state: string;
409
- description: string;
410
- custom_instructions?: string | null;
411
- suggested_questions?: Array<string>;
412
- basic_gen?: AiStudioAgentBasicGenToolResponse;
413
- }
414
- export interface AiTaxonomyFileReference {
415
- type?: AiCitationType;
416
- taxonomy_key?: string;
417
- id?: string;
418
- }
419
- export interface AiTaxonomyReference {
420
- type?: AiTaxonomyReferenceType;
421
- taxonomy_key?: string;
422
- namespace?: string;
423
- }
424
- export type AiTaxonomySource = (AiTaxonomyReference & {
425
- type: "taxonomy";
426
- }) | (AiTaxonomyFileReference & {
427
- type: "file";
428
- }) | {
429
- type: string;
430
- [key: string]: unknown;
431
- };
432
- export interface AiTextGen {
433
- prompt: string;
434
- items: Array<AiTextGenItems>;
435
- dialogue_history?: Array<AiDialogueHistory>;
436
- ai_agent?: AiTextGenAgent;
437
- }
438
- export type AiTextGenAgent = (AiAgentReference & {
439
- type: "ai_agent_id";
440
- }) | (AiAgentTextGen & {
441
- type: "ai_agent_text_gen";
442
- }) | {
443
- type: string;
444
- [key: string]: unknown;
445
- };
446
160
  export interface AppItem {
447
161
  id: string;
448
162
  type: AppItemType;
449
163
  application_type: string;
450
164
  }
451
- export type AppItemAssociatedItem = (FileBase & {
452
- type: "file";
453
- }) | (FolderBase & {
454
- type: "folder";
455
- }) | (WebLinkBase & {
456
- type: "web_link";
457
- }) | {
458
- type: string;
459
- [key: string]: unknown;
460
- };
461
- export interface AppItemAssociation {
462
- id: string;
463
- type: AppItemAssociationType;
464
- app_item: AppItem;
465
- item: AppItemAssociatedItem;
466
- }
467
- export interface AppItemAssociations {
468
- limit?: number;
469
- next_marker?: string | null;
470
- prev_marker?: string | null;
471
- entries?: Array<AppItemAssociation>;
472
- }
473
- export interface AppItemEventSource {
474
- id: string;
475
- type: AppItemType;
476
- app_item_type: string;
477
- user?: UserMini;
478
- group?: GroupMini;
479
- }
480
165
  export interface Classification {
481
166
  Box__Security__Classification__Key?: string;
482
167
  $parent?: string;
@@ -487,16 +172,6 @@ export interface Classification {
487
172
  $typeVersion?: number;
488
173
  $canEdit?: boolean;
489
174
  }
490
- export interface ClassificationTemplate {
491
- id: string;
492
- type: MetadataTemplateType;
493
- scope: string;
494
- templateKey: ClassificationTemplate2;
495
- displayName: ClassificationTemplateDisplayName;
496
- hidden?: boolean;
497
- copyInstanceOnItemCopy?: boolean;
498
- fields: Array<ClassificationTemplateFields>;
499
- }
500
175
  export interface ClientError {
501
176
  type?: ClientErrorType;
502
177
  status?: number;
@@ -531,34 +206,6 @@ export type CollaborationAccessGrantee = (UserCollaborations & {
531
206
  type: string;
532
207
  [key: string]: unknown;
533
208
  };
534
- export interface CollaborationAllowlistEntries {
535
- limit?: number;
536
- next_marker?: string | null;
537
- prev_marker?: string | null;
538
- entries?: Array<CollaborationAllowlistEntry>;
539
- }
540
- export interface CollaborationAllowlistEntry {
541
- id?: string;
542
- type?: CollaborationAllowlistEntryType;
543
- domain?: string;
544
- direction?: CollaborationAllowlistEntryDirection;
545
- enterprise?: CollaborationAllowlistEntryEnterprise;
546
- created_at?: string;
547
- }
548
- export interface CollaborationAllowlistExemptTarget {
549
- id?: string;
550
- type?: CollaborationAllowlistExemptTargetType;
551
- enterprise?: CollaborationAllowlistEntryEnterprise;
552
- user?: UserMini;
553
- created_at?: string;
554
- modified_at?: string;
555
- }
556
- export interface CollaborationAllowlistExemptTargets {
557
- limit?: number;
558
- next_marker?: string | null;
559
- prev_marker?: string | null;
560
- entries?: Array<CollaborationAllowlistExemptTarget>;
561
- }
562
209
  export type CollaborationItem = (File & {
563
210
  type: "file";
564
211
  }) | (Folder & {
@@ -569,36 +216,12 @@ export type CollaborationItem = (File & {
569
216
  type: string;
570
217
  [key: string]: unknown;
571
218
  };
572
- export interface Collaborations {
573
- limit?: number;
574
- next_marker?: string | null;
575
- prev_marker?: string | null;
576
- entries?: Array<Collaboration>;
577
- }
578
- export interface CollaborationsOffsetPaginated {
579
- total_count?: number;
580
- limit?: number;
581
- offset?: number;
582
- entries?: Array<Collaboration>;
583
- }
584
- export interface CollaboratorVariable {
585
- type: CollaboratorVariableType;
586
- variable_type: CollaboratorVariableVariableType;
587
- variable_value: Array<CollaboratorVariableVariableValue>;
588
- }
589
219
  export interface Collection {
590
220
  id?: string;
591
221
  type?: CollectionType;
592
222
  name?: CollectionName;
593
223
  collection_type?: CollectionCollectionType;
594
224
  }
595
- export interface Collections {
596
- total_count?: number;
597
- limit?: number;
598
- offset?: number;
599
- order?: Array<CollectionsOrder>;
600
- entries?: Array<Collection>;
601
- }
602
225
  export interface Comment {
603
226
  id?: string;
604
227
  type?: CommentType;
@@ -613,29 +236,6 @@ export interface CommentBase {
613
236
  id?: string;
614
237
  type?: CommentType;
615
238
  }
616
- export interface CommentFull {
617
- id?: string;
618
- type?: CommentType;
619
- is_reply_comment?: boolean;
620
- message?: string;
621
- created_by?: UserMini;
622
- created_at?: string;
623
- modified_at?: string;
624
- item?: CommentItem;
625
- tagged_message?: string;
626
- }
627
- export interface Comments {
628
- total_count?: number;
629
- limit?: number;
630
- offset?: number;
631
- order?: Array<CollectionsOrder>;
632
- entries?: Array<CommentFull>;
633
- }
634
- export interface CompletionRuleVariable {
635
- type: CollaboratorVariableType;
636
- variable_type: CompletionRuleVariableVariableType;
637
- variable_value: CompletionRuleVariableVariableValue;
638
- }
639
239
  export interface ConflictError {
640
240
  type?: ClientErrorType;
641
241
  status?: number;
@@ -645,67 +245,6 @@ export interface ConflictError {
645
245
  help_url?: string;
646
246
  request_id?: string;
647
247
  }
648
- export interface CreateAiAgent {
649
- type: AiSingleAgentResponseType;
650
- name: string;
651
- access_state: string;
652
- icon_reference?: string;
653
- allowed_entities?: Array<AiAgentAllowedEntity>;
654
- ask?: AiStudioAgentAsk;
655
- text_gen?: AiStudioAgentTextGen;
656
- extract?: AiStudioAgentExtract;
657
- }
658
- export interface DevicePinner {
659
- id?: string;
660
- type?: DevicePinnerType;
661
- owned_by?: UserMini;
662
- product_name?: string;
663
- }
664
- export interface DevicePinners {
665
- entries?: Array<DevicePinner>;
666
- limit?: number;
667
- next_marker?: number;
668
- order?: Array<DevicePinnersOrder>;
669
- }
670
- export interface EmailAlias {
671
- id?: string;
672
- type?: EmailAliasType;
673
- email?: string;
674
- is_confirmed?: boolean;
675
- }
676
- export interface EmailAliases {
677
- total_count?: number;
678
- entries?: Array<EmailAlias>;
679
- }
680
- export interface EnterpriseBase {
681
- id?: string;
682
- type?: EnterpriseType;
683
- }
684
- export interface Event {
685
- type?: string;
686
- created_at?: string;
687
- recorded_at?: string;
688
- event_id?: string;
689
- created_by?: UserMini;
690
- event_type?: EventEventType;
691
- session_id?: string;
692
- source?: EventSourceResource;
693
- additional_details?: Record<string, unknown>;
694
- }
695
- export interface Events {
696
- chunk_size?: number;
697
- next_stream_position?: EventsNextStreamPosition;
698
- entries?: Array<Event>;
699
- }
700
- export interface EventSource {
701
- item_type: EventSourceItemType;
702
- item_id: string;
703
- item_name: string;
704
- classification?: EventSourceClassification;
705
- parent?: FolderMini | null;
706
- owned_by?: UserMini;
707
- }
708
- export type EventSourceResource = unknown;
709
248
  export interface File {
710
249
  id: string;
711
250
  etag?: string | null;
@@ -779,6 +318,11 @@ export interface FileFull {
779
318
  disposition_at?: string | null;
780
319
  shared_link_permission_options?: Array<FileFullSharedLinkPermissionOptions> | null;
781
320
  is_associated_with_app_item?: boolean;
321
+ collections?: Array<Collection>;
322
+ is_download_available?: boolean;
323
+ download_url?: string;
324
+ authenticated_download_url?: string;
325
+ allowed_shared_link_access_levels?: Array<SharedLinkAccess>;
782
326
  }
783
327
  export interface FileMini {
784
328
  id: string;
@@ -798,140 +342,19 @@ export interface FileConflict {
798
342
  sha1?: string;
799
343
  file_version?: FileVersionMini;
800
344
  }
801
- export interface FileRequest {
802
- id: string;
803
- type: FileRequestType;
804
- title?: string;
805
- description?: string | null;
806
- status?: FileRequestStatus;
807
- is_email_required?: boolean;
808
- is_description_required?: boolean;
809
- expires_at?: string;
810
- folder: FolderMini;
811
- url?: string;
812
- etag?: string | null;
813
- created_by?: UserMini;
814
- created_at: string;
815
- updated_by?: UserMini;
816
- updated_at: string;
817
- }
818
- export interface FileRequestCopyRequest {
819
- title?: string;
820
- description?: string;
821
- status?: FileRequestStatus;
822
- is_email_required?: boolean;
823
- is_description_required?: boolean;
824
- expires_at?: string;
825
- folder: FileRequestCopyRequestFolder;
826
- }
827
- export interface FileRequestUpdateRequest {
828
- title?: string;
829
- description?: string;
830
- status?: FileRequestStatus;
831
- is_email_required?: boolean;
832
- is_description_required?: boolean;
833
- expires_at?: string;
834
- }
835
345
  export interface Files {
836
346
  total_count?: number;
837
347
  entries?: Array<FileFull>;
838
348
  }
839
- export interface FilesOnHold {
840
- limit?: number;
841
- next_marker?: string | null;
842
- prev_marker?: string | null;
843
- entries?: Array<FileMini>;
844
- }
845
- export interface FilesUnderRetention {
846
- limit?: number;
847
- next_marker?: string | null;
848
- prev_marker?: string | null;
849
- entries?: Array<FileMini>;
850
- }
851
- export interface FileVersion {
852
- id: string;
853
- type: FileVersionType;
854
- sha1?: string;
855
- name?: string;
856
- size?: number;
857
- created_at?: string;
858
- modified_at?: string;
859
- modified_by?: UserMini;
860
- trashed_at?: string | null;
861
- trashed_by?: UserMini;
862
- restored_at?: string | null;
863
- restored_by?: UserMini;
864
- purged_at?: string | null;
865
- uploader_display_name?: string;
866
- }
867
349
  export interface FileVersionBase {
868
350
  id: string;
869
351
  type: FileVersionType;
870
352
  }
871
- export interface FileVersionFull {
872
- id: string;
873
- type: FileVersionType;
874
- sha1?: string;
875
- name?: string;
876
- size?: number;
877
- created_at?: string;
878
- modified_at?: string;
879
- modified_by?: UserMini;
880
- trashed_at?: string | null;
881
- trashed_by?: UserMini;
882
- restored_at?: string | null;
883
- restored_by?: UserMini;
884
- purged_at?: string | null;
885
- uploader_display_name?: string;
886
- version_number?: string;
887
- }
888
353
  export interface FileVersionMini {
889
354
  id: string;
890
355
  type: FileVersionType;
891
356
  sha1?: string;
892
357
  }
893
- export interface FileVersionLegalHold {
894
- id?: string;
895
- type?: FileVersionLegalHoldType;
896
- file_version?: FileVersionMini;
897
- file?: FileMini;
898
- legal_hold_policy_assignments?: Array<LegalHoldPolicyAssignment>;
899
- deleted_at?: string;
900
- }
901
- export interface FileVersionLegalHolds {
902
- limit?: number;
903
- next_marker?: string | null;
904
- prev_marker?: string | null;
905
- entries?: Array<FileVersionLegalHold>;
906
- }
907
- export interface FileVersionRetention {
908
- id?: string;
909
- type?: FileVersionRetentionType;
910
- file_version?: FileVersionMini;
911
- file?: FileMini;
912
- applied_at?: string;
913
- disposition_at?: string;
914
- winning_retention_policy?: RetentionPolicyMini;
915
- }
916
- export interface FileVersionRetentions {
917
- limit?: number;
918
- next_marker?: string | null;
919
- prev_marker?: string | null;
920
- entries?: Array<FileVersionRetention>;
921
- }
922
- export interface FileVersions {
923
- total_count?: number;
924
- limit?: number;
925
- offset?: number;
926
- order?: Array<CollectionsOrder>;
927
- entries?: Array<FileVersionFull>;
928
- }
929
- export interface FileVersionsOnHold {
930
- limit?: number;
931
- next_marker?: string | null;
932
- prev_marker?: string | null;
933
- entries?: Array<FileVersion>;
934
- }
935
358
  export interface Folder {
936
359
  id: string;
937
360
  etag?: string | null;
@@ -956,11 +379,6 @@ export interface Folder {
956
379
  item_status?: FileItemStatus;
957
380
  item_collection?: Items;
958
381
  }
959
- export interface FolderBase {
960
- id: string;
961
- etag?: string | null;
962
- type: FolderType;
963
- }
964
382
  export interface FolderFull {
965
383
  id: string;
966
384
  etag?: string | null;
@@ -999,6 +417,7 @@ export interface FolderFull {
999
417
  can_non_owners_view_collaborators?: boolean;
1000
418
  classification?: FileFullClassification | null;
1001
419
  is_associated_with_app_item?: boolean;
420
+ collections?: Array<Collection>;
1002
421
  }
1003
422
  export interface FolderMini {
1004
423
  id: string;
@@ -1007,25 +426,10 @@ export interface FolderMini {
1007
426
  sequence_id?: string;
1008
427
  name?: string;
1009
428
  }
1010
- export interface FolderLock {
1011
- folder?: FolderMini;
1012
- id?: string;
1013
- type?: string;
1014
- created_by?: UserBase;
1015
- created_at?: string;
1016
- locked_operations?: FolderLockLockedOperations;
1017
- lock_type?: string;
1018
- }
1019
- export interface FolderLocks {
1020
- entries?: Array<FolderLock>;
1021
- limit?: string;
1022
- next_marker?: string | null;
1023
- }
1024
429
  export interface FolderReference {
1025
430
  type: FolderType;
1026
431
  id: string;
1027
432
  }
1028
- export type GenericSource = Record<string, never>;
1029
433
  export interface Group {
1030
434
  id: string;
1031
435
  type: GroupType;
@@ -1034,131 +438,16 @@ export interface Group {
1034
438
  created_at?: string;
1035
439
  modified_at?: string;
1036
440
  }
1037
- export interface GroupBase {
1038
- id: string;
1039
- type: GroupType;
1040
- }
1041
- export interface GroupFull {
1042
- id: string;
1043
- type: GroupType;
1044
- name?: string;
1045
- group_type?: GroupGroupType;
1046
- created_at?: string;
1047
- modified_at?: string;
1048
- provenance?: string;
1049
- external_sync_identifier?: string;
1050
- description?: string;
1051
- invitability_level?: GroupFullInvitabilityLevel;
1052
- member_viewability_level?: GroupFullInvitabilityLevel;
1053
- permissions?: GroupFullPermissions;
1054
- }
1055
441
  export interface GroupMini {
1056
442
  id: string;
1057
443
  type: GroupType;
1058
444
  name?: string;
1059
445
  group_type?: GroupGroupType;
1060
446
  }
1061
- export interface GroupMembership {
1062
- id?: string;
1063
- type?: GroupMembershipType;
1064
- user?: UserMini;
1065
- group?: GroupMini;
1066
- role?: GroupMembershipRole;
1067
- created_at?: string;
1068
- modified_at?: string;
1069
- }
1070
- export interface GroupMemberships {
1071
- total_count?: number;
1072
- limit?: number;
1073
- offset?: number;
1074
- order?: Array<CollectionsOrder>;
1075
- entries?: Array<GroupMembership>;
1076
- }
1077
- export interface Groups {
1078
- total_count?: number;
1079
- limit?: number;
1080
- offset?: number;
1081
- order?: Array<CollectionsOrder>;
1082
- entries?: Array<GroupFull>;
1083
- }
1084
- export interface IntegrationMapping {
1085
- id: string;
1086
- type: IntegrationMappingType;
1087
- integration_type?: IntegrationMappingIntegrationType;
1088
- is_manually_created?: boolean;
1089
- options?: IntegrationMappingSlackOptions;
1090
- created_by?: UserIntegrationMappings;
1091
- modified_by?: UserIntegrationMappings;
1092
- partner_item: IntegrationMappingPartnerItemSlack;
1093
- box_item: FolderMini;
1094
- created_at?: string;
1095
- modified_at?: string;
1096
- }
1097
447
  export interface IntegrationMappingBase {
1098
448
  id: string;
1099
449
  type: IntegrationMappingType;
1100
450
  }
1101
- export interface IntegrationMappingBoxItemSlack {
1102
- type: FolderType;
1103
- id: string;
1104
- }
1105
- export interface IntegrationMappingPartnerItemSlack {
1106
- type: IntegrationMappingPartnerItemSlackType;
1107
- id: string;
1108
- slack_workspace_id?: string | null;
1109
- slack_org_id?: string | null;
1110
- }
1111
- export interface IntegrationMappingPartnerItemTeams {
1112
- type: IntegrationMappingPartnerItemTeamsType;
1113
- id: string;
1114
- tenant_id: string;
1115
- }
1116
- export interface IntegrationMappingPartnerItemTeamsCreateRequest {
1117
- type: IntegrationMappingPartnerItemTeamsType;
1118
- id: string;
1119
- tenant_id: string;
1120
- team_id: string;
1121
- }
1122
- export interface IntegrationMappings {
1123
- limit?: number;
1124
- next_marker?: string | null;
1125
- entries?: Array<IntegrationMapping>;
1126
- }
1127
- export interface IntegrationMappingSlackCreateRequest {
1128
- partner_item: IntegrationMappingPartnerItemSlack;
1129
- box_item: IntegrationMappingBoxItemSlack;
1130
- options?: IntegrationMappingSlackOptions;
1131
- }
1132
- export interface IntegrationMappingSlackOptions {
1133
- is_access_management_disabled?: boolean;
1134
- }
1135
- export interface IntegrationMappingsTeams {
1136
- entries?: Array<IntegrationMappingTeams>;
1137
- }
1138
- export interface IntegrationMappingTeams {
1139
- id: string;
1140
- type: IntegrationMappingType;
1141
- integration_type?: IntegrationMappingTeamsIntegrationType;
1142
- is_overridden_by_manual_mapping?: boolean;
1143
- partner_item: IntegrationMappingPartnerItemTeams;
1144
- box_item: FolderReference;
1145
- created_at?: string;
1146
- modified_at?: string;
1147
- }
1148
- export interface IntegrationMappingTeamsCreateRequest {
1149
- partner_item: IntegrationMappingPartnerItemTeamsCreateRequest;
1150
- box_item: FolderReference;
1151
- }
1152
- export interface Invite {
1153
- id: string;
1154
- type: InviteType;
1155
- invited_to?: CollaborationAllowlistEntryEnterprise;
1156
- actionable_by?: UserMini;
1157
- invited_by?: UserMini;
1158
- status?: string;
1159
- created_at?: string;
1160
- modified_at?: string;
1161
- }
1162
451
  export type Item = (FileFull & {
1163
452
  type: "file";
1164
453
  }) | (FolderMini & {
@@ -1178,43 +467,6 @@ export interface Items {
1178
467
  order?: Array<CollectionsOrder>;
1179
468
  entries?: Array<Item>;
1180
469
  }
1181
- export interface ItemsOffsetPaginated {
1182
- total_count?: number;
1183
- limit?: number;
1184
- offset?: number;
1185
- order?: Array<CollectionsOrder>;
1186
- entries?: Array<Item>;
1187
- }
1188
- export interface KeywordSkillCard {
1189
- created_at?: string;
1190
- type: KeywordSkillCardType;
1191
- skill_card_type: KeywordSkillCardSkillCardType;
1192
- skill_card_title?: KeywordSkillCardSkillCardTitle;
1193
- skill: KeywordSkillCardSkill;
1194
- invocation: KeywordSkillCardInvocation;
1195
- entries: Array<KeywordSkillCardEntries>;
1196
- }
1197
- export interface LegalHoldPolicies {
1198
- limit?: number;
1199
- next_marker?: string | null;
1200
- prev_marker?: string | null;
1201
- entries?: Array<LegalHoldPolicy>;
1202
- }
1203
- export interface LegalHoldPolicy {
1204
- id: string;
1205
- type: LegalHoldPolicyType;
1206
- policy_name?: string;
1207
- description?: string;
1208
- status?: LegalHoldPolicyStatus;
1209
- assignment_counts?: LegalHoldPolicyAssignmentCounts;
1210
- created_by?: UserMini;
1211
- created_at?: string;
1212
- modified_at?: string;
1213
- deleted_at?: string;
1214
- filter_started_at?: string;
1215
- filter_ended_at?: string;
1216
- release_notes?: string;
1217
- }
1218
470
  export interface LegalHoldPolicyMini {
1219
471
  id: string;
1220
472
  type: LegalHoldPolicyType;
@@ -1236,12 +488,6 @@ export interface LegalHoldPolicyAssignmentBase {
1236
488
  id?: string;
1237
489
  type?: LegalHoldPolicyAssignmentType;
1238
490
  }
1239
- export interface LegalHoldPolicyAssignments {
1240
- limit?: number;
1241
- next_marker?: string | null;
1242
- prev_marker?: string | null;
1243
- entries?: Array<LegalHoldPolicyAssignment>;
1244
- }
1245
491
  export type Metadata = MetadataBase;
1246
492
  export interface MetadataBase {
1247
493
  $parent?: string;
@@ -1259,197 +505,20 @@ export interface MetadataFull {
1259
505
  $type?: string;
1260
506
  $typeVersion?: number;
1261
507
  }
1262
- export interface MetadataCascadePolicies {
1263
- limit?: number;
1264
- next_marker?: string | null;
1265
- prev_marker?: string | null;
1266
- entries?: Array<MetadataCascadePolicy>;
1267
- }
1268
- export interface MetadataCascadePolicy {
1269
- id: string;
1270
- type: MetadataCascadePolicyType;
1271
- owner_enterprise?: MetadataCascadePolicyOwnerEnterprise;
1272
- parent?: MetadataCascadePolicyParent;
1273
- scope?: string;
1274
- templateKey?: string;
1275
- }
1276
508
  export interface MetadataError {
1277
509
  code?: string;
1278
510
  message?: string;
1279
511
  request_id?: string;
1280
512
  }
1281
- export interface MetadataFieldFilterDateRange {
1282
- lt?: string;
1283
- gt?: string;
1284
- }
1285
- export interface MetadataFieldFilterFloatRange {
1286
- lt?: number;
1287
- gt?: number;
1288
- }
1289
- export interface MetadataFilter {
1290
- scope?: MetadataFilterScope;
1291
- templateKey?: string;
1292
- filters?: Record<string, MetadataFilterValue>;
1293
- }
1294
- export type MetadataFilterValue = unknown;
1295
513
  export type MetadataInstanceValue = unknown;
1296
- export interface MetadataQuery {
1297
- from: string;
1298
- query?: string;
1299
- query_params?: Record<string, unknown>;
1300
- ancestor_folder_id: string;
1301
- order_by?: Array<MetadataQueryOrderBy>;
1302
- limit?: number;
1303
- marker?: string;
1304
- fields?: Array<string>;
1305
- }
1306
- export type MetadataQueryResultItem = (FileFull & {
1307
- type: "file";
1308
- }) | (FolderFull & {
1309
- type: "folder";
1310
- }) | {
1311
- type: string;
1312
- [key: string]: unknown;
1313
- };
1314
- export interface MetadataQueryResults {
1315
- entries?: Array<MetadataQueryResultItem>;
1316
- limit?: number;
1317
- next_marker?: string;
1318
- }
1319
514
  export interface Metadatas {
1320
515
  entries?: Array<Metadata>;
1321
516
  limit?: number;
1322
517
  }
1323
- export interface MetadataTaxonomies {
1324
- limit?: number;
1325
- next_marker?: string | null;
1326
- prev_marker?: string | null;
1327
- entries?: Array<MetadataTaxonomy>;
1328
- }
1329
- export interface MetadataTaxonomy {
1330
- id: string;
1331
- key?: string;
1332
- displayName: string;
1333
- namespace: string;
1334
- levels?: Array<MetadataTaxonomyLevel>;
1335
- }
1336
- export interface MetadataTaxonomyAncestor {
1337
- id?: string;
1338
- displayName?: string;
1339
- level?: number;
1340
- }
1341
- export interface MetadataTaxonomyLevel {
1342
- displayName?: string;
1343
- description?: string;
1344
- level?: number;
1345
- }
1346
- export interface MetadataTaxonomyLevels {
1347
- entries?: Array<MetadataTaxonomyLevel>;
1348
- }
1349
- export interface MetadataTaxonomyNode {
1350
- id: string;
1351
- displayName: string;
1352
- level: number;
1353
- parentId?: string;
1354
- nodePath?: Array<string>;
1355
- ancestors?: Array<MetadataTaxonomyAncestor>;
1356
- }
1357
- export interface MetadataTaxonomyNodes {
1358
- limit?: number;
1359
- next_marker?: string | null;
1360
- prev_marker?: string | null;
1361
- entries?: Array<MetadataTaxonomyNode>;
1362
- }
1363
- export interface MetadataTemplate {
1364
- id: string;
1365
- type: MetadataTemplateType;
1366
- scope?: string;
1367
- templateKey?: string;
1368
- displayName?: string;
1369
- hidden?: boolean;
1370
- fields?: Array<MetadataTemplateFields>;
1371
- copyInstanceOnItemCopy?: boolean;
1372
- }
1373
- export interface MetadataTemplates {
1374
- limit?: number;
1375
- next_marker?: string | null;
1376
- prev_marker?: string | null;
1377
- entries?: Array<MetadataTemplate>;
1378
- }
1379
518
  export interface OAuth2Error {
1380
519
  error?: string;
1381
520
  error_description?: string;
1382
521
  }
1383
- export interface Outcome {
1384
- id: string;
1385
- collaborators?: CollaboratorVariable;
1386
- completion_rule?: CompletionRuleVariable;
1387
- file_collaborator_role?: RoleVariable;
1388
- task_collaborators?: CollaboratorVariable;
1389
- role?: RoleVariable;
1390
- }
1391
- export interface PostOAuth2Revoke {
1392
- client_id?: string;
1393
- client_secret?: string;
1394
- token?: string;
1395
- }
1396
- export interface PostOAuth2Token {
1397
- grant_type: PostOAuth2TokenGrantType;
1398
- client_id?: string;
1399
- client_secret?: string;
1400
- code?: string;
1401
- refresh_token?: string;
1402
- assertion?: string;
1403
- subject_token?: string;
1404
- subject_token_type?: AccessTokenIssuedTokenType;
1405
- actor_token?: string;
1406
- actor_token_type?: PostOAuth2TokenActorTokenType;
1407
- scope?: string;
1408
- resource?: string;
1409
- box_subject_type?: PostOAuth2TokenBoxSubjectType;
1410
- box_subject_id?: string;
1411
- box_shared_link?: string;
1412
- }
1413
- export interface PostOAuth2TokenRefreshAccessToken {
1414
- grant_type: PostOAuth2TokenRefreshAccessTokenGrantType;
1415
- client_id: string;
1416
- client_secret: string;
1417
- refresh_token: string;
1418
- }
1419
- export interface RealtimeServer {
1420
- type?: string;
1421
- url?: string;
1422
- ttl?: string;
1423
- max_retries?: string;
1424
- retry_timeout?: number;
1425
- }
1426
- export interface RealtimeServers {
1427
- chunk_size?: number;
1428
- entries?: Array<RealtimeServer>;
1429
- }
1430
- export interface RecentItem {
1431
- type?: string;
1432
- item?: RecentItemResource;
1433
- interaction_type?: RecentItemInteractionType;
1434
- interacted_at?: string;
1435
- interaction_shared_link?: string;
1436
- }
1437
- export type RecentItemResource = (FileFull & {
1438
- type: "file";
1439
- }) | (FolderFull & {
1440
- type: "folder";
1441
- }) | (WebLink & {
1442
- type: "web_link";
1443
- }) | {
1444
- type: string;
1445
- [key: string]: unknown;
1446
- };
1447
- export interface RecentItems {
1448
- limit?: number;
1449
- next_marker?: string | null;
1450
- prev_marker?: string | null;
1451
- entries?: Array<RecentItem>;
1452
- }
1453
522
  export type Resource = (FolderMini & {
1454
523
  type: "folder";
1455
524
  }) | (FileMini & {
@@ -1462,30 +531,6 @@ export interface ResourceScope {
1462
531
  scope?: ResourceScopeScope;
1463
532
  object?: Resource;
1464
533
  }
1465
- export interface RetentionPolicies {
1466
- entries?: Array<RetentionPolicy>;
1467
- limit?: number;
1468
- next_marker?: string | null;
1469
- }
1470
- export interface RetentionPolicy {
1471
- id: string;
1472
- type: RetentionPolicyType;
1473
- policy_name?: string;
1474
- retention_length?: string;
1475
- disposition_action?: RetentionPolicyDispositionAction;
1476
- max_extension_length?: RetentionPolicyMaxExtensionLengthResponse;
1477
- description?: string;
1478
- policy_type?: RetentionPolicyPolicyType;
1479
- retention_type?: RetentionPolicyRetentionType;
1480
- status?: RetentionPolicyStatus;
1481
- created_by?: UserMini;
1482
- created_at?: string;
1483
- modified_at?: string;
1484
- can_owner_extend_retention?: boolean;
1485
- are_owners_notified?: boolean;
1486
- custom_notification_recipients?: Array<UserMini>;
1487
- assignment_counts?: RetentionPolicyAssignmentCounts;
1488
- }
1489
534
  export interface RetentionPolicyBase {
1490
535
  id: string;
1491
536
  type: RetentionPolicyType;
@@ -1498,170 +543,23 @@ export interface RetentionPolicyMini {
1498
543
  disposition_action?: RetentionPolicyDispositionAction;
1499
544
  max_extension_length?: RetentionPolicyMaxExtensionLengthResponse;
1500
545
  }
1501
- export interface RetentionPolicyAssignment {
1502
- id: string;
1503
- type: RetentionPolicyAssignmentType;
1504
- retention_policy?: RetentionPolicyMini;
1505
- assigned_to?: RetentionPolicyAssignmentAssignedTo;
1506
- filter_fields?: Array<RetentionPolicyAssignmentFilterFields> | null;
1507
- assigned_by?: UserMini;
1508
- assigned_at?: string;
1509
- start_date_field?: string;
1510
- }
1511
- export interface RetentionPolicyAssignments {
1512
- entries?: Array<RetentionPolicyAssignment>;
1513
- limit?: number;
1514
- next_marker?: string | null;
1515
- }
1516
- export type RetentionPolicyMaxExtensionLengthRequest = unknown;
1517
546
  export type RetentionPolicyMaxExtensionLengthResponse = unknown;
1518
- export interface RoleVariable {
1519
- type: CollaboratorVariableType;
1520
- variable_type: RoleVariableVariableType;
1521
- variable_value: FileFullAllowedInviteeRoles;
547
+ export interface ShieldInformationBarrierBase {
548
+ id?: string;
549
+ type?: ShieldInformationBarrierType;
1522
550
  }
1523
- export type SearchResultItem = (FileFull & {
1524
- type: "file";
1525
- }) | (FolderFull & {
1526
- type: "folder";
1527
- }) | (WebLink & {
1528
- type: "web_link";
1529
- }) | {
1530
- type: string;
1531
- [key: string]: unknown;
1532
- };
1533
- export interface SearchResults {
1534
- total_count?: number;
1535
- limit?: number;
1536
- offset?: number;
1537
- type: SearchResultsType;
1538
- entries?: Array<SearchResultItem>;
551
+ export interface ShieldInformationBarrierReportBase {
552
+ id?: string;
553
+ type?: ShieldInformationBarrierReportType;
1539
554
  }
1540
- export type SearchResultsResponse = (SearchResults & {
1541
- type: "search_results_items";
1542
- }) | (SearchResultsWithSharedLinks & {
1543
- type: "search_results_with_shared_links";
1544
- }) | {
1545
- type: string;
1546
- [key: string]: unknown;
1547
- };
1548
- export interface SearchResultsWithSharedLinks {
1549
- total_count?: number;
1550
- limit?: number;
1551
- offset?: number;
1552
- type: SearchResultsWithSharedLinksType;
1553
- entries?: Array<SearchResultWithSharedLink>;
555
+ export interface ShieldInformationBarrierSegmentMemberBase {
556
+ id?: string;
557
+ type?: ShieldInformationBarrierSegmentMemberType;
1554
558
  }
1555
- export interface SearchResultWithSharedLink {
1556
- accessible_via_shared_link?: string;
1557
- item?: SearchResultWithSharedLinkItem;
1558
- type?: string;
1559
- }
1560
- export type SearchResultWithSharedLinkItem = (FileFull & {
1561
- type: "file";
1562
- }) | (FolderFull & {
1563
- type: "folder";
1564
- }) | (WebLink & {
1565
- type: "web_link";
1566
- }) | {
1567
- type: string;
1568
- [key: string]: unknown;
1569
- };
1570
- export interface SessionTerminationMessage {
1571
- message?: string;
1572
- }
1573
- export interface ShieldInformationBarrier {
1574
- id?: string;
1575
- type?: ShieldInformationBarrierType;
1576
- enterprise?: EnterpriseBase;
1577
- status?: ShieldInformationBarrierStatus;
1578
- created_at?: string;
1579
- created_by?: UserBase;
1580
- updated_at?: string;
1581
- updated_by?: UserBase;
1582
- enabled_at?: string;
1583
- enabled_by?: UserBase;
1584
- }
1585
- export interface ShieldInformationBarrierBase {
1586
- id?: string;
1587
- type?: ShieldInformationBarrierType;
1588
- }
1589
- export interface ShieldInformationBarrierReference {
1590
- shield_information_barrier?: ShieldInformationBarrierBase;
1591
- }
1592
- export interface ShieldInformationBarrierReport {
1593
- id?: string;
1594
- type?: ShieldInformationBarrierReportType;
1595
- shield_information_barrier?: ShieldInformationBarrierReference;
1596
- status?: ShieldInformationBarrierReportStatus;
1597
- details?: ShieldInformationBarrierReportDetails;
1598
- created_at?: string;
1599
- created_by?: UserBase;
1600
- updated_at?: string;
1601
- }
1602
- export interface ShieldInformationBarrierReportBase {
1603
- id?: string;
1604
- type?: ShieldInformationBarrierReportType;
1605
- }
1606
- export interface ShieldInformationBarrierReportDetails {
1607
- details?: ShieldInformationBarrierReportDetailsDetails;
1608
- }
1609
- export interface ShieldInformationBarrierReports {
1610
- limit?: number;
1611
- next_marker?: string | null;
1612
- entries?: Array<ShieldInformationBarrierReport>;
1613
- }
1614
- export interface ShieldInformationBarriers {
1615
- limit?: number;
1616
- next_marker?: string | null;
1617
- entries?: Array<ShieldInformationBarrier>;
1618
- }
1619
- export interface ShieldInformationBarrierSegment {
1620
- id?: string;
1621
- type?: ShieldInformationBarrierSegmentType;
1622
- shield_information_barrier?: ShieldInformationBarrierBase;
1623
- name?: string;
1624
- description?: string;
1625
- created_at?: string;
1626
- created_by?: UserBase;
1627
- updated_at?: string;
1628
- updated_by?: UserBase;
1629
- }
1630
- export interface ShieldInformationBarrierSegmentMember {
1631
- id?: string;
1632
- type?: ShieldInformationBarrierSegmentMemberType;
1633
- user?: UserBase;
1634
- shield_information_barrier?: ShieldInformationBarrierBase;
1635
- shield_information_barrier_segment?: ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment;
1636
- created_at?: string;
1637
- created_by?: UserBase;
1638
- updated_at?: string;
1639
- updated_by?: UserBase;
1640
- }
1641
- export interface ShieldInformationBarrierSegmentMemberBase {
1642
- id?: string;
1643
- type?: ShieldInformationBarrierSegmentMemberType;
1644
- }
1645
- export interface ShieldInformationBarrierSegmentMemberMini {
1646
- id?: string;
1647
- type?: ShieldInformationBarrierSegmentMemberType;
1648
- user?: UserBase;
1649
- }
1650
- export interface ShieldInformationBarrierSegmentMembers {
1651
- limit?: number;
1652
- next_marker?: string | null;
1653
- entries?: Array<ShieldInformationBarrierSegmentMember>;
1654
- }
1655
- export interface ShieldInformationBarrierSegmentRestriction {
1656
- type?: ShieldInformationBarrierSegmentRestrictionType;
1657
- id?: string;
1658
- shield_information_barrier_segment: ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment;
1659
- restricted_segment: ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment;
1660
- shield_information_barrier?: ShieldInformationBarrierBase;
1661
- created_at?: string;
1662
- created_by?: UserBase;
1663
- updated_at?: string;
1664
- updated_by?: UserBase;
559
+ export interface ShieldInformationBarrierSegmentMemberMini {
560
+ id?: string;
561
+ type?: ShieldInformationBarrierSegmentMemberType;
562
+ user?: UserBase;
1665
563
  }
1666
564
  export interface ShieldInformationBarrierSegmentRestrictionBase {
1667
565
  type?: ShieldInformationBarrierSegmentRestrictionType;
@@ -1673,50 +571,6 @@ export interface ShieldInformationBarrierSegmentRestrictionMini {
1673
571
  shield_information_barrier_segment: ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment;
1674
572
  restricted_segment: ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment;
1675
573
  }
1676
- export interface ShieldInformationBarrierSegmentRestrictions {
1677
- limit?: number;
1678
- next_marker?: string | null;
1679
- entries?: Array<ShieldInformationBarrierSegmentRestriction>;
1680
- }
1681
- export interface ShieldInformationBarrierSegments {
1682
- limit?: number;
1683
- next_marker?: string | null;
1684
- entries?: Array<ShieldInformationBarrierSegment>;
1685
- }
1686
- export interface SignRequest {
1687
- is_document_preparation_needed?: boolean;
1688
- redirect_url?: string | null;
1689
- declined_redirect_url?: string | null;
1690
- are_text_signatures_enabled?: boolean;
1691
- email_subject?: string | null;
1692
- email_message?: string | null;
1693
- are_reminders_enabled?: boolean;
1694
- name?: string;
1695
- prefill_tags?: Array<SignRequestPrefillTag>;
1696
- days_valid?: number | null;
1697
- external_id?: string | null;
1698
- template_id?: string | null;
1699
- external_system_name?: string | null;
1700
- request_flow?: string | null;
1701
- type?: SignRequestType;
1702
- source_files?: Array<FileBase>;
1703
- signers?: Array<SignRequestSigner>;
1704
- signature_color?: string | null;
1705
- id?: string;
1706
- prepare_url?: string | null;
1707
- signing_log?: FileMini;
1708
- status?: SignRequestStatus;
1709
- sign_files?: SignRequestSignFiles;
1710
- auto_expire_at?: string | null;
1711
- parent_folder?: FolderMini;
1712
- collaborator_level?: string | null;
1713
- short_id?: string;
1714
- created_at?: string;
1715
- finished_at?: string | null;
1716
- error_code?: string | null;
1717
- sender_email?: string | null;
1718
- sender_id?: number | null;
1719
- }
1720
574
  export interface SignRequestBase {
1721
575
  is_document_preparation_needed?: boolean;
1722
576
  redirect_url?: string | null;
@@ -1733,93 +587,6 @@ export interface SignRequestBase {
1733
587
  external_system_name?: string | null;
1734
588
  request_flow?: string | null;
1735
589
  }
1736
- export interface SignRequestCancelRequest {
1737
- reason?: string;
1738
- }
1739
- export interface SignRequestCreateRequest {
1740
- is_document_preparation_needed?: boolean;
1741
- redirect_url?: string | null;
1742
- declined_redirect_url?: string | null;
1743
- are_text_signatures_enabled?: boolean;
1744
- email_subject?: string | null;
1745
- email_message?: string | null;
1746
- are_reminders_enabled?: boolean;
1747
- name?: string;
1748
- prefill_tags?: Array<SignRequestPrefillTag>;
1749
- days_valid?: number | null;
1750
- external_id?: string | null;
1751
- template_id?: string | null;
1752
- external_system_name?: string | null;
1753
- request_flow?: string | null;
1754
- source_files?: Array<FileBase> | null;
1755
- signature_color?: SignRequestCreateRequestSignatureColor | null;
1756
- signers: Array<SignRequestCreateSigner>;
1757
- parent_folder?: FolderMini;
1758
- }
1759
- export interface SignRequestCreateSigner {
1760
- email?: string | null;
1761
- role?: SignRequestCreateSignerRole;
1762
- is_in_person?: boolean;
1763
- order?: number;
1764
- embed_url_external_user_id?: string | null;
1765
- redirect_url?: string | null;
1766
- declined_redirect_url?: string | null;
1767
- login_required?: boolean | null;
1768
- verification_phone_number?: string | null;
1769
- password?: string | null;
1770
- signer_group_id?: string | null;
1771
- suppress_notifications?: boolean | null;
1772
- language?: string | null;
1773
- }
1774
- export interface SignRequestPrefillTag {
1775
- document_tag_id?: string | null;
1776
- text_value?: string | null;
1777
- checkbox_value?: boolean | null;
1778
- date_value?: string | null;
1779
- }
1780
- export interface SignRequests {
1781
- limit?: number;
1782
- next_marker?: string | null;
1783
- entries?: Array<SignRequest>;
1784
- }
1785
- export interface SignRequestSigner {
1786
- email: string | null;
1787
- role?: SignRequestCreateSignerRole;
1788
- is_in_person?: boolean;
1789
- order?: number;
1790
- embed_url_external_user_id?: string | null;
1791
- redirect_url?: string | null;
1792
- declined_redirect_url?: string | null;
1793
- login_required?: boolean | null;
1794
- verification_phone_number?: string | null;
1795
- password?: string | null;
1796
- signer_group_id?: string | null;
1797
- suppress_notifications?: boolean | null;
1798
- language?: string | null;
1799
- has_viewed_document?: boolean;
1800
- signer_decision?: SignRequestSignerSignerDecision | null;
1801
- inputs?: Array<SignRequestSignerInput>;
1802
- embed_url?: string | null;
1803
- iframeable_embed_url?: string | null;
1804
- attachments?: Array<SignRequestSignerAttachment> | null;
1805
- }
1806
- export interface SignRequestSignerAttachment {
1807
- id?: string | null;
1808
- name?: string | null;
1809
- }
1810
- export interface SignRequestSignerInput {
1811
- document_tag_id?: string | null;
1812
- text_value?: string | null;
1813
- checkbox_value?: boolean | null;
1814
- date_value?: string | null;
1815
- type?: SignRequestSignerInputType;
1816
- content_type?: SignRequestSignerInputContentType;
1817
- page_index: number;
1818
- read_only?: boolean;
1819
- validation?: SignRequestSignerInputValidation2;
1820
- reason?: string | null;
1821
- is_validated?: boolean | null;
1822
- }
1823
590
  export interface SignRequestSignerInputCustomValidation {
1824
591
  validation_type: SignRequestSignerInputCustomValidationValidationType;
1825
592
  custom_regex: string | null;
@@ -1856,93 +623,6 @@ export interface SignRequestSignerInputZIP4Validation {
1856
623
  export interface SignRequestSignerInputZIPValidation {
1857
624
  validation_type: SignRequestSignerInputZIPValidationValidationType;
1858
625
  }
1859
- export interface SignTemplate {
1860
- type?: SignTemplateType;
1861
- id?: string;
1862
- name?: string | null;
1863
- email_subject?: string | null;
1864
- email_message?: string | null;
1865
- days_valid?: number | null;
1866
- parent_folder?: FolderMini;
1867
- source_files?: Array<FileMini>;
1868
- are_fields_locked?: boolean;
1869
- are_options_locked?: boolean;
1870
- are_recipients_locked?: boolean;
1871
- are_email_settings_locked?: boolean;
1872
- are_files_locked?: boolean;
1873
- signers?: Array<TemplateSigner>;
1874
- additional_info?: SignTemplateAdditionalInfo;
1875
- ready_sign_link?: SignTemplateReadySignLink | null;
1876
- custom_branding?: SignTemplateCustomBranding | null;
1877
- request_flow?: string | null;
1878
- }
1879
- export interface SignTemplates {
1880
- limit?: number;
1881
- next_marker?: string | null;
1882
- prev_marker?: string | null;
1883
- entries?: Array<SignTemplate>;
1884
- }
1885
- export type SkillCard = unknown;
1886
- export interface SkillCardsMetadata {
1887
- $canEdit?: boolean;
1888
- $id?: string;
1889
- $parent?: string;
1890
- $scope?: string;
1891
- $template?: string;
1892
- $type?: string;
1893
- $typeVersion?: number;
1894
- $version?: number;
1895
- cards?: Array<SkillCard>;
1896
- }
1897
- export interface StatusSkillCard {
1898
- created_at?: string;
1899
- type: KeywordSkillCardType;
1900
- skill_card_type: StatusSkillCardSkillCardType;
1901
- skill_card_title?: KeywordSkillCardSkillCardTitle;
1902
- status: StatusSkillCardStatus;
1903
- skill: KeywordSkillCardSkill;
1904
- invocation: KeywordSkillCardInvocation;
1905
- }
1906
- export interface StoragePolicies {
1907
- limit?: number;
1908
- next_marker?: string | null;
1909
- prev_marker?: string | null;
1910
- entries?: Array<StoragePolicy>;
1911
- }
1912
- export interface StoragePolicy {
1913
- id: string;
1914
- type: StoragePolicyType;
1915
- name?: string;
1916
- }
1917
- export interface StoragePolicyMini {
1918
- id: string;
1919
- type: StoragePolicyType;
1920
- }
1921
- export interface StoragePolicyAssignment {
1922
- id: string;
1923
- type: StoragePolicyAssignmentType;
1924
- storage_policy?: StoragePolicyMini;
1925
- assigned_to?: CommentItem;
1926
- }
1927
- export interface StoragePolicyAssignments {
1928
- limit?: number;
1929
- next_marker?: string | null;
1930
- prev_marker?: string | null;
1931
- entries?: Array<StoragePolicyAssignment>;
1932
- }
1933
- export interface Task {
1934
- id?: string;
1935
- type?: TaskType;
1936
- item?: FileMini;
1937
- due_at?: string;
1938
- action?: TaskAction;
1939
- message?: string;
1940
- task_assignment_collection?: TaskAssignments;
1941
- is_completed?: boolean;
1942
- created_by?: UserMini;
1943
- created_at?: string;
1944
- completion_rule?: TaskCompletionRule;
1945
- }
1946
626
  export interface TaskAssignment {
1947
627
  id?: string;
1948
628
  type?: TaskAssignmentType;
@@ -1959,201 +639,45 @@ export interface TaskAssignments {
1959
639
  total_count?: number;
1960
640
  entries?: Array<TaskAssignment>;
1961
641
  }
1962
- export interface Tasks {
1963
- total_count?: number;
1964
- entries?: Array<Task>;
1965
- }
1966
- export interface TemplateSigner {
1967
- inputs?: Array<TemplateSignerInput>;
1968
- email?: string | null;
1969
- role?: SignRequestCreateSignerRole;
1970
- is_in_person?: boolean;
1971
- order?: number;
1972
- signer_group_id?: string | null;
1973
- label?: string | null;
1974
- public_id?: string;
1975
- is_password_required?: boolean | null;
1976
- is_phone_number_required?: boolean | null;
1977
- login_required?: boolean | null;
1978
- }
1979
- export interface TemplateSignerInput {
1980
- document_tag_id?: string | null;
1981
- text_value?: string | null;
1982
- checkbox_value?: boolean | null;
1983
- date_value?: string | null;
1984
- type?: TemplateSignerInputType;
1985
- content_type?: SignRequestSignerInputContentType;
1986
- is_required?: boolean;
1987
- page_index: number;
1988
- document_id?: string | null;
1989
- dropdown_choices?: Array<string> | null;
1990
- group_id?: string | null;
1991
- coordinates?: TemplateSignerInputCoordinates;
1992
- dimensions?: TemplateSignerInputDimensions;
1993
- label?: string | null;
1994
- read_only?: boolean;
1995
- validation?: SignRequestSignerInputValidation2;
1996
- }
1997
- export interface TermsOfService {
1998
- id: string;
1999
- type: TermsOfServiceType;
2000
- status?: TermsOfServiceStatus;
2001
- enterprise?: CollaborationAllowlistEntryEnterprise;
2002
- tos_type?: TermsOfServiceTosType;
2003
- text?: string;
2004
- created_at?: string;
2005
- modified_at?: string;
2006
- }
2007
642
  export interface TermsOfServiceBase {
2008
643
  id: string;
2009
644
  type: TermsOfServiceType;
2010
645
  }
2011
- export interface TermsOfServices {
2012
- total_count?: number;
2013
- entries?: Array<TermsOfService>;
646
+ export interface UploadPartMini {
647
+ part_id?: string;
648
+ offset?: number;
649
+ size?: number;
2014
650
  }
2015
- export interface TermsOfServiceUserStatus {
651
+ export interface UserBase {
2016
652
  id: string;
2017
- type: TermsOfServiceUserStatusType;
2018
- tos?: TermsOfServiceBase;
2019
- user?: UserMini;
2020
- is_accepted?: boolean;
2021
- created_at?: string;
2022
- modified_at?: string;
2023
- }
2024
- export interface TermsOfServiceUserStatuses {
2025
- total_count?: number;
2026
- entries?: Array<TermsOfServiceUserStatus>;
2027
- }
2028
- export interface TimelineSkillCard {
2029
- created_at?: string;
2030
- type: KeywordSkillCardType;
2031
- skill_card_type: TimelineSkillCardSkillCardType;
2032
- skill_card_title?: KeywordSkillCardSkillCardTitle;
2033
- skill: KeywordSkillCardSkill;
2034
- invocation: KeywordSkillCardInvocation;
2035
- duration?: number;
2036
- entries: Array<TimelineSkillCardEntries>;
2037
- }
2038
- export interface TrackingCode {
2039
- type?: TrackingCodeType;
2040
- name?: string;
2041
- value?: string;
653
+ type: VariableValueType;
2042
654
  }
2043
- export interface TranscriptSkillCard {
2044
- created_at?: string;
2045
- type: KeywordSkillCardType;
2046
- skill_card_type: TranscriptSkillCardSkillCardType;
2047
- skill_card_title?: KeywordSkillCardSkillCardTitle;
2048
- skill: KeywordSkillCardSkill;
2049
- invocation: KeywordSkillCardInvocation;
2050
- duration?: number;
2051
- entries: Array<TranscriptSkillCardEntries>;
2052
- }
2053
- export interface TrashFile {
655
+ export interface UserCollaborations {
2054
656
  id: string;
2055
- etag?: string | null;
2056
- type: AiCitationType;
2057
- sequence_id: string;
657
+ type: VariableValueType;
2058
658
  name?: string;
2059
- sha1: string;
2060
- file_version?: FileVersionMini;
2061
- description: string;
2062
- size: number;
2063
- path_collection: TrashFilePathCollection;
2064
- created_at: string;
2065
- modified_at: string;
2066
- trashed_at?: string | null;
2067
- purged_at?: string | null;
2068
- content_created_at?: string | null;
2069
- content_modified_at?: string | null;
2070
- created_by?: UserMini;
2071
- modified_by: UserMini;
2072
- owned_by: UserMini;
2073
- shared_link?: string | null;
2074
- parent?: FolderMini | null;
2075
- item_status: FileItemStatus;
659
+ login?: string;
660
+ is_active?: boolean;
2076
661
  }
2077
- export interface TrashFileRestored {
662
+ export interface UserMini {
2078
663
  id: string;
2079
- etag?: string | null;
2080
- type: AiCitationType;
2081
- sequence_id: string;
664
+ type: VariableValueType;
2082
665
  name?: string;
2083
- sha1: string;
2084
- file_version?: FileVersionMini;
2085
- description: string;
2086
- size: number;
2087
- path_collection: FilePathCollection;
2088
- created_at: string;
2089
- modified_at: string;
2090
- trashed_at?: string | null;
2091
- purged_at?: string | null;
2092
- content_created_at?: string | null;
2093
- content_modified_at?: string | null;
2094
- created_by?: UserMini;
2095
- modified_by: UserMini;
2096
- owned_by: UserMini;
2097
- shared_link?: string | null;
2098
- parent?: FolderMini | null;
2099
- item_status: FileItemStatus;
2100
- }
2101
- export interface TrashFolder {
2102
- id: string;
2103
- etag?: string | null;
2104
- type: FolderType;
2105
- sequence_id?: string;
2106
- name: string;
2107
- created_at?: string | null;
2108
- modified_at?: string | null;
2109
- description: string;
2110
- size: number;
2111
- path_collection: TrashFilePathCollection;
2112
- created_by: UserMini;
2113
- modified_by: UserMini;
2114
- trashed_at?: string | null;
2115
- purged_at?: string | null;
2116
- content_created_at?: string | null;
2117
- content_modified_at?: string | null;
2118
- owned_by: UserMini;
2119
- shared_link?: string | null;
2120
- folder_upload_email?: string | null;
2121
- parent?: FolderMini | null;
2122
- item_status: FileItemStatus;
666
+ login?: string;
2123
667
  }
2124
- export interface TrashFolderRestored {
2125
- id?: string;
2126
- etag?: string | null;
2127
- type?: FolderType;
2128
- sequence_id?: string;
2129
- name?: string;
2130
- created_at?: string | null;
2131
- modified_at?: string | null;
2132
- description?: string;
2133
- size?: number;
2134
- path_collection?: FilePathCollection;
2135
- created_by?: UserMini;
2136
- modified_by?: UserMini;
2137
- trashed_at?: string | null;
2138
- purged_at?: string | null;
2139
- content_created_at?: string | null;
2140
- content_modified_at?: string | null;
2141
- owned_by?: UserMini;
2142
- shared_link?: string | null;
2143
- folder_upload_email?: string | null;
2144
- parent?: FolderMini | null;
2145
- item_status?: FileItemStatus;
668
+ export interface Watermark {
669
+ watermark?: WatermarkWatermark;
2146
670
  }
2147
- export interface TrashWebLink {
2148
- type?: TrashWebLinkType;
2149
- id?: string;
2150
- sequence_id?: string;
671
+ export interface WebLink {
672
+ id: string;
673
+ type: TrashWebLinkType;
2151
674
  etag?: string;
2152
- name?: string;
2153
675
  url?: string;
676
+ sequence_id?: string;
677
+ name?: string;
2154
678
  parent?: FolderMini;
2155
679
  description?: string;
2156
- path_collection?: TrashFilePathCollection;
680
+ path_collection?: FilePathCollection;
2157
681
  created_at?: string;
2158
682
  modified_at?: string;
2159
683
  trashed_at?: string | null;
@@ -2161,212 +685,19 @@ export interface TrashWebLink {
2161
685
  created_by?: UserMini;
2162
686
  modified_by?: UserMini;
2163
687
  owned_by?: UserMini;
2164
- shared_link?: string | null;
688
+ shared_link?: FileSharedLink | null;
2165
689
  item_status?: FileItemStatus;
690
+ collections?: Array<Collection>;
691
+ allowed_shared_link_access_levels?: Array<SharedLinkAccess>;
2166
692
  }
2167
- export interface TrashWebLinkRestored {
2168
- type?: TrashWebLinkType;
2169
- id?: string;
2170
- sequence_id: string;
2171
- etag?: string;
2172
- name?: string;
2173
- url?: string;
2174
- parent?: FolderMini;
2175
- description?: string;
2176
- path_collection: FilePathCollection;
2177
- created_at?: string;
2178
- modified_at?: string;
2179
- trashed_at?: string | null;
2180
- purged_at?: string | null;
2181
- created_by?: UserMini;
2182
- modified_by?: UserMini;
2183
- owned_by?: UserMini;
2184
- shared_link?: string | null;
2185
- item_status?: FileItemStatus;
2186
- }
2187
- export interface UploadedPart {
2188
- part?: UploadPart;
2189
- }
2190
- export interface UploadPart {
2191
- part_id?: string;
2192
- offset?: number;
2193
- size?: number;
2194
- sha1?: string;
2195
- }
2196
- export interface UploadPartMini {
2197
- part_id?: string;
2198
- offset?: number;
2199
- size?: number;
2200
- }
2201
- export interface UploadParts {
2202
- total_count?: number;
2203
- limit?: number;
2204
- offset?: number;
2205
- order?: Array<CollectionsOrder>;
2206
- entries?: Array<UploadPart>;
2207
- }
2208
- export interface UploadSession {
2209
- id?: string;
2210
- type?: UploadSessionType;
2211
- session_expires_at?: string;
2212
- part_size?: number;
2213
- total_parts?: number;
2214
- num_parts_processed?: number;
2215
- session_endpoints?: UploadSessionSessionEndpoints;
2216
- }
2217
- export interface UploadUrl {
2218
- upload_url?: string;
2219
- upload_token?: string;
2220
- }
2221
- export interface User {
2222
- id: string;
2223
- type: VariableValueType;
2224
- name?: string;
2225
- login?: string;
2226
- created_at?: string;
2227
- modified_at?: string;
2228
- language?: string;
2229
- timezone?: string;
2230
- space_amount?: number;
2231
- space_used?: number;
2232
- max_upload_size?: number;
2233
- status?: UserStatus;
2234
- job_title?: string;
2235
- phone?: string;
2236
- address?: string;
2237
- avatar_url?: string;
2238
- notification_email?: UserNotificationEmail | null;
2239
- }
2240
- export interface UserBase {
2241
- id: string;
2242
- type: VariableValueType;
2243
- }
2244
- export interface UserCollaborations {
2245
- id: string;
2246
- type: VariableValueType;
2247
- name?: string;
2248
- login?: string;
2249
- is_active?: boolean;
2250
- }
2251
- export interface UserFull {
2252
- id: string;
2253
- type: VariableValueType;
2254
- name?: string;
2255
- login?: string;
2256
- created_at?: string;
2257
- modified_at?: string;
2258
- language?: string;
2259
- timezone?: string;
2260
- space_amount?: number;
2261
- space_used?: number;
2262
- max_upload_size?: number;
2263
- status?: UserStatus;
2264
- job_title?: string;
2265
- phone?: string;
2266
- address?: string;
2267
- avatar_url?: string;
2268
- notification_email?: UserNotificationEmail | null;
2269
- role?: UserFullRole;
2270
- tracking_codes?: Array<TrackingCode>;
2271
- can_see_managed_users?: boolean;
2272
- is_sync_enabled?: boolean;
2273
- is_external_collab_restricted?: boolean;
2274
- is_exempt_from_device_limits?: boolean;
2275
- is_exempt_from_login_verification?: boolean;
2276
- enterprise?: CollaborationAllowlistEntryEnterprise;
2277
- my_tags?: Array<string>;
2278
- hostname?: string;
2279
- is_platform_access_only?: boolean;
2280
- external_app_user_id?: string;
2281
- }
2282
- export interface UserMini {
2283
- id: string;
2284
- type: VariableValueType;
2285
- name?: string;
2286
- login?: string;
2287
- }
2288
- export interface UserAvatar {
2289
- pic_urls?: UserAvatarPicUrls;
2290
- }
2291
- export interface UserIntegrationMappings {
2292
- id: string;
2293
- type: VariableValueType;
2294
- name?: string;
2295
- login?: string;
2296
- }
2297
- export interface Users {
2298
- limit?: number;
2299
- next_marker?: string | null;
2300
- prev_marker?: string | null;
2301
- total_count?: number;
2302
- offset?: number;
2303
- order?: Array<CollectionsOrder>;
2304
- entries?: Array<UserFull>;
2305
- }
2306
- export interface Watermark {
2307
- watermark?: WatermarkWatermark;
2308
- }
2309
- export interface Webhook {
2310
- id?: string;
2311
- type?: WebhookType;
2312
- target?: WebhookTarget;
2313
- created_by?: UserMini;
2314
- created_at?: string;
2315
- address?: string;
2316
- triggers?: Array<WebhookTriggers>;
2317
- }
2318
- export interface WebhookMini {
2319
- id?: string;
2320
- type?: WebhookType;
2321
- target?: WebhookTarget;
2322
- }
2323
- export interface Webhooks {
2324
- limit?: number;
2325
- next_marker?: string | null;
2326
- prev_marker?: string | null;
2327
- entries?: Array<WebhookMini>;
2328
- }
2329
- export interface WebLink {
2330
- id: string;
2331
- type: TrashWebLinkType;
2332
- etag?: string;
2333
- url?: string;
2334
- sequence_id?: string;
2335
- name?: string;
2336
- parent?: FolderMini;
2337
- description?: string;
2338
- path_collection?: FilePathCollection;
2339
- created_at?: string;
2340
- modified_at?: string;
2341
- trashed_at?: string | null;
2342
- purged_at?: string | null;
2343
- created_by?: UserMini;
2344
- modified_by?: UserMini;
2345
- owned_by?: UserMini;
2346
- shared_link?: FileSharedLink | null;
2347
- item_status?: FileItemStatus;
2348
- }
2349
- export interface WebLinkBase {
2350
- id: string;
2351
- type: TrashWebLinkType;
2352
- etag?: string;
2353
- }
2354
- export interface WebLinkMini {
2355
- id: string;
2356
- type: TrashWebLinkType;
693
+ export interface WebLinkMini {
694
+ id: string;
695
+ type: TrashWebLinkType;
2357
696
  etag?: string;
2358
697
  url?: string;
2359
698
  sequence_id?: string;
2360
699
  name?: string;
2361
700
  }
2362
- export interface Workflow {
2363
- id?: string;
2364
- type?: WorkflowType;
2365
- name?: string;
2366
- description?: string;
2367
- is_enabled?: boolean;
2368
- flows?: Array<WorkflowFlows>;
2369
- }
2370
701
  export interface WorkflowMini {
2371
702
  id?: string;
2372
703
  type?: WorkflowType;
@@ -2374,31 +705,7 @@ export interface WorkflowMini {
2374
705
  description?: string;
2375
706
  is_enabled?: boolean;
2376
707
  }
2377
- export interface Workflows {
2378
- limit?: number;
2379
- next_marker?: string | null;
2380
- prev_marker?: string | null;
2381
- entries?: Array<Workflow>;
2382
- }
2383
- export interface ZipDownload {
2384
- download_url?: string;
2385
- status_url?: string;
2386
- expires_at?: string;
2387
- name_conflicts?: Array<Array<ZipDownloadNameConflicts>>;
2388
- }
2389
- export interface ZipDownloadRequest {
2390
- items: Array<ZipDownloadRequestItems>;
2391
- download_file_name?: string;
2392
- }
2393
- export interface ZipDownloadStatus {
2394
- total_file_count?: number;
2395
- downloaded_file_count?: number;
2396
- skipped_file_count?: number;
2397
- skipped_folder_count?: number;
2398
- state?: ZipDownloadStatusState;
2399
- }
2400
708
  export type AccessTokenTokenType = "bearer" | (string & {});
2401
- export type AccessTokenIssuedTokenType = "urn:ietf:params:oauth:token-type:access_token" | (string & {});
2402
709
  export type AiAgentAskType = "ai_agent_ask" | (string & {});
2403
710
  export interface EmbeddingsStrategy {
2404
711
  id?: string;
@@ -2409,75 +716,18 @@ export interface AiAgentBasicGenToolEmbeddings {
2409
716
  strategy?: EmbeddingsStrategy;
2410
717
  }
2411
718
  export type AiAgentExtractType = "ai_agent_extract" | (string & {});
2412
- export type AiAgentExtractStructuredType = "ai_agent_extract_structured" | (string & {});
2413
- export interface AiAgentInfoModels {
2414
- name?: string;
2415
- provider?: string;
2416
- supported_purpose?: string;
2417
- }
2418
- export type AiAgentReferenceType = "ai_agent_id" | (string & {});
2419
719
  export type AiAgentTextGenType = "ai_agent_text_gen" | (string & {});
2420
- export type AiAskMode = "multiple_item_qa" | "single_item_qa" | (string & {});
2421
720
  export type AiCitationType = "file" | (string & {});
2422
721
  export type MetadataTemplateType = "metadata_template" | (string & {});
2423
- export interface AiExtractStructuredMetadataTemplate {
2424
- template_key?: string;
2425
- type?: MetadataTemplateType;
2426
- scope?: string;
2427
- }
2428
722
  export interface FieldsOptions {
2429
723
  key: string;
2430
724
  }
2431
- export interface AiExtractStructuredFields {
2432
- key: string;
2433
- description?: string;
2434
- displayName?: string;
2435
- prompt?: string;
2436
- type?: string;
2437
- options?: Array<FieldsOptions>;
2438
- fields?: Array<AiExtractSubField>;
2439
- taxonomy_key?: string;
2440
- namespace?: string;
2441
- options_rules?: AiOptionsRules;
2442
- }
2443
- export type AiItemAskType = "file" | "hubs" | (string & {});
2444
725
  export type AiLlmEndpointParamsAWSType = "aws_params" | (string & {});
2445
726
  export type AiLlmEndpointParamsGoogleType = "google_params" | (string & {});
2446
727
  export type AiLlmEndpointParamsIBMType = "ibm_params" | (string & {});
2447
728
  export type AiLlmEndpointParamsOpenAiType = "openai_params" | (string & {});
2448
- export type AiSingleAgentResponseType = "ai_agent" | (string & {});
2449
- export type AiTaxonomyReferenceType = "taxonomy" | (string & {});
2450
- export interface AiTextGenItems {
2451
- id: string;
2452
- type: AiCitationType;
2453
- content?: string;
2454
- }
2455
729
  export type AppItemType = "app_item" | (string & {});
2456
- export type AppItemAssociationType = "app_item_association" | (string & {});
2457
730
  export type ClassificationTemplate2 = "securityClassification-6VMVochwUWo" | (string & {});
2458
- export type ClassificationTemplateDisplayName = "Classification" | (string & {});
2459
- export type FieldsType = "enum" | (string & {});
2460
- export type FieldsKey = "Box__Security__Classification__Key" | (string & {});
2461
- export interface StaticConfigClassification {
2462
- classificationDefinition?: string;
2463
- colorID?: number;
2464
- }
2465
- export interface OptionsStaticConfig {
2466
- classification?: StaticConfigClassification;
2467
- }
2468
- export interface FieldsOptions2 {
2469
- id: string;
2470
- key: string;
2471
- staticConfig?: OptionsStaticConfig;
2472
- }
2473
- export interface ClassificationTemplateFields {
2474
- id: string;
2475
- type: FieldsType;
2476
- key: FieldsKey;
2477
- displayName: ClassificationTemplateDisplayName;
2478
- hidden?: boolean;
2479
- options: Array<FieldsOptions2>;
2480
- }
2481
731
  export type ClientErrorType = "error" | (string & {});
2482
732
  export type ClientErrorCode = "created" | "accepted" | "no_content" | "redirect" | "not_modified" | "bad_request" | "unauthorized" | "forbidden" | "not_found" | "method_not_allowed" | "conflict" | "precondition_failed" | "too_many_requests" | "internal_server_error" | "unavailable" | "item_name_invalid" | "insufficient_scope" | (string & {});
2483
733
  export type CollaborationType = "collaboration" | (string & {});
@@ -2500,17 +750,12 @@ export interface CollaborationAcceptanceRequirementsStatus {
2500
750
  strong_password_requirement?: AcceptanceRequirementsStatusStrongPasswordRequirement;
2501
751
  two_factor_authentication_requirement?: AcceptanceRequirementsStatusTwoFactorAuthenticationRequirement;
2502
752
  }
2503
- export type CollaborationAllowlistEntryType = "collaboration_whitelist_entry" | (string & {});
2504
- export type CollaborationAllowlistEntryDirection = "inbound" | "outbound" | "both" | (string & {});
2505
753
  export type EnterpriseType = "enterprise" | (string & {});
2506
754
  export interface CollaborationAllowlistEntryEnterprise {
2507
755
  id?: string;
2508
756
  type?: EnterpriseType;
2509
757
  name?: string;
2510
758
  }
2511
- export type CollaborationAllowlistExemptTargetType = "collaboration_whitelist_exempt_target" | (string & {});
2512
- export type CollaboratorVariableType = "variable" | (string & {});
2513
- export type CollaboratorVariableVariableType = "user_list" | (string & {});
2514
759
  export type VariableValueType = "user" | (string & {});
2515
760
  export interface CollaboratorVariableVariableValue {
2516
761
  type: VariableValueType;
@@ -2524,30 +769,14 @@ export interface CollectionsOrder {
2524
769
  by?: string;
2525
770
  direction?: OrderDirection;
2526
771
  }
2527
- export type CommentType = "comment" | (string & {});
2528
772
  export interface CommentItem {
2529
773
  id?: string;
2530
774
  type?: string;
2531
775
  }
2532
- export type CompletionRuleVariableVariableType = "task_completion_rule" | (string & {});
2533
- export type CompletionRuleVariableVariableValue = "all_assignees" | "any_assignees" | (string & {});
2534
776
  export interface ConflictErrorContextInfo {
2535
777
  conflicts?: Array<FileConflict>;
2536
778
  }
2537
- export type DevicePinnerType = "device_pinner" | (string & {});
2538
- export type OrderBy = "id" | (string & {});
2539
- export type OrderDirection2 = "asc" | "desc" | (string & {});
2540
- export interface DevicePinnersOrder {
2541
- by?: OrderBy;
2542
- direction?: OrderDirection2;
2543
- }
2544
- export type EmailAliasType = "email_alias" | (string & {});
2545
- export type EventEventType = "ACCESS_GRANTED" | "ACCESS_REVOKED" | "ADD_DEVICE_ASSOCIATION" | "ADD_LOGIN_ACTIVITY_DEVICE" | "ADMIN_LOGIN" | "ADVANCED_FOLDER_SETTINGS_UPDATE" | "AI_SECURITY_DETECTION" | "ANNOTATIONV2_CREATE" | "ANNOTATIONV2_DELETE" | "ANNOTATIONV2_EDIT" | "APPLICATION_CREATED" | "APPLICATION_PUBLIC_KEY_ADDED" | "APPLICATION_PUBLIC_KEY_DELETED" | "BOX_AI_USER_FAILED_REQUEST" | "BOX_AI_USER_REQUEST" | "CHANGE_ADMIN_ROLE" | "CHANGE_FOLDER_PERMISSION" | "COLLABORATION_ACCEPT" | "COLLABORATION_EXPIRATION" | "COLLABORATION_INVITE" | "COLLABORATION_REMOVE" | "COLLABORATION_ROLE_CHANGE" | "COLLAB_ADD_COLLABORATOR" | "COLLAB_INVITE_COLLABORATOR" | "COLLAB_REMOVE_COLLABORATOR" | "COLLAB_ROLE_CHANGE" | "COLLECTION_CREATE" | "COLLECTION_DELETE" | "COLLECTION_ITEM_CREATE" | "COLLECTION_ITEM_DELETE" | "COLLECTION_ITEM_UPDATE" | "COLLECTION_UPDATE" | "COMMENT_CREATE" | "COMMENT_DELETE" | "COMMENT_EDIT" | "CONTENT_ACCESS" | "CONTENT_RECOVERY_REPORT_CREATE" | "CONTENT_RECOVERY_REPORT_DELETE" | "CONTENT_RECOVERY_REPORT_INITIATE" | "CONTENT_WORKFLOW_ABNORMAL_DOWNLOAD_ACTIVITY" | "CONTENT_WORKFLOW_AUTOMATION_ADD" | "CONTENT_WORKFLOW_AUTOMATION_DELETE" | "CONTENT_WORKFLOW_POLICY_ADD" | "CONTENT_WORKFLOW_SHARING_POLICY_VIOLATION" | "CONTENT_WORKFLOW_UPLOAD_POLICY_VIOLATION" | "COPY" | "DATA_RETENTION_CREATE_RETENTION" | "DATA_RETENTION_REMOVE_RETENTION" | "DELETE" | "DELETE_USER" | "DEVICE_TRUST_CHECK_FAILED" | "DISABLE_MULTI_FACTOR_AUTH" | "DOWNLOAD" | "EDIT" | "EDIT_USER" | "EDR_CROWDSTRIKE_ACCESS_ALLOWED_NO_CROWDSTRIKE_DEVICE" | "EDR_CROWDSTRIKE_ACCESS_REVOKED" | "EDR_CROWDSTRIKE_BOX_TOOLS_OUTDATED" | "EDR_CROWDSTRIKE_DEVICE_DETECTED" | "EDR_CROWDSTRIKE_DRIVE_OUTDATED" | "EDR_CROWDSTRIKE_NO_BOX_TOOLS" | "EMAIL_ALIAS_CONFIRM" | "EMAIL_ALIAS_PRIMARY" | "EMAIL_ALIAS_REMOVE" | "EMAIL_UPLOAD_DISABLED" | "EMAIL_UPLOAD_ENABLED" | "ENABLE_MULTI_FACTOR_AUTH" | "ENABLE_TWO_FACTOR_AUTH" | "ENTERPRISE_APP_AUTHORIZATION_UPDATE" | "EXTERNAL_COLLAB_SECURITY_SETTINGS" | "FAILED_LOGIN" | "FAVORITE" | "FILE_MARKED_MALICIOUS" | "FILE_REQUEST_CREATE" | "FILE_REQUEST_DELETE" | "FILE_REQUEST_UPDATE" | "FILE_VERSION_RESTORE" | "FILE_WATERMARKED_DOWNLOAD" | "GROUP_ADD_ITEM" | "GROUP_ADD_USER" | "GROUP_ADMIN_CREATED" | "GROUP_ADMIN_DELETED" | "GROUP_ADMIN_PERMISSIONS_UPDATED" | "GROUP_CREATION" | "GROUP_DELETION" | "GROUP_EDITED" | "GROUP_REMOVE_ITEM" | "GROUP_REMOVE_USER" | "ILLEGAL_ITEM_OWNERSHIP_TRANSFER_BY_USER" | "ITEM_ASSOCIATION_CREATED" | "ITEM_ASSOCIATION_DELETED" | "ITEM_ASSOCIATION_UPDATED" | "ITEM_COPY" | "ITEM_CREATE" | "ITEM_DOWNLOAD" | "ITEM_EMAIL_SEND" | "ITEM_MAKE_CURRENT_VERSION" | "ITEM_MODIFY" | "ITEM_MOVE" | "ITEM_OPEN" | "ITEM_PREVIEW" | "ITEM_RENAME" | "ITEM_SHARED" | "ITEM_SHARED_CREATE" | "ITEM_SHARED_UNSHARE" | "ITEM_SHARED_UPDATE" | "ITEM_SYNC" | "ITEM_TRASH" | "ITEM_UNDELETE_VIA_TRASH" | "ITEM_UNSYNC" | "ITEM_UPLOAD" | "LEGAL_HOLD_ASSIGNMENT_CREATE" | "LEGAL_HOLD_ASSIGNMENT_DELETE" | "LEGAL_HOLD_POLICY_CREATE" | "LEGAL_HOLD_POLICY_DELETE" | "LEGAL_HOLD_POLICY_UPDATE" | "LOCK" | "LOCK_CREATE" | "LOCK_DESTROY" | "LOGIN" | "MASTER_INVITE_ACCEPT" | "MASTER_INVITE_REJECT" | "METADATA_CASCADE_POLICY_APPLY" | "METADATA_CASCADE_POLICY_CREATE" | "METADATA_INSTANCE_COPY" | "METADATA_INSTANCE_CREATE" | "METADATA_INSTANCE_DELETE" | "METADATA_INSTANCE_UPDATE" | "METADATA_TEMPLATE_CREATE" | "METADATA_TEMPLATE_DELETE" | "METADATA_TEMPLATE_UPDATE" | "MOVE" | "NEW_USER" | "OAUTH2_ACCESS_TOKEN_REVOKE" | "OAUTH2_REFRESH_TOKEN_REVOKE" | "PREVIEW" | "REMOVE_DEVICE_ASSOCIATION" | "REMOVE_LOGIN_ACTIVITY_DEVICE" | "RENAME" | "RETENTION_POLICY_ASSIGNMENT_ADD" | "SHARE" | "SHARED_LINK_REDIRECT_OUT_OF_SHARED_CONTEXT" | "SHARED_LINK_SEND" | "SHARE_EXPIRATION" | "SHIELD_ACCESS_POLICY_CREATED" | "SHIELD_ACCESS_POLICY_DELETED" | "SHIELD_ACCESS_POLICY_UPDATED" | "SHIELD_ALERT" | "SHIELD_DOWNLOAD_BLOCKED" | "SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED" | "SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED_MISSING_JUSTIFICATION" | "SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED" | "SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED_MISSING_JUSTIFICATION" | "SHIELD_EXTERNAL_COLLAB_INVITE_JUSTIFIED" | "SHIELD_INFORMATION_BARRIER_COLLAB_BLOCKED" | "SHIELD_INFORMATION_BARRIER_DISABLED" | "SHIELD_INFORMATION_BARRIER_ENABLED" | "SHIELD_INFORMATION_BARRIER_GROUP_ADD_USER_BLOCKED" | "SHIELD_INFORMATION_BARRIER_ITEM_COPY_BLOCKED" | "SHIELD_INFORMATION_BARRIER_ITEM_MOVE_BLOCKED" | "SHIELD_INFORMATION_BARRIER_ITEM_OWNER_TRANSFER_BLOCKED" | "SHIELD_INFORMATION_BARRIER_PENDING" | "SHIELD_INFORMATION_BARRIER_SHARED_ITEM_ACCESS_BLOCKED" | "SHIELD_JUSTIFICATION_APPROVAL" | "SHIELD_SHARED_LINK_ACCESS_BLOCKED" | "SHIELD_SHARED_LINK_STATUS_RESTRICTED_ON_CREATE" | "SHIELD_SHARED_LINK_STATUS_RESTRICTED_ON_UPDATE" | "SIGN_DOCUMENT_ASSIGNED" | "SIGN_DOCUMENT_CANCELLED" | "SIGN_DOCUMENT_COMPLETED" | "SIGN_DOCUMENT_CONVERTED" | "SIGN_DOCUMENT_CREATED" | "SIGN_DOCUMENT_DECLINED" | "SIGN_DOCUMENT_EXPIRED" | "SIGN_DOCUMENT_SIGNED" | "SIGN_DOCUMENT_VIEWED_BY_SIGNED" | "SIGN_DOCUMENT_VIEWED_BY_SIGNER" | "SIGNER_DOWNLOADED" | "SIGNER_FORWARDED" | "STORAGE_EXPIRATION" | "TAG_ITEM_CREATE" | "TASK_ASSIGNMENT_CREATE" | "TASK_ASSIGNMENT_DELETE" | "TASK_ASSIGNMENT_UPDATE" | "TASK_CREATE" | "TASK_UPDATE" | "TERMS_OF_SERVICE_ACCEPT" | "TERMS_OF_SERVICE_REJECT" | "UNDELETE" | "UNFAVORITE" | "UNLOCK" | "UNSHARE" | "UPDATE_COLLABORATION_EXPIRATION" | "UPDATE_SHARE_EXPIRATION" | "UPLOAD" | "USER_AUTHENTICATE_OAUTH2_ACCESS_TOKEN_CREATE" | "WATERMARK_LABEL_CREATE" | "WATERMARK_LABEL_DELETE" | "WORKFLOW_AUTOMATION_CREATE" | "WORKFLOW_AUTOMATION_DELETE" | "WORKFLOW_AUTOMATION_UPDATE" | (string & {});
2546
- export type EventsNextStreamPosition = unknown;
2547
779
  export type EventSourceItemType = "file" | "folder" | (string & {});
2548
- export interface EventSourceClassification {
2549
- name?: string;
2550
- }
2551
780
  export interface FilePathCollection {
2552
781
  total_count: number;
2553
782
  entries: Array<FolderMini>;
@@ -2648,16 +877,8 @@ export interface FileFullClassification {
2648
877
  color?: string;
2649
878
  }
2650
879
  export type FileFullSharedLinkPermissionOptions = "can_preview" | "can_download" | "can_edit" | (string & {});
2651
- export type FileRequestType = "file_request" | (string & {});
2652
- export type FileRequestStatus = "active" | "inactive" | (string & {});
2653
880
  export type FolderType = "folder" | (string & {});
2654
- export interface FileRequestCopyRequestFolder {
2655
- type?: FolderType;
2656
- id: string;
2657
- }
2658
881
  export type FileVersionType = "file_version" | (string & {});
2659
- export type FileVersionLegalHoldType = "file_version_legal_hold" | (string & {});
2660
- export type FileVersionRetentionType = "file_version_retention" | (string & {});
2661
882
  export type FolderUploadEmailAccess = "open" | "collaborators" | (string & {});
2662
883
  export interface FolderFolderUploadEmail {
2663
884
  access?: FolderUploadEmailAccess;
@@ -2674,153 +895,27 @@ export interface FolderFullPermissions {
2674
895
  can_upload: boolean;
2675
896
  can_apply_watermark?: boolean;
2676
897
  }
2677
- export interface FolderLockLockedOperations {
2678
- move: boolean;
2679
- delete: boolean;
2680
- }
2681
898
  export type GroupType = "group" | (string & {});
2682
899
  export type GroupGroupType = "managed_group" | "all_users_group" | (string & {});
2683
- export type GroupFullInvitabilityLevel = "admins_only" | "admins_and_members" | "all_managed_users" | (string & {});
2684
- export interface GroupFullPermissions {
2685
- can_invite_as_collaborator?: boolean;
2686
- }
2687
- export type GroupMembershipType = "group_membership" | (string & {});
2688
- export type GroupMembershipRole = "member" | "admin" | (string & {});
2689
- export type IntegrationMappingType = "integration_mapping" | (string & {});
2690
- export type IntegrationMappingIntegrationType = "slack" | (string & {});
2691
- export type IntegrationMappingPartnerItemSlackType = "channel" | (string & {});
2692
- export type IntegrationMappingPartnerItemTeamsType = "channel" | "team" | (string & {});
2693
- export type IntegrationMappingTeamsIntegrationType = "teams" | (string & {});
2694
- export type InviteType = "invite" | (string & {});
2695
- export type KeywordSkillCardType = "skill_card" | (string & {});
2696
- export type KeywordSkillCardSkillCardType = "keyword" | (string & {});
2697
- export interface KeywordSkillCardSkillCardTitle {
2698
- code?: string;
2699
- message: string;
2700
- }
2701
- export type SkillType = "service" | (string & {});
2702
- export interface KeywordSkillCardSkill {
2703
- type: SkillType;
2704
- id: string;
2705
- }
2706
- export type InvocationType = "skill_invocation" | (string & {});
2707
- export interface KeywordSkillCardInvocation {
2708
- type: InvocationType;
2709
- id: string;
2710
- }
2711
- export interface KeywordSkillCardEntries {
2712
- text?: string;
2713
- }
2714
900
  export type LegalHoldPolicyType = "legal_hold_policy" | (string & {});
2715
- export type LegalHoldPolicyStatus = "active" | "applying" | "releasing" | "released" | (string & {});
2716
- export interface LegalHoldPolicyAssignmentCounts {
2717
- user?: number;
2718
- folder?: number;
2719
- file?: number;
2720
- file_version?: number;
2721
- ownership?: number;
2722
- interactions?: number;
2723
- }
2724
901
  export type LegalHoldPolicyAssignedItemType = "file" | "file_version" | "folder" | "user" | "ownership" | "interactions" | (string & {});
2725
902
  export type LegalHoldPolicyAssignmentType = "legal_hold_policy_assignment" | (string & {});
2726
- export type MetadataCascadePolicyType = "metadata_cascade_policy" | (string & {});
2727
- export interface MetadataCascadePolicyOwnerEnterprise {
2728
- type?: EnterpriseType;
2729
- id?: string;
2730
- }
2731
903
  export interface MetadataCascadePolicyParent {
2732
904
  type?: FolderType;
2733
905
  id?: string;
2734
906
  }
2735
- export type MetadataFilterScope = "global" | "enterprise" | "enterprise_{enterprise_id}" | (string & {});
2736
- export type OrderByDirection = "ASC" | "DESC" | "asc" | "desc" | (string & {});
2737
- export interface MetadataQueryOrderBy {
2738
- field_key?: string;
2739
- direction?: OrderByDirection;
2740
- }
2741
- export type FieldsType2 = "string" | "float" | "date" | "enum" | "multiSelect" | "taxonomy" | "integer" | (string & {});
2742
- export interface FieldsOptions3 {
2743
- key: string;
2744
- id?: string;
2745
- }
2746
- export interface FieldsOptionsRules {
2747
- multiSelect?: boolean;
2748
- selectableLevels?: Array<number>;
2749
- }
2750
- export interface MetadataTemplateFields {
2751
- type: FieldsType2;
2752
- key: string;
2753
- displayName: string;
2754
- description?: string;
2755
- hidden?: boolean;
2756
- options?: Array<FieldsOptions3>;
2757
- taxonomyKey?: string;
2758
- taxonomyId?: string;
2759
- namespace?: string;
2760
- optionsRules?: FieldsOptionsRules;
2761
- id?: string;
2762
- }
2763
- export type PostOAuth2TokenGrantType = "authorization_code" | "refresh_token" | "client_credentials" | "urn:ietf:params:oauth:grant-type:jwt-bearer" | "urn:ietf:params:oauth:grant-type:token-exchange" | (string & {});
2764
- export type PostOAuth2TokenActorTokenType = "urn:ietf:params:oauth:token-type:id_token" | (string & {});
2765
- export type PostOAuth2TokenBoxSubjectType = "enterprise" | "user" | (string & {});
2766
- export type PostOAuth2TokenRefreshAccessTokenGrantType = "refresh_token" | (string & {});
2767
- export type RecentItemInteractionType = "item_preview" | "item_upload" | "item_comment" | "item_open" | "item_modify" | (string & {});
2768
907
  export type ResourceScopeScope = "annotation_edit" | "annotation_view_all" | "annotation_view_self" | "base_explorer" | "base_picker" | "base_preview" | "base_upload" | "item_delete" | "item_download" | "item_preview" | "item_rename" | "item_share" | "item_upload" | "item_read" | (string & {});
2769
908
  export type RetentionPolicyType = "retention_policy" | (string & {});
2770
909
  export type RetentionPolicyDispositionAction = "permanently_delete" | "remove_retention" | (string & {});
2771
- export type RetentionPolicyPolicyType = "finite" | "indefinite" | (string & {});
2772
- export type RetentionPolicyRetentionType = "modifiable" | "non_modifiable" | (string & {});
2773
- export type RetentionPolicyStatus = "active" | "retired" | (string & {});
2774
- export interface RetentionPolicyAssignmentCounts {
2775
- enterprise?: number;
2776
- folder?: number;
2777
- metadata_template?: number;
2778
- }
2779
- export type RetentionPolicyAssignmentType = "retention_policy_assignment" | (string & {});
2780
- export type AssignedToType = "folder" | "enterprise" | "metadata_template" | (string & {});
2781
- export interface RetentionPolicyAssignmentAssignedTo {
2782
- id?: string | null;
2783
- type?: AssignedToType;
2784
- }
2785
- export interface RetentionPolicyAssignmentFilterFields {
2786
- field?: string | null;
2787
- value?: string | null;
2788
- }
2789
910
  export type RetentionPolicyMaxExtensionLengthRequestVariant0 = "none" | (string & {});
2790
- export type RoleVariableVariableType = "collaborator_role" | (string & {});
2791
- export type SearchResultsType = "search_results_items" | (string & {});
2792
- export type SearchResultsWithSharedLinksType = "search_results_with_shared_links" | (string & {});
2793
911
  export type ShieldInformationBarrierType = "shield_information_barrier" | (string & {});
2794
- export type ShieldInformationBarrierStatus = "draft" | "pending" | "disabled" | "enabled" | "invalid" | (string & {});
2795
- export type ShieldInformationBarrierReportType = "shield_information_barrier_report" | (string & {});
2796
- export type ShieldInformationBarrierReportStatus = "pending" | "error" | "done" | "cancelled" | (string & {});
2797
- export interface ShieldInformationBarrierReportDetailsDetails {
2798
- folder_id?: string;
2799
- }
2800
912
  export type ShieldInformationBarrierSegmentType = "shield_information_barrier_segment" | (string & {});
2801
- export type ShieldInformationBarrierSegmentMemberType = "shield_information_barrier_segment_member" | (string & {});
2802
913
  export interface ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment {
2803
914
  id?: string;
2804
915
  type?: ShieldInformationBarrierSegmentType;
2805
916
  }
2806
- export type ShieldInformationBarrierSegmentRestrictionType = "shield_information_barrier_segment_restriction" | (string & {});
2807
- export type SignRequestType = "sign-request" | (string & {});
2808
- export type SignRequestStatus = "converting" | "created" | "sent" | "viewed" | "signed" | "cancelled" | "declined" | "error" | "error_converting" | "error_sending" | "expired" | "finalizing" | "error_finalizing" | (string & {});
2809
- export interface SignRequestSignFiles {
2810
- files?: Array<FileMini>;
2811
- is_ready_for_download?: boolean;
2812
- }
2813
- export type SignRequestCreateRequestSignatureColor = "blue" | "black" | "red" | (string & {});
2814
917
  export type SignRequestCreateSignerRole = "signer" | "approver" | "final_copy_reader" | (string & {});
2815
- export type SignerDecisionType = "signed" | "declined" | (string & {});
2816
- export interface SignRequestSignerSignerDecision {
2817
- type?: SignerDecisionType;
2818
- finalized_at?: string;
2819
- additional_info?: string | null;
2820
- }
2821
- export type SignRequestSignerInputType = "signature" | "date" | "text" | "checkbox" | "radio" | "dropdown" | (string & {});
2822
918
  export type SignRequestSignerInputContentType = "signature" | "initial" | "stamp" | "date" | "checkbox" | "text" | "full_name" | "first_name" | "last_name" | "company" | "title" | "email" | "attachment" | "radio" | "dropdown" | (string & {});
2823
- export type SignRequestSignerInputValidation2 = unknown;
2824
919
  export type SignRequestSignerInputCustomValidationValidationType = "custom" | (string & {});
2825
920
  export type SignRequestSignerInputDateAsiaValidationValidationType = "date_asia" | (string & {});
2826
921
  export type SignRequestSignerInputDateEUValidationValidationType = "date_eu" | (string & {});
@@ -2832,74 +927,11 @@ export type SignRequestSignerInputNumberWithPeriodValidationValidationType = "nu
2832
927
  export type SignRequestSignerInputSSNValidationValidationType = "ssn" | (string & {});
2833
928
  export type SignRequestSignerInputZIP4ValidationValidationType = "zip_4" | (string & {});
2834
929
  export type SignRequestSignerInputZIPValidationValidationType = "zip" | (string & {});
2835
- export type SignTemplateType = "sign-template" | (string & {});
2836
- export type AdditionalInfoNonEditable = "email_subject" | "email_message" | "name" | "days_valid" | "signers" | "source_files" | (string & {});
2837
- export interface AdditionalInfoRequired {
2838
- signers?: Array<Array<SignRequestSignerInputEmailValidationValidationType>>;
2839
- }
2840
- export interface SignTemplateAdditionalInfo {
2841
- non_editable?: Array<AdditionalInfoNonEditable>;
2842
- required?: AdditionalInfoRequired;
2843
- }
2844
- export interface SignTemplateReadySignLink {
2845
- url?: string;
2846
- name?: string | null;
2847
- instructions?: string | null;
2848
- folder_id?: string | null;
2849
- is_notification_disabled?: boolean;
2850
- is_active?: boolean;
2851
- }
2852
- export interface SignTemplateCustomBranding {
2853
- company_name?: string | null;
2854
- logo_uri?: string | null;
2855
- branding_color?: string | null;
2856
- email_footer_text?: string | null;
2857
- }
2858
- export type StatusSkillCardSkillCardType = "status" | (string & {});
2859
- export type StatusCode = "invoked" | "processing" | "success" | "transient_failure" | "permanent_failure" | (string & {});
2860
- export interface StatusSkillCardStatus {
2861
- code: StatusCode;
2862
- message?: string;
2863
- }
2864
930
  export type StoragePolicyType = "storage_policy" | (string & {});
2865
- export type StoragePolicyAssignmentType = "storage_policy_assignment" | (string & {});
2866
931
  export type TaskType = "task" | (string & {});
2867
- export type TaskAction = "review" | "complete" | (string & {});
2868
- export type TaskCompletionRule = "all_assignees" | "any_assignee" | (string & {});
2869
932
  export type TaskAssignmentType = "task_assignment" | (string & {});
2870
933
  export type TaskAssignmentResolutionState = "completed" | "incomplete" | "approved" | "rejected" | (string & {});
2871
- export type TemplateSignerInputType = "signature" | "date" | "text" | "checkbox" | "attachment" | "radio" | "dropdown" | (string & {});
2872
- export interface TemplateSignerInputCoordinates {
2873
- x?: number;
2874
- y?: number;
2875
- }
2876
- export interface TemplateSignerInputDimensions {
2877
- width?: number;
2878
- height?: number;
2879
- }
2880
934
  export type TermsOfServiceType = "terms_of_service" | (string & {});
2881
- export type TermsOfServiceStatus = "enabled" | "disabled" | (string & {});
2882
- export type TermsOfServiceTosType = "managed" | "external" | (string & {});
2883
- export type TermsOfServiceUserStatusType = "terms_of_service_user_status" | (string & {});
2884
- export type TimelineSkillCardSkillCardType = "timeline" | (string & {});
2885
- export interface EntriesAppears {
2886
- start?: number;
2887
- end?: number;
2888
- }
2889
- export interface TimelineSkillCardEntries {
2890
- text?: string;
2891
- appears?: Array<EntriesAppears>;
2892
- image_url?: string;
2893
- }
2894
- export type TrackingCodeType = "tracking_code" | (string & {});
2895
- export type TranscriptSkillCardSkillCardType = "transcript" | (string & {});
2896
- export interface EntriesAppears2 {
2897
- start?: number;
2898
- }
2899
- export interface TranscriptSkillCardEntries {
2900
- text?: string;
2901
- appears?: Array<EntriesAppears2>;
2902
- }
2903
935
  export interface PathCollectionEntries {
2904
936
  type?: FolderType;
2905
937
  id?: string;
@@ -2912,91 +944,20 @@ export interface TrashFilePathCollection {
2912
944
  entries: Array<PathCollectionEntries>;
2913
945
  }
2914
946
  export type TrashWebLinkType = "web_link" | (string & {});
2915
- export type UploadSessionType = "upload_session" | (string & {});
2916
- export interface UploadSessionSessionEndpoints {
2917
- upload_part?: string;
2918
- commit?: string;
2919
- abort?: string;
2920
- list_parts?: string;
2921
- status?: string;
2922
- log_event?: string;
2923
- }
2924
947
  export type UserStatus = "active" | "inactive" | "cannot_delete_edit" | "cannot_delete_edit_upload" | (string & {});
2925
948
  export interface UserNotificationEmail {
2926
949
  email?: string;
2927
950
  is_confirmed?: boolean;
2928
951
  }
2929
- export type UserFullRole = "admin" | "coadmin" | "user" | (string & {});
2930
- export interface UserAvatarPicUrls {
2931
- small?: string;
2932
- large?: string;
2933
- preview?: string;
2934
- }
2935
952
  export interface WatermarkWatermark {
2936
953
  created_at?: string;
2937
954
  modified_at?: string;
2938
955
  }
2939
- export type WebhookType = "webhook" | (string & {});
2940
- export interface WebhookTarget {
2941
- id?: string;
2942
- type?: EventSourceItemType;
2943
- }
2944
- export type WebhookTriggers = "FILE.UPLOADED" | "FILE.PREVIEWED" | "FILE.DOWNLOADED" | "FILE.TRASHED" | "FILE.DELETED" | "FILE.RESTORED" | "FILE.COPIED" | "FILE.MOVED" | "FILE.LOCKED" | "FILE.UNLOCKED" | "FILE.RENAMED" | "COMMENT.CREATED" | "COMMENT.UPDATED" | "COMMENT.DELETED" | "TASK_ASSIGNMENT.CREATED" | "TASK_ASSIGNMENT.UPDATED" | "METADATA_INSTANCE.CREATED" | "METADATA_INSTANCE.UPDATED" | "METADATA_INSTANCE.DELETED" | "FOLDER.CREATED" | "FOLDER.RENAMED" | "FOLDER.DOWNLOADED" | "FOLDER.RESTORED" | "FOLDER.DELETED" | "FOLDER.COPIED" | "FOLDER.MOVED" | "FOLDER.TRASHED" | "WEBHOOK.DELETED" | "COLLABORATION.CREATED" | "COLLABORATION.ACCEPTED" | "COLLABORATION.REJECTED" | "COLLABORATION.REMOVED" | "COLLABORATION.UPDATED" | "SHARED_LINK.DELETED" | "SHARED_LINK.CREATED" | "SHARED_LINK.UPDATED" | "SIGN_REQUEST.COMPLETED" | "SIGN_REQUEST.DECLINED" | "SIGN_REQUEST.EXPIRED" | "SIGN_REQUEST.SIGNER_EMAIL_BOUNCED" | "SIGN_REQUEST.SIGN_SIGNER_SIGNED" | "SIGN_REQUEST.SIGN_DOCUMENT_CREATED" | "SIGN_REQUEST.SIGN_ERROR_FINALIZING" | (string & {});
2945
- export type WorkflowType = "workflow" | (string & {});
2946
- export type FlowsType = "flow" | (string & {});
2947
- export type TriggerType = "trigger" | (string & {});
2948
- export type TriggerTriggerType = "WORKFLOW_MANUAL_START" | (string & {});
2949
- export type ScopeType = "trigger_scope" | (string & {});
2950
- export interface TriggerScope {
2951
- type?: ScopeType;
2952
- ref?: string;
2953
- object?: MetadataCascadePolicyParent;
2954
- }
2955
- export interface FlowsTrigger {
2956
- type?: TriggerType;
2957
- trigger_type?: TriggerTriggerType;
2958
- scope?: Array<TriggerScope>;
2959
- }
2960
- export type OutcomesType = "outcome" | (string & {});
2961
- export type OutcomesActionType = "add_metadata" | "assign_task" | "copy_file" | "copy_folder" | "create_folder" | "delete_file" | "delete_folder" | "lock_file" | "move_file" | "move_folder" | "remove_watermark_file" | "rename_folder" | "restore_folder" | "share_file" | "share_folder" | "unlock_file" | "upload_file" | "wait_for_task" | "watermark_file" | "go_back_to_step" | "apply_file_classification" | "apply_folder_classification" | "send_notification" | (string & {});
2962
- export interface OutcomesIfRejected {
2963
- id?: string;
2964
- type?: OutcomesType;
2965
- name?: string;
2966
- action_type?: OutcomesActionType;
2967
- }
2968
- export interface FlowsOutcomes {
2969
- id?: string;
2970
- type?: OutcomesType;
2971
- name?: string;
2972
- action_type?: OutcomesActionType;
2973
- if_rejected?: Array<OutcomesIfRejected>;
2974
- }
2975
- export interface WorkflowFlows {
2976
- id?: string;
2977
- type?: FlowsType;
2978
- trigger?: FlowsTrigger;
2979
- outcomes?: Array<FlowsOutcomes>;
2980
- created_at?: string;
2981
- created_by?: UserBase;
2982
- }
2983
- export interface ZipDownloadNameConflicts {
2984
- id?: string;
2985
- type?: EventSourceItemType;
2986
- original_name?: string;
2987
- download_name?: string;
2988
- }
2989
- export interface ZipDownloadRequestItems {
2990
- type: EventSourceItemType;
2991
- id: string;
2992
- }
2993
- export type ZipDownloadStatusState = "in_progress" | "failed" | "succeeded" | (string & {});
2994
- export type GetAuthorizeResponseType = "code" | (string & {});
2995
956
  export interface PutIdParent {
2996
957
  id?: string;
2997
958
  user_id?: string;
2998
959
  }
2999
- export interface SharedLinkPermissions2 {
960
+ export interface UpdateFileRequestSharedLinkPermissions {
3000
961
  can_download?: boolean;
3001
962
  }
3002
963
  export interface PutIdSharedLink {
@@ -3004,709 +965,78 @@ export interface PutIdSharedLink {
3004
965
  password?: string | null;
3005
966
  vanity_name?: string;
3006
967
  unshared_at?: string;
3007
- permissions?: SharedLinkPermissions2;
3008
- }
3009
- export interface PutIdLock {
3010
- access?: LockType;
3011
- expires_at?: string;
3012
- is_download_prevented?: boolean;
3013
- }
3014
- export type PermissionsCanDownload = "open" | "company" | (string & {});
3015
- export interface PutIdPermissions {
3016
- can_download?: PermissionsCanDownload;
3017
- }
3018
- export interface FileUpdateRequest {
3019
- name?: string;
3020
- description?: string;
3021
- parent?: PutIdParent;
3022
- shared_link?: PutIdSharedLink | null;
3023
- lock?: PutIdLock | null;
3024
- disposition_at?: string;
3025
- permissions?: PutIdPermissions;
3026
- collections?: Array<CommentItem> | null;
3027
- tags?: Array<string>;
968
+ permissions?: UpdateFileRequestSharedLinkPermissions;
3028
969
  }
3029
970
  export interface PostFileIdParent {
3030
971
  id?: string;
3031
972
  }
3032
- export interface FileCreateRequest {
973
+ export interface CreateFileRequest {
3033
974
  name?: string;
3034
975
  parent?: PostFileIdParent;
3035
976
  }
3036
- export interface PostFileIdContentAttributes {
3037
- name: string;
3038
- content_modified_at?: string;
3039
- }
3040
- export interface FileIdContentCreateRequest {
3041
- attributes: PostFileIdContentAttributes;
3042
- file: Blob;
3043
- }
3044
977
  export interface AttributesParent {
3045
978
  id: string;
3046
979
  }
3047
- export interface PostFileContentAttributes {
3048
- name: string;
3049
- parent: AttributesParent;
3050
- content_created_at?: string;
3051
- content_modified_at?: string;
3052
- }
3053
- export interface FileContentCreateRequest {
3054
- attributes: PostFileContentAttributes;
3055
- file: Blob;
3056
- }
3057
- export interface OptionFileContentRequest {
3058
- name?: string;
3059
- size?: number;
3060
- parent?: PostFileIdParent;
3061
- }
3062
- export interface FileUploadSessionCreateRequest {
3063
- folder_id: string;
3064
- file_size: number;
3065
- file_name: string;
3066
- }
3067
- export interface FileVersionUploadSessionCreateRequest {
3068
- file_size: number;
3069
- file_name?: string;
3070
- }
3071
- export interface FileUploadSessionCommitRequest {
3072
- parts: Array<UploadPart>;
3073
- }
3074
- export interface FileCopyRequest {
3075
- name?: string;
3076
- version?: string;
3077
- parent: AttributesParent;
3078
- }
3079
- export type GetIdThumbnailIdExtension = "png" | "jpg" | (string & {});
3080
- export interface FileVersionUpdateRequest {
3081
- trashed_at?: string | null;
3082
- }
3083
- export interface FileVersionCurrentCreateRequest {
3084
- id?: string;
3085
- type?: FileVersionType;
3086
- }
3087
980
  export type PutOp = "replace" | (string & {});
3088
981
  export type PutPath = "/Box__Security__Classification__Key" | (string & {});
3089
- export interface FileClassificationUpdateRequest {
982
+ export interface UpdateFileClassificationRequest {
3090
983
  op: PutOp;
3091
984
  path: PutPath;
3092
985
  value: string;
3093
986
  }
3094
- export interface FileClassificationCreateRequest {
987
+ export interface CreateFileClassificationRequest {
3095
988
  Box__Security__Classification__Key?: string;
3096
989
  }
3097
- export type GetFileIdMetadataIdIdScope = "global" | "enterprise" | (string & {});
3098
- export type PutFileIdMetadataIdIdOp = "add" | "replace" | "remove" | "test" | "move" | "copy" | (string & {});
3099
- export interface FileMetadataUpdateRequest {
3100
- op?: PutFileIdMetadataIdIdOp;
990
+ export type GetFileIdMetadataIdScope = "global" | "enterprise" | (string & {});
991
+ export type PutFileIdMetadataIdOp = "add" | "replace" | "remove" | "test" | "move" | "copy" | (string & {});
992
+ export interface UpdateFileMetadataRequest {
993
+ op?: PutFileIdMetadataIdOp;
3101
994
  path?: string;
3102
995
  value?: MetadataInstanceValue;
3103
996
  from?: string;
3104
997
  }
3105
- export interface SkillUpdateRequest {
3106
- op?: PutOp;
3107
- path?: string;
3108
- value?: SkillCard;
3109
- }
3110
- export interface SkillCreateRequest {
3111
- cards: Array<SkillCard>;
3112
- }
3113
998
  export type WatermarkImprint = "default" | (string & {});
3114
999
  export interface PutFileIdWatermarkWatermark {
3115
1000
  imprint: WatermarkImprint;
3116
1001
  }
3117
- export interface FileWatermarkUpdateRequest {
1002
+ export interface UpdateFileWatermarkRequest {
3118
1003
  watermark: PutFileIdWatermarkWatermark;
3119
1004
  }
3120
- export type GetIdSort = "id" | "name" | "date" | "size" | (string & {});
3121
- export interface PutIdFolderUploadEmail {
3122
- access?: FolderUploadEmailAccess;
1005
+ export type GetDirection = "DESC" | "ASC" | (string & {});
1006
+ export interface UpdateFileAddSharedLinkRequestSharedLinkPermissions {
1007
+ can_download?: boolean;
1008
+ can_preview?: boolean;
1009
+ can_edit?: boolean;
3123
1010
  }
3124
- export interface FolderUpdateRequest {
3125
- name?: string;
3126
- description?: string;
3127
- sync_state?: FolderFullSyncState;
3128
- can_non_owners_invite?: boolean;
3129
- parent?: PutIdParent;
3130
- shared_link?: PutIdSharedLink;
3131
- folder_upload_email?: PutIdFolderUploadEmail | null;
3132
- tags?: Array<string>;
3133
- is_collaboration_restricted_to_enterprise?: boolean;
3134
- collections?: Array<CommentItem> | null;
3135
- can_non_owners_view_collaborators?: boolean;
1011
+ export interface PutFileIdAddSharedLinkSharedLink {
1012
+ access?: SharedLinkAccess;
1013
+ password?: string | null;
1014
+ vanity_name?: string;
1015
+ unshared_at?: string;
1016
+ permissions?: UpdateFileAddSharedLinkRequestSharedLinkPermissions;
3136
1017
  }
3137
- export interface FolderCreateRequest {
3138
- name: string;
3139
- parent: AttributesParent;
3140
- folder_upload_email?: PutIdFolderUploadEmail;
3141
- sync_state?: FolderFullSyncState;
1018
+ export interface UpdateFileAddSharedLinkRequest {
1019
+ shared_link?: PutFileIdAddSharedLinkSharedLink;
3142
1020
  }
3143
- export interface FolderCopyRequest {
3144
- name?: string;
3145
- parent: AttributesParent;
3146
- }
3147
- export type GetFolderTrashItemsSort = "name" | "date" | "size" | (string & {});
3148
- export interface PostFolder {
3149
- type: string;
3150
- id: string;
3151
- }
3152
- export interface FolderLockCreateRequest {
3153
- locked_operations?: FolderLockLockedOperations;
3154
- folder: PostFolder;
3155
- }
3156
- export type PutAddOp = "addEnumOption" | (string & {});
3157
- export interface PutAddData {
3158
- key: string;
3159
- staticConfig?: OptionsStaticConfig;
3160
- }
3161
- export interface ClassificationUpdateRequest {
3162
- op: PutAddOp;
3163
- fieldKey: FieldsKey;
3164
- data: PutAddData;
3165
- }
3166
- export type PutUpdateOp = "editEnumOption" | (string & {});
3167
- export interface ClassificationUpdateRequest2 {
3168
- op: PutUpdateOp;
3169
- fieldKey: FieldsKey;
3170
- enumOptionKey: string;
3171
- data: PutAddData;
3172
- }
3173
- export type PutIdIdSchemaOp = "editTemplate" | "addField" | "reorderFields" | "addEnumOption" | "reorderEnumOptions" | "reorderMultiSelectOptions" | "addMultiSelectOption" | "editField" | "removeField" | "editEnumOption" | "removeEnumOption" | "editMultiSelectOption" | "removeMultiSelectOption" | (string & {});
3174
- export interface SchemaUpdateRequest {
3175
- op: PutIdIdSchemaOp;
3176
- data?: Record<string, unknown>;
3177
- fieldKey?: string;
3178
- fieldKeys?: Array<string>;
3179
- enumOptionKey?: string;
3180
- enumOptionKeys?: Array<string>;
3181
- multiSelectOptionKey?: string;
3182
- multiSelectOptionKeys?: Array<string>;
3183
- }
3184
- export type FieldsType3 = "string" | "float" | "date" | "enum" | "multiSelect" | "taxonomy" | (string & {});
3185
- export interface PostSchemaFields {
3186
- type: FieldsType3;
3187
- key: string;
3188
- displayName: string;
3189
- description?: string;
3190
- hidden?: boolean;
3191
- options?: Array<FieldsOptions>;
3192
- taxonomyKey?: string;
3193
- taxonomyId?: string;
3194
- namespace?: string;
3195
- optionsRules?: FieldsOptionsRules;
3196
- }
3197
- export interface SchemaCreateRequest {
3198
- scope: string;
3199
- templateKey?: string;
3200
- displayName: string;
3201
- hidden?: boolean;
3202
- fields?: Array<PostSchemaFields>;
3203
- copyInstanceOnItemCopy?: boolean;
3204
- }
3205
- export interface PostMetadataTemplateSchemaClassificationsFields {
3206
- type: FieldsType;
3207
- key: FieldsKey;
3208
- displayName: ClassificationTemplateDisplayName;
3209
- hidden?: boolean;
3210
- options: Array<PutAddData>;
3211
- }
3212
- export interface MetadataTemplateSchemaCreateRequest {
3213
- scope: EnterpriseType;
3214
- templateKey: ClassificationTemplate2;
3215
- displayName: ClassificationTemplateDisplayName;
3216
- hidden?: boolean;
3217
- copyInstanceOnItemCopy?: boolean;
3218
- fields: Array<PostMetadataTemplateSchemaClassificationsFields>;
3219
- }
3220
- export interface MetadataCascadePolicyCreateRequest {
3221
- folder_id: string;
3222
- scope: GetFileIdMetadataIdIdScope;
3223
- templateKey: string;
3224
- }
3225
- export type PostIdApplyConflictResolution = "none" | "overwrite" | (string & {});
3226
- export interface MetadataCascadePolicyApplyRequest {
3227
- conflict_resolution: PostIdApplyConflictResolution;
3228
- }
3229
- export interface CommentUpdateRequest {
3230
- message?: string;
3231
- }
3232
- export type ItemType = "file" | "comment" | (string & {});
3233
- export interface PostItem {
3234
- id: string;
3235
- type: ItemType;
3236
- }
3237
- export interface CommentCreateRequest {
3238
- message: string;
3239
- tagged_message?: string;
3240
- item: PostItem;
3241
- }
3242
- export type PutCollaborationIdStatus = "pending" | "accepted" | "rejected" | (string & {});
3243
- export interface CollaborationUpdateRequest {
3244
- role?: CollaborationRole;
3245
- status?: PutCollaborationIdStatus;
3246
- expires_at?: string;
3247
- can_view_path?: boolean;
3248
- }
3249
- export type GetCollaborationsStatus = "pending" | (string & {});
3250
- export interface PostCollaborationsItem {
3251
- type?: EventSourceItemType;
3252
- id?: string;
3253
- }
3254
- export type AccessibleByType = "user" | "group" | (string & {});
3255
- export interface PostCollaborationsAccessibleBy {
3256
- type: AccessibleByType;
3257
- id?: string;
3258
- login?: string;
3259
- }
3260
- export interface CollaborationsCreateRequest {
3261
- item: PostCollaborationsItem;
3262
- accessible_by: PostCollaborationsAccessibleBy;
3263
- role: FileFullAllowedInviteeRoles;
3264
- is_access_only?: boolean;
3265
- can_view_path?: boolean;
3266
- expires_at?: string;
3267
- }
3268
- export type GetScope = "user_content" | "enterprise_content" | (string & {});
3269
- export type GetContentTypes = "name" | "description" | "file_content" | "comments" | "tags" | (string & {});
3270
- export type GetType = "file" | "folder" | "web_link" | (string & {});
3271
- export type GetTrashContent = "non_trashed_only" | "trashed_only" | "all_items" | (string & {});
3272
- export type GetSort = "modified_at" | "relevance" | (string & {});
3273
- export type GetDirection = "DESC" | "ASC" | (string & {});
3274
- export interface PostItem2 {
3275
- id?: string;
3276
- type?: AiCitationType;
3277
- }
3278
- export interface TaskCreateRequest {
3279
- item: PostItem2;
3280
- action?: TaskAction;
3281
- message?: string;
3282
- due_at?: string;
3283
- completion_rule?: TaskCompletionRule;
3284
- }
3285
- export interface TaskUpdateRequest {
3286
- action?: TaskAction;
3287
- message?: string;
3288
- due_at?: string;
3289
- completion_rule?: TaskCompletionRule;
3290
- }
3291
- export interface PostTask {
3292
- id: string;
3293
- type: TaskType;
3294
- }
3295
- export interface PostAssignTo {
3296
- id?: string;
3297
- login?: string;
3298
- }
3299
- export interface TaskAssignmentCreateRequest {
3300
- task: PostTask;
3301
- assign_to: PostAssignTo;
3302
- }
3303
- export interface TaskAssignmentUpdateRequest {
3304
- message?: string;
3305
- resolution_state?: TaskAssignmentResolutionState;
3306
- }
3307
- export interface SharedLinkPermissions3 {
3308
- can_download?: boolean;
3309
- can_preview?: boolean;
3310
- can_edit?: boolean;
3311
- }
3312
- export interface PutFileIdAddSharedLinkSharedLink {
3313
- access?: SharedLinkAccess;
3314
- password?: string | null;
3315
- vanity_name?: string;
3316
- unshared_at?: string;
3317
- permissions?: SharedLinkPermissions3;
3318
- }
3319
- export interface FileUpdateRequest2 {
3320
- shared_link?: PutFileIdAddSharedLinkSharedLink;
3321
- }
3322
- export interface FileUpdateRequest3 {
3323
- shared_link?: Record<string, unknown> | null;
3324
- }
3325
- export interface PutFolderIdUpdateSharedLinkSharedLink {
3326
- access?: SharedLinkAccess;
3327
- password?: string;
3328
- vanity_name?: string;
3329
- unshared_at?: string;
3330
- permissions?: SharedLinkPermissions3;
3331
- }
3332
- export interface FolderUpdateRequest2 {
3333
- shared_link?: PutFolderIdUpdateSharedLinkSharedLink;
3334
- }
3335
- export interface WebLinkCreateRequest {
3336
- url: string;
3337
- parent: AttributesParent;
3338
- name?: string;
3339
- description?: string;
3340
- }
3341
- export interface PutIdSharedLink2 {
3342
- access?: SharedLinkAccess;
3343
- password?: string | null;
3344
- vanity_name?: string;
3345
- unshared_at?: string;
3346
- }
3347
- export interface WebLinkUpdateRequest {
3348
- url?: string;
3349
- parent?: PutIdParent;
3350
- name?: string;
3351
- description?: string;
3352
- shared_link?: PutIdSharedLink2;
3353
- }
3354
- export type GetUserType = "all" | "managed" | "external" | (string & {});
3355
- export type PostRole = "coadmin" | "user" | (string & {});
3356
- export interface UserCreateRequest {
3357
- name: string;
3358
- login?: string;
3359
- is_platform_access_only?: boolean;
3360
- role?: PostRole;
3361
- language?: string;
3362
- is_sync_enabled?: boolean;
3363
- job_title?: string;
3364
- phone?: string;
3365
- address?: string;
3366
- space_amount?: number;
3367
- tracking_codes?: Array<TrackingCode>;
3368
- can_see_managed_users?: boolean;
3369
- timezone?: string;
3370
- is_external_collab_restricted?: boolean;
3371
- is_exempt_from_device_limits?: boolean;
3372
- is_exempt_from_login_verification?: boolean;
3373
- status?: UserStatus;
3374
- external_app_user_id?: string;
3375
- }
3376
- export interface UserTerminateSessionsCreateRequest {
3377
- user_ids: Array<string>;
3378
- user_logins: Array<string>;
3379
- }
3380
- export interface PutIdNotificationEmail {
3381
- email?: string;
3382
- }
3383
- export interface UserUpdateRequest {
3384
- enterprise?: string | null;
3385
- notify?: boolean;
3386
- name?: string;
3387
- login?: string;
3388
- role?: PostRole;
3389
- language?: string;
3390
- is_sync_enabled?: boolean;
3391
- job_title?: string;
3392
- phone?: string;
3393
- address?: string;
3394
- tracking_codes?: Array<TrackingCode>;
3395
- can_see_managed_users?: boolean;
3396
- timezone?: string;
3397
- is_external_collab_restricted?: boolean;
3398
- is_exempt_from_device_limits?: boolean;
3399
- is_exempt_from_login_verification?: boolean;
3400
- is_password_reset_required?: boolean;
3401
- status?: UserStatus;
3402
- space_amount?: number;
3403
- notification_email?: PutIdNotificationEmail | null;
3404
- external_app_user_id?: string;
3405
- }
3406
- export interface UserAvatarCreateRequest {
3407
- pic: Blob;
3408
- }
3409
- export interface UserFolder0UpdateRequest {
3410
- owned_by: AttributesParent;
3411
- }
3412
- export interface UserIdCreateRequest {
3413
- email: string;
3414
- }
3415
- export interface PostActionableBy {
3416
- login?: string;
3417
- }
3418
- export interface InviteCreateRequest {
3419
- enterprise: AttributesParent;
3420
- actionable_by: PostActionableBy;
3421
- }
3422
- export interface GroupCreateRequest {
3423
- name: string;
3424
- provenance?: string;
3425
- external_sync_identifier?: string;
3426
- description?: string;
3427
- invitability_level?: GroupFullInvitabilityLevel;
3428
- member_viewability_level?: GroupFullInvitabilityLevel;
3429
- }
3430
- export interface GroupTerminateSessionsCreateRequest {
3431
- group_ids: Array<string>;
3432
- }
3433
- export interface GroupUpdateRequest {
3434
- name?: string;
3435
- provenance?: string;
3436
- external_sync_identifier?: string;
3437
- description?: string;
3438
- invitability_level?: GroupFullInvitabilityLevel;
3439
- member_viewability_level?: GroupFullInvitabilityLevel;
3440
- }
3441
- export interface GroupCreateRequest2 {
3442
- user: AttributesParent;
3443
- group: AttributesParent;
3444
- role?: GroupMembershipRole;
3445
- configurable_permissions?: Record<string, boolean> | null;
3446
- }
3447
- export interface GroupUpdateRequest2 {
3448
- role?: GroupMembershipRole;
3449
- configurable_permissions?: Record<string, boolean> | null;
3450
- }
3451
- export interface WebhookCreateRequest {
3452
- target: WebhookTarget;
3453
- address: string;
3454
- triggers: Array<WebhookTriggers>;
3455
- }
3456
- export interface WebhookUpdateRequest {
3457
- target?: WebhookTarget;
3458
- address?: string;
3459
- triggers?: Array<WebhookTriggers>;
3460
- }
3461
- export interface PutSkillInvocationIdMetadata {
3462
- cards?: Array<SkillCard>;
1021
+ export interface UpdateFileRemoveSharedLinkRequest {
1022
+ shared_link?: Record<string, unknown> | null;
3463
1023
  }
3464
1024
  export interface PutSkillInvocationIdFile {
3465
1025
  type?: AiCitationType;
3466
1026
  id?: string;
3467
1027
  }
3468
- export interface PutSkillInvocationIdFileVersion {
3469
- type?: FileVersionType;
3470
- id?: string;
3471
- }
3472
- export interface PutSkillInvocationIdUsage {
3473
- unit?: string;
3474
- value?: number;
3475
- }
3476
- export interface SkillInvocationUpdateRequest {
3477
- status: StatusCode;
3478
- metadata: PutSkillInvocationIdMetadata;
3479
- file: PutSkillInvocationIdFile;
3480
- file_version?: PutSkillInvocationIdFileVersion;
3481
- usage?: PutSkillInvocationIdUsage;
3482
- }
3483
- export type GetStreamType = "all" | "changes" | "sync" | "admin_logs" | "admin_logs_streaming" | (string & {});
3484
- export type GetEventType = "ACCESS_GRANTED" | "ACCESS_REVOKED" | "ADD_DEVICE_ASSOCIATION" | "ADD_LOGIN_ACTIVITY_DEVICE" | "ADMIN_LOGIN" | "ADVANCED_FOLDER_SETTINGS_UPDATE" | "APPLICATION_CREATED" | "APPLICATION_PUBLIC_KEY_ADDED" | "APPLICATION_PUBLIC_KEY_DELETED" | "CHANGE_ADMIN_ROLE" | "CHANGE_FOLDER_PERMISSION" | "COLLABORATION_ACCEPT" | "COLLABORATION_EXPIRATION" | "COLLABORATION_INVITE" | "COLLABORATION_REMOVE" | "COLLABORATION_ROLE_CHANGE" | "COMMENT_CREATE" | "COMMENT_DELETE" | "COMMENT_EDIT" | "CONTENT_WORKFLOW_ABNORMAL_DOWNLOAD_ACTIVITY" | "CONTENT_WORKFLOW_AUTOMATION_ADD" | "CONTENT_WORKFLOW_AUTOMATION_DELETE" | "CONTENT_WORKFLOW_POLICY_ADD" | "CONTENT_WORKFLOW_SHARING_POLICY_VIOLATION" | "CONTENT_WORKFLOW_UPLOAD_POLICY_VIOLATION" | "COPY" | "DATA_RETENTION_CREATE_RETENTION" | "DATA_RETENTION_REMOVE_RETENTION" | "DELETE" | "DELETE_USER" | "DEVICE_TRUST_CHECK_FAILED" | "DOWNLOAD" | "EDIT" | "EDIT_USER" | "EMAIL_ALIAS_CONFIRM" | "EMAIL_ALIAS_PRIMARY" | "EMAIL_ALIAS_REMOVE" | "EMAIL_UPLOAD_DISABLED" | "EMAIL_UPLOAD_ENABLED" | "ENTERPRISE_APP_AUTHORIZATION_UPDATE" | "EXTERNAL_COLLAB_SECURITY_SETTINGS" | "FAILED_LOGIN" | "FAVORITE" | "FILE_MARKED_MALICIOUS" | "FILE_REQUEST_CREATE" | "FILE_REQUEST_DELETE" | "FILE_REQUEST_UPDATE" | "FILE_VERSION_RESTORE" | "FILE_WATERMARKED_DOWNLOAD" | "GROUP_ADD_ITEM" | "GROUP_ADD_USER" | "GROUP_CREATION" | "GROUP_DELETION" | "GROUP_EDITED" | "GROUP_REMOVE_ITEM" | "GROUP_REMOVE_USER" | "ILLEGAL_ITEM_OWNERSHIP_TRANSFER_BY_USER" | "ITEM_EMAIL_SEND" | "ITEM_MODIFY" | "ITEM_OPEN" | "ITEM_SHARED_UPDATE" | "ITEM_SYNC" | "ITEM_UNSYNC" | "LEGAL_HOLD_ASSIGNMENT_CREATE" | "LEGAL_HOLD_ASSIGNMENT_DELETE" | "LEGAL_HOLD_POLICY_CREATE" | "LEGAL_HOLD_POLICY_DELETE" | "LEGAL_HOLD_POLICY_UPDATE" | "LOCK" | "LOGIN" | "METADATA_CASCADE_POLICY_APPLY" | "METADATA_CASCADE_POLICY_CREATE" | "METADATA_INSTANCE_COPY" | "METADATA_INSTANCE_CREATE" | "METADATA_INSTANCE_DELETE" | "METADATA_INSTANCE_UPDATE" | "METADATA_TEMPLATE_CREATE" | "METADATA_TEMPLATE_DELETE" | "METADATA_TEMPLATE_UPDATE" | "MOVE" | "NEW_USER" | "OAUTH2_ACCESS_TOKEN_REVOKE" | "OAUTH2_REFRESH_TOKEN_REVOKE" | "PREVIEW" | "REMOVE_DEVICE_ASSOCIATION" | "REMOVE_LOGIN_ACTIVITY_DEVICE" | "RENAME" | "RETENTION_POLICY_ASSIGNMENT_ADD" | "SHARE" | "SHARED_LINK_SEND" | "SHARE_EXPIRATION" | "SHIELD_ALERT" | "SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED" | "SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED_MISSING_JUSTIFICATION" | "SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED" | "SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED_MISSING_JUSTIFICATION" | "SHIELD_JUSTIFICATION_APPROVAL" | "SHIELD_SHARED_LINK_ACCESS_BLOCKED" | "SHIELD_SHARED_LINK_STATUS_RESTRICTED_ON_CREATE" | "SHIELD_SHARED_LINK_STATUS_RESTRICTED_ON_UPDATE" | "SIGN_DOCUMENT_ASSIGNED" | "SIGN_DOCUMENT_CANCELLED" | "SIGN_DOCUMENT_COMPLETED" | "SIGN_DOCUMENT_CONVERTED" | "SIGN_DOCUMENT_CREATED" | "SIGN_DOCUMENT_DECLINED" | "SIGN_DOCUMENT_EXPIRED" | "SIGN_DOCUMENT_SIGNED" | "SIGN_DOCUMENT_VIEWED_BY_SIGNED" | "SIGNER_DOWNLOADED" | "SIGNER_FORWARDED" | "STORAGE_EXPIRATION" | "TASK_ASSIGNMENT_CREATE" | "TASK_ASSIGNMENT_DELETE" | "TASK_ASSIGNMENT_UPDATE" | "TASK_CREATE" | "TASK_UPDATE" | "TERMS_OF_SERVICE_ACCEPT" | "TERMS_OF_SERVICE_REJECT" | "UNDELETE" | "UNFAVORITE" | "UNLOCK" | "UNSHARE" | "UPDATE_COLLABORATION_EXPIRATION" | "UPDATE_SHARE_EXPIRATION" | "UPLOAD" | "USER_AUTHENTICATE_OAUTH2_ACCESS_TOKEN_CREATE" | "WATERMARK_LABEL_CREATE" | "WATERMARK_LABEL_DELETE" | "WORKFLOW_AUTOMATION_CREATE" | "WORKFLOW_AUTOMATION_DELETE" | "WORKFLOW_AUTOMATION_UPDATE" | (string & {});
3485
- export type PostRetentionLength = unknown;
3486
- export interface RetentionPolicyCreateRequest {
3487
- policy_name: string;
3488
- description?: string;
3489
- policy_type: RetentionPolicyPolicyType;
3490
- disposition_action: RetentionPolicyDispositionAction;
3491
- retention_length?: PostRetentionLength;
3492
- retention_type?: RetentionPolicyRetentionType;
3493
- can_owner_extend_retention?: boolean;
3494
- max_extension_length?: RetentionPolicyMaxExtensionLengthRequest;
3495
- are_owners_notified?: boolean;
3496
- custom_notification_recipients?: Array<UserMini>;
3497
- }
3498
- export type PutIdDispositionAction = unknown;
3499
- export interface RetentionPolicyUpdateRequest {
3500
- policy_name?: string | null;
3501
- description?: string | null;
3502
- disposition_action?: PutIdDispositionAction;
3503
- retention_type?: string | null;
3504
- retention_length?: PostRetentionLength;
3505
- status?: string | null;
3506
- can_owner_extend_retention?: boolean | null;
3507
- max_extension_length?: RetentionPolicyMaxExtensionLengthRequest;
3508
- are_owners_notified?: boolean | null;
3509
- custom_notification_recipients?: Array<UserBase> | null;
3510
- }
3511
- export type AssignToType = "enterprise" | "folder" | "metadata_template" | (string & {});
3512
- export interface PostAssignTo2 {
3513
- type: AssignToType;
3514
- id?: string | null;
3515
- }
3516
- export interface PostFilterFields {
3517
- field?: string;
3518
- value?: string;
3519
- }
3520
- export interface RetentionPolicyAssignmentCreateRequest {
3521
- policy_id: string;
3522
- assign_to: PostAssignTo2;
3523
- filter_fields?: Array<PostFilterFields>;
3524
- start_date_field?: string;
3525
- }
3526
- export interface LegalHoldPolicyCreateRequest {
3527
- policy_name: string;
3528
- description?: string;
3529
- filter_started_at?: string;
3530
- filter_ended_at?: string;
3531
- is_ongoing?: boolean;
3532
- }
3533
- export interface LegalHoldPolicyUpdateRequest {
3534
- policy_name?: string;
3535
- description?: string;
3536
- release_notes?: string;
3537
- }
3538
- export interface PostAssignTo3 {
3539
- type: LegalHoldPolicyAssignedItemType;
3540
- id: string;
3541
- }
3542
- export interface LegalHoldPolicyAssignmentCreateRequest {
3543
- policy_id: string;
3544
- assign_to: PostAssignTo3;
3545
- }
3546
- export type PostChangeStatusStatus = "pending" | "disabled" | (string & {});
3547
- export interface ChangeStatusCreateRequest {
3548
- id: string;
3549
- status: PostChangeStatusStatus;
3550
- }
3551
- export interface ShieldInformationBarrierCreateRequest {
3552
- enterprise: EnterpriseBase;
3553
- }
3554
- export interface ShieldInformationBarrierSegmentUpdateRequest {
3555
- name?: string;
3556
- description?: string | null;
3557
- }
3558
- export interface ShieldInformationBarrierSegmentCreateRequest {
3559
- shield_information_barrier: ShieldInformationBarrierBase;
3560
- name: string;
3561
- description?: string;
3562
- }
3563
- export interface ShieldInformationBarrierSegmentMemberCreateRequest {
3564
- type?: ShieldInformationBarrierSegmentMemberType;
3565
- shield_information_barrier?: ShieldInformationBarrierBase;
3566
- shield_information_barrier_segment: ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment;
3567
- user: UserBase;
3568
- }
3569
- export interface ShieldInformationBarrierSegmentRestrictionCreateRequest {
3570
- type: ShieldInformationBarrierSegmentRestrictionType;
3571
- shield_information_barrier?: ShieldInformationBarrierBase;
3572
- shield_information_barrier_segment: ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment;
3573
- restricted_segment: ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment;
3574
- }
3575
- export type GetTosType = "external" | "managed" | (string & {});
3576
- export interface TermsOfServiceCreateRequest {
3577
- status: TermsOfServiceStatus;
3578
- tos_type?: GetTosType;
3579
- text: string;
3580
- }
3581
- export interface TermsOfServiceUpdateRequest {
3582
- status: TermsOfServiceStatus;
3583
- text: string;
3584
- }
3585
- export interface PostTos {
3586
- type: TermsOfServiceType;
3587
- id: string;
3588
- }
3589
- export interface TermsOfServiceUserStatuseCreateRequest {
3590
- tos: PostTos;
3591
- user: CollaboratorVariableVariableValue;
3592
- is_accepted: boolean;
3593
- }
3594
- export interface TermsOfServiceUserStatuseUpdateRequest {
3595
- is_accepted: boolean;
3596
- }
3597
- export interface CollaborationWhitelistEntriesCreateRequest {
3598
- domain: string;
3599
- direction: CollaborationAllowlistEntryDirection;
3600
- }
3601
- export interface CollaborationWhitelistExemptTargetsCreateRequest {
3602
- user: AttributesParent;
3603
- }
3604
- export type GetResolvedForType = "user" | "enterprise" | (string & {});
3605
- export interface PostStoragePolicy {
3606
- type: StoragePolicyType;
3607
- id: string;
3608
- }
3609
- export interface PostAssignedTo {
3610
- type: GetResolvedForType;
3611
- id: string;
3612
- }
3613
- export interface StoragePolicyAssignmentCreateRequest {
3614
- storage_policy: PostStoragePolicy;
3615
- assigned_to: PostAssignedTo;
3616
- }
3617
- export interface StoragePolicyAssignmentUpdateRequest {
3618
- storage_policy: PostStoragePolicy;
3619
- }
3620
- export type PostIdStartType = "workflow_parameters" | (string & {});
3621
- export interface PostIdStartFlow {
3622
- type?: string;
3623
- id?: string;
3624
- }
3625
- export interface WorkflowStartRequest {
3626
- type?: PostIdStartType;
3627
- flow: PostIdStartFlow;
3628
- files: Array<PutSkillInvocationIdFile>;
3629
- folder: MetadataCascadePolicyParent;
3630
- outcomes?: Array<Outcome>;
3631
- }
3632
- export interface SlackUpdateRequest {
3633
- box_item?: IntegrationMappingBoxItemSlack;
3634
- options?: IntegrationMappingSlackOptions;
3635
- }
3636
- export interface TeamUpdateRequest {
3637
- box_item?: FolderReference;
3638
- }
3639
- export type GetAgentDefaultMode = "ask" | "text_gen" | "extract" | "extract_structured" | (string & {});
3640
- export interface MetadataTaxonomyCreateRequest {
3641
- key?: string;
3642
- displayName: string;
3643
- namespace: string;
3644
- }
3645
- export interface MetadataTaxonomyUpdateRequest {
3646
- displayName: string;
3647
- }
3648
- export interface LevelUpdateRequest {
3649
- displayName: string;
3650
- description?: string;
3651
- }
3652
- export interface NodesCreateRequest {
3653
- displayName: string;
3654
- level: number;
3655
- parentId?: string;
3656
- }
3657
- export interface NodeUpdateRequest {
3658
- displayName?: string;
3659
- }
3660
- export interface Archive {
3661
- id: string;
3662
- type: ArchiveType;
3663
- name: string;
3664
- size: number;
3665
- description?: string | null;
3666
- owned_by?: ArchiveOwnedBy;
3667
- }
3668
- export interface Archives {
3669
- entries?: Array<Archive>;
3670
- limit?: number;
3671
- next_marker?: string | null;
3672
- }
3673
- export interface CollaborationPermissions {
3674
- is_co_owner_role_enabled?: boolean;
3675
- is_editor_role_enabled?: boolean;
3676
- is_previewer_role_enabled?: boolean;
3677
- is_previewer_uploader_role_enabled?: boolean;
3678
- is_uploader_role_enabled?: boolean;
3679
- is_viewer_role_enabled?: boolean;
3680
- is_viewer_uploader_role_enabled?: boolean;
3681
- }
3682
- export interface CustomSessionDurationGroupItem {
3683
- id?: string;
3684
- name?: string;
3685
- }
3686
1028
  export interface DocGenBatchBase {
3687
1029
  id: string;
3688
1030
  type: DocGenBatchBaseType;
3689
1031
  }
3690
- export interface DocGenBatchCreateRequest {
3691
- file: FileReference;
3692
- file_version?: FileVersionBase;
3693
- input_source: string;
3694
- destination_folder: DocGenBatchCreateRequestDestinationFolder;
3695
- output_type: string;
3696
- document_generation_data: Array<DocGenDocumentGenerationData>;
3697
- }
3698
- export interface DocGenDocumentGenerationData {
3699
- generated_file_name: string;
3700
- user_input: Record<string, unknown>;
3701
- }
3702
1032
  export interface DocGenJob {
3703
1033
  id: string;
3704
1034
  type: DocGenJobType;
3705
1035
  batch: DocGenBatchBase;
3706
1036
  template_file: FileReference;
3707
1037
  template_file_version: FileVersionBase;
3708
- output_file?: DocGenJobOutputFile;
3709
- output_file_version?: DocGenJobOutputFileVersion;
1038
+ output_file?: FileReference | null;
1039
+ output_file_version?: FileVersionBase | null;
3710
1040
  status: DocGenJobStatus;
3711
1041
  output_type: string;
3712
1042
  failures?: DocGenJobFailures | null;
@@ -3715,710 +1045,44 @@ export interface DocGenJobBase {
3715
1045
  id: string;
3716
1046
  type: DocGenJobType;
3717
1047
  }
3718
- export interface DocGenJobFull {
3719
- id: string;
3720
- type: DocGenJobType;
3721
- batch: DocGenBatchBase;
3722
- template_file: FileReference;
3723
- template_file_version: FileVersionBase;
3724
- output_file?: DocGenJobOutputFile;
3725
- output_file_version?: DocGenJobOutputFileVersion;
3726
- status: DocGenJobStatus;
3727
- output_type: string;
3728
- failures?: DocGenJobFailures | null;
3729
- created_at?: string;
3730
- created_by: UserBase;
3731
- enterprise: EnterpriseReference;
3732
- source: string;
3733
- }
3734
1048
  export interface DocGenJobs {
3735
1049
  limit?: number;
3736
1050
  next_marker?: string | null;
3737
1051
  prev_marker?: string | null;
3738
1052
  entries?: Array<DocGenJob>;
3739
1053
  }
3740
- export interface DocGenJobsFull {
3741
- limit?: number;
3742
- next_marker?: string | null;
3743
- prev_marker?: string | null;
3744
- entries?: Array<DocGenJobFull>;
3745
- }
3746
- export interface DocGenTag {
3747
- tag_content: string;
3748
- tag_type: DocGenTagTagType;
3749
- json_paths: Array<string>;
3750
- }
3751
- export interface DocGenTags {
3752
- limit?: number;
3753
- next_marker?: string | null;
3754
- prev_marker?: string | null;
3755
- entries?: Array<DocGenTag>;
3756
- }
3757
1054
  export interface DocGenTagsProcessingMessage {
3758
1055
  message: string;
3759
1056
  }
3760
- export interface DocGenTemplate {
3761
- file?: FileReference;
3762
- file_name?: string | null;
3763
- }
3764
- export interface DocGenTemplateBase {
3765
- file?: FileReference;
3766
- }
3767
- export interface DocGenTemplateCreateRequest {
3768
- file: FileReference;
3769
- }
3770
- export interface DocGenTemplates {
3771
- limit?: number;
3772
- next_marker?: string | null;
3773
- prev_marker?: string | null;
3774
- entries?: Array<DocGenTemplate>;
3775
- }
3776
- export interface EnterpriseConfiguration {
3777
- id?: string;
3778
- type?: EnterpriseConfigurationType;
3779
- security?: EnterpriseConfigurationSecurity2;
3780
- content_and_sharing?: EnterpriseConfigurationContentAndSharing2;
3781
- user_settings?: EnterpriseConfigurationUserSettings2;
3782
- shield?: EnterpriseConfigurationShield2;
3783
- }
3784
- export interface EnterpriseConfigurationContentAndSharing {
3785
- enterprise_feature_settings?: Array<EnterpriseFeatureSettingsItem>;
3786
- sharing_item_type?: EnterpriseConfigurationItemString;
3787
- shared_link_company_definition?: EnterpriseConfigurationItemString;
3788
- shared_link_access?: EnterpriseConfigurationItemString;
3789
- shared_link_default_access?: EnterpriseConfigurationItemString;
3790
- shared_link_default_permissions_selected?: EnterpriseConfigurationContentAndSharingSharedLinkDefaultPermissionsSelected;
3791
- is_open_custom_urls_disabled?: EnterpriseConfigurationItemBoolean;
3792
- is_custom_domain_hidden_in_shared_link?: EnterpriseConfigurationItemBoolean;
3793
- collaboration_permissions?: EnterpriseConfigurationContentAndSharingCollaborationPermissions;
3794
- default_collaboration_role?: EnterpriseConfigurationItemString;
3795
- is_invite_privilege_restricted?: EnterpriseConfigurationItemBoolean;
3796
- collaboration_restrictions?: EnterpriseConfigurationContentAndSharingCollaborationRestrictions;
3797
- is_collaborator_invite_links_disabled?: EnterpriseConfigurationItemBoolean;
3798
- is_invite_group_collaborator_disabled?: EnterpriseConfigurationItemBoolean;
3799
- is_ownership_transfer_restricted?: EnterpriseConfigurationItemBoolean;
3800
- external_collaboration_status?: EnterpriseConfigurationContentAndSharingExternalCollaborationStatus;
3801
- external_collaboration_allowlist_users?: EnterpriseConfigurationContentAndSharingExternalCollaborationAllowlistUsers;
3802
- is_watermarking_enterprise_feature_enabled?: EnterpriseConfigurationItemBoolean;
3803
- is_root_content_creation_restricted?: EnterpriseConfigurationItemBoolean;
3804
- is_tag_creation_restricted?: EnterpriseConfigurationItemBoolean;
3805
- tag_creation_restriction?: EnterpriseConfigurationItemString;
3806
- is_email_uploads_enabled?: EnterpriseConfigurationItemBoolean;
3807
- is_custom_settings_enabled?: EnterpriseConfigurationItemBoolean;
3808
- is_forms_login_required?: EnterpriseConfigurationItemBoolean;
3809
- is_forms_branding_default_enabled?: EnterpriseConfigurationItemBoolean;
3810
- is_cc_free_trial_active?: EnterpriseConfigurationItemBoolean;
3811
- is_file_request_editors_allowed?: EnterpriseConfigurationItemBoolean;
3812
- is_file_request_branding_default_enabled?: EnterpriseConfigurationItemBoolean;
3813
- is_file_request_login_required?: EnterpriseConfigurationItemBoolean;
3814
- is_shared_links_expiration_enabled?: EnterpriseConfigurationItemBoolean;
3815
- shared_links_expiration_days?: EnterpriseConfigurationItemInteger;
3816
- is_public_shared_links_expiration_enabled?: EnterpriseConfigurationItemBoolean;
3817
- public_shared_links_expiration_days?: EnterpriseConfigurationItemInteger;
3818
- shared_expiration_target?: EnterpriseConfigurationItemString;
3819
- is_shared_links_expiration_notification_enabled?: EnterpriseConfigurationItemBoolean;
3820
- shared_links_expiration_notification_days?: EnterpriseConfigurationItemInteger;
3821
- is_shared_links_expiration_notification_prevented?: EnterpriseConfigurationItemBoolean;
3822
- is_auto_delete_enabled?: EnterpriseConfigurationItemBoolean;
3823
- auto_delete_days?: EnterpriseConfigurationItemInteger;
3824
- is_auto_delete_expiration_modification_prevented?: EnterpriseConfigurationItemBoolean;
3825
- auto_delete_target?: EnterpriseConfigurationItemString;
3826
- is_collaboration_expiration_enabled?: EnterpriseConfigurationItemBoolean;
3827
- collaboration_expiration_days?: EnterpriseConfigurationItemInteger;
3828
- is_collaboration_expiration_modification_prevented?: EnterpriseConfigurationItemBoolean;
3829
- is_collaboration_expiration_notification_enabled?: EnterpriseConfigurationItemBoolean;
3830
- collaboration_expiration_target?: EnterpriseConfigurationItemString;
3831
- trash_auto_clear_time?: EnterpriseConfigurationItemInteger;
3832
- permanent_deletion_access?: EnterpriseConfigurationItemString;
3833
- permanent_deletion_allowlist_users?: EnterpriseConfigurationContentAndSharingExternalCollaborationAllowlistUsers;
3834
- }
3835
1057
  export interface EnterpriseConfigurationItem {
3836
1058
  is_used?: boolean;
3837
1059
  }
3838
- export interface EnterpriseConfigurationItemBoolean {
3839
- is_used?: boolean;
3840
- value?: boolean | null;
3841
- }
3842
- export interface EnterpriseConfigurationItemInteger {
3843
- is_used?: boolean;
3844
- value?: number | null;
3845
- }
3846
- export interface EnterpriseConfigurationItemString {
3847
- is_used?: boolean;
3848
- value?: string | null;
3849
- }
3850
- export interface EnterpriseConfigurationSecurity {
3851
- is_managed_user_signup_enabled?: EnterpriseConfigurationItemBoolean;
3852
- is_managed_user_signup_notification_enabled?: EnterpriseConfigurationItemBoolean;
3853
- is_managed_user_signup_corporate_email_enabled?: EnterpriseConfigurationItemBoolean;
3854
- is_new_user_notification_daily_digest_enabled?: EnterpriseConfigurationItemBoolean;
3855
- is_managed_user_email_change_disabled?: EnterpriseConfigurationItemBoolean;
3856
- is_multi_factor_auth_required?: EnterpriseConfigurationItemBoolean;
3857
- is_weak_password_prevention_enabled?: EnterpriseConfigurationItemBoolean;
3858
- is_password_leak_detection_enabled?: EnterpriseConfigurationItemBoolean;
3859
- last_password_reset_at?: EnterpriseConfigurationSecurityLastPasswordResetAt;
3860
- is_password_request_notification_enabled?: EnterpriseConfigurationItemBoolean;
3861
- is_password_change_notification_enabled?: EnterpriseConfigurationItemBoolean;
3862
- is_strong_password_for_ext_collab_enabled?: EnterpriseConfigurationItemBoolean;
3863
- is_managed_user_migration_disabled?: EnterpriseConfigurationItemBoolean;
3864
- join_link?: EnterpriseConfigurationItemString;
3865
- join_url?: EnterpriseConfigurationItemString;
3866
- failed_login_attempts_to_trigger_admin_notification?: EnterpriseConfigurationItemInteger;
3867
- password_min_length?: EnterpriseConfigurationItemInteger;
3868
- password_min_uppercase_characters?: EnterpriseConfigurationItemInteger;
3869
- password_min_numeric_characters?: EnterpriseConfigurationItemInteger;
3870
- password_min_special_characters?: EnterpriseConfigurationItemInteger;
3871
- password_reset_frequency?: EnterpriseConfigurationItemString;
3872
- previous_password_reuse_limit?: EnterpriseConfigurationItemString;
3873
- session_duration?: EnterpriseConfigurationItemString;
3874
- external_collab_multi_factor_auth_settings?: EnterpriseConfigurationSecurityExternalCollabMultiFactorAuthSettings;
3875
- keysafe?: EnterpriseConfigurationSecurityKeysafe;
3876
- is_custom_session_duration_enabled?: EnterpriseConfigurationItemBoolean;
3877
- custom_session_duration_value?: EnterpriseConfigurationItemString;
3878
- custom_session_duration_groups?: EnterpriseConfigurationSecurityCustomSessionDurationGroups;
3879
- multi_factor_auth_type?: EnterpriseConfigurationItemString;
3880
- enforced_mfa_frequency?: EnterpriseConfigurationSecurityEnforcedMfaFrequency;
3881
- }
3882
- export interface EnterpriseConfigurationShield {
3883
- shield_rules?: Array<ShieldRuleItem>;
3884
- }
3885
- export interface EnterpriseConfigurationUserSettings {
3886
- enterprise_feature_settings?: Array<EnterpriseFeatureSettingsItem>;
3887
- user_invites_expiration_time_frame?: EnterpriseConfigurationItemString;
3888
- is_username_change_restricted?: EnterpriseConfigurationItemBoolean;
3889
- is_box_sync_restricted_for_new_users?: EnterpriseConfigurationItemBoolean;
3890
- is_view_all_users_enabled_for_new_users?: EnterpriseConfigurationItemBoolean;
3891
- is_device_limit_exemption_enabled_for_new_users?: EnterpriseConfigurationItemBoolean;
3892
- is_external_collaboration_restricted_for_new_users?: EnterpriseConfigurationItemBoolean;
3893
- is_unlimited_storage_enabled_for_new_users?: EnterpriseConfigurationItemBoolean;
3894
- new_user_default_storage_limit?: EnterpriseConfigurationItemInteger;
3895
- new_user_default_timezone?: EnterpriseConfigurationItemString;
3896
- new_user_default_language?: EnterpriseConfigurationItemString;
3897
- is_enterprise_sso_required?: EnterpriseConfigurationItemBoolean;
3898
- is_enterprise_sso_in_testing?: EnterpriseConfigurationItemBoolean;
3899
- is_sso_auto_add_groups_enabled?: EnterpriseConfigurationItemBoolean;
3900
- is_sso_auto_add_user_to_groups_enabled?: EnterpriseConfigurationItemBoolean;
3901
- is_sso_auto_remove_user_from_groups_enabled?: EnterpriseConfigurationItemBoolean;
3902
- user_tracking_codes?: EnterpriseConfigurationUserSettingsUserTrackingCodes;
3903
- number_of_user_tracking_codes_remaining?: EnterpriseConfigurationItemInteger;
3904
- is_instant_login_restricted?: EnterpriseConfigurationItemBoolean;
3905
- }
3906
- export interface EnterpriseFeatureSetting {
3907
- id?: string | null;
3908
- feature?: EnterpriseFeatureSettingFeature;
3909
- state?: string | null;
3910
- can_configure?: boolean | null;
3911
- is_configured?: boolean | null;
3912
- allowlist?: Array<UserOrGroupReference> | null;
3913
- denylist?: Array<UserOrGroupReference> | null;
3914
- }
3915
- export interface EnterpriseFeatureSettingsItem {
3916
- is_used?: boolean;
3917
- value?: EnterpriseFeatureSetting;
3918
- }
3919
1060
  export interface EnterpriseReference {
3920
1061
  id?: string;
3921
1062
  type?: EnterpriseReferenceType;
3922
1063
  }
3923
- export interface ExternalCollabSecuritySettings {
3924
- denylist_domains?: Array<string>;
3925
- denylist_emails?: Array<string>;
3926
- allowlist_domains?: Array<string>;
3927
- allowlist_emails?: Array<string>;
3928
- state?: string | null;
3929
- scheduled_status?: string | null;
3930
- scheduled_at?: string | null;
3931
- factor_type_settings?: string | null;
3932
- }
3933
- export interface ExternalUserDeletionResult {
3934
- user_id: string;
3935
- status: number;
3936
- detail?: string;
3937
- }
3938
- export interface ExternalUsersSubmitDeleteJobRequest {
3939
- external_users: Array<UserReference>;
3940
- }
3941
- export interface ExternalUsersSubmitDeleteJobResponse {
3942
- entries: Array<ExternalUserDeletionResult>;
3943
- }
3944
1064
  export interface FileReference {
3945
1065
  type: FileReferenceType;
3946
1066
  id: string;
3947
1067
  }
3948
- export interface Hub {
3949
- id: string;
3950
- type: HubType;
3951
- title?: string;
3952
- description?: string;
3953
- created_at?: string;
3954
- updated_at?: string;
3955
- created_by?: UserMini;
3956
- updated_by?: UserMini;
3957
- view_count?: number;
3958
- is_ai_enabled?: boolean;
3959
- is_collaboration_restricted_to_enterprise?: boolean;
3960
- can_non_owners_invite?: boolean;
3961
- can_shared_link_be_created?: boolean;
3962
- can_public_shared_link_be_created?: boolean;
3963
- copy_hub_access?: HubCopyHubAccess;
3964
- }
3965
- export interface HubBase {
3966
- id: string;
3967
- type: HubType;
3968
- }
3969
- export type HubAccessGrantee = (HubCollaborationUser & {
3970
- type: "user";
3971
- }) | (GroupMini & {
3972
- type: "group";
3973
- }) | {
3974
- type: string;
3975
- [key: string]: unknown;
3976
- };
3977
- export interface HubCalloutBoxTextBlock {
3978
- id: string;
3979
- parent_id?: string | null;
3980
- type: HubCalloutBoxTextBlockType;
3981
- fragment: string;
3982
- }
3983
- export interface HubCollaboration {
3984
- id: string;
3985
- type: HubCollaborationType;
3986
- hub?: HubBase;
3987
- accessible_by?: HubAccessGrantee;
3988
- role?: string;
3989
- status?: HubCollaborationStatus;
3990
- acceptance_requirements_status?: HubCollaborationAcceptanceRequirementsStatus;
3991
- }
3992
- export interface HubCollaborationCreateRequest {
3993
- hub: HubCollaborationCreateRequestHub;
3994
- accessible_by: HubCollaborationCreateRequestAccessibleBy;
3995
- role: string;
3996
- }
3997
- export interface HubCollaborations {
3998
- entries?: Array<HubCollaboration>;
3999
- limit?: number;
4000
- next_marker?: string | null;
4001
- }
4002
- export interface HubCollaborationUpdateRequest {
4003
- role?: string;
4004
- }
4005
- export interface HubCollaborationUser {
4006
- id: string;
4007
- type: HubCollaborationUserType;
4008
- name?: string;
4009
- login?: string;
4010
- }
4011
- export interface HubCopyRequest {
4012
- title?: string;
4013
- description?: string;
4014
- include_items?: boolean;
4015
- }
4016
- export interface HubCreateRequest {
4017
- title: string;
4018
- description?: string;
4019
- }
4020
- export interface HubDividerBlock {
4021
- id: string;
4022
- parent_id?: string | null;
4023
- type: HubDividerBlockType;
4024
- }
4025
1068
  export interface HubDocumentBlock {
4026
1069
  id: string;
4027
1070
  parent_id?: string | null;
4028
1071
  }
4029
- export type HubDocumentBlockEntry = (HubParagraphTextBlock & {
4030
- type: "paragraph";
4031
- }) | (HubSectionTitleTextBlock & {
4032
- type: "section_title";
4033
- }) | (HubCalloutBoxTextBlock & {
4034
- type: "callout_box";
4035
- }) | (HubItemListBlock & {
4036
- type: "item_list";
4037
- }) | (HubDividerBlock & {
4038
- type: "divider";
4039
- }) | {
4040
- type: string;
4041
- [key: string]: unknown;
4042
- };
4043
- export interface HubDocumentBlocks {
4044
- entries: Array<HubDocumentBlockEntry>;
4045
- type: HubDocumentBlocksType;
4046
- limit?: number;
4047
- next_marker?: string | null;
4048
- }
4049
- export interface HubDocumentPage {
4050
- id: string;
4051
- type: string;
4052
- parent_id?: string | null;
4053
- title_fragment: string;
4054
- }
4055
- export interface HubDocumentPages {
4056
- entries: Array<HubDocumentPage>;
4057
- type: HubDocumentPagesType;
4058
- limit?: number;
4059
- next_marker?: string | null;
4060
- }
4061
- export interface HubItem {
4062
- id: string;
4063
- type: HubItemType;
4064
- name: string;
4065
- }
4066
- export interface HubItemListBlock {
4067
- id: string;
4068
- parent_id?: string | null;
4069
- type: HubItemListBlockType;
4070
- }
4071
- export interface HubItemOperation {
4072
- action: HubItemOperationAction;
4073
- item: HubItemReference;
4074
- parent_id?: string;
4075
- }
4076
- export interface HubItemOperationResult {
4077
- action?: string;
4078
- item?: HubItemReference;
4079
- parent_id?: string;
4080
- status?: number;
4081
- error?: string;
4082
- }
4083
- export type HubItemReference = (FileReference & {
4084
- type: "file";
4085
- }) | (FolderReference & {
4086
- type: "folder";
4087
- }) | (WeblinkReference & {
4088
- type: "web_link";
4089
- }) | {
4090
- type: string;
4091
- [key: string]: unknown;
4092
- };
4093
- export interface HubItems {
4094
- entries?: Array<HubItem>;
4095
- limit?: number;
4096
- next_marker?: string | null;
4097
- }
4098
- export interface HubItemsManageRequest {
4099
- operations?: Array<HubItemOperation>;
4100
- }
4101
- export interface HubItemsManageResponse {
4102
- operations: Array<HubItemOperationResult>;
4103
- }
4104
- export interface HubParagraphTextBlock {
4105
- id: string;
4106
- parent_id?: string | null;
4107
- type: HubParagraphTextBlockType;
4108
- fragment: string;
4109
- }
4110
- export interface Hubs {
4111
- entries?: Array<Hub>;
4112
- limit?: number;
4113
- next_marker?: string | null;
4114
- }
4115
- export interface HubSectionTitleTextBlock {
4116
- id: string;
4117
- parent_id?: string | null;
4118
- type: HubSectionTitleTextBlockType;
4119
- fragment: string;
4120
- }
4121
- export interface HubUpdateRequest {
4122
- title?: string;
4123
- description?: string;
4124
- is_ai_enabled?: boolean;
4125
- is_collaboration_restricted_to_enterprise?: boolean;
4126
- can_non_owners_invite?: boolean;
4127
- can_shared_link_be_created?: boolean;
4128
- can_public_shared_link_be_created?: boolean;
4129
- copy_hub_access?: HubCopyHubAccess;
4130
- }
4131
- export interface KeysafeSettings {
4132
- keysafe_enabled?: boolean;
4133
- cloud_provider?: string | null;
4134
- key_id?: string | null;
4135
- account_id?: string | null;
4136
- location_id?: string | null;
4137
- project_id?: string | null;
4138
- keyring_id?: string | null;
4139
- }
4140
- export interface ListUser {
4141
- id?: number | null;
4142
- name?: string | null;
4143
- email?: string | null;
4144
- }
4145
- export interface ShieldList {
4146
- id: string;
4147
- type: string;
4148
- name: string;
4149
- enterprise: EnterpriseReference;
4150
- description?: string;
4151
- created_at: string;
4152
- updated_at: string;
4153
- content: ShieldListContent;
4154
- }
4155
- export interface ShieldListMini {
4156
- id: string;
4157
- type: ShieldListMiniType;
4158
- name: string;
4159
- content: ShieldListMiniContent;
4160
- }
4161
- export type ShieldListContent = (ShieldListContentCountry & {
4162
- type: "country";
4163
- }) | (ShieldListContentDomain & {
4164
- type: "domain";
4165
- }) | (ShieldListContentEmail & {
4166
- type: "email";
4167
- }) | (ShieldListContentIp & {
4168
- type: "ip";
4169
- }) | (ShieldListContentIntegration & {
4170
- type: "integration";
4171
- }) | {
4172
- type: string;
4173
- [key: string]: unknown;
4174
- };
4175
- export interface ShieldListContentCountry {
4176
- type: ShieldListContentCountryType;
4177
- country_codes: Array<string>;
4178
- }
4179
- export interface ShieldListContentDomain {
4180
- type: ShieldListContentDomainType;
4181
- domains: Array<string>;
4182
- }
4183
- export interface ShieldListContentEmail {
4184
- type: ShieldListContentEmailType;
4185
- email_addresses: Array<string>;
4186
- }
4187
- export interface ShieldListContentIntegration {
4188
- type: ShieldListContentIntegrationType;
4189
- integrations: Array<ShieldListContentIntegrationIntegrations>;
4190
- }
4191
- export interface ShieldListContentIp {
4192
- type: ShieldListContentIpType;
4193
- ip_addresses: Array<string>;
4194
- }
4195
- export type ShieldListContentRequest = (ShieldListContentCountry & {
4196
- type: "country";
4197
- }) | (ShieldListContentDomain & {
4198
- type: "domain";
4199
- }) | (ShieldListContentEmail & {
4200
- type: "email";
4201
- }) | (ShieldListContentIp & {
4202
- type: "ip";
4203
- }) | {
4204
- type: string;
4205
- [key: string]: unknown;
4206
- };
4207
- export interface ShieldLists {
4208
- entries?: Array<ShieldListMini>;
4209
- }
4210
- export interface ShieldListsCreate {
4211
- name: string;
4212
- description?: string;
4213
- content: ShieldListContentRequest;
4214
- }
4215
- export interface ShieldListsUpdate {
4216
- name: string;
4217
- description?: string;
4218
- content: ShieldListContentRequest;
4219
- }
4220
- export interface ShieldRuleItem {
4221
- id?: string;
4222
- type?: ShieldRuleItemType;
4223
- rule_category?: string;
4224
- name?: string;
4225
- description?: string;
4226
- priority?: ShieldRuleItemPriority;
4227
- created_at?: string;
4228
- modified_at?: string;
4229
- }
4230
- export interface UserOrGroupReference {
4231
- type?: UserOrGroupReferenceType;
4232
- id?: string;
4233
- }
4234
- export interface UserReference {
4235
- type: HubCollaborationUserType;
4236
- id: string;
4237
- }
4238
- export interface UserTrackingCode {
4239
- id?: number | null;
4240
- name?: string | null;
4241
- }
4242
- export interface WeblinkReference {
4243
- type: WeblinkReferenceType;
4244
- id: string;
4245
- }
4246
- export type ArchiveType = "archive" | (string & {});
4247
- export interface ArchiveOwnedBy {
4248
- id: string;
4249
- type: string;
4250
- }
4251
1072
  export type DocGenBatchBaseType = "docgen_batch" | (string & {});
4252
- export type DestinationFolderType = "folder" | (string & {});
4253
- export interface DocGenBatchCreateRequestDestinationFolder {
4254
- type: DestinationFolderType;
4255
- id: string;
4256
- }
4257
1073
  export type DocGenJobType = "docgen_job" | (string & {});
4258
- export type DocGenJobOutputFile = unknown;
4259
- export type DocGenJobOutputFileVersion = unknown;
4260
1074
  export type DocGenJobStatus = "submitted" | "completed" | "failed" | "completed_with_error" | "pending" | (string & {});
4261
1075
  export interface DocGenJobFailures {
4262
1076
  errors: Array<string>;
4263
1077
  warnings: Array<string>;
4264
1078
  }
4265
- export type DocGenTagTagType = "text" | "arithmetic" | "conditional" | "for-loop" | "table-loop" | "image" | (string & {});
4266
- export type EnterpriseConfigurationType = "enterprise_configuration" | (string & {});
4267
- export type EnterpriseConfigurationSecurity2 = unknown;
4268
- export type EnterpriseConfigurationContentAndSharing2 = unknown;
4269
- export type EnterpriseConfigurationUserSettings2 = unknown;
4270
- export type EnterpriseConfigurationShield2 = unknown;
4271
- export interface EnterpriseConfigurationContentAndSharingSharedLinkDefaultPermissionsSelected {
4272
- is_used?: boolean;
4273
- value?: SharedLinkPermissions;
4274
- }
4275
- export interface EnterpriseConfigurationContentAndSharingCollaborationPermissions {
4276
- is_used?: boolean;
4277
- value?: CollaborationPermissions;
4278
- }
4279
- export interface EnterpriseConfigurationContentAndSharingCollaborationRestrictions {
4280
- is_used?: boolean;
4281
- value?: Array<string>;
4282
- }
4283
- export interface EnterpriseConfigurationContentAndSharingExternalCollaborationStatus {
4284
- is_used?: boolean;
4285
- value?: string | null;
4286
- }
4287
- export interface EnterpriseConfigurationContentAndSharingExternalCollaborationAllowlistUsers {
4288
- is_used?: boolean;
4289
- value?: Array<ListUser>;
4290
- }
4291
- export interface EnterpriseConfigurationSecurityLastPasswordResetAt {
4292
- is_used?: boolean;
4293
- value?: string | null;
4294
- }
4295
- export type ExternalCollabMultiFactorAuthSettingsValue = unknown;
4296
- export interface EnterpriseConfigurationSecurityExternalCollabMultiFactorAuthSettings {
4297
- is_used?: boolean;
4298
- value?: ExternalCollabMultiFactorAuthSettingsValue;
4299
- }
4300
- export type KeysafeValue = unknown;
4301
- export interface EnterpriseConfigurationSecurityKeysafe {
4302
- is_used?: boolean;
4303
- value?: KeysafeValue;
4304
- }
4305
- export interface EnterpriseConfigurationSecurityCustomSessionDurationGroups {
4306
- is_used?: boolean;
4307
- value?: Array<CustomSessionDurationGroupItem>;
4308
- }
4309
- export interface EnforcedMfaFrequencyValue {
4310
- days?: number | null;
4311
- hours?: number | null;
4312
- }
4313
- export interface EnterpriseConfigurationSecurityEnforcedMfaFrequency {
4314
- is_used?: boolean;
4315
- value?: EnforcedMfaFrequencyValue;
4316
- }
4317
- export interface EnterpriseConfigurationUserSettingsUserTrackingCodes {
4318
- is_used?: boolean;
4319
- value?: Array<UserTrackingCode>;
4320
- }
4321
- export interface EnterpriseFeatureSettingFeature {
4322
- id?: string | null;
4323
- }
4324
1079
  export type EnterpriseReferenceType = "enterprise" | (string & {});
4325
1080
  export type FileReferenceType = "file" | (string & {});
4326
1081
  export type FileVersionBaseType = "file_version" | (string & {});
4327
1082
  export type GroupBaseType = "group" | (string & {});
4328
1083
  export type GroupMiniGroupType = "managed_group" | "all_users_group" | (string & {});
4329
1084
  export type HubType = "hubs" | (string & {});
4330
- export type HubCopyHubAccess = "all" | "company" | "none" | (string & {});
4331
- export type HubCalloutBoxTextBlockType = "callout_box" | (string & {});
4332
- export type HubCollaborationType = "hub_collaboration" | (string & {});
4333
- export type HubCollaborationStatus = "accepted" | "pending" | "rejected" | (string & {});
4334
- export interface HubCollaborationAcceptanceRequirementsStatus {
4335
- terms_of_service_requirement?: AcceptanceRequirementsStatusTermsOfServiceRequirement;
4336
- strong_password_requirement?: AcceptanceRequirementsStatusStrongPasswordRequirement;
4337
- two_factor_authentication_requirement?: AcceptanceRequirementsStatusTwoFactorAuthenticationRequirement;
4338
- }
4339
- export interface HubCollaborationCreateRequestHub {
4340
- type: HubType;
4341
- id: string;
4342
- }
4343
- export interface HubCollaborationCreateRequestAccessibleBy {
4344
- type: string;
4345
- id?: string;
4346
- login?: string;
4347
- }
4348
1085
  export type HubCollaborationUserType = "user" | (string & {});
4349
- export type HubDividerBlockType = "divider" | (string & {});
4350
- export type HubDocumentBlocksType = "document_blocks" | (string & {});
4351
- export type HubDocumentPagesType = "document_pages" | (string & {});
4352
- export type HubItemType = "file" | "folder" | "web_link" | (string & {});
4353
- export type HubItemListBlockType = "item_list" | (string & {});
4354
- export type HubItemOperationAction = "add" | "remove" | (string & {});
4355
- export type HubParagraphTextBlockType = "paragraph" | (string & {});
4356
- export type HubSectionTitleTextBlockType = "section_title" | (string & {});
4357
- export type ShieldListMiniType = "shield_list" | (string & {});
4358
- export interface ShieldListMiniContent {
4359
- type?: string;
4360
- }
4361
- export type ShieldListContentCountryType = "country" | (string & {});
4362
- export type ShieldListContentDomainType = "domain" | (string & {});
4363
- export type ShieldListContentEmailType = "email" | (string & {});
4364
- export type ShieldListContentIntegrationType = "integration" | (string & {});
4365
- export interface ShieldListContentIntegrationIntegrations {
4366
- id?: string;
4367
- }
4368
- export type ShieldListContentIpType = "ip" | (string & {});
4369
- export type ShieldRuleItemType = "shield_rule" | (string & {});
4370
- export type ShieldRuleItemPriority = "informational" | "low" | "medium" | "high" | "critical" | (string & {});
4371
1086
  export type TermsOfServiceBaseType = "terms_of_service" | (string & {});
4372
- export type UserOrGroupReferenceType = "user" | "group" | (string & {});
4373
- export type WeblinkReferenceType = "web_link" | (string & {});
4374
- export interface ArchiveCreateRequest {
4375
- name: string;
4376
- description?: string;
4377
- storage_policy_id?: string;
4378
- }
4379
- export interface ArchiveUpdateRequest {
4380
- name?: string;
4381
- description?: string;
4382
- }
4383
- export interface AutomateWorkflowAction {
4384
- id: string;
4385
- type: AutomateWorkflowActionType;
4386
- action_type: AutomateWorkflowActionActionType;
4387
- description?: string;
4388
- created_at?: string;
4389
- updated_at?: string;
4390
- created_by?: UserMini;
4391
- updated_by?: UserMini;
4392
- workflow: AutomateWorkflowReference;
4393
- }
4394
- export interface AutomateWorkflowReference {
4395
- id: string;
4396
- type: AutomateWorkflowReferenceType;
4397
- name?: string;
4398
- }
4399
- export interface AutomateWorkflows {
4400
- entries?: Array<AutomateWorkflowAction>;
4401
- limit?: number;
4402
- next_marker?: string | null;
4403
- }
4404
- export interface AutomateWorkflowStartRequest {
4405
- workflow_action_id: string;
4406
- file_ids: Array<string>;
4407
- }
4408
- export interface NotesConvertRequestBody {
4409
- content: string;
4410
- content_format: NotesConvertRequestBodyContentFormat;
4411
- parent: FolderReference;
4412
- name: string;
4413
- }
4414
- export interface NotesConvertResponse {
4415
- type: NotesConvertResponseType;
4416
- id: string;
4417
- }
4418
- export type AutomateWorkflowActionType = "workflow_action" | (string & {});
4419
- export type AutomateWorkflowActionActionType = "run_workflow" | (string & {});
4420
- export type AutomateWorkflowReferenceType = "workflow" | (string & {});
4421
1087
  export type FolderReferenceType = "folder" | (string & {});
4422
- export type NotesConvertRequestBodyContentFormat = "markdown" | (string & {});
4423
- export type NotesConvertResponseType = "file" | (string & {});
4424
1088
  export type UserBaseType = "user" | (string & {});