@unofficialbox/box-open-sdk 0.4.0 → 0.4.2

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