@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,123 @@
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 "memberships" API area. */
5
+ export class MembershipsManager {
6
+ session;
7
+ constructor(session) {
8
+ this.session = session;
9
+ }
10
+ /** Iterate every `models.schemas.GroupMembership` across pages, threading the offset cursor. */
11
+ async *listUser(userId, opts) {
12
+ const options = { ...opts };
13
+ for (;;) {
14
+ const page = await this.listUserPage(userId, 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 listUserPage(userId, opts) {
26
+ let url = this.session.baseUrl("api");
27
+ url += "/users";
28
+ url += '/' + pathEscape(userId);
29
+ url += "/memberships";
30
+ let req = this.session.newRequest("GET", url);
31
+ const options = opts ?? {};
32
+ if (options.limit !== undefined) {
33
+ req = runtime.withQuery(req, "limit", String(options.limit));
34
+ }
35
+ if (options.offset !== undefined) {
36
+ req = runtime.withQuery(req, "offset", String(options.offset));
37
+ }
38
+ const resp = await this.session.fetch(req);
39
+ const data = runtime.responseBytes(resp);
40
+ return JSON.parse(new TextDecoder().decode(data));
41
+ }
42
+ /** Iterate every `models.schemas.GroupMembership` across pages, threading the offset cursor. */
43
+ async *listGroup(groupId, opts) {
44
+ const options = { ...opts };
45
+ for (;;) {
46
+ const page = await this.listGroupPage(groupId, options);
47
+ const items = page.entries ?? [];
48
+ for (const item of items) {
49
+ yield item;
50
+ }
51
+ if (items.length === 0) {
52
+ return;
53
+ }
54
+ options.offset = (options.offset ?? 0) + items.length;
55
+ }
56
+ }
57
+ async listGroupPage(groupId, opts) {
58
+ let url = this.session.baseUrl("api");
59
+ url += "/groups";
60
+ url += '/' + pathEscape(groupId);
61
+ url += "/memberships";
62
+ let req = this.session.newRequest("GET", url);
63
+ const options = opts ?? {};
64
+ if (options.limit !== undefined) {
65
+ req = runtime.withQuery(req, "limit", String(options.limit));
66
+ }
67
+ if (options.offset !== undefined) {
68
+ req = runtime.withQuery(req, "offset", String(options.offset));
69
+ }
70
+ const resp = await this.session.fetch(req);
71
+ const data = runtime.responseBytes(resp);
72
+ return JSON.parse(new TextDecoder().decode(data));
73
+ }
74
+ async createGroup(body, opts) {
75
+ let url = this.session.baseUrl("api");
76
+ url += "/group_memberships";
77
+ let req = this.session.newRequest("POST", url);
78
+ const options = opts ?? {};
79
+ if (options.fields !== undefined) {
80
+ req = runtime.withQuery(req, "fields", options.fields.join(','));
81
+ }
82
+ const payload = new TextEncoder().encode(JSON.stringify(body));
83
+ req = runtime.withJsonBody(req, payload);
84
+ const resp = await this.session.fetch(req);
85
+ const data = runtime.responseBytes(resp);
86
+ return JSON.parse(new TextDecoder().decode(data));
87
+ }
88
+ async getGroup(groupMembershipId, opts) {
89
+ let url = this.session.baseUrl("api");
90
+ url += "/group_memberships";
91
+ url += '/' + pathEscape(groupMembershipId);
92
+ let req = this.session.newRequest("GET", url);
93
+ const options = opts ?? {};
94
+ if (options.fields !== undefined) {
95
+ req = runtime.withQuery(req, "fields", options.fields.join(','));
96
+ }
97
+ const resp = await this.session.fetch(req);
98
+ const data = runtime.responseBytes(resp);
99
+ return JSON.parse(new TextDecoder().decode(data));
100
+ }
101
+ async updateGroup(groupMembershipId, body, opts) {
102
+ let url = this.session.baseUrl("api");
103
+ url += "/group_memberships";
104
+ url += '/' + pathEscape(groupMembershipId);
105
+ let req = this.session.newRequest("PUT", url);
106
+ const options = opts ?? {};
107
+ if (options.fields !== undefined) {
108
+ req = runtime.withQuery(req, "fields", options.fields.join(','));
109
+ }
110
+ const payload = new TextEncoder().encode(JSON.stringify(body));
111
+ req = runtime.withJsonBody(req, payload);
112
+ const resp = await this.session.fetch(req);
113
+ const data = runtime.responseBytes(resp);
114
+ return JSON.parse(new TextDecoder().decode(data));
115
+ }
116
+ async deleteGroup(groupMembershipId) {
117
+ let url = this.session.baseUrl("api");
118
+ url += "/group_memberships";
119
+ url += '/' + pathEscape(groupMembershipId);
120
+ let req = this.session.newRequest("DELETE", url);
121
+ await this.session.fetch(req);
122
+ }
123
+ }
@@ -0,0 +1,81 @@
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 "metadata_cascade_policies" API area. */
5
+ export class MetadataCascadePoliciesManager {
6
+ session;
7
+ constructor(session) {
8
+ this.session = session;
9
+ }
10
+ /** Iterate every `models.schemas.MetadataCascadePolicy` across pages, threading the marker cursor. */
11
+ async *list(folderId, opts) {
12
+ const options = { ...opts };
13
+ for (;;) {
14
+ const page = await this.listPage(folderId, 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(folderId, opts) {
27
+ let url = this.session.baseUrl("api");
28
+ url += "/metadata_cascade_policies";
29
+ let req = this.session.newRequest("GET", url);
30
+ req = runtime.withQuery(req, "folder_id", folderId);
31
+ const options = opts ?? {};
32
+ if (options.owner_enterprise_id !== undefined) {
33
+ req = runtime.withQuery(req, "owner_enterprise_id", options.owner_enterprise_id);
34
+ }
35
+ if (options.marker !== undefined) {
36
+ req = runtime.withQuery(req, "marker", options.marker);
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 create(body) {
46
+ let url = this.session.baseUrl("api");
47
+ url += "/metadata_cascade_policies";
48
+ let req = this.session.newRequest("POST", url);
49
+ const payload = new TextEncoder().encode(JSON.stringify(body));
50
+ req = runtime.withJsonBody(req, payload);
51
+ const resp = await this.session.fetch(req);
52
+ const data = runtime.responseBytes(resp);
53
+ return JSON.parse(new TextDecoder().decode(data));
54
+ }
55
+ async get(metadataCascadePolicyId) {
56
+ let url = this.session.baseUrl("api");
57
+ url += "/metadata_cascade_policies";
58
+ url += '/' + pathEscape(metadataCascadePolicyId);
59
+ let req = this.session.newRequest("GET", url);
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 delete_(metadataCascadePolicyId) {
65
+ let url = this.session.baseUrl("api");
66
+ url += "/metadata_cascade_policies";
67
+ url += '/' + pathEscape(metadataCascadePolicyId);
68
+ let req = this.session.newRequest("DELETE", url);
69
+ await this.session.fetch(req);
70
+ }
71
+ async apply(metadataCascadePolicyId, body) {
72
+ let url = this.session.baseUrl("api");
73
+ url += "/metadata_cascade_policies";
74
+ url += '/' + pathEscape(metadataCascadePolicyId);
75
+ url += "/apply";
76
+ let req = this.session.newRequest("POST", url);
77
+ const payload = new TextEncoder().encode(JSON.stringify(body));
78
+ req = runtime.withJsonBody(req, payload);
79
+ await this.session.fetch(req);
80
+ }
81
+ }
@@ -0,0 +1,285 @@
1
+ // Code generated by box-gantry. DO NOT EDIT.
2
+ import * as runtime from '../runtime.js';
3
+ import { join, pathEscape } from '../internal.js';
4
+ /** Operations for the "metadata_taxonomies" API area. */
5
+ export class MetadataTaxonomiesManager {
6
+ session;
7
+ constructor(session) {
8
+ this.session = session;
9
+ }
10
+ async create(body) {
11
+ let url = this.session.baseUrl("api");
12
+ url += "/metadata_taxonomies";
13
+ let req = this.session.newRequest("POST", url);
14
+ const payload = new TextEncoder().encode(JSON.stringify(body));
15
+ req = runtime.withJsonBody(req, payload);
16
+ const resp = await this.session.fetch(req);
17
+ const data = runtime.responseBytes(resp);
18
+ return JSON.parse(new TextDecoder().decode(data));
19
+ }
20
+ /** Iterate every `models.schemas.MetadataTaxonomy` across pages, threading the marker cursor. */
21
+ async *list(namespace, opts) {
22
+ const options = { ...opts };
23
+ for (;;) {
24
+ const page = await this.listPage(namespace, options);
25
+ const items = page.entries ?? [];
26
+ for (const item of items) {
27
+ yield item;
28
+ }
29
+ const cursor = page.next_marker;
30
+ if (cursor === undefined || cursor === null || cursor === '') {
31
+ return;
32
+ }
33
+ options.marker = cursor;
34
+ }
35
+ }
36
+ async listPage(namespace, opts) {
37
+ let url = this.session.baseUrl("api");
38
+ url += "/metadata_taxonomies";
39
+ url += '/' + pathEscape(namespace);
40
+ let req = this.session.newRequest("GET", url);
41
+ const options = opts ?? {};
42
+ if (options.marker !== undefined) {
43
+ req = runtime.withQuery(req, "marker", options.marker);
44
+ }
45
+ if (options.limit !== undefined) {
46
+ req = runtime.withQuery(req, "limit", String(options.limit));
47
+ }
48
+ const resp = await this.session.fetch(req);
49
+ const data = runtime.responseBytes(resp);
50
+ return JSON.parse(new TextDecoder().decode(data));
51
+ }
52
+ async get(namespace, taxonomyKey) {
53
+ let url = this.session.baseUrl("api");
54
+ url += "/metadata_taxonomies";
55
+ url += '/' + pathEscape(namespace);
56
+ url += '/' + pathEscape(taxonomyKey);
57
+ let req = this.session.newRequest("GET", url);
58
+ const resp = await this.session.fetch(req);
59
+ const data = runtime.responseBytes(resp);
60
+ return JSON.parse(new TextDecoder().decode(data));
61
+ }
62
+ async delete_(namespace, taxonomyKey) {
63
+ let url = this.session.baseUrl("api");
64
+ url += "/metadata_taxonomies";
65
+ url += '/' + pathEscape(namespace);
66
+ url += '/' + pathEscape(taxonomyKey);
67
+ let req = this.session.newRequest("DELETE", url);
68
+ await this.session.fetch(req);
69
+ }
70
+ async update(namespace, taxonomyKey, body) {
71
+ let url = this.session.baseUrl("api");
72
+ url += "/metadata_taxonomies";
73
+ url += '/' + pathEscape(namespace);
74
+ url += '/' + pathEscape(taxonomyKey);
75
+ let req = this.session.newRequest("PATCH", url);
76
+ const payload = new TextEncoder().encode(JSON.stringify(body));
77
+ req = runtime.withJsonBody(req, payload);
78
+ const resp = await this.session.fetch(req);
79
+ const data = runtime.responseBytes(resp);
80
+ return JSON.parse(new TextDecoder().decode(data));
81
+ }
82
+ async createLevels(namespace, taxonomyKey, body) {
83
+ let url = this.session.baseUrl("api");
84
+ url += "/metadata_taxonomies";
85
+ url += '/' + pathEscape(namespace);
86
+ url += '/' + pathEscape(taxonomyKey);
87
+ url += "/levels";
88
+ let req = this.session.newRequest("POST", url);
89
+ const payload = new TextEncoder().encode(JSON.stringify(body));
90
+ req = runtime.withJsonBody(req, payload);
91
+ const resp = await this.session.fetch(req);
92
+ const data = runtime.responseBytes(resp);
93
+ return JSON.parse(new TextDecoder().decode(data));
94
+ }
95
+ async updateLevel(namespace, taxonomyKey, levelIndex, body) {
96
+ let url = this.session.baseUrl("api");
97
+ url += "/metadata_taxonomies";
98
+ url += '/' + pathEscape(namespace);
99
+ url += '/' + pathEscape(taxonomyKey);
100
+ url += "/levels";
101
+ url += '/' + pathEscape(String(levelIndex));
102
+ let req = this.session.newRequest("PATCH", url);
103
+ const payload = new TextEncoder().encode(JSON.stringify(body));
104
+ req = runtime.withJsonBody(req, payload);
105
+ const resp = await this.session.fetch(req);
106
+ const data = runtime.responseBytes(resp);
107
+ return JSON.parse(new TextDecoder().decode(data));
108
+ }
109
+ async appendLevels(namespace, taxonomyKey, body) {
110
+ let url = this.session.baseUrl("api");
111
+ url += "/metadata_taxonomies";
112
+ url += '/' + pathEscape(namespace);
113
+ url += '/' + pathEscape(taxonomyKey);
114
+ url += "/levels:append";
115
+ let req = this.session.newRequest("POST", url);
116
+ const payload = new TextEncoder().encode(JSON.stringify(body));
117
+ req = runtime.withJsonBody(req, payload);
118
+ const resp = await this.session.fetch(req);
119
+ const data = runtime.responseBytes(resp);
120
+ return JSON.parse(new TextDecoder().decode(data));
121
+ }
122
+ async trimLevels(namespace, taxonomyKey) {
123
+ let url = this.session.baseUrl("api");
124
+ url += "/metadata_taxonomies";
125
+ url += '/' + pathEscape(namespace);
126
+ url += '/' + pathEscape(taxonomyKey);
127
+ url += "/levels:trim";
128
+ let req = this.session.newRequest("POST", url);
129
+ const resp = await this.session.fetch(req);
130
+ const data = runtime.responseBytes(resp);
131
+ return JSON.parse(new TextDecoder().decode(data));
132
+ }
133
+ /** Iterate every `models.schemas.MetadataTaxonomyNode` across pages, threading the marker cursor. */
134
+ async *listNodes(namespace, taxonomyKey, opts) {
135
+ const options = { ...opts };
136
+ for (;;) {
137
+ const page = await this.listNodesPage(namespace, taxonomyKey, options);
138
+ const items = page.entries ?? [];
139
+ for (const item of items) {
140
+ yield item;
141
+ }
142
+ const cursor = page.next_marker;
143
+ if (cursor === undefined || cursor === null || cursor === '') {
144
+ return;
145
+ }
146
+ options.marker = cursor;
147
+ }
148
+ }
149
+ async listNodesPage(namespace, taxonomyKey, opts) {
150
+ let url = this.session.baseUrl("api");
151
+ url += "/metadata_taxonomies";
152
+ url += '/' + pathEscape(namespace);
153
+ url += '/' + pathEscape(taxonomyKey);
154
+ url += "/nodes";
155
+ let req = this.session.newRequest("GET", url);
156
+ const options = opts ?? {};
157
+ if (options.level !== undefined) {
158
+ req = runtime.withQuery(req, "level", join(options.level, (v) => String(v)));
159
+ }
160
+ if (options.parent !== undefined) {
161
+ req = runtime.withQuery(req, "parent", options.parent.join(','));
162
+ }
163
+ if (options.ancestor !== undefined) {
164
+ req = runtime.withQuery(req, "ancestor", options.ancestor.join(','));
165
+ }
166
+ if (options.query !== undefined) {
167
+ req = runtime.withQuery(req, "query", options.query);
168
+ }
169
+ if (options["include-total-result-count"] !== undefined) {
170
+ req = runtime.withQuery(req, "include-total-result-count", String(options["include-total-result-count"]));
171
+ }
172
+ if (options.marker !== undefined) {
173
+ req = runtime.withQuery(req, "marker", options.marker);
174
+ }
175
+ if (options.limit !== undefined) {
176
+ req = runtime.withQuery(req, "limit", String(options.limit));
177
+ }
178
+ const resp = await this.session.fetch(req);
179
+ const data = runtime.responseBytes(resp);
180
+ return JSON.parse(new TextDecoder().decode(data));
181
+ }
182
+ async createNodes(namespace, taxonomyKey, body) {
183
+ let url = this.session.baseUrl("api");
184
+ url += "/metadata_taxonomies";
185
+ url += '/' + pathEscape(namespace);
186
+ url += '/' + pathEscape(taxonomyKey);
187
+ url += "/nodes";
188
+ let req = this.session.newRequest("POST", url);
189
+ const payload = new TextEncoder().encode(JSON.stringify(body));
190
+ req = runtime.withJsonBody(req, payload);
191
+ const resp = await this.session.fetch(req);
192
+ const data = runtime.responseBytes(resp);
193
+ return JSON.parse(new TextDecoder().decode(data));
194
+ }
195
+ async getNode(namespace, taxonomyKey, nodeId) {
196
+ let url = this.session.baseUrl("api");
197
+ url += "/metadata_taxonomies";
198
+ url += '/' + pathEscape(namespace);
199
+ url += '/' + pathEscape(taxonomyKey);
200
+ url += "/nodes";
201
+ url += '/' + pathEscape(nodeId);
202
+ let req = this.session.newRequest("GET", url);
203
+ const resp = await this.session.fetch(req);
204
+ const data = runtime.responseBytes(resp);
205
+ return JSON.parse(new TextDecoder().decode(data));
206
+ }
207
+ async deleteNode(namespace, taxonomyKey, nodeId) {
208
+ let url = this.session.baseUrl("api");
209
+ url += "/metadata_taxonomies";
210
+ url += '/' + pathEscape(namespace);
211
+ url += '/' + pathEscape(taxonomyKey);
212
+ url += "/nodes";
213
+ url += '/' + pathEscape(nodeId);
214
+ let req = this.session.newRequest("DELETE", url);
215
+ await this.session.fetch(req);
216
+ }
217
+ async updateNode(namespace, taxonomyKey, nodeId, body) {
218
+ let url = this.session.baseUrl("api");
219
+ url += "/metadata_taxonomies";
220
+ url += '/' + pathEscape(namespace);
221
+ url += '/' + pathEscape(taxonomyKey);
222
+ url += "/nodes";
223
+ url += '/' + pathEscape(nodeId);
224
+ let req = this.session.newRequest("PATCH", url);
225
+ const payload = new TextEncoder().encode(JSON.stringify(body));
226
+ req = runtime.withJsonBody(req, payload);
227
+ const resp = await this.session.fetch(req);
228
+ const data = runtime.responseBytes(resp);
229
+ return JSON.parse(new TextDecoder().decode(data));
230
+ }
231
+ /** Iterate every `models.schemas.MetadataTaxonomyNode` across pages, threading the marker cursor. */
232
+ async *listMetadataTemplateFieldOptions(namespace, templateKey, fieldKey, opts) {
233
+ const options = { ...opts };
234
+ for (;;) {
235
+ const page = await this.listMetadataTemplateFieldOptionsPage(namespace, templateKey, fieldKey, options);
236
+ const items = page.entries ?? [];
237
+ for (const item of items) {
238
+ yield item;
239
+ }
240
+ const cursor = page.next_marker;
241
+ if (cursor === undefined || cursor === null || cursor === '') {
242
+ return;
243
+ }
244
+ options.marker = cursor;
245
+ }
246
+ }
247
+ async listMetadataTemplateFieldOptionsPage(namespace, templateKey, fieldKey, opts) {
248
+ let url = this.session.baseUrl("api");
249
+ url += "/metadata_templates";
250
+ url += '/' + pathEscape(namespace);
251
+ url += '/' + pathEscape(templateKey);
252
+ url += "/fields";
253
+ url += '/' + pathEscape(fieldKey);
254
+ url += "/options";
255
+ let req = this.session.newRequest("GET", url);
256
+ const options = opts ?? {};
257
+ if (options.level !== undefined) {
258
+ req = runtime.withQuery(req, "level", join(options.level, (v) => String(v)));
259
+ }
260
+ if (options.parent !== undefined) {
261
+ req = runtime.withQuery(req, "parent", options.parent.join(','));
262
+ }
263
+ if (options.ancestor !== undefined) {
264
+ req = runtime.withQuery(req, "ancestor", options.ancestor.join(','));
265
+ }
266
+ if (options.query !== undefined) {
267
+ req = runtime.withQuery(req, "query", options.query);
268
+ }
269
+ if (options["include-total-result-count"] !== undefined) {
270
+ req = runtime.withQuery(req, "include-total-result-count", String(options["include-total-result-count"]));
271
+ }
272
+ if (options["only-selectable-options"] !== undefined) {
273
+ req = runtime.withQuery(req, "only-selectable-options", String(options["only-selectable-options"]));
274
+ }
275
+ if (options.marker !== undefined) {
276
+ req = runtime.withQuery(req, "marker", options.marker);
277
+ }
278
+ if (options.limit !== undefined) {
279
+ req = runtime.withQuery(req, "limit", String(options.limit));
280
+ }
281
+ const resp = await this.session.fetch(req);
282
+ const data = runtime.responseBytes(resp);
283
+ return JSON.parse(new TextDecoder().decode(data));
284
+ }
285
+ }
@@ -0,0 +1,159 @@
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 "metadata_templates" API area. */
5
+ export class MetadataTemplatesManager {
6
+ session;
7
+ constructor(session) {
8
+ this.session = session;
9
+ }
10
+ /** Iterate every `models.schemas.MetadataTemplate` across pages, threading the marker cursor. */
11
+ async *list(metadataInstanceId, opts) {
12
+ const options = { ...opts };
13
+ for (;;) {
14
+ const page = await this.listPage(metadataInstanceId, 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(metadataInstanceId, opts) {
27
+ let url = this.session.baseUrl("api");
28
+ url += "/metadata_templates";
29
+ let req = this.session.newRequest("GET", url);
30
+ req = runtime.withQuery(req, "metadata_instance_id", metadataInstanceId);
31
+ const options = opts ?? {};
32
+ if (options.marker !== undefined) {
33
+ req = runtime.withQuery(req, "marker", options.marker);
34
+ }
35
+ if (options.limit !== undefined) {
36
+ req = runtime.withQuery(req, "limit", String(options.limit));
37
+ }
38
+ const resp = await this.session.fetch(req);
39
+ const data = runtime.responseBytes(resp);
40
+ return JSON.parse(new TextDecoder().decode(data));
41
+ }
42
+ async getSchema(scope, templateKey) {
43
+ let url = this.session.baseUrl("api");
44
+ url += "/metadata_templates";
45
+ url += '/' + pathEscape(scope);
46
+ url += '/' + pathEscape(templateKey);
47
+ url += "/schema";
48
+ let req = this.session.newRequest("GET", url);
49
+ const resp = await this.session.fetch(req);
50
+ const data = runtime.responseBytes(resp);
51
+ return JSON.parse(new TextDecoder().decode(data));
52
+ }
53
+ async updateSchema(scope, templateKey, body) {
54
+ let url = this.session.baseUrl("api");
55
+ url += "/metadata_templates";
56
+ url += '/' + pathEscape(scope);
57
+ url += '/' + pathEscape(templateKey);
58
+ url += "/schema";
59
+ let req = this.session.newRequest("PUT", url);
60
+ const payload = new TextEncoder().encode(JSON.stringify(body));
61
+ req = runtime.withJsonBody(req, payload);
62
+ const resp = await this.session.fetch(req);
63
+ const data = runtime.responseBytes(resp);
64
+ return JSON.parse(new TextDecoder().decode(data));
65
+ }
66
+ async deleteSchema(scope, templateKey) {
67
+ let url = this.session.baseUrl("api");
68
+ url += "/metadata_templates";
69
+ url += '/' + pathEscape(scope);
70
+ url += '/' + pathEscape(templateKey);
71
+ url += "/schema";
72
+ let req = this.session.newRequest("DELETE", url);
73
+ await this.session.fetch(req);
74
+ }
75
+ async get(templateId) {
76
+ let url = this.session.baseUrl("api");
77
+ url += "/metadata_templates";
78
+ url += '/' + pathEscape(templateId);
79
+ let req = this.session.newRequest("GET", url);
80
+ const resp = await this.session.fetch(req);
81
+ const data = runtime.responseBytes(resp);
82
+ return JSON.parse(new TextDecoder().decode(data));
83
+ }
84
+ /** Iterate every `models.schemas.MetadataTemplate` across pages, threading the marker cursor. */
85
+ async *listGlobal(opts) {
86
+ const options = { ...opts };
87
+ for (;;) {
88
+ const page = await this.listGlobalPage(options);
89
+ const items = page.entries ?? [];
90
+ for (const item of items) {
91
+ yield item;
92
+ }
93
+ const cursor = page.next_marker;
94
+ if (cursor === undefined || cursor === null || cursor === '') {
95
+ return;
96
+ }
97
+ options.marker = cursor;
98
+ }
99
+ }
100
+ async listGlobalPage(opts) {
101
+ let url = this.session.baseUrl("api");
102
+ url += "/metadata_templates";
103
+ url += "/global";
104
+ let req = this.session.newRequest("GET", url);
105
+ const options = opts ?? {};
106
+ if (options.marker !== undefined) {
107
+ req = runtime.withQuery(req, "marker", options.marker);
108
+ }
109
+ if (options.limit !== undefined) {
110
+ req = runtime.withQuery(req, "limit", String(options.limit));
111
+ }
112
+ const resp = await this.session.fetch(req);
113
+ const data = runtime.responseBytes(resp);
114
+ return JSON.parse(new TextDecoder().decode(data));
115
+ }
116
+ /** Iterate every `models.schemas.MetadataTemplate` across pages, threading the marker cursor. */
117
+ async *listEnterprise(opts) {
118
+ const options = { ...opts };
119
+ for (;;) {
120
+ const page = await this.listEnterprisePage(options);
121
+ const items = page.entries ?? [];
122
+ for (const item of items) {
123
+ yield item;
124
+ }
125
+ const cursor = page.next_marker;
126
+ if (cursor === undefined || cursor === null || cursor === '') {
127
+ return;
128
+ }
129
+ options.marker = cursor;
130
+ }
131
+ }
132
+ async listEnterprisePage(opts) {
133
+ let url = this.session.baseUrl("api");
134
+ url += "/metadata_templates";
135
+ url += "/enterprise";
136
+ let req = this.session.newRequest("GET", url);
137
+ const options = opts ?? {};
138
+ if (options.marker !== undefined) {
139
+ req = runtime.withQuery(req, "marker", options.marker);
140
+ }
141
+ if (options.limit !== undefined) {
142
+ req = runtime.withQuery(req, "limit", String(options.limit));
143
+ }
144
+ const resp = await this.session.fetch(req);
145
+ const data = runtime.responseBytes(resp);
146
+ return JSON.parse(new TextDecoder().decode(data));
147
+ }
148
+ async createSchema(body) {
149
+ let url = this.session.baseUrl("api");
150
+ url += "/metadata_templates";
151
+ url += "/schema";
152
+ let req = this.session.newRequest("POST", url);
153
+ const payload = new TextEncoder().encode(JSON.stringify(body));
154
+ req = runtime.withJsonBody(req, payload);
155
+ const resp = await this.session.fetch(req);
156
+ const data = runtime.responseBytes(resp);
157
+ return JSON.parse(new TextDecoder().decode(data));
158
+ }
159
+ }
@@ -0,0 +1,21 @@
1
+ // Code generated by box-gantry. DO NOT EDIT.
2
+ import * as runtime from '../runtime.js';
3
+ /** Operations for the "notes" API area. */
4
+ export class NotesManager {
5
+ session;
6
+ constructor(session) {
7
+ this.session = session;
8
+ }
9
+ async convert(body) {
10
+ let url = this.session.baseUrl("api");
11
+ url += "/notes";
12
+ url += "/convert";
13
+ let req = this.session.newRequest("POST", url);
14
+ req = runtime.withHeader(req, "box-version", "2026.0");
15
+ const payload = new TextEncoder().encode(JSON.stringify(body));
16
+ req = runtime.withJsonBody(req, payload);
17
+ const resp = await this.session.fetch(req);
18
+ const data = runtime.responseBytes(resp);
19
+ return JSON.parse(new TextDecoder().decode(data));
20
+ }
21
+ }