@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
@@ -0,0 +1,93 @@
1
+ import type { CollaboratorVariableValue, FileFullAllowedInviteeRoles, MetadataCascadePolicyParent, PutSkillInvocationIdFile, UserBase } from '../schemas.js';
2
+ export interface CollaboratorVariable {
3
+ type: CollaboratorVariableType;
4
+ variable_type: CollaboratorVariableType2;
5
+ variable_value: Array<CollaboratorVariableValue>;
6
+ }
7
+ export interface CompletionRuleVariable {
8
+ type: CollaboratorVariableType;
9
+ variable_type: CompletionRuleVariableType;
10
+ variable_value: CompletionRuleVariableValue;
11
+ }
12
+ export interface Outcome {
13
+ id: string;
14
+ collaborators?: CollaboratorVariable;
15
+ completion_rule?: CompletionRuleVariable;
16
+ file_collaborator_role?: RoleVariable;
17
+ task_collaborators?: CollaboratorVariable;
18
+ role?: RoleVariable;
19
+ }
20
+ export interface RoleVariable {
21
+ type: CollaboratorVariableType;
22
+ variable_type: RoleVariableType;
23
+ variable_value: FileFullAllowedInviteeRoles;
24
+ }
25
+ export interface Workflow {
26
+ id?: string;
27
+ type?: WorkflowType;
28
+ name?: string;
29
+ description?: string;
30
+ is_enabled?: boolean;
31
+ flows?: Array<WorkflowFlows>;
32
+ }
33
+ export interface Workflows {
34
+ limit?: number;
35
+ next_marker?: string | null;
36
+ prev_marker?: string | null;
37
+ entries?: Array<Workflow>;
38
+ }
39
+ export type CollaboratorVariableType = "variable" | (string & {});
40
+ export type CollaboratorVariableType2 = "user_list" | (string & {});
41
+ export type CompletionRuleVariableType = "task_completion_rule" | (string & {});
42
+ export type CompletionRuleVariableValue = "all_assignees" | "any_assignees" | (string & {});
43
+ export type RoleVariableType = "collaborator_role" | (string & {});
44
+ export type WorkflowType = "workflow" | (string & {});
45
+ export type FlowsType = "flow" | (string & {});
46
+ export type TriggerType = "trigger" | (string & {});
47
+ export type WorkflowFlowsTriggerType = "WORKFLOW_MANUAL_START" | (string & {});
48
+ export type ScopeType = "trigger_scope" | (string & {});
49
+ export interface TriggerScope {
50
+ type?: ScopeType;
51
+ ref?: string;
52
+ object?: MetadataCascadePolicyParent;
53
+ }
54
+ export interface FlowsTrigger {
55
+ type?: TriggerType;
56
+ trigger_type?: WorkflowFlowsTriggerType;
57
+ scope?: Array<TriggerScope>;
58
+ }
59
+ export type OutcomesType = "outcome" | (string & {});
60
+ 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 & {});
61
+ export interface OutcomesIfRejected {
62
+ id?: string;
63
+ type?: OutcomesType;
64
+ name?: string;
65
+ action_type?: OutcomesActionType;
66
+ }
67
+ export interface FlowsOutcomes {
68
+ id?: string;
69
+ type?: OutcomesType;
70
+ name?: string;
71
+ action_type?: OutcomesActionType;
72
+ if_rejected?: Array<OutcomesIfRejected>;
73
+ }
74
+ export interface WorkflowFlows {
75
+ id?: string;
76
+ type?: FlowsType;
77
+ trigger?: FlowsTrigger;
78
+ outcomes?: Array<FlowsOutcomes>;
79
+ created_at?: string;
80
+ created_by?: UserBase;
81
+ }
82
+ export type PostIdStartType = "workflow_parameters" | (string & {});
83
+ export interface PostIdStartFlow {
84
+ type?: string;
85
+ id?: string;
86
+ }
87
+ export interface StartWorkflowRequest {
88
+ type?: PostIdStartType;
89
+ flow: PostIdStartFlow;
90
+ files: Array<PutSkillInvocationIdFile>;
91
+ folder: MetadataCascadePolicyParent;
92
+ outcomes?: Array<Outcome>;
93
+ }
@@ -0,0 +1,29 @@
1
+ import type { EventSourceItemType } from '../schemas.js';
2
+ export interface ZipDownload {
3
+ download_url?: string;
4
+ status_url?: string;
5
+ expires_at?: string;
6
+ name_conflicts?: Array<Array<ZipDownloadNameConflicts>>;
7
+ }
8
+ export interface ZipDownloadRequest {
9
+ items: Array<ZipDownloadRequestItems>;
10
+ download_file_name?: string;
11
+ }
12
+ export interface ZipDownloadStatus {
13
+ total_file_count?: number;
14
+ downloaded_file_count?: number;
15
+ skipped_file_count?: number;
16
+ skipped_folder_count?: number;
17
+ state?: ZipDownloadStatusState;
18
+ }
19
+ export interface ZipDownloadNameConflicts {
20
+ id?: string;
21
+ type?: EventSourceItemType;
22
+ original_name?: string;
23
+ download_name?: string;
24
+ }
25
+ export interface ZipDownloadRequestItems {
26
+ type: EventSourceItemType;
27
+ id: string;
28
+ }
29
+ export type ZipDownloadStatusState = "in_progress" | "failed" | "succeeded" | (string & {});