@unofficialbox/box-open-sdk 0.1.0

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 (384) hide show
  1. package/README.md +13 -0
  2. package/dist/cjs/auth.js +112 -0
  3. package/dist/cjs/buildinfo.js +10 -0
  4. package/dist/cjs/client.js +268 -0
  5. package/dist/cjs/errors.js +20 -0
  6. package/dist/cjs/index.js +43 -0
  7. package/dist/cjs/internal.js +37 -0
  8. package/dist/cjs/jwt.js +122 -0
  9. package/dist/cjs/managers/ai.js +106 -0
  10. package/dist/cjs/managers/ai_studio.js +131 -0
  11. package/dist/cjs/managers/app_item_associations.js +119 -0
  12. package/dist/cjs/managers/archives.js +110 -0
  13. package/dist/cjs/managers/authorization.js +149 -0
  14. package/dist/cjs/managers/automate_workflows.js +91 -0
  15. package/dist/cjs/managers/avatars.js +76 -0
  16. package/dist/cjs/managers/chunked_uploads.js +156 -0
  17. package/dist/cjs/managers/classifications.js +94 -0
  18. package/dist/cjs/managers/collaboration_allowlist_entries.js +104 -0
  19. package/dist/cjs/managers/collaboration_allowlist_exempt_targets.js +104 -0
  20. package/dist/cjs/managers/collections.js +124 -0
  21. package/dist/cjs/managers/comments.js +131 -0
  22. package/dist/cjs/managers/device_pinners.js +99 -0
  23. package/dist/cjs/managers/docgen.js +133 -0
  24. package/dist/cjs/managers/docgen_template.js +178 -0
  25. package/dist/cjs/managers/downloads.js +69 -0
  26. package/dist/cjs/managers/email_aliases.js +78 -0
  27. package/dist/cjs/managers/enterprise_configurations.js +58 -0
  28. package/dist/cjs/managers/events.js +82 -0
  29. package/dist/cjs/managers/external_users.js +58 -0
  30. package/dist/cjs/managers/file_classifications.js +97 -0
  31. package/dist/cjs/managers/file_metadata.js +115 -0
  32. package/dist/cjs/managers/file_requests.js +90 -0
  33. package/dist/cjs/managers/file_version_legal_holds.js +88 -0
  34. package/dist/cjs/managers/file_version_retentions.js +105 -0
  35. package/dist/cjs/managers/file_versions.js +140 -0
  36. package/dist/cjs/managers/file_watermarks.js +77 -0
  37. package/dist/cjs/managers/files.js +138 -0
  38. package/dist/cjs/managers/folder_classifications.js +97 -0
  39. package/dist/cjs/managers/folder_locks.js +73 -0
  40. package/dist/cjs/managers/folder_metadata.js +111 -0
  41. package/dist/cjs/managers/folder_watermarks.js +77 -0
  42. package/dist/cjs/managers/folders.js +191 -0
  43. package/dist/cjs/managers/groups.js +132 -0
  44. package/dist/cjs/managers/hub_collaborations.js +121 -0
  45. package/dist/cjs/managers/hub_document.js +113 -0
  46. package/dist/cjs/managers/hub_items.js +96 -0
  47. package/dist/cjs/managers/hubs.js +186 -0
  48. package/dist/cjs/managers/index.js +102 -0
  49. package/dist/cjs/managers/integration_mappings.js +178 -0
  50. package/dist/cjs/managers/invites.js +74 -0
  51. package/dist/cjs/managers/legal_hold_policies.js +121 -0
  52. package/dist/cjs/managers/legal_hold_policy_assignments.js +186 -0
  53. package/dist/cjs/managers/list_collaborations.js +185 -0
  54. package/dist/cjs/managers/memberships.js +160 -0
  55. package/dist/cjs/managers/metadata_cascade_policies.js +118 -0
  56. package/dist/cjs/managers/metadata_taxonomies.js +322 -0
  57. package/dist/cjs/managers/metadata_templates.js +196 -0
  58. package/dist/cjs/managers/notes.js +58 -0
  59. package/dist/cjs/managers/recent_items.js +80 -0
  60. package/dist/cjs/managers/retention_policies.js +131 -0
  61. package/dist/cjs/managers/retention_policy_assignments.js +182 -0
  62. package/dist/cjs/managers/search.js +130 -0
  63. package/dist/cjs/managers/session_termination.js +68 -0
  64. package/dist/cjs/managers/shared_links_app_items.js +55 -0
  65. package/dist/cjs/managers/shared_links_files.js +109 -0
  66. package/dist/cjs/managers/shared_links_folders.js +109 -0
  67. package/dist/cjs/managers/shared_links_web_links.js +109 -0
  68. package/dist/cjs/managers/shield_information_barrier_reports.js +98 -0
  69. package/dist/cjs/managers/shield_information_barrier_segment_members.js +105 -0
  70. package/dist/cjs/managers/shield_information_barrier_segment_restrictions.js +105 -0
  71. package/dist/cjs/managers/shield_information_barrier_segments.js +116 -0
  72. package/dist/cjs/managers/shield_information_barriers.js +108 -0
  73. package/dist/cjs/managers/shield_lists.js +97 -0
  74. package/dist/cjs/managers/sign_requests.js +123 -0
  75. package/dist/cjs/managers/sign_templates.js +87 -0
  76. package/dist/cjs/managers/skills.js +106 -0
  77. package/dist/cjs/managers/storage_policies.js +90 -0
  78. package/dist/cjs/managers/storage_policy_assignments.js +114 -0
  79. package/dist/cjs/managers/task_assignments.js +94 -0
  80. package/dist/cjs/managers/tasks.js +94 -0
  81. package/dist/cjs/managers/terms_of_service_user_statuses.js +81 -0
  82. package/dist/cjs/managers/terms_of_services.js +89 -0
  83. package/dist/cjs/managers/transfer.js +67 -0
  84. package/dist/cjs/managers/trashed_files.js +84 -0
  85. package/dist/cjs/managers/trashed_folders.js +84 -0
  86. package/dist/cjs/managers/trashed_items.js +94 -0
  87. package/dist/cjs/managers/trashed_web_links.js +84 -0
  88. package/dist/cjs/managers/uploads.js +98 -0
  89. package/dist/cjs/managers/user_collaborations.js +95 -0
  90. package/dist/cjs/managers/users.js +165 -0
  91. package/dist/cjs/managers/web_links.js +88 -0
  92. package/dist/cjs/managers/webhooks.js +115 -0
  93. package/dist/cjs/managers/workflows.js +92 -0
  94. package/dist/cjs/managers/zip_downloads.js +76 -0
  95. package/dist/cjs/models/index.js +38 -0
  96. package/dist/cjs/models/schemas.js +3 -0
  97. package/dist/cjs/package.json +3 -0
  98. package/dist/cjs/runtime.js +304 -0
  99. package/dist/cjs/tokens.js +121 -0
  100. package/dist/esm/auth.js +105 -0
  101. package/dist/esm/buildinfo.js +7 -0
  102. package/dist/esm/client.js +264 -0
  103. package/dist/esm/errors.js +16 -0
  104. package/dist/esm/index.js +6 -0
  105. package/dist/esm/internal.js +32 -0
  106. package/dist/esm/jwt.js +86 -0
  107. package/dist/esm/managers/ai.js +69 -0
  108. package/dist/esm/managers/ai_studio.js +94 -0
  109. package/dist/esm/managers/app_item_associations.js +82 -0
  110. package/dist/esm/managers/archives.js +73 -0
  111. package/dist/esm/managers/authorization.js +112 -0
  112. package/dist/esm/managers/automate_workflows.js +54 -0
  113. package/dist/esm/managers/avatars.js +39 -0
  114. package/dist/esm/managers/chunked_uploads.js +119 -0
  115. package/dist/esm/managers/classifications.js +57 -0
  116. package/dist/esm/managers/collaboration_allowlist_entries.js +67 -0
  117. package/dist/esm/managers/collaboration_allowlist_exempt_targets.js +67 -0
  118. package/dist/esm/managers/collections.js +87 -0
  119. package/dist/esm/managers/comments.js +94 -0
  120. package/dist/esm/managers/device_pinners.js +62 -0
  121. package/dist/esm/managers/docgen.js +96 -0
  122. package/dist/esm/managers/docgen_template.js +141 -0
  123. package/dist/esm/managers/downloads.js +32 -0
  124. package/dist/esm/managers/email_aliases.js +41 -0
  125. package/dist/esm/managers/enterprise_configurations.js +21 -0
  126. package/dist/esm/managers/events.js +45 -0
  127. package/dist/esm/managers/external_users.js +21 -0
  128. package/dist/esm/managers/file_classifications.js +60 -0
  129. package/dist/esm/managers/file_metadata.js +78 -0
  130. package/dist/esm/managers/file_requests.js +53 -0
  131. package/dist/esm/managers/file_version_legal_holds.js +51 -0
  132. package/dist/esm/managers/file_version_retentions.js +68 -0
  133. package/dist/esm/managers/file_versions.js +103 -0
  134. package/dist/esm/managers/file_watermarks.js +40 -0
  135. package/dist/esm/managers/files.js +101 -0
  136. package/dist/esm/managers/folder_classifications.js +60 -0
  137. package/dist/esm/managers/folder_locks.js +36 -0
  138. package/dist/esm/managers/folder_metadata.js +74 -0
  139. package/dist/esm/managers/folder_watermarks.js +40 -0
  140. package/dist/esm/managers/folders.js +154 -0
  141. package/dist/esm/managers/groups.js +95 -0
  142. package/dist/esm/managers/hub_collaborations.js +84 -0
  143. package/dist/esm/managers/hub_document.js +76 -0
  144. package/dist/esm/managers/hub_items.js +59 -0
  145. package/dist/esm/managers/hubs.js +149 -0
  146. package/dist/esm/managers/index.js +86 -0
  147. package/dist/esm/managers/integration_mappings.js +141 -0
  148. package/dist/esm/managers/invites.js +37 -0
  149. package/dist/esm/managers/legal_hold_policies.js +84 -0
  150. package/dist/esm/managers/legal_hold_policy_assignments.js +149 -0
  151. package/dist/esm/managers/list_collaborations.js +148 -0
  152. package/dist/esm/managers/memberships.js +123 -0
  153. package/dist/esm/managers/metadata_cascade_policies.js +81 -0
  154. package/dist/esm/managers/metadata_taxonomies.js +285 -0
  155. package/dist/esm/managers/metadata_templates.js +159 -0
  156. package/dist/esm/managers/notes.js +21 -0
  157. package/dist/esm/managers/recent_items.js +43 -0
  158. package/dist/esm/managers/retention_policies.js +94 -0
  159. package/dist/esm/managers/retention_policy_assignments.js +145 -0
  160. package/dist/esm/managers/search.js +93 -0
  161. package/dist/esm/managers/session_termination.js +31 -0
  162. package/dist/esm/managers/shared_links_app_items.js +18 -0
  163. package/dist/esm/managers/shared_links_files.js +72 -0
  164. package/dist/esm/managers/shared_links_folders.js +72 -0
  165. package/dist/esm/managers/shared_links_web_links.js +72 -0
  166. package/dist/esm/managers/shield_information_barrier_reports.js +61 -0
  167. package/dist/esm/managers/shield_information_barrier_segment_members.js +68 -0
  168. package/dist/esm/managers/shield_information_barrier_segment_restrictions.js +68 -0
  169. package/dist/esm/managers/shield_information_barrier_segments.js +79 -0
  170. package/dist/esm/managers/shield_information_barriers.js +71 -0
  171. package/dist/esm/managers/shield_lists.js +60 -0
  172. package/dist/esm/managers/sign_requests.js +86 -0
  173. package/dist/esm/managers/sign_templates.js +50 -0
  174. package/dist/esm/managers/skills.js +69 -0
  175. package/dist/esm/managers/storage_policies.js +53 -0
  176. package/dist/esm/managers/storage_policy_assignments.js +77 -0
  177. package/dist/esm/managers/task_assignments.js +57 -0
  178. package/dist/esm/managers/tasks.js +57 -0
  179. package/dist/esm/managers/terms_of_service_user_statuses.js +44 -0
  180. package/dist/esm/managers/terms_of_services.js +52 -0
  181. package/dist/esm/managers/transfer.js +30 -0
  182. package/dist/esm/managers/trashed_files.js +47 -0
  183. package/dist/esm/managers/trashed_folders.js +47 -0
  184. package/dist/esm/managers/trashed_items.js +57 -0
  185. package/dist/esm/managers/trashed_web_links.js +47 -0
  186. package/dist/esm/managers/uploads.js +61 -0
  187. package/dist/esm/managers/user_collaborations.js +58 -0
  188. package/dist/esm/managers/users.js +128 -0
  189. package/dist/esm/managers/web_links.js +51 -0
  190. package/dist/esm/managers/webhooks.js +78 -0
  191. package/dist/esm/managers/workflows.js +55 -0
  192. package/dist/esm/managers/zip_downloads.js +39 -0
  193. package/dist/esm/models/index.js +2 -0
  194. package/dist/esm/models/schemas.js +2 -0
  195. package/dist/esm/package.json +3 -0
  196. package/dist/esm/runtime.js +272 -0
  197. package/dist/esm/tokens.js +116 -0
  198. package/dist/types/auth.d.ts +56 -0
  199. package/dist/types/buildinfo.d.ts +6 -0
  200. package/dist/types/client.d.ts +176 -0
  201. package/dist/types/errors.d.ts +19 -0
  202. package/dist/types/index.d.ts +5 -0
  203. package/dist/types/internal.d.ts +9 -0
  204. package/dist/types/jwt.d.ts +23 -0
  205. package/dist/types/managers/ai.d.ts +17 -0
  206. package/dist/types/managers/ai_studio.d.ts +27 -0
  207. package/dist/types/managers/app_item_associations.d.ts +25 -0
  208. package/dist/types/managers/archives.d.ts +18 -0
  209. package/dist/types/managers/authorization.d.ts +17 -0
  210. package/dist/types/managers/automate_workflows.d.ts +16 -0
  211. package/dist/types/managers/avatars.d.ts +10 -0
  212. package/dist/types/managers/chunked_uploads.d.ts +26 -0
  213. package/dist/types/managers/classifications.d.ts +11 -0
  214. package/dist/types/managers/collaboration_allowlist_entries.d.ts +18 -0
  215. package/dist/types/managers/collaboration_allowlist_exempt_targets.d.ts +18 -0
  216. package/dist/types/managers/collections.d.ts +26 -0
  217. package/dist/types/managers/comments.d.ts +32 -0
  218. package/dist/types/managers/device_pinners.d.ts +18 -0
  219. package/dist/types/managers/docgen.d.ts +25 -0
  220. package/dist/types/managers/docgen_template.d.ts +35 -0
  221. package/dist/types/managers/downloads.d.ts +14 -0
  222. package/dist/types/managers/email_aliases.d.ts +10 -0
  223. package/dist/types/managers/enterprise_configurations.d.ts +8 -0
  224. package/dist/types/managers/events.d.ts +18 -0
  225. package/dist/types/managers/external_users.d.ts +8 -0
  226. package/dist/types/managers/file_classifications.d.ts +11 -0
  227. package/dist/types/managers/file_metadata.d.ts +20 -0
  228. package/dist/types/managers/file_requests.d.ts +15 -0
  229. package/dist/types/managers/file_version_legal_holds.d.ts +16 -0
  230. package/dist/types/managers/file_version_retentions.d.ts +22 -0
  231. package/dist/types/managers/file_versions.d.ts +32 -0
  232. package/dist/types/managers/file_watermarks.d.ts +10 -0
  233. package/dist/types/managers/files.d.ts +39 -0
  234. package/dist/types/managers/folder_classifications.d.ts +11 -0
  235. package/dist/types/managers/folder_locks.d.ts +10 -0
  236. package/dist/types/managers/folder_metadata.d.ts +16 -0
  237. package/dist/types/managers/folder_watermarks.d.ts +10 -0
  238. package/dist/types/managers/folders.d.ts +54 -0
  239. package/dist/types/managers/groups.d.ts +33 -0
  240. package/dist/types/managers/hub_collaborations.d.ts +19 -0
  241. package/dist/types/managers/hub_document.d.ts +23 -0
  242. package/dist/types/managers/hub_items.d.ts +17 -0
  243. package/dist/types/managers/hubs.d.ts +35 -0
  244. package/dist/types/managers/index.d.ts +85 -0
  245. package/dist/types/managers/integration_mappings.d.ts +34 -0
  246. package/dist/types/managers/invites.d.ts +17 -0
  247. package/dist/types/managers/legal_hold_policies.d.ts +21 -0
  248. package/dist/types/managers/legal_hold_policy_assignments.d.ts +39 -0
  249. package/dist/types/managers/list_collaborations.d.ts +42 -0
  250. package/dist/types/managers/memberships.d.ts +39 -0
  251. package/dist/types/managers/metadata_cascade_policies.d.ts +20 -0
  252. package/dist/types/managers/metadata_taxonomies.d.ts +54 -0
  253. package/dist/types/managers/metadata_templates.d.ts +36 -0
  254. package/dist/types/managers/notes.d.ts +8 -0
  255. package/dist/types/managers/recent_items.d.ts +16 -0
  256. package/dist/types/managers/retention_policies.d.ts +27 -0
  257. package/dist/types/managers/retention_policy_assignments.d.ts +40 -0
  258. package/dist/types/managers/search.d.ts +33 -0
  259. package/dist/types/managers/session_termination.d.ts +9 -0
  260. package/dist/types/managers/shared_links_app_items.d.ts +8 -0
  261. package/dist/types/managers/shared_links_files.d.ts +17 -0
  262. package/dist/types/managers/shared_links_folders.d.ts +17 -0
  263. package/dist/types/managers/shared_links_web_links.d.ts +17 -0
  264. package/dist/types/managers/shield_information_barrier_reports.d.ts +17 -0
  265. package/dist/types/managers/shield_information_barrier_segment_members.d.ts +18 -0
  266. package/dist/types/managers/shield_information_barrier_segment_restrictions.d.ts +18 -0
  267. package/dist/types/managers/shield_information_barrier_segments.d.ts +19 -0
  268. package/dist/types/managers/shield_information_barriers.d.ts +18 -0
  269. package/dist/types/managers/shield_lists.d.ts +12 -0
  270. package/dist/types/managers/sign_requests.d.ts +21 -0
  271. package/dist/types/managers/sign_templates.d.ts +16 -0
  272. package/dist/types/managers/skills.d.ts +12 -0
  273. package/dist/types/managers/storage_policies.d.ts +17 -0
  274. package/dist/types/managers/storage_policy_assignments.d.ts +18 -0
  275. package/dist/types/managers/task_assignments.d.ts +12 -0
  276. package/dist/types/managers/tasks.d.ts +12 -0
  277. package/dist/types/managers/terms_of_service_user_statuses.d.ts +14 -0
  278. package/dist/types/managers/terms_of_services.d.ts +15 -0
  279. package/dist/types/managers/transfer.d.ts +13 -0
  280. package/dist/types/managers/trashed_files.d.ts +18 -0
  281. package/dist/types/managers/trashed_folders.d.ts +18 -0
  282. package/dist/types/managers/trashed_items.d.ts +20 -0
  283. package/dist/types/managers/trashed_web_links.d.ts +18 -0
  284. package/dist/types/managers/uploads.d.ts +21 -0
  285. package/dist/types/managers/user_collaborations.d.ts +20 -0
  286. package/dist/types/managers/users.d.ts +47 -0
  287. package/dist/types/managers/web_links.d.ts +15 -0
  288. package/dist/types/managers/webhooks.d.ts +19 -0
  289. package/dist/types/managers/workflows.d.ts +17 -0
  290. package/dist/types/managers/zip_downloads.d.ts +10 -0
  291. package/dist/types/models/index.d.ts +1 -0
  292. package/dist/types/models/schemas.d.ts +4424 -0
  293. package/dist/types/runtime.d.ts +85 -0
  294. package/dist/types/tokens.d.ts +50 -0
  295. package/docs/README.md +101 -0
  296. package/docs/auth.md +60 -0
  297. package/docs/errors.md +20 -0
  298. package/docs/managers/ai.md +49 -0
  299. package/docs/managers/ai_studio.md +63 -0
  300. package/docs/managers/app_item_associations.md +35 -0
  301. package/docs/managers/archives.md +48 -0
  302. package/docs/managers/authorization.md +43 -0
  303. package/docs/managers/automate_workflows.md +31 -0
  304. package/docs/managers/avatars.md +37 -0
  305. package/docs/managers/chunked_uploads.md +88 -0
  306. package/docs/managers/classifications.md +35 -0
  307. package/docs/managers/collaboration_allowlist_entries.md +46 -0
  308. package/docs/managers/collaboration_allowlist_exempt_targets.md +46 -0
  309. package/docs/managers/collections.md +44 -0
  310. package/docs/managers/comments.md +66 -0
  311. package/docs/managers/device_pinners.md +40 -0
  312. package/docs/managers/docgen.md +50 -0
  313. package/docs/managers/docgen_template.md +75 -0
  314. package/docs/managers/downloads.md +19 -0
  315. package/docs/managers/email_aliases.md +38 -0
  316. package/docs/managers/enterprise_configurations.md +16 -0
  317. package/docs/managers/events.md +26 -0
  318. package/docs/managers/external_users.md +13 -0
  319. package/docs/managers/file_classifications.md +49 -0
  320. package/docs/managers/file_metadata.md +69 -0
  321. package/docs/managers/file_requests.md +50 -0
  322. package/docs/managers/file_version_legal_holds.md +29 -0
  323. package/docs/managers/file_version_retentions.md +34 -0
  324. package/docs/managers/file_versions.md +70 -0
  325. package/docs/managers/file_watermarks.md +37 -0
  326. package/docs/managers/files.md +72 -0
  327. package/docs/managers/folder_classifications.md +49 -0
  328. package/docs/managers/folder_locks.md +33 -0
  329. package/docs/managers/folder_metadata.md +68 -0
  330. package/docs/managers/folder_watermarks.md +37 -0
  331. package/docs/managers/folders.md +93 -0
  332. package/docs/managers/groups.md +66 -0
  333. package/docs/managers/hub_collaborations.md +59 -0
  334. package/docs/managers/hub_document.md +34 -0
  335. package/docs/managers/hub_items.md +32 -0
  336. package/docs/managers/hubs.md +90 -0
  337. package/docs/managers/integration_mappings.md +96 -0
  338. package/docs/managers/invites.md +28 -0
  339. package/docs/managers/legal_hold_policies.md +60 -0
  340. package/docs/managers/legal_hold_policy_assignments.md +80 -0
  341. package/docs/managers/list_collaborations.md +64 -0
  342. package/docs/managers/memberships.md +79 -0
  343. package/docs/managers/metadata_cascade_policies.md +60 -0
  344. package/docs/managers/metadata_taxonomies.md +206 -0
  345. package/docs/managers/metadata_templates.md +98 -0
  346. package/docs/managers/notes.md +13 -0
  347. package/docs/managers/recent_items.md +19 -0
  348. package/docs/managers/retention_policies.md +63 -0
  349. package/docs/managers/retention_policy_assignments.md +78 -0
  350. package/docs/managers/search.md +43 -0
  351. package/docs/managers/session_termination.md +21 -0
  352. package/docs/managers/shared_links_app_items.md +15 -0
  353. package/docs/managers/shared_links_files.md +67 -0
  354. package/docs/managers/shared_links_folders.md +67 -0
  355. package/docs/managers/shared_links_web_links.md +67 -0
  356. package/docs/managers/shield_information_barrier_reports.md +37 -0
  357. package/docs/managers/shield_information_barrier_segment_members.md +47 -0
  358. package/docs/managers/shield_information_barrier_segment_restrictions.md +47 -0
  359. package/docs/managers/shield_information_barrier_segments.md +59 -0
  360. package/docs/managers/shield_information_barriers.md +44 -0
  361. package/docs/managers/shield_lists.md +51 -0
  362. package/docs/managers/sign_requests.md +60 -0
  363. package/docs/managers/sign_templates.md +28 -0
  364. package/docs/managers/skills.md +61 -0
  365. package/docs/managers/storage_policies.md +29 -0
  366. package/docs/managers/storage_policy_assignments.md +59 -0
  367. package/docs/managers/task_assignments.md +55 -0
  368. package/docs/managers/tasks.md +55 -0
  369. package/docs/managers/terms_of_service_user_statuses.md +36 -0
  370. package/docs/managers/terms_of_services.md +45 -0
  371. package/docs/managers/transfer.md +19 -0
  372. package/docs/managers/trashed_files.md +39 -0
  373. package/docs/managers/trashed_folders.md +39 -0
  374. package/docs/managers/trashed_items.md +23 -0
  375. package/docs/managers/trashed_web_links.md +39 -0
  376. package/docs/managers/uploads.md +41 -0
  377. package/docs/managers/user_collaborations.md +51 -0
  378. package/docs/managers/users.md +82 -0
  379. package/docs/managers/web_links.md +46 -0
  380. package/docs/managers/webhooks.md +58 -0
  381. package/docs/managers/workflows.md +32 -0
  382. package/docs/managers/zip_downloads.md +33 -0
  383. package/docs/pagination.md +17 -0
  384. package/package.json +32 -0
@@ -0,0 +1,78 @@
1
+ // Code generated by box-gantry. DO NOT EDIT.
2
+ import * as runtime from '../runtime.js';
3
+ import { pathEscape } from '../internal.js';
4
+ /** Operations for the "file_metadata" API area. */
5
+ export class FileMetadataManager {
6
+ session;
7
+ constructor(session) {
8
+ this.session = session;
9
+ }
10
+ async listFileMetadata(fileId, opts) {
11
+ let url = this.session.baseUrl("api");
12
+ url += "/files";
13
+ url += '/' + pathEscape(fileId);
14
+ url += "/metadata";
15
+ let req = this.session.newRequest("GET", url);
16
+ const options = opts ?? {};
17
+ if (options.view !== undefined) {
18
+ req = runtime.withQuery(req, "view", options.view);
19
+ }
20
+ const resp = await this.session.fetch(req);
21
+ const data = runtime.responseBytes(resp);
22
+ return JSON.parse(new TextDecoder().decode(data));
23
+ }
24
+ async getFileMetadata(fileId, scope, templateKey, opts) {
25
+ let url = this.session.baseUrl("api");
26
+ url += "/files";
27
+ url += '/' + pathEscape(fileId);
28
+ url += "/metadata";
29
+ url += '/' + pathEscape(scope);
30
+ url += '/' + pathEscape(templateKey);
31
+ let req = this.session.newRequest("GET", url);
32
+ const options = opts ?? {};
33
+ if (options.view !== undefined) {
34
+ req = runtime.withQuery(req, "view", options.view);
35
+ }
36
+ const resp = await this.session.fetch(req);
37
+ const data = runtime.responseBytes(resp);
38
+ return JSON.parse(new TextDecoder().decode(data));
39
+ }
40
+ async updateFileMetadata(fileId, scope, templateKey, body) {
41
+ let url = this.session.baseUrl("api");
42
+ url += "/files";
43
+ url += '/' + pathEscape(fileId);
44
+ url += "/metadata";
45
+ url += '/' + pathEscape(scope);
46
+ url += '/' + pathEscape(templateKey);
47
+ let req = this.session.newRequest("PUT", url);
48
+ const payload = new TextEncoder().encode(JSON.stringify(body));
49
+ req = runtime.withJsonBody(req, payload);
50
+ const resp = await this.session.fetch(req);
51
+ const data = runtime.responseBytes(resp);
52
+ return JSON.parse(new TextDecoder().decode(data));
53
+ }
54
+ async createFileMetadata(fileId, scope, templateKey, body) {
55
+ let url = this.session.baseUrl("api");
56
+ url += "/files";
57
+ url += '/' + pathEscape(fileId);
58
+ url += "/metadata";
59
+ url += '/' + pathEscape(scope);
60
+ url += '/' + pathEscape(templateKey);
61
+ let req = this.session.newRequest("POST", url);
62
+ const payload = new TextEncoder().encode(JSON.stringify(body));
63
+ req = runtime.withJsonBody(req, payload);
64
+ const resp = await this.session.fetch(req);
65
+ const data = runtime.responseBytes(resp);
66
+ return JSON.parse(new TextDecoder().decode(data));
67
+ }
68
+ async deleteFileMetadata(fileId, scope, templateKey) {
69
+ let url = this.session.baseUrl("api");
70
+ url += "/files";
71
+ url += '/' + pathEscape(fileId);
72
+ url += "/metadata";
73
+ url += '/' + pathEscape(scope);
74
+ url += '/' + pathEscape(templateKey);
75
+ let req = this.session.newRequest("DELETE", url);
76
+ await this.session.fetch(req);
77
+ }
78
+ }
@@ -0,0 +1,53 @@
1
+ // Code generated by box-gantry. DO NOT EDIT.
2
+ import * as runtime from '../runtime.js';
3
+ import { pathEscape } from '../internal.js';
4
+ /** Operations for the "file_requests" API area. */
5
+ export class FileRequestsManager {
6
+ session;
7
+ constructor(session) {
8
+ this.session = session;
9
+ }
10
+ async get(fileRequestId) {
11
+ let url = this.session.baseUrl("api");
12
+ url += "/file_requests";
13
+ url += '/' + pathEscape(fileRequestId);
14
+ let req = this.session.newRequest("GET", url);
15
+ const resp = await this.session.fetch(req);
16
+ const data = runtime.responseBytes(resp);
17
+ return JSON.parse(new TextDecoder().decode(data));
18
+ }
19
+ async update(fileRequestId, body, opts) {
20
+ let url = this.session.baseUrl("api");
21
+ url += "/file_requests";
22
+ url += '/' + pathEscape(fileRequestId);
23
+ let req = this.session.newRequest("PUT", url);
24
+ const options = opts ?? {};
25
+ if (options["if-match"] !== undefined) {
26
+ req = runtime.withHeader(req, "if-match", options["if-match"]);
27
+ }
28
+ const payload = new TextEncoder().encode(JSON.stringify(body));
29
+ req = runtime.withJsonBody(req, payload);
30
+ const resp = await this.session.fetch(req);
31
+ const data = runtime.responseBytes(resp);
32
+ return JSON.parse(new TextDecoder().decode(data));
33
+ }
34
+ async delete_(fileRequestId) {
35
+ let url = this.session.baseUrl("api");
36
+ url += "/file_requests";
37
+ url += '/' + pathEscape(fileRequestId);
38
+ let req = this.session.newRequest("DELETE", url);
39
+ await this.session.fetch(req);
40
+ }
41
+ async copy(fileRequestId, body) {
42
+ let url = this.session.baseUrl("api");
43
+ url += "/file_requests";
44
+ url += '/' + pathEscape(fileRequestId);
45
+ url += "/copy";
46
+ let req = this.session.newRequest("POST", url);
47
+ const payload = new TextEncoder().encode(JSON.stringify(body));
48
+ req = runtime.withJsonBody(req, payload);
49
+ const resp = await this.session.fetch(req);
50
+ const data = runtime.responseBytes(resp);
51
+ return JSON.parse(new TextDecoder().decode(data));
52
+ }
53
+ }
@@ -0,0 +1,51 @@
1
+ // Code generated by box-gantry. DO NOT EDIT.
2
+ import * as runtime from '../runtime.js';
3
+ import { pathEscape } from '../internal.js';
4
+ /** Operations for the "file_version_legal_holds" API area. */
5
+ export class FileVersionLegalHoldsManager {
6
+ session;
7
+ constructor(session) {
8
+ this.session = session;
9
+ }
10
+ async get(fileVersionLegalHoldId) {
11
+ let url = this.session.baseUrl("api");
12
+ url += "/file_version_legal_holds";
13
+ url += '/' + pathEscape(fileVersionLegalHoldId);
14
+ let req = this.session.newRequest("GET", url);
15
+ const resp = await this.session.fetch(req);
16
+ const data = runtime.responseBytes(resp);
17
+ return JSON.parse(new TextDecoder().decode(data));
18
+ }
19
+ /** Iterate every `models.schemas.FileVersionLegalHold` across pages, threading the marker cursor. */
20
+ async *list(policyId, opts) {
21
+ const options = { ...opts };
22
+ for (;;) {
23
+ const page = await this.listPage(policyId, options);
24
+ const items = page.entries ?? [];
25
+ for (const item of items) {
26
+ yield item;
27
+ }
28
+ const cursor = page.next_marker;
29
+ if (cursor === undefined || cursor === null || cursor === '') {
30
+ return;
31
+ }
32
+ options.marker = cursor;
33
+ }
34
+ }
35
+ async listPage(policyId, opts) {
36
+ let url = this.session.baseUrl("api");
37
+ url += "/file_version_legal_holds";
38
+ let req = this.session.newRequest("GET", url);
39
+ req = runtime.withQuery(req, "policy_id", policyId);
40
+ const options = opts ?? {};
41
+ if (options.marker !== undefined) {
42
+ req = runtime.withQuery(req, "marker", options.marker);
43
+ }
44
+ if (options.limit !== undefined) {
45
+ req = runtime.withQuery(req, "limit", String(options.limit));
46
+ }
47
+ const resp = await this.session.fetch(req);
48
+ const data = runtime.responseBytes(resp);
49
+ return JSON.parse(new TextDecoder().decode(data));
50
+ }
51
+ }
@@ -0,0 +1,68 @@
1
+ // Code generated by box-gantry. DO NOT EDIT.
2
+ import * as runtime from '../runtime.js';
3
+ import { pathEscape } from '../internal.js';
4
+ /** Operations for the "file_version_retentions" API area. */
5
+ export class FileVersionRetentionsManager {
6
+ session;
7
+ constructor(session) {
8
+ this.session = session;
9
+ }
10
+ /** Iterate every `models.schemas.FileVersionRetention` across pages, threading the marker cursor. */
11
+ async *list(opts) {
12
+ const options = { ...opts };
13
+ for (;;) {
14
+ const page = await this.listPage(options);
15
+ const items = page.entries ?? [];
16
+ for (const item of items) {
17
+ yield item;
18
+ }
19
+ const cursor = page.next_marker;
20
+ if (cursor === undefined || cursor === null || cursor === '') {
21
+ return;
22
+ }
23
+ options.marker = cursor;
24
+ }
25
+ }
26
+ async listPage(opts) {
27
+ let url = this.session.baseUrl("api");
28
+ url += "/file_version_retentions";
29
+ let req = this.session.newRequest("GET", url);
30
+ const options = opts ?? {};
31
+ if (options.file_id !== undefined) {
32
+ req = runtime.withQuery(req, "file_id", options.file_id);
33
+ }
34
+ if (options.file_version_id !== undefined) {
35
+ req = runtime.withQuery(req, "file_version_id", options.file_version_id);
36
+ }
37
+ if (options.policy_id !== undefined) {
38
+ req = runtime.withQuery(req, "policy_id", options.policy_id);
39
+ }
40
+ if (options.disposition_action !== undefined) {
41
+ req = runtime.withQuery(req, "disposition_action", options.disposition_action);
42
+ }
43
+ if (options.disposition_before !== undefined) {
44
+ req = runtime.withQuery(req, "disposition_before", options.disposition_before);
45
+ }
46
+ if (options.disposition_after !== undefined) {
47
+ req = runtime.withQuery(req, "disposition_after", options.disposition_after);
48
+ }
49
+ if (options.limit !== undefined) {
50
+ req = runtime.withQuery(req, "limit", String(options.limit));
51
+ }
52
+ if (options.marker !== undefined) {
53
+ req = runtime.withQuery(req, "marker", options.marker);
54
+ }
55
+ const resp = await this.session.fetch(req);
56
+ const data = runtime.responseBytes(resp);
57
+ return JSON.parse(new TextDecoder().decode(data));
58
+ }
59
+ async get(fileVersionRetentionId) {
60
+ let url = this.session.baseUrl("api");
61
+ url += "/file_version_retentions";
62
+ url += '/' + pathEscape(fileVersionRetentionId);
63
+ let req = this.session.newRequest("GET", url);
64
+ const resp = await this.session.fetch(req);
65
+ const data = runtime.responseBytes(resp);
66
+ return JSON.parse(new TextDecoder().decode(data));
67
+ }
68
+ }
@@ -0,0 +1,103 @@
1
+ // Code generated by box-gantry. DO NOT EDIT.
2
+ import * as runtime from '../runtime.js';
3
+ import { pathEscape } from '../internal.js';
4
+ /** Operations for the "file_versions" API area. */
5
+ export class FileVersionsManager {
6
+ session;
7
+ constructor(session) {
8
+ this.session = session;
9
+ }
10
+ /** Iterate every `models.schemas.FileVersionFull` across pages, threading the offset cursor. */
11
+ async *listFileVersions(fileId, opts) {
12
+ const options = { ...opts };
13
+ for (;;) {
14
+ const page = await this.listFileVersionsPage(fileId, options);
15
+ const items = page.entries ?? [];
16
+ for (const item of items) {
17
+ yield item;
18
+ }
19
+ if (items.length === 0) {
20
+ return;
21
+ }
22
+ options.offset = (options.offset ?? 0) + items.length;
23
+ }
24
+ }
25
+ async listFileVersionsPage(fileId, opts) {
26
+ let url = this.session.baseUrl("api");
27
+ url += "/files";
28
+ url += '/' + pathEscape(fileId);
29
+ url += "/versions";
30
+ let req = this.session.newRequest("GET", url);
31
+ const options = opts ?? {};
32
+ if (options.fields !== undefined) {
33
+ req = runtime.withQuery(req, "fields", options.fields.join(','));
34
+ }
35
+ if (options.limit !== undefined) {
36
+ req = runtime.withQuery(req, "limit", String(options.limit));
37
+ }
38
+ if (options.offset !== undefined) {
39
+ req = runtime.withQuery(req, "offset", String(options.offset));
40
+ }
41
+ const resp = await this.session.fetch(req);
42
+ const data = runtime.responseBytes(resp);
43
+ return JSON.parse(new TextDecoder().decode(data));
44
+ }
45
+ async getFileVersion(fileId, fileVersionId, opts) {
46
+ let url = this.session.baseUrl("api");
47
+ url += "/files";
48
+ url += '/' + pathEscape(fileId);
49
+ url += "/versions";
50
+ url += '/' + pathEscape(fileVersionId);
51
+ let req = this.session.newRequest("GET", url);
52
+ const options = opts ?? {};
53
+ if (options.fields !== undefined) {
54
+ req = runtime.withQuery(req, "fields", options.fields.join(','));
55
+ }
56
+ const resp = await this.session.fetch(req);
57
+ const data = runtime.responseBytes(resp);
58
+ return JSON.parse(new TextDecoder().decode(data));
59
+ }
60
+ async updateFileVersion(fileId, fileVersionId, body) {
61
+ let url = this.session.baseUrl("api");
62
+ url += "/files";
63
+ url += '/' + pathEscape(fileId);
64
+ url += "/versions";
65
+ url += '/' + pathEscape(fileVersionId);
66
+ let req = this.session.newRequest("PUT", url);
67
+ const payload = new TextEncoder().encode(JSON.stringify(body));
68
+ req = runtime.withJsonBody(req, payload);
69
+ const resp = await this.session.fetch(req);
70
+ const data = runtime.responseBytes(resp);
71
+ return JSON.parse(new TextDecoder().decode(data));
72
+ }
73
+ async deleteFileVersion(fileId, fileVersionId, opts) {
74
+ let url = this.session.baseUrl("api");
75
+ url += "/files";
76
+ url += '/' + pathEscape(fileId);
77
+ url += "/versions";
78
+ url += '/' + pathEscape(fileVersionId);
79
+ let req = this.session.newRequest("DELETE", url);
80
+ const options = opts ?? {};
81
+ if (options["if-match"] !== undefined) {
82
+ req = runtime.withHeader(req, "if-match", options["if-match"]);
83
+ }
84
+ await this.session.fetch(req);
85
+ }
86
+ async createFileVersionCurrent(fileId, body, opts) {
87
+ let url = this.session.baseUrl("api");
88
+ url += "/files";
89
+ url += '/' + pathEscape(fileId);
90
+ url += "/versions";
91
+ url += "/current";
92
+ let req = this.session.newRequest("POST", url);
93
+ const options = opts ?? {};
94
+ if (options.fields !== undefined) {
95
+ req = runtime.withQuery(req, "fields", options.fields.join(','));
96
+ }
97
+ const payload = new TextEncoder().encode(JSON.stringify(body));
98
+ req = runtime.withJsonBody(req, payload);
99
+ const resp = await this.session.fetch(req);
100
+ const data = runtime.responseBytes(resp);
101
+ return JSON.parse(new TextDecoder().decode(data));
102
+ }
103
+ }
@@ -0,0 +1,40 @@
1
+ // Code generated by box-gantry. DO NOT EDIT.
2
+ import * as runtime from '../runtime.js';
3
+ import { pathEscape } from '../internal.js';
4
+ /** Operations for the "file_watermarks" API area. */
5
+ export class FileWatermarksManager {
6
+ session;
7
+ constructor(session) {
8
+ this.session = session;
9
+ }
10
+ async getFileWatermark(fileId) {
11
+ let url = this.session.baseUrl("api");
12
+ url += "/files";
13
+ url += '/' + pathEscape(fileId);
14
+ url += "/watermark";
15
+ let req = this.session.newRequest("GET", url);
16
+ const resp = await this.session.fetch(req);
17
+ const data = runtime.responseBytes(resp);
18
+ return JSON.parse(new TextDecoder().decode(data));
19
+ }
20
+ async updateFileWatermark(fileId, body) {
21
+ let url = this.session.baseUrl("api");
22
+ url += "/files";
23
+ url += '/' + pathEscape(fileId);
24
+ url += "/watermark";
25
+ let req = this.session.newRequest("PUT", url);
26
+ const payload = new TextEncoder().encode(JSON.stringify(body));
27
+ req = runtime.withJsonBody(req, payload);
28
+ const resp = await this.session.fetch(req);
29
+ const data = runtime.responseBytes(resp);
30
+ return JSON.parse(new TextDecoder().decode(data));
31
+ }
32
+ async deleteFileWatermark(fileId) {
33
+ let url = this.session.baseUrl("api");
34
+ url += "/files";
35
+ url += '/' + pathEscape(fileId);
36
+ url += "/watermark";
37
+ let req = this.session.newRequest("DELETE", url);
38
+ await this.session.fetch(req);
39
+ }
40
+ }
@@ -0,0 +1,101 @@
1
+ // Code generated by box-gantry. DO NOT EDIT.
2
+ import * as runtime from '../runtime.js';
3
+ import { pathEscape } from '../internal.js';
4
+ /** Operations for the "files" API area. */
5
+ export class FilesManager {
6
+ session;
7
+ constructor(session) {
8
+ this.session = session;
9
+ }
10
+ async get(fileId, opts) {
11
+ let url = this.session.baseUrl("api");
12
+ url += "/files";
13
+ url += '/' + pathEscape(fileId);
14
+ let req = this.session.newRequest("GET", url);
15
+ const options = opts ?? {};
16
+ if (options.fields !== undefined) {
17
+ req = runtime.withQuery(req, "fields", options.fields.join(','));
18
+ }
19
+ if (options["if-none-match"] !== undefined) {
20
+ req = runtime.withHeader(req, "if-none-match", options["if-none-match"]);
21
+ }
22
+ if (options.boxapi !== undefined) {
23
+ req = runtime.withHeader(req, "boxapi", options.boxapi);
24
+ }
25
+ if (options["x-rep-hints"] !== undefined) {
26
+ req = runtime.withHeader(req, "x-rep-hints", options["x-rep-hints"]);
27
+ }
28
+ const resp = await this.session.fetch(req);
29
+ const data = runtime.responseBytes(resp);
30
+ return JSON.parse(new TextDecoder().decode(data));
31
+ }
32
+ async update(fileId, body, opts) {
33
+ let url = this.session.baseUrl("api");
34
+ url += "/files";
35
+ url += '/' + pathEscape(fileId);
36
+ let req = this.session.newRequest("PUT", url);
37
+ const options = opts ?? {};
38
+ if (options.fields !== undefined) {
39
+ req = runtime.withQuery(req, "fields", options.fields.join(','));
40
+ }
41
+ if (options["if-match"] !== undefined) {
42
+ req = runtime.withHeader(req, "if-match", options["if-match"]);
43
+ }
44
+ const payload = new TextEncoder().encode(JSON.stringify(body));
45
+ req = runtime.withJsonBody(req, payload);
46
+ const resp = await this.session.fetch(req);
47
+ const data = runtime.responseBytes(resp);
48
+ return JSON.parse(new TextDecoder().decode(data));
49
+ }
50
+ async delete_(fileId, opts) {
51
+ let url = this.session.baseUrl("api");
52
+ url += "/files";
53
+ url += '/' + pathEscape(fileId);
54
+ let req = this.session.newRequest("DELETE", url);
55
+ const options = opts ?? {};
56
+ if (options["if-match"] !== undefined) {
57
+ req = runtime.withHeader(req, "if-match", options["if-match"]);
58
+ }
59
+ await this.session.fetch(req);
60
+ }
61
+ async copy(fileId, body, opts) {
62
+ let url = this.session.baseUrl("api");
63
+ url += "/files";
64
+ url += '/' + pathEscape(fileId);
65
+ url += "/copy";
66
+ let req = this.session.newRequest("POST", url);
67
+ const options = opts ?? {};
68
+ if (options.fields !== undefined) {
69
+ req = runtime.withQuery(req, "fields", options.fields.join(','));
70
+ }
71
+ const payload = new TextEncoder().encode(JSON.stringify(body));
72
+ req = runtime.withJsonBody(req, payload);
73
+ const resp = await this.session.fetch(req);
74
+ const data = runtime.responseBytes(resp);
75
+ return JSON.parse(new TextDecoder().decode(data));
76
+ }
77
+ async getThumbnail(fileId, extension, opts) {
78
+ let url = this.session.baseUrl("api");
79
+ url += "/files";
80
+ url += '/' + pathEscape(fileId);
81
+ url += '/';
82
+ url += "thumbnail.";
83
+ url += pathEscape(extension);
84
+ let req = this.session.newRequest("GET", url);
85
+ const options = opts ?? {};
86
+ if (options.min_height !== undefined) {
87
+ req = runtime.withQuery(req, "min_height", String(options.min_height));
88
+ }
89
+ if (options.min_width !== undefined) {
90
+ req = runtime.withQuery(req, "min_width", String(options.min_width));
91
+ }
92
+ if (options.max_height !== undefined) {
93
+ req = runtime.withQuery(req, "max_height", String(options.max_height));
94
+ }
95
+ if (options.max_width !== undefined) {
96
+ req = runtime.withQuery(req, "max_width", String(options.max_width));
97
+ }
98
+ const resp = await this.session.fetch(req);
99
+ return runtime.responseStream(resp);
100
+ }
101
+ }
@@ -0,0 +1,60 @@
1
+ // Code generated by box-gantry. DO NOT EDIT.
2
+ import * as runtime from '../runtime.js';
3
+ import { pathEscape } from '../internal.js';
4
+ /** Operations for the "folder_classifications" API area. */
5
+ export class FolderClassificationsManager {
6
+ session;
7
+ constructor(session) {
8
+ this.session = session;
9
+ }
10
+ async get(folderId) {
11
+ let url = this.session.baseUrl("api");
12
+ url += "/folders";
13
+ url += '/' + pathEscape(folderId);
14
+ url += "/metadata";
15
+ url += "/enterprise";
16
+ url += "/securityClassification-6VMVochwUWo";
17
+ let req = this.session.newRequest("GET", url);
18
+ const resp = await this.session.fetch(req);
19
+ const data = runtime.responseBytes(resp);
20
+ return JSON.parse(new TextDecoder().decode(data));
21
+ }
22
+ async update(folderId, body) {
23
+ let url = this.session.baseUrl("api");
24
+ url += "/folders";
25
+ url += '/' + pathEscape(folderId);
26
+ url += "/metadata";
27
+ url += "/enterprise";
28
+ url += "/securityClassification-6VMVochwUWo";
29
+ let req = this.session.newRequest("PUT", url);
30
+ const payload = new TextEncoder().encode(JSON.stringify(body));
31
+ req = runtime.withJsonBody(req, payload);
32
+ const resp = await this.session.fetch(req);
33
+ const data = runtime.responseBytes(resp);
34
+ return JSON.parse(new TextDecoder().decode(data));
35
+ }
36
+ async create(folderId, body) {
37
+ let url = this.session.baseUrl("api");
38
+ url += "/folders";
39
+ url += '/' + pathEscape(folderId);
40
+ url += "/metadata";
41
+ url += "/enterprise";
42
+ url += "/securityClassification-6VMVochwUWo";
43
+ let req = this.session.newRequest("POST", url);
44
+ const payload = new TextEncoder().encode(JSON.stringify(body));
45
+ req = runtime.withJsonBody(req, payload);
46
+ const resp = await this.session.fetch(req);
47
+ const data = runtime.responseBytes(resp);
48
+ return JSON.parse(new TextDecoder().decode(data));
49
+ }
50
+ async delete_(folderId) {
51
+ let url = this.session.baseUrl("api");
52
+ url += "/folders";
53
+ url += '/' + pathEscape(folderId);
54
+ url += "/metadata";
55
+ url += "/enterprise";
56
+ url += "/securityClassification-6VMVochwUWo";
57
+ let req = this.session.newRequest("DELETE", url);
58
+ await this.session.fetch(req);
59
+ }
60
+ }
@@ -0,0 +1,36 @@
1
+ // Code generated by box-gantry. DO NOT EDIT.
2
+ import * as runtime from '../runtime.js';
3
+ import { pathEscape } from '../internal.js';
4
+ /** Operations for the "folder_locks" API area. */
5
+ export class FolderLocksManager {
6
+ session;
7
+ constructor(session) {
8
+ this.session = session;
9
+ }
10
+ async list(folderId) {
11
+ let url = this.session.baseUrl("api");
12
+ url += "/folder_locks";
13
+ let req = this.session.newRequest("GET", url);
14
+ req = runtime.withQuery(req, "folder_id", folderId);
15
+ const resp = await this.session.fetch(req);
16
+ const data = runtime.responseBytes(resp);
17
+ return JSON.parse(new TextDecoder().decode(data));
18
+ }
19
+ async create(body) {
20
+ let url = this.session.baseUrl("api");
21
+ url += "/folder_locks";
22
+ let req = this.session.newRequest("POST", url);
23
+ const payload = new TextEncoder().encode(JSON.stringify(body));
24
+ req = runtime.withJsonBody(req, payload);
25
+ const resp = await this.session.fetch(req);
26
+ const data = runtime.responseBytes(resp);
27
+ return JSON.parse(new TextDecoder().decode(data));
28
+ }
29
+ async delete_(folderLockId) {
30
+ let url = this.session.baseUrl("api");
31
+ url += "/folder_locks";
32
+ url += '/' + pathEscape(folderLockId);
33
+ let req = this.session.newRequest("DELETE", url);
34
+ await this.session.fetch(req);
35
+ }
36
+ }
@@ -0,0 +1,74 @@
1
+ // Code generated by box-gantry. DO NOT EDIT.
2
+ import * as runtime from '../runtime.js';
3
+ import { pathEscape } from '../internal.js';
4
+ /** Operations for the "folder_metadata" API area. */
5
+ export class FolderMetadataManager {
6
+ session;
7
+ constructor(session) {
8
+ this.session = session;
9
+ }
10
+ async listFolderMetadata(folderId, opts) {
11
+ let url = this.session.baseUrl("api");
12
+ url += "/folders";
13
+ url += '/' + pathEscape(folderId);
14
+ url += "/metadata";
15
+ let req = this.session.newRequest("GET", url);
16
+ const options = opts ?? {};
17
+ if (options.view !== undefined) {
18
+ req = runtime.withQuery(req, "view", options.view);
19
+ }
20
+ const resp = await this.session.fetch(req);
21
+ const data = runtime.responseBytes(resp);
22
+ return JSON.parse(new TextDecoder().decode(data));
23
+ }
24
+ async getFolderMetadata(folderId, scope, templateKey) {
25
+ let url = this.session.baseUrl("api");
26
+ url += "/folders";
27
+ url += '/' + pathEscape(folderId);
28
+ url += "/metadata";
29
+ url += '/' + pathEscape(scope);
30
+ url += '/' + pathEscape(templateKey);
31
+ let req = this.session.newRequest("GET", url);
32
+ const resp = await this.session.fetch(req);
33
+ const data = runtime.responseBytes(resp);
34
+ return JSON.parse(new TextDecoder().decode(data));
35
+ }
36
+ async updateFolderMetadata(folderId, scope, templateKey, body) {
37
+ let url = this.session.baseUrl("api");
38
+ url += "/folders";
39
+ url += '/' + pathEscape(folderId);
40
+ url += "/metadata";
41
+ url += '/' + pathEscape(scope);
42
+ url += '/' + pathEscape(templateKey);
43
+ let req = this.session.newRequest("PUT", url);
44
+ const payload = new TextEncoder().encode(JSON.stringify(body));
45
+ req = runtime.withJsonBody(req, payload);
46
+ const resp = await this.session.fetch(req);
47
+ const data = runtime.responseBytes(resp);
48
+ return JSON.parse(new TextDecoder().decode(data));
49
+ }
50
+ async createFolderMetadata(folderId, scope, templateKey, body) {
51
+ let url = this.session.baseUrl("api");
52
+ url += "/folders";
53
+ url += '/' + pathEscape(folderId);
54
+ url += "/metadata";
55
+ url += '/' + pathEscape(scope);
56
+ url += '/' + pathEscape(templateKey);
57
+ let req = this.session.newRequest("POST", url);
58
+ const payload = new TextEncoder().encode(JSON.stringify(body));
59
+ req = runtime.withJsonBody(req, payload);
60
+ const resp = await this.session.fetch(req);
61
+ const data = runtime.responseBytes(resp);
62
+ return JSON.parse(new TextDecoder().decode(data));
63
+ }
64
+ async deleteFolderMetadata(folderId, scope, templateKey) {
65
+ let url = this.session.baseUrl("api");
66
+ url += "/folders";
67
+ url += '/' + pathEscape(folderId);
68
+ url += "/metadata";
69
+ url += '/' + pathEscape(scope);
70
+ url += '/' + pathEscape(templateKey);
71
+ let req = this.session.newRequest("DELETE", url);
72
+ await this.session.fetch(req);
73
+ }
74
+ }